| blob | 7e82050c803f5afdd6465512671a34b55c0b7452 |
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:
108 \f
109 ;;; Internal Variables
110 ;;
111 ;; Among internal variables, the most important is
112 ;; `org-export-options-alist'. This variable define the global export
113 ;; options, shared between every exporter, and how they are acquired.
153 "Alist between export properties and ways to set them.
155 The CAR of the alist is the property name, and the CDR is a list
156 like (KEYWORD OPTION DEFAULT BEHAVIOUR) where:
158 KEYWORD is a string representing a buffer keyword, or nil.
159 OPTION is a string that could be found in an #+OPTIONS: line.
160 DEFAULT is the default value for the property.
161 BEHAVIOUR determine how Org should handle multiple keywords for
162 the same property. It is a symbol among:
163 nil Keep old value and discard the new one.
164 t Replace old value with the new one.
165 `space' Concatenate the values, separating them with a space.
166 `newline' Concatenate the values, separating them with
167 a newline.
168 `split' Split values at white spaces, and cons them to the
169 previous list.
171 KEYWORD and OPTION have precedence over DEFAULT.
173 All these properties should be back-end agnostic. For back-end
174 specific properties, define a similar variable named
175 `org-BACKEND-options-alist', replacing BACKEND with the name of
176 the appropriate back-end. You can also redefine properties
181 "List of in-buffer keywords that require special treatment.
182 These keywords are not directly associated to a property. The
183 way they are handled must be hard-coded into
241 "Alist between filters properties and initial values.
243 The key of each association is a property name accessible through
244 the communication channel its value is a configurable global
245 variable defining initial filters.
247 This list is meant to install user specified filters. Back-end
248 developers may install their own filters using
249 `org-BACKEND-filters-alist', where BACKEND is the name of the
250 considered back-end. Filters defined there will always be
251 prepended to the current list, so they always get applied
260 "Default rule for link matching an inline image.
261 This rule applies to links with no description. By default, it
262 will be considered as an inline image if it targets a local file
265 See `org-export-inline-image-p' for more information about
269 \f
270 ;;; User-configurable Variables
271 ;;
272 ;; Configuration for the masses.
273 ;;
274 ;; They should never be accessed directly, as their value is to be
275 ;; stored in a property list (cf. `org-export-options-alist').
276 ;; Back-ends will read their value from there instead.
279 "Options for exporting Org mode files."
284 "General options for export engine."
289 "Whether sub-trees with the ARCHIVE tag should be exported.
291 This can have three different values:
292 nil Do not export, pretend this tree is not present.
293 t Do export the entire tree.
294 `headline' Only export the headline, but skip the tree below it.
296 This option can also be set with the #+OPTIONS line,
305 "Non-nil means insert author name into the exported file.
306 This option can also be set with the #+OPTIONS line,
312 "Non-nil means export CLOCK keywords.
313 This option can also be set with the #+OPTIONS line,
319 "Non-nil means the postamble should contain a creator sentence.
321 The sentence can be set in `org-export-creator-string' and
324 If the value is `comment' insert it as a comment."
334 emacs-version)
335 "String to insert at the end of the generated document."
340 "Non-nil means export contents of standard drawers.
342 When t, all drawers are exported. This may also be a list of
343 drawer names to export. This variable doesn't apply to
344 properties drawers.
346 This option can also be set with the #+OPTIONS line,
356 "Non-nil means insert author email into the exported file.
357 This option can also be set with the #+OPTIONS line,
363 "Non-nil means interpret *word*, /word/, and _word_ as emphasized text.
365 If the export target supports emphasizing text, the word will be
366 typeset in bold, italic, or underlined, respectively. Not all
367 export backends support this.
374 "Tags that exclude a tree from export.
376 All trees carrying any of these tags will be excluded from
377 export. This is without condition, so even subtrees inside that
378 carry one of the `org-export-select-tags' will be removed.
380 This option can also be set with the #+EXPORT_EXCLUDE_TAGS:
381 keyword."
388 This can be used to have pre-formatted text, fragments of code
389 etc. For example:
390 : ;; Some Lisp examples
391 : (while (defc cnt)
392 : (ding))
393 will be looking just like this in also HTML. See also the QUOTE
394 keyword. Not all export backends support this.
401 "Non-nil means Org footnotes should be exported.
402 This option can also be set with the #+OPTIONS line,
408 "The last level which is still exported as a headline.
410 Inferior levels will produce itemize lists when exported. Note
411 that a numeric prefix argument to an exporter function overrides
412 this setting.
419 "The default language for export and clocktable translations, as a string.
420 This may have an association in
421 `org-clock-clocktable-language-setup'."
426 "Non-nil means preserve all line breaks when exporting.
428 Normally, in HTML output paragraphs will be reformatted.
430 This option can also be set with the #+OPTIONS line,
436 "Non-nil means interpret entities when exporting.
439 Å.
441 For a list of supported names, see the constant `org-entities'
442 and the user option `org-entities-user'.
444 This option can also be set with the #+OPTIONS line,
450 "Non-nil means include planning info in export.
451 This option can also be set with the #+OPTIONS: line,
457 "Non-nil means include priority cookies in export.
459 When nil, remove priority cookies for export.
461 This option can also be set with the #+OPTIONS line,
467 "Non-nil means add section numbers to headlines when exporting.
469 When set to an integer n, numbering will only happen for
470 headlines whose relative level is higher or equal to n.
472 This option can also be set with the #+OPTIONS line,
478 "Tags that select a tree for export.
480 If any such tag is found in a buffer, all trees that do not carry
481 one of these tags will be ignored during export. Inside trees
482 that are selected like this, you can still deselect a subtree by
483 tagging it with one of the `org-export-exclude-tags'.
485 This option can also be set with the #+EXPORT_SELECT_TAGS:
486 keyword."
493 When this option is turned on, these strings will be exported as:
495 Org HTML LaTeX
496 -----+----------+--------
498 -- – --
499 --- — ---
500 ... … \ldots
502 This option can also be set with the #+OPTIONS line,
510 When this option is turned on, you can use TeX-like syntax for
512 will be considered as a single item - so grouping with {} is
513 normally not needed. For example, the following things will be
514 parsed as single sub- or superscripts.
516 10^24 or 10^tau several digits will be considered 1 item.
517 10^-12 or 10^-tau a leading sign with digits or a word
518 x^2-y^3 will be read as x^2 - y^3, because items are
519 terminated by almost any nonword/nondigit char.
520 x_{i^2} or x^(2-i) braces or parenthesis do grouping.
522 Still, ambiguity is possible - so when in doubt use {} to enclose
523 the sub/superscript. If you set this variable to the symbol
524 `{}', the braces are *required* in order to trigger
525 interpretations as sub/superscript. This can be helpful in
528 This option can also be set with the #+OPTIONS line,
537 "Non-nil means create a table of contents in exported files.
539 The TOC contains headlines with levels up
540 to`org-export-headline-levels'. When an integer, include levels
541 up to N in the toc, this may then be different from
542 `org-export-headline-levels', but it will not be allowed to be
543 larger than the number of headline levels. When nil, no table of
544 contents is made.
546 This option can also be set with the #+OPTIONS line,
556 For example:
558 | Name | Address | Birthday |
559 |-------------+----------+-----------|
560 | Arthur Dent | England | 29.2.2100 |
567 "If nil, do not export tags, just remove them from headlines.
569 If this is the symbol `not-in-toc', tags will be removed from
570 table of contents entries, but still be shown in the headlines of
571 the document.
573 This option can also be set with the #+OPTIONS line,
582 "Non-nil means include TODO items for export.
583 This may have the following values:
584 t include tasks independent of state.
585 todo include only tasks that are not yet done.
586 done include only tasks that are already done.
587 nil remove all tasks before export
588 list of keywords keep only tasks with these keywords"
599 "Non-nil means insert a time stamp into the exported file.
600 The time stamp shows when the file was created.
602 This option can also be set with the #+OPTIONS line,
608 "Non nil means allow timestamps in export.
610 It can be set to `active', `inactive', t or nil, in order to
611 export, respectively, only active timestamps, only inactive ones,
612 all of them or none.
614 This option can also be set with the #+OPTIONS line, e.g.
624 "Non-nil means include TODO keywords in export.
625 When nil, remove all these keywords from the export."
630 "Non-nil means allow #+BIND to define local variable values for export.
631 This is a potential security risk, which is why the user must
632 confirm the use of these lines."
640 "Alist between export snippets back-ends and exporter back-ends.
642 This variable allows to provide shortcuts for export snippets.
646 while every other back-end will ignore it."
654 "Coding system for the exported file."
659 "Non-nil means exported stuff will also be pushed onto the kill ring."
664 "The initial scope when exporting with `org-export-dispatch'.
665 This variable can be either set to `buffer' or `subtree'."
672 "Non-nil means show buffer after exporting to temp buffer.
673 When Org exports to a file, the buffer visiting that file is ever
674 shown, but remains buried. However, when exporting to
675 a temporary buffer, that buffer is popped up in a second window.
676 When this variable is nil, the buffer remains buried also in
677 these cases."
682 "Non-nil means using a non-intrusive `org-export-dispatch'.
683 In that case, no help buffer is displayed. Though, an indicator
687 considered for export\). Also, \[?] allows to switch back to
688 standard mode."
693 \f
694 ;;; Defining New Back-ends
697 "Create a new back-end as a variant of an existing one.
699 CHILD is the name of the derived back-end. PARENT is the name of
700 the parent back-end.
702 BODY can start with pre-defined keyword arguments. The following
703 keywords are understood:
705 `:filters-alist'
707 Alist of filters that will overwrite or complete filters
708 defined in PARENT back-end, if any.
710 `:options-alist'
712 Alist of buffer keywords or #+OPTIONS items that will
713 overwrite or complete those defined in PARENT back-end, if
714 any.
716 `:translate-alist'
718 Alist of element and object types and transcoders that will
719 overwrite or complete transcode table from PARENT back-end.
722 as a variant of `e-latex' back-end with a custom template
723 function:
725 \(org-export-define-derived-backend my-latex e-latex
726 :translate-alist ((template . my-latex-template-fun)))
728 The back-end could then be called with, for example:
741 ;; Define filters.
748 "Alist between filters keywords and back-end specific filters.
750 ;; Define options.
757 "Alist between LaTeX export properties and ways to set them.
758 See `org-export-options-alist' for more information on the
760 ;; Define translators.
767 ;; Splice in the body, if any.
771 \f
772 ;;; The Communication Channel
773 ;;
774 ;; During export process, every function has access to a number of
775 ;; properties. They are of two types:
776 ;;
777 ;; 1. Environment options are collected once at the very beginning of
778 ;; the process, out of the original buffer and configuration.
779 ;; Collecting them is handled by `org-export-get-environment'
780 ;; function.
781 ;;
782 ;; Most environment options are defined through the
783 ;; `org-export-options-alist' variable.
784 ;;
785 ;; 2. Tree properties are extracted directly from the parsed tree,
786 ;; just before export, by `org-export-collect-tree-properties'.
787 ;;
788 ;; Here is the full list of properties available during transcode
789 ;; process, with their category (option, tree or local) and their
790 ;; value type.
791 ;;
792 ;; + `:author' :: Author's name.
793 ;; - category :: option
794 ;; - type :: string
795 ;;
796 ;; + `:back-end' :: Current back-end used for transcoding.
797 ;; - category :: tree
798 ;; - type :: symbol
799 ;;
800 ;; + `:creator' :: String to write as creation information.
801 ;; - category :: option
802 ;; - type :: string
803 ;;
804 ;; + `:date' :: String to use as date.
805 ;; - category :: option
806 ;; - type :: string
807 ;;
808 ;; + `:description' :: Description text for the current data.
809 ;; - category :: option
810 ;; - type :: string
811 ;;
812 ;; + `:email' :: Author's email.
813 ;; - category :: option
814 ;; - type :: string
815 ;;
816 ;; + `:exclude-tags' :: Tags for exclusion of subtrees from export
817 ;; process.
818 ;; - category :: option
819 ;; - type :: list of strings
820 ;;
821 ;; + `:footnote-definition-alist' :: Alist between footnote labels and
822 ;; their definition, as parsed data. Only non-inlined footnotes
823 ;; are represented in this alist. Also, every definition isn't
824 ;; guaranteed to be referenced in the parse tree. The purpose of
825 ;; this property is to preserve definitions from oblivion
826 ;; (i.e. when the parse tree comes from a part of the original
827 ;; buffer), it isn't meant for direct use in a back-end. To
828 ;; retrieve a definition relative to a reference, use
829 ;; `org-export-get-footnote-definition' instead.
830 ;; - category :: option
831 ;; - type :: alist (STRING . LIST)
832 ;;
833 ;; + `:headline-levels' :: Maximum level being exported as an
834 ;; headline. Comparison is done with the relative level of
835 ;; headlines in the parse tree, not necessarily with their
836 ;; actual level.
837 ;; - category :: option
838 ;; - type :: integer
839 ;;
840 ;; + `:headline-offset' :: Difference between relative and real level
841 ;; of headlines in the parse tree. For example, a value of -1
842 ;; means a level 2 headline should be considered as level
843 ;; 1 (cf. `org-export-get-relative-level').
844 ;; - category :: tree
845 ;; - type :: integer
846 ;;
847 ;; + `:headline-numbering' :: Alist between headlines and their
848 ;; numbering, as a list of numbers
849 ;; (cf. `org-export-get-headline-number').
850 ;; - category :: tree
851 ;; - type :: alist (INTEGER . LIST)
852 ;;
853 ;; + `:id-alist' :: Alist between ID strings and destination file's
854 ;; path, relative to current directory. It is used by
855 ;; `org-export-resolve-id-link' to resolve ID links targeting an
856 ;; external file.
857 ;; - category :: option
858 ;; - type :: alist (STRING . STRING)
859 ;;
860 ;; + `:ignore-list' :: List of elements and objects that should be
861 ;; ignored during export.
862 ;; - category :: tree
863 ;; - type :: list of elements and objects
864 ;;
865 ;; + `:input-file' :: Full path to input file, if any.
866 ;; - category :: option
867 ;; - type :: string or nil
868 ;;
869 ;; + `:keywords' :: List of keywords attached to data.
870 ;; - category :: option
871 ;; - type :: string
872 ;;
873 ;; + `:language' :: Default language used for translations.
874 ;; - category :: option
875 ;; - type :: string
876 ;;
877 ;; + `:parse-tree' :: Whole parse tree, available at any time during
878 ;; transcoding.
879 ;; - category :: option
880 ;; - type :: list (as returned by `org-element-parse-buffer')
881 ;;
882 ;; + `:preserve-breaks' :: Non-nil means transcoding should preserve
883 ;; all line breaks.
884 ;; - category :: option
885 ;; - type :: symbol (nil, t)
886 ;;
887 ;; + `:section-numbers' :: Non-nil means transcoding should add
888 ;; section numbers to headlines.
889 ;; - category :: option
890 ;; - type :: symbol (nil, t)
891 ;;
892 ;; + `:select-tags' :: List of tags enforcing inclusion of sub-trees
893 ;; in transcoding. When such a tag is present, subtrees without
894 ;; it are de facto excluded from the process. See
895 ;; `use-select-tags'.
896 ;; - category :: option
897 ;; - type :: list of strings
898 ;;
899 ;; + `:target-list' :: List of targets encountered in the parse tree.
900 ;; This is used to partly resolve "fuzzy" links
901 ;; (cf. `org-export-resolve-fuzzy-link').
902 ;; - category :: tree
903 ;; - type :: list of strings
904 ;;
905 ;; + `:time-stamp-file' :: Non-nil means transcoding should insert
906 ;; a time stamp in the output.
907 ;; - category :: option
908 ;; - type :: symbol (nil, t)
909 ;;
910 ;; + `:translate-alist' :: Alist between element and object types and
911 ;; transcoding functions relative to the current back-end.
912 ;; Special keys `template' and `plain-text' are also possible.
913 ;; - category :: option
914 ;; - type :: alist (SYMBOL . FUNCTION)
915 ;;
916 ;; + `:with-archived-trees' :: Non-nil when archived subtrees should
917 ;; also be transcoded. If it is set to the `headline' symbol,
918 ;; only the archived headline's name is retained.
919 ;; - category :: option
920 ;; - type :: symbol (nil, t, `headline')
921 ;;
922 ;; + `:with-author' :: Non-nil means author's name should be included
923 ;; in the output.
924 ;; - category :: option
925 ;; - type :: symbol (nil, t)
926 ;;
927 ;; + `:with-clocks' :: Non-nild means clock keywords should be exported.
928 ;; - category :: option
929 ;; - type :: symbol (nil, t)
930 ;;
931 ;; + `:with-creator' :: Non-nild means a creation sentence should be
932 ;; inserted at the end of the transcoded string. If the value
933 ;; is `comment', it should be commented.
934 ;; - category :: option
935 ;; - type :: symbol (`comment', nil, t)
936 ;;
937 ;; + `:with-drawers' :: Non-nil means drawers should be exported. If
938 ;; its value is a list of names, only drawers with such names
939 ;; will be transcoded.
940 ;; - category :: option
941 ;; - type :: symbol (nil, t) or list of strings
942 ;;
943 ;; + `:with-email' :: Non-nil means output should contain author's
944 ;; email.
945 ;; - category :: option
946 ;; - type :: symbol (nil, t)
947 ;;
948 ;; + `:with-emphasize' :: Non-nil means emphasized text should be
949 ;; interpreted.
950 ;; - category :: option
951 ;; - type :: symbol (nil, t)
952 ;;
953 ;; + `:with-fixed-width' :: Non-nil if transcoder should interpret
954 ;; strings starting with a colon as a fixed-with (verbatim) area.
955 ;; - category :: option
956 ;; - type :: symbol (nil, t)
957 ;;
958 ;; + `:with-footnotes' :: Non-nil if transcoder should interpret
959 ;; footnotes.
960 ;; - category :: option
961 ;; - type :: symbol (nil, t)
962 ;;
963 ;; + `:with-plannings' :: Non-nil means transcoding should include
964 ;; planning info.
965 ;; - category :: option
966 ;; - type :: symbol (nil, t)
967 ;;
968 ;; + `:with-priority' :: Non-nil means transcoding should include
969 ;; priority cookies.
970 ;; - category :: option
971 ;; - type :: symbol (nil, t)
972 ;;
973 ;; + `:with-special-strings' :: Non-nil means transcoding should
974 ;; interpret special strings in plain text.
975 ;; - category :: option
976 ;; - type :: symbol (nil, t)
977 ;;
978 ;; + `:with-sub-superscript' :: Non-nil means transcoding should
979 ;; interpret subscript and superscript. With a value of "{}",
980 ;; only interpret those using curly brackets.
981 ;; - category :: option
982 ;; - type :: symbol (nil, {}, t)
983 ;;
984 ;; + `:with-tables' :: Non-nil means transcoding should interpret
985 ;; tables.
986 ;; - category :: option
987 ;; - type :: symbol (nil, t)
988 ;;
989 ;; + `:with-tags' :: Non-nil means transcoding should keep tags in
990 ;; headlines. A `not-in-toc' value will remove them from the
991 ;; table of contents, if any, nonetheless.
992 ;; - category :: option
993 ;; - type :: symbol (nil, t, `not-in-toc')
994 ;;
995 ;; + `:with-tasks' :: Non-nil means transcoding should include
996 ;; headlines with a TODO keyword. A `todo' value will only
997 ;; include headlines with a todo type keyword while a `done'
998 ;; value will do the contrary. If a list of strings is provided,
999 ;; only tasks with keywords belonging to that list will be kept.
1000 ;; - category :: option
1001 ;; - type :: symbol (t, todo, done, nil) or list of strings
1002 ;;
1003 ;; + `:with-timestamps' :: Non-nil means transcoding should include
1004 ;; time stamps. Special value `active' (resp. `inactive') ask to
1005 ;; export only active (resp. inactive) timestamps. Otherwise,
1006 ;; completely remove them.
1007 ;; - category :: option
1008 ;; - type :: symbol: (`active', `inactive', t, nil)
1009 ;;
1010 ;; + `:with-toc' :: Non-nil means that a table of contents has to be
1011 ;; added to the output. An integer value limits its depth.
1012 ;; - category :: option
1013 ;; - type :: symbol (nil, t or integer)
1014 ;;
1015 ;; + `:with-todo-keywords' :: Non-nil means transcoding should
1016 ;; include TODO keywords.
1017 ;; - category :: option
1018 ;; - type :: symbol (nil, t)
1021 ;;;; Environment Options
1022 ;;
1023 ;; Environment options encompass all parameters defined outside the
1024 ;; scope of the parsed data. They come from five sources, in
1025 ;; increasing precedence order:
1026 ;;
1027 ;; - Global variables,
1028 ;; - Buffer's attributes,
1029 ;; - Options keyword symbols,
1030 ;; - Buffer keywords,
1031 ;; - Subtree properties.
1032 ;;
1033 ;; The central internal function with regards to environment options
1034 ;; is `org-export-get-environment'. It updates global variables with
1035 ;; "#+BIND:" keywords, then retrieve and prioritize properties from
1036 ;; the different sources.
1037 ;;
1038 ;; The internal functions doing the retrieval are:
1039 ;; `org-export-get-global-options',
1040 ;; `org-export-get-buffer-attributes',
1041 ;; `org-export-parse-option-keyword',
1042 ;; `org-export-get-subtree-options' and
1043 ;; `org-export-get-inbuffer-options'
1044 ;;
1045 ;; Also, `org-export-confirm-letbind' and `org-export-install-letbind'
1046 ;; take care of the part relative to "#+BIND:" keywords.
1049 "Collect export options from the current buffer.
1051 Optional argument BACKEND is a symbol specifying which back-end
1052 specific options to read, if any.
1054 When optional argument SUBTREEP is non-nil, assume the export is
1055 done against the current sub-tree.
1057 Third optional argument EXT-PLIST is a property list with
1058 external parameters overriding Org default settings, but still
1059 inferior to file-local settings."
1060 ;; First install #+BIND variables.
1062 ;; Get and prioritize export options...
1064 ;; ... from global variables...
1066 ;; ... from buffer's attributes...
1068 ;; ... from an external property list...
1069 ext-plist
1070 ;; ... from in-buffer settings...
1072 backend
1074 ;; ... and from subtree, when appropriate.
1076 ;; Eventually install back-end symbol and its translation table.
1077 `(:back-end
1078 ,backend
1079 :translate-alist
1084 "Parse an OPTIONS line and return values as a plist.
1085 Optional argument BACKEND is a symbol specifying which back-end
1086 specific items to read, if any."
1093 ;; Build an alist between #+OPTION: item and property-name.
1098 all)))
1099 plist)
1104 options)
1109 alist)
1110 plist))
1113 "Get export options in subtree at point.
1114 Return options as a plist."
1117 ;; Make sure point is at an heading.
1125 plist :title
1136 plist)))
1139 "Return current buffer export options, as a plist.
1141 Optional argument BACKEND, when non-nil, is a symbol specifying
1142 which back-end specific options should also be read in the
1143 process.
1145 Optional argument FILES is a list of setup files names read so
1146 far, used to avoid circular dependencies.
1148 Assume buffer is in Org mode. Narrowing, if any, is ignored."
1152 ;; 1. Special keywords, as in `org-export-special-keywords'.
1165 ;; Avoid circular dependencies.
1177 val)
1185 ;; Value will be evaled: do not parse it.
1188 ;; Value has to be parsed for nested
1189 ;; macros.
1192 key
1195 ;; If user explicitly asks for
1196 ;; a newline, be sure to preserve it
1197 ;; from further filling with
1198 ;; `hard-newline'. Also replace
1199 ;; "\\n" with "\n", "\\\n" with "\\n"
1200 ;; and so on...
1207 restr)))))))))))
1209 ;; 2. Standard options, as in `org-export-options-alist'.
1211 ;; Also look for back-end specific options
1212 ;; if BACKEND is defined.
1218 ;; Build alist between keyword name and property name.
1222 all)))
1223 ;; Build regexp matching all keywords associated to export
1224 ;; options. Note: the search is case insensitive.
1237 plist prop
1238 ;; Handle value depending on specified BEHAVIOUR.
1251 ;; Parse keywords specified in `org-element-parsed-keywords'.
1259 plist prop
1262 org-element-parsed-keywords))
1263 ;; 3. Return final value.
1264 plist)))
1267 "Return properties related to buffer attributes, as a plist."
1270 ;; Store full path of input file name, or nil. For internal use.
1271 :input-file visited-file
1276 :footnote-definition-alist
1277 ;; Footnotes definitions must be collected in the original
1278 ;; buffer, as there's no insurance that they will still be in the
1279 ;; parse tree, due to possible narrowing.
1290 ;; Like `org-element-parse-buffer', but
1291 ;; makes sure the definition doesn't start
1292 ;; with a section element.
1296 alist))))
1297 alist))
1298 :id-alist
1299 ;; Collect id references.
1308 alist)
1309 :macro-modification-time
1315 ;; Store input file name as a macro.
1317 ;; `:macro-date', `:macro-time' and `:macro-property' could as
1318 ;; well be initialized as tree properties, since they don't
1319 ;; depend on buffer properties. Though, it may be more logical
1320 ;; to keep them close to other ":macro-" properties.
1326 "Return global export options as a plist.
1328 Optional argument BACKEND, if non-nil, is a symbol specifying
1329 which back-end specific export options should also be read in the
1330 process."
1336 ;; Output value.
1337 plist)
1342 plist
1344 ;; Eval default value provided. If keyword is a member
1345 ;; of `org-element-parsed-keywords', parse it as
1346 ;; a secondary string before storing it.
1353 all)
1354 ;; Return value.
1355 plist))
1359 "Can we use #+BIND values during export?
1360 By default this will ask for confirmation by the user, to divert
1361 possible security risks."
1370 "Install the values from #+BIND lines as local variables.
1371 Variables must be installed before in-buffer options are
1372 retrieved."
1379 letbind))))
1384 ;;;; Tree Properties
1385 ;;
1386 ;; Tree properties are infromation extracted from parse tree. They
1387 ;; are initialized at the beginning of the transcoding process by
1388 ;; `org-export-collect-tree-properties'.
1389 ;;
1390 ;; Dedicated functions focus on computing the value of specific tree
1391 ;; properties during initialization. Thus,
1392 ;; `org-export-populate-ignore-list' lists elements and objects that
1393 ;; should be skipped during export, `org-export-get-min-level' gets
1394 ;; the minimal exportable level, used as a basis to compute relative
1395 ;; level for headlines. Eventually
1396 ;; `org-export-collect-headline-numbering' builds an alist between
1397 ;; headlines and their numbering.
1400 "Extract tree properties from parse tree.
1402 DATA is the parse tree from which information is retrieved. INFO
1403 is a list holding export options.
1405 Following tree properties are set or updated:
1406 `:footnote-definition-alist' List of footnotes definitions in
1407 original buffer and current parse tree.
1409 `:headline-offset' Offset between true level of headlines and
1410 local level. An offset of -1 means an headline
1411 of level 2 should be considered as a level
1412 1 headline in the context.
1414 `:headline-numbering' Alist of all headlines as key an the
1415 associated numbering as value.
1417 `:ignore-list' List of elements that should be ignored during
1418 export.
1420 `:target-list' List of all targets in the parse tree.
1422 Return updated plist."
1423 ;; Install the parse tree in the communication channel, in order to
1424 ;; use `org-export-get-genealogy' and al.
1426 ;; Get the list of elements and objects to ignore, and put it into
1427 ;; `:ignore-list'. Do not overwrite any user ignore that might have
1428 ;; been done during parse tree filtering.
1431 :ignore-list
1434 ;; Compute `:headline-offset' in order to be able to use
1435 ;; `org-export-get-relative-level'.
1439 ;; Update footnotes definitions list with definitions in parse tree.
1440 ;; This is required since buffer expansion might have modified
1441 ;; boundaries of footnote definitions contained in the parse tree.
1442 ;; This way, definitions in `footnote-definition-alist' are bound to
1443 ;; match those in the parse tree.
1446 data 'footnote-definition
1450 defs)))
1452 ;; Properties order doesn't matter: get the rest of the tree
1453 ;; properties.
1455 `(:target-list
1463 info))
1466 "Return minimum exportable headline's level in DATA.
1467 DATA is parsed tree as returned by `org-element-parse-buffer'.
1468 OPTIONS is a plist holding export options."
1479 ;; If no headline was found, for the sake of consistency, set
1480 ;; minimum level to 1 nonetheless.
1484 "Return numbering of all exportable headlines in a parse tree.
1486 DATA is the parse tree. OPTIONS is the plist holding export
1487 options.
1489 Return an alist whose key is an headline and value is its
1490 associated numbering \(in the shape of a list of numbers\)."
1493 data
1494 'headline
1499 headline
1501 for idx from 0 to org-export-max-depth
1505 options)))
1508 "Return list of elements and objects to ignore during export.
1509 DATA is the parse tree to traverse. OPTIONS is the plist holding
1510 export options."
1512 walk-data ; for byte-compiler.
1516 ;; Collect ignored elements or objects into IGNORE-LIST.
1525 ;; If headline is archived but tree below has
1526 ;; to be skipped, add it to ignore list.
1529 ;; Move into recursive objects/elements.
1533 ;; Main call. First find trees containing a select tag, if any.
1535 ;; Return value.
1536 ignore))
1539 "Return list of headlines containing a select tag in their tree.
1540 DATA is parsed data as returned by `org-element-parse-buffer'.
1541 INFO is a plist holding export options."
1543 walk-data ; for byte-compiler.
1554 ;; When a select tag is found, mark full
1555 ;; genealogy and every headline within the tree
1556 ;; as acceptable.
1559 genealogy
1561 selected-trees))
1562 ;; Else, continue searching in tree, recursively.
1569 "Non-nil when element or object BLOB should be skipped during export.
1570 OPTIONS is the plist holding export options. SELECTED, when
1571 non-nil, is a list of headlines belonging to a tree with a select
1572 tag."
1574 ;; Check headline.
1582 ;; Ignore subtrees with an exclude tag.
1585 ;; When a select tag is present in the buffer, ignore any tree
1586 ;; without it.
1588 ;; Ignore commented sub-trees.
1590 ;; Ignore archived subtrees if `:with-archived-trees' is nil.
1592 ;; Ignore tasks, if specified by `:with-tasks' property.
1598 ;; Check timestamp.
1601 ;; No timestamp allowed.
1603 ;; Only active timestamps allowed and the current one isn't
1604 ;; active.
1608 ;; Only inactive timestamps allowed and the current one isn't
1609 ;; inactive.
1613 ;; Check drawer.
1619 ;; Check table-row.
1621 ;; Check table-cell.
1626 ;; Check clock.
1628 ;; Check planning.
1632 \f
1633 ;;; The Transcoder
1634 ;;
1635 ;; `org-export-data' reads a parse tree (obtained with, i.e.
1636 ;; `org-element-parse-buffer') and transcodes it into a specified
1637 ;; back-end output. It takes care of filtering out elements or
1638 ;; objects according to export options and organizing the output blank
1639 ;; lines and white space are preserved.
1640 ;;
1641 ;; Internally, three functions handle the filtering of objects and
1642 ;; elements during the export. In particular,
1643 ;; `org-export-ignore-element' marks an element or object so future
1644 ;; parse tree traversals skip it, `org-export-interpret-p' tells which
1645 ;; elements or objects should be seen as real Org syntax and
1646 ;; `org-export-expand' transforms the others back into their original
1647 ;; shape
1648 ;;
1649 ;; `org-export-transcoder' is an accessor returning appropriate
1650 ;; translator function for a given element or object.
1653 "Return appropriate transcoder for BLOB.
1654 INFO is a plist containing export directives."
1656 ;; Return contents only for complete parse trees.
1662 "Convert DATA into current back-end format.
1664 DATA is a parse tree, an element or an object or a secondary
1665 string. INFO is a plist holding export options.
1667 Return transcoded string."
1671 ;; Ignored element/object.
1673 ;; Plain text.
1679 info))
1680 ;; Uninterpreted element/object: change it back to Org
1681 ;; syntax and export again resulting raw string.
1685 data
1689 info))
1690 ;; Secondary string.
1693 ;; Element/Object without contents or, as a special case,
1694 ;; headline with archive tag and archived trees restricted
1695 ;; to title only.
1702 ;; Element/Object with contents.
1714 ;; Elements directly containing objects
1715 ;; must have their indentation normalized
1716 ;; first.
1718 data
1719 ;; When normalizing contents of the first
1720 ;; paragraph in an item or a footnote
1721 ;; definition, ignore first line's
1722 ;; indentation: there is none and it
1723 ;; might be misleading.
1727 data)
1733 contents)
1734 info))))))))
1738 ;; Append the same white space between elements or objects as in
1739 ;; the original buffer, and call appropriate filters.
1749 info)))
1750 ;; Eventually return string.
1751 results)))))
1754 "Non-nil if element or object BLOB should be interpreted as Org syntax.
1755 Check is done according to export options INFO, stored as
1756 a plist."
1758 ;; ... entities...
1760 ;; ... emphasis...
1762 ;; ... fixed-width areas.
1764 ;; ... footnotes...
1767 ;; ... sub/superscripts...
1773 ;; ... tables...
1778 "Expand a parsed element or object to its original state.
1779 BLOB is either an element or an object. CONTENTS is its
1780 contents, as a string or nil."
1783 blob contents))
1786 "Add ELEMENT to `:ignore-list' in INFO.
1788 Any element in `:ignore-list' will be skipped when using
1789 `org-element-map'. INFO is modified by side effects."
1793 \f
1794 ;;; The Filter System
1795 ;;
1796 ;; Filters allow end-users to tweak easily the transcoded output.
1797 ;; They are the functional counterpart of hooks, as every filter in
1798 ;; a set is applied to the return value of the previous one.
1799 ;;
1800 ;; Every set is back-end agnostic. Although, a filter is always
1801 ;; called, in addition to the string it applies to, with the back-end
1802 ;; used as argument, so it's easy for the end-user to add back-end
1803 ;; specific filters in the set. The communication channel, as
1804 ;; a plist, is required as the third argument.
1805 ;;
1806 ;; From the developer side, filters sets can be installed in the
1807 ;; process with the help of `org-BACKEND-filters-alist' variable.
1808 ;; Each association has a key among the following symbols and
1809 ;; a function or a list of functions as value.
1810 ;;
1811 ;; - `:filter-parse-tree' applies directly on the complete parsed
1812 ;; tree. It's the only filters set that doesn't apply to a string.
1813 ;; Users can set it through `org-export-filter-parse-tree-functions'
1814 ;; variable.
1815 ;;
1816 ;; - `:filter-final-output' applies to the final transcoded string.
1817 ;; Users can set it with `org-export-filter-final-output-functions'
1818 ;; variable
1819 ;;
1820 ;; - `:filter-plain-text' applies to any string not recognized as Org
1821 ;; syntax. `org-export-filter-plain-text-functions' allows users to
1822 ;; configure it.
1823 ;;
1824 ;; - `:filter-TYPE' applies on the string returned after an element or
1825 ;; object of type TYPE has been transcoded. An user can modify
1826 ;; `org-export-filter-TYPE-functions'
1827 ;;
1828 ;; All filters sets are applied with
1829 ;; `org-export-filter-apply-functions' function. Filters in a set are
1830 ;; applied in a LIFO fashion. It allows developers to be sure that
1831 ;; their filters will be applied first.
1832 ;;
1833 ;; Filters properties are installed in communication channel with
1834 ;; `org-export-install-filters' function.
1835 ;;
1836 ;; Eventually, a hook (`org-export-before-parsing-hook') is run just
1837 ;; before parsing to allow for heavy structure modifications.
1840 ;;;; Before Parsing Hook
1843 "Hook run before parsing an export buffer.
1844 This is run after include keywords have been expanded and Babel
1845 code executed, on a copy of original buffer's area being
1846 exported. Visibility is the same as in the original one. Point
1850 ;;;; Special Filters
1853 "List of functions applied to the parsed tree.
1854 Each filter is called with three arguments: the parse tree, as
1855 returned by `org-element-parse-buffer', the back-end, as
1856 a symbol, and the communication channel, as a plist. It must
1860 "List of functions applied to the transcoded string.
1861 Each filter is called with three arguments: the full transcoded
1862 string, the back-end, as a symbol, and the communication channel,
1863 as a plist. It must return a string that will be used as the
1867 "List of functions applied to plain text.
1868 Each filter is called with three arguments: a string which
1869 contains no Org syntax, the back-end, as a symbol, and the
1870 communication channel, as a plist. It must return a string or
1874 ;;;; Elements Filters
1877 "List of functions applied to a transcoded center block.
1878 Each filter is called with three arguments: the transcoded data,
1879 as a string, the back-end, as a symbol, and the communication
1883 "List of functions applied to a transcoded clock.
1884 Each filter is called with three arguments: the transcoded data,
1885 as a string, the back-end, as a symbol, and the communication
1889 "List of functions applied to a transcoded drawer.
1890 Each filter is called with three arguments: the transcoded data,
1891 as a string, the back-end, as a symbol, and the communication
1895 "List of functions applied to a transcoded dynamic-block.
1896 Each filter is called with three arguments: the transcoded data,
1897 as a string, the back-end, as a symbol, and the communication
1901 "List of functions applied to a transcoded headline.
1902 Each filter is called with three arguments: the transcoded data,
1903 as a string, the back-end, as a symbol, and the communication
1907 "List of functions applied to a transcoded inlinetask.
1908 Each filter is called with three arguments: the transcoded data,
1909 as a string, the back-end, as a symbol, and the communication
1913 "List of functions applied to a transcoded plain-list.
1914 Each filter is called with three arguments: the transcoded data,
1915 as a string, the back-end, as a symbol, and the communication
1919 "List of functions applied to a transcoded item.
1920 Each filter is called with three arguments: the transcoded data,
1921 as a string, the back-end, as a symbol, and the communication
1925 "List of functions applied to a transcoded comment.
1926 Each filter is called with three arguments: the transcoded data,
1927 as a string, the back-end, as a symbol, and the communication
1931 "List of functions applied to a transcoded comment-comment.
1932 Each filter is called with three arguments: the transcoded data,
1933 as a string, the back-end, as a symbol, and the communication
1937 "List of functions applied to a transcoded example-block.
1938 Each filter is called with three arguments: the transcoded data,
1939 as a string, the back-end, as a symbol, and the communication
1943 "List of functions applied to a transcoded export-block.
1944 Each filter is called with three arguments: the transcoded data,
1945 as a string, the back-end, as a symbol, and the communication
1949 "List of functions applied to a transcoded fixed-width.
1950 Each filter is called with three arguments: the transcoded data,
1951 as a string, the back-end, as a symbol, and the communication
1955 "List of functions applied to a transcoded footnote-definition.
1956 Each filter is called with three arguments: the transcoded data,
1957 as a string, the back-end, as a symbol, and the communication
1961 "List of functions applied to a transcoded horizontal-rule.
1962 Each filter is called with three arguments: the transcoded data,
1963 as a string, the back-end, as a symbol, and the communication
1967 "List of functions applied to a transcoded keyword.
1968 Each filter is called with three arguments: the transcoded data,
1969 as a string, the back-end, as a symbol, and the communication
1973 "List of functions applied to a transcoded latex-environment.
1974 Each filter is called with three arguments: the transcoded data,
1975 as a string, the back-end, as a symbol, and the communication
1979 "List of functions applied to a transcoded babel-call.
1980 Each filter is called with three arguments: the transcoded data,
1981 as a string, the back-end, as a symbol, and the communication
1985 "List of functions applied to a transcoded paragraph.
1986 Each filter is called with three arguments: the transcoded data,
1987 as a string, the back-end, as a symbol, and the communication
1991 "List of functions applied to a transcoded planning.
1992 Each filter is called with three arguments: the transcoded data,
1993 as a string, the back-end, as a symbol, and the communication
1997 "List of functions applied to a transcoded property-drawer.
1998 Each filter is called with three arguments: the transcoded data,
1999 as a string, the back-end, as a symbol, and the communication
2003 "List of functions applied to a transcoded quote block.
2004 Each filter is called with three arguments: the transcoded quote
2005 data, as a string, the back-end, as a symbol, and the
2006 communication channel, as a plist. It must return a string or
2010 "List of functions applied to a transcoded quote-section.
2011 Each filter is called with three arguments: the transcoded data,
2012 as a string, the back-end, as a symbol, and the communication
2016 "List of functions applied to a transcoded section.
2017 Each filter is called with three arguments: the transcoded data,
2018 as a string, the back-end, as a symbol, and the communication
2022 "List of functions applied to a transcoded special block.
2023 Each filter is called with three arguments: the transcoded data,
2024 as a string, the back-end, as a symbol, and the communication
2028 "List of functions applied to a transcoded src-block.
2029 Each filter is called with three arguments: the transcoded data,
2030 as a string, the back-end, as a symbol, and the communication
2034 "List of functions applied to a transcoded table.
2035 Each filter is called with three arguments: the transcoded data,
2036 as a string, the back-end, as a symbol, and the communication
2040 "List of functions applied to a transcoded table-cell.
2041 Each filter is called with three arguments: the transcoded data,
2042 as a string, the back-end, as a symbol, and the communication
2046 "List of functions applied to a transcoded table-row.
2047 Each filter is called with three arguments: the transcoded data,
2048 as a string, the back-end, as a symbol, and the communication
2052 "List of functions applied to a transcoded verse block.
2053 Each filter is called with three arguments: the transcoded data,
2054 as a string, the back-end, as a symbol, and the communication
2058 ;;;; Objects Filters
2061 "List of functions applied to transcoded bold text.
2062 Each filter is called with three arguments: the transcoded data,
2063 as a string, the back-end, as a symbol, and the communication
2067 "List of functions applied to transcoded code text.
2068 Each filter is called with three arguments: the transcoded data,
2069 as a string, the back-end, as a symbol, and the communication
2073 "List of functions applied to a transcoded entity.
2074 Each filter is called with three arguments: the transcoded data,
2075 as a string, the back-end, as a symbol, and the communication
2079 "List of functions applied to a transcoded export-snippet.
2080 Each filter is called with three arguments: the transcoded data,
2081 as a string, the back-end, as a symbol, and the communication
2085 "List of functions applied to a transcoded footnote-reference.
2086 Each filter is called with three arguments: the transcoded data,
2087 as a string, the back-end, as a symbol, and the communication
2091 "List of functions applied to a transcoded inline-babel-call.
2092 Each filter is called with three arguments: the transcoded data,
2093 as a string, the back-end, as a symbol, and the communication
2097 "List of functions applied to a transcoded inline-src-block.
2098 Each filter is called with three arguments: the transcoded data,
2099 as a string, the back-end, as a symbol, and the communication
2103 "List of functions applied to transcoded italic text.
2104 Each filter is called with three arguments: the transcoded data,
2105 as a string, the back-end, as a symbol, and the communication
2109 "List of functions applied to a transcoded latex-fragment.
2110 Each filter is called with three arguments: the transcoded data,
2111 as a string, the back-end, as a symbol, and the communication
2115 "List of functions applied to a transcoded line-break.
2116 Each filter is called with three arguments: the transcoded data,
2117 as a string, the back-end, as a symbol, and the communication
2121 "List of functions applied to a transcoded link.
2122 Each filter is called with three arguments: the transcoded data,
2123 as a string, the back-end, as a symbol, and the communication
2127 "List of functions applied to a transcoded macro.
2128 Each filter is called with three arguments: the transcoded data,
2129 as a string, the back-end, as a symbol, and the communication
2133 "List of functions applied to a transcoded radio-target.
2134 Each filter is called with three arguments: the transcoded data,
2135 as a string, the back-end, as a symbol, and the communication
2139 "List of functions applied to a transcoded statistics-cookie.
2140 Each filter is called with three arguments: the transcoded data,
2141 as a string, the back-end, as a symbol, and the communication
2145 "List of functions applied to transcoded strike-through text.
2146 Each filter is called with three arguments: the transcoded data,
2147 as a string, the back-end, as a symbol, and the communication
2151 "List of functions applied to a transcoded subscript.
2152 Each filter is called with three arguments: the transcoded data,
2153 as a string, the back-end, as a symbol, and the communication
2157 "List of functions applied to a transcoded superscript.
2158 Each filter is called with three arguments: the transcoded data,
2159 as a string, the back-end, as a symbol, and the communication
2163 "List of functions applied to a transcoded target.
2164 Each filter is called with three arguments: the transcoded data,
2165 as a string, the back-end, as a symbol, and the communication
2169 "List of functions applied to a transcoded timestamp.
2170 Each filter is called with three arguments: the transcoded data,
2171 as a string, the back-end, as a symbol, and the communication
2175 "List of functions applied to transcoded underline text.
2176 Each filter is called with three arguments: the transcoded data,
2177 as a string, the back-end, as a symbol, and the communication
2181 "List of functions applied to transcoded verbatim text.
2182 Each filter is called with three arguments: the transcoded data,
2183 as a string, the back-end, as a symbol, and the communication
2187 ;;;; Filters Tools
2188 ;;
2189 ;; Internal function `org-export-install-filters' installs filters
2190 ;; hard-coded in back-ends (developer filters) and filters from global
2191 ;; variables (user filters) in the communication channel.
2192 ;;
2193 ;; Internal function `org-export-filter-apply-functions' takes care
2194 ;; about applying each filter in order to a given data. It stops
2195 ;; whenever a filter returns a nil value.
2196 ;;
2197 ;; User-oriented function `org-export-set-element' replaces one
2198 ;; element or object in the parse tree with another one. It is meant
2199 ;; to be used as a tool for parse tree filters.
2202 "Call every function in FILTERS.
2203 Functions are called with arguments VALUE, current export
2204 back-end and INFO. Call is done in a LIFO fashion, to be sure
2205 that developer specified filters, if any, are called first."
2209 value)
2212 "Install filters properties in communication channel.
2214 INFO is a plist containing the current communication channel.
2216 Return the updated communication channel."
2218 ;; Install user defined filters with `org-export-filters-alist'.
2221 org-export-filters-alist)
2222 ;; Prepend back-end specific filters to that list.
2227 ;; Single values get consed, lists are prepended.
2232 plist key
2236 ;; Return new communication channel.
2240 "Replace element or object OLD with element or object NEW.
2241 The function takes care of setting `:parent' property for NEW."
2242 ;; OLD can belong to the contents of PARENT or to its secondary
2243 ;; string.
2246 org-element-secondary-value-alist)))
2249 ;; Ensure NEW has correct parent. Then replace OLD with NEW.
2256 \f
2257 ;;; Core functions
2258 ;;
2259 ;; This is the room for the main function, `org-export-as', along with
2260 ;; its derivatives, `org-export-to-buffer' and `org-export-to-file'.
2261 ;; They differ only by the way they output the resulting code.
2262 ;;
2263 ;; `org-export-output-file-name' is an auxiliary function meant to be
2264 ;; used with `org-export-to-file'. With a given extension, it tries
2265 ;; to provide a canonical file name to write export output to.
2266 ;;
2267 ;; Note that `org-export-as' doesn't really parse the current buffer,
2268 ;; but a copy of it (with the same buffer-local variables and
2269 ;; visibility), where include keywords are expanded and Babel blocks
2270 ;; are executed, if appropriate.
2271 ;; `org-export-with-current-buffer-copy' macro prepares that copy.
2272 ;;
2273 ;; File inclusion is taken care of by
2274 ;; `org-export-expand-include-keyword' and
2275 ;; `org-export-prepare-file-contents'. Structure wise, including
2276 ;; a whole Org file in a buffer often makes little sense. For
2277 ;; example, if the file contains an headline and the include keyword
2278 ;; was within an item, the item should contain the headline. That's
2279 ;; why file inclusion should be done before any structure can be
2280 ;; associated to the file, that is before parsing.
2286 "Transcode current Org buffer into BACKEND code.
2288 If narrowing is active in the current buffer, only transcode its
2289 narrowed part.
2291 If a region is active, transcode that region.
2293 When optional argument SUBTREEP is non-nil, transcode the
2294 sub-tree at point, extracting information from the headline
2295 properties first.
2297 When optional argument VISIBLE-ONLY is non-nil, don't export
2298 contents of hidden elements.
2300 When optional argument BODY-ONLY is non-nil, only return body
2301 code, without preamble nor postamble.
2303 Optional argument EXT-PLIST, when provided, is a property list
2304 with external parameters overriding Org default settings, but
2305 still inferior to file-local settings.
2307 Optional argument NOEXPAND, when non-nil, prevents included files
2308 to be expanded and Babel code to be executed.
2310 Return code as a string."
2313 ;; Narrow buffer to an appropriate region or subtree for
2314 ;; parsing. If parsing subtree, be sure to remove main headline
2315 ;; too.
2323 ;; 1. Get export environment from original buffer. Store
2324 ;; original footnotes definitions in communication channel as
2325 ;; they might not be accessible anymore in a narrowed parse
2326 ;; tree. Also install user's and developer's filters.
2329 ;; 2. Get parse tree. Buffer isn't parsed directly.
2330 ;; Instead, a temporary copy is created, where include
2331 ;; keywords are expanded and code blocks are evaluated.
2337 ;; Setting `org-current-export-file' is
2338 ;; required by Org Babel to properly resolve
2339 ;; noweb references.
2343 ;; Run hook with `org-export-current-backend' set
2344 ;; to BACKEND.
2347 ;; Eventually parse buffer.
2349 ;; 3. Call parse-tree filters to get the final tree.
2353 ;; 4. Now tree is complete, compute its properties and add
2354 ;; them to communication channel.
2358 ;; 5. Eventually transcode TREE. Wrap the resulting string
2359 ;; into a template, if required. Eventually call
2360 ;; final-output filter.
2368 info)))
2369 ;; Maybe add final OUTPUT to kill ring, then return it.
2371 output)))))
2375 "Call `org-export-as' with output to a specified buffer.
2377 BACKEND is the back-end used for transcoding, as a symbol.
2379 BUFFER is the output buffer. If it already exists, it will be
2380 erased first, otherwise, it will be created.
2382 Optional arguments SUBTREEP, VISIBLE-ONLY, BODY-ONLY, EXT-PLIST
2383 and NOEXPAND are similar to those used in `org-export-as', which
2384 see.
2386 Return buffer."
2388 backend subtreep visible-only body-only ext-plist noexpand))
2394 buffer))
2398 "Call `org-export-as' with output to a specified file.
2400 BACKEND is the back-end used for transcoding, as a symbol. FILE
2401 is the name of the output file, as a string.
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 output file's name."
2408 ;; Checks for FILE permissions. `write-file' would do the same, but
2409 ;; we'd rather avoid needless transcoding of parse tree.
2411 ;; Insert contents to a temporary buffer and write it to FILE.
2413 backend subtreep visible-only body-only ext-plist noexpand)))
2418 ;; Return full path.
2419 file)
2422 "Return output file's name according to buffer specifications.
2424 EXTENSION is a string representing the output file extension,
2425 with the leading dot.
2427 With a non-nil optional argument SUBTREEP, try to determine
2429 of subtree at point.
2431 When optional argument PUB-DIR is set, use it as the publishing
2432 directory.
2434 When optional argument VISIBLE-ONLY is non-nil, don't export
2435 contents of hidden elements.
2437 Return file name as a string, or nil if it couldn't be
2438 determined."
2440 ;; File name may come from EXPORT_FILE_NAME subtree property,
2441 ;; assuming point is at beginning of said sub-tree.
2448 ;; File name may be extracted from buffer's associated
2449 ;; file, if any.
2451 ;; Can't determine file name on our own: Ask user.
2455 "Output file: " pub-dir nil nil nil
2458 ;; Build file name. Enforce EXTENSION over whatever user may have
2459 ;; come up with. PUB-DIR, if defined, always has precedence over
2460 ;; any provided path.
2465 extension))
2471 "Apply BODY in a copy of the current buffer.
2473 The copy preserves local variables and visibility of the original
2474 buffer.
2476 Point is at buffer's beginning when BODY is applied."
2486 ,original-buffer
2491 ov
2501 "Expand every include keyword in buffer.
2502 Optional argument INCLUDED is a list of included file names along
2503 with their line restriction, when appropriate. It is used to
2504 avoid infinite recursion. Optional argument DIR is the current
2505 working directory. It is used to properly resolve relative
2506 paths."
2513 ;; Extract arguments from keyword's value.
2527 ;; Minimal level of included file defaults to the child
2528 ;; level of the current headline, if any, or one. It
2529 ;; only applies is the file is meant to be included as
2530 ;; an Org one.
2538 ;; Remove keyword.
2542 ;; Check if files has already been parsed. Look after
2543 ;; inclusion lines too, as different parts of the same file
2544 ;; can be included too.
2553 ;; Protect sensitive contents with commas.
2559 ind-str contents ind-str))))
2564 ;; Protect sensitive contents with commas.
2571 ind-str env contents ind-str))))
2584 "Prepare the contents of FILE for inclusion and return them as a string.
2586 When optional argument LINES is a string specifying a range of
2587 lines, include only those lines.
2589 Optional argument IND, when non-nil, is an integer specifying the
2590 global indentation of returned contents. Since its purpose is to
2591 allow an included file to stay in the same environment it was
2592 created \(i.e. a list item), it doesn't apply past the first
2593 headline encountered.
2595 Optional argument MINLEVEL, when non-nil, is an integer
2596 specifying the level that any top-level headline in the included
2597 file should have."
2613 ;; Remove blank lines at beginning and end of contents. The logic
2614 ;; behind that removal is that blank lines around include keyword
2615 ;; override blank lines in included file.
2624 ;; If IND is set, preserve indentation of include keyword until
2625 ;; the first headline encountered.
2631 ;; Do not move footnote definitions out of column 0.
2637 ;; When MINLEVEL is specified, compute minimal level for headlines
2638 ;; in the file (CUR-MIN), and remove stars to each headline so
2639 ;; that headlines with minimal level have a level of MINLEVEL.
2648 ;; Only change stars, don't bother moving whole
2649 ;; sections.
2655 \f
2656 ;;; Tools For Back-Ends
2657 ;;
2658 ;; A whole set of tools is available to help build new exporters. Any
2659 ;; function general enough to have its use across many back-ends
2660 ;; should be added here.
2661 ;;
2662 ;; As of now, functions operating on footnotes, headlines, links,
2663 ;; macros, references, src-blocks, tables and tables of contents are
2664 ;; implemented.
2666 ;;;; For Affiliated Keywords
2667 ;;
2668 ;; `org-export-read-attribute' reads a property from a given element
2669 ;; as a plist. It can be used to normalize affiliated keywords'
2670 ;; syntax.
2673 "Turn ATTRIBUTE property from ELEMENT into a plist.
2676 properties."
2682 ;;;; For Export Snippets
2683 ;;
2684 ;; Every export snippet is transmitted to the back-end. Though, the
2685 ;; latter will only retain one type of export-snippet, ignoring
2686 ;; others, based on the former's target back-end. The function
2687 ;; `org-export-snippet-backend' returns that back-end for a given
2688 ;; export-snippet.
2691 "Return EXPORT-SNIPPET targeted back-end as a symbol.
2692 Translation, with `org-export-snippet-translation-alist', is
2693 applied."
2697 back-end))))
2700 ;;;; For Footnotes
2701 ;;
2702 ;; `org-export-collect-footnote-definitions' is a tool to list
2703 ;; actually used footnotes definitions in the whole parse tree, or in
2704 ;; an headline, in order to add footnote listings throughout the
2705 ;; transcoded data.
2706 ;;
2707 ;; `org-export-footnote-first-reference-p' is a predicate used by some
2708 ;; back-ends, when they need to attach the footnote definition only to
2709 ;; the first occurrence of the corresponding label.
2710 ;;
2711 ;; `org-export-get-footnote-definition' and
2712 ;; `org-export-get-footnote-number' provide easier access to
2713 ;; additional information relative to a footnote reference.
2716 "Return an alist between footnote numbers, labels and definitions.
2718 DATA is the parse tree from which definitions are collected.
2719 INFO is the plist used as a communication channel.
2721 Definitions are sorted by order of references. They either
2722 appear as Org data or as a secondary string for inlined
2723 footnotes. Unreferenced definitions are ignored."
2725 collect-fn ; for byte-compiler.
2729 ;; Collect footnote number, label and definition in DATA.
2731 data 'footnote-reference
2738 def)
2739 num-alist)
2740 ;; Also search in definition for nested footnotes.
2743 ;; Don't enter footnote definitions since it will happen
2744 ;; when their first reference is found.
2750 "Non-nil when a footnote reference is the first one for its label.
2752 FOOTNOTE-REFERENCE is the footnote reference being considered.
2753 INFO is the plist used as a communication channel."
2755 ;; Anonymous footnotes are always a first reference.
2757 ;; Otherwise, return the first footnote with the same LABEL and
2758 ;; test if it is equal to FOOTNOTE-REFERENCE.
2764 data 'footnote-reference
2769 ;; If FN isn't inlined, be sure to traverse its
2770 ;; definition before resuming search. See
2771 ;; comments in `org-export-get-footnote-number'
2772 ;; for more information.
2776 ;; Don't enter footnote definitions since it will
2777 ;; happen when their first reference is found.
2780 footnote-reference)))))
2783 "Return definition of FOOTNOTE-REFERENCE as parsed data.
2784 INFO is the plist used as a communication channel."
2790 "Return number associated to a footnote.
2792 FOOTNOTE is either a footnote reference or a footnote definition.
2793 INFO is the plist used as a communication channel."
2795 seen-refs
2796 search-ref ; for byte-compiler.
2800 ;; Search footnote references through DATA, filling
2801 ;; SEEN-REFS along the way.
2803 data 'footnote-reference
2807 ;; Anonymous footnote match: return number.
2810 ;; Labels match: return number.
2813 ;; Anonymous footnote: it's always a new one. Also,
2814 ;; be sure to return nil from the `cond' so
2815 ;; `first-match' doesn't get us out of the loop.
2817 ;; Label not seen so far: add it so SEEN-REFS.
2818 ;;
2819 ;; Also search for subsequent references in footnote
2820 ;; definition so numbering following reading logic.
2821 ;; Note that we don't have to care about inline
2822 ;; definitions, since `org-element-map' already
2823 ;; traverse them at the right time.
2824 ;;
2825 ;; Once again, return nil to stay in the loop.
2830 nil))))
2831 ;; Don't enter footnote definitions since it will happen
2832 ;; when their first reference is found.
2837 ;;;; For Headlines
2838 ;;
2839 ;; `org-export-get-relative-level' is a shortcut to get headline
2840 ;; level, relatively to the lower headline level in the parsed tree.
2841 ;;
2842 ;; `org-export-get-headline-number' returns the section number of an
2843 ;; headline, while `org-export-number-to-roman' allows to convert it
2844 ;; to roman numbers.
2845 ;;
2846 ;; `org-export-low-level-p', `org-export-first-sibling-p' and
2847 ;; `org-export-last-sibling-p' are three useful predicates when it
2848 ;; comes to fulfill the `:headline-levels' property.
2851 "Return HEADLINE relative level within current parsed tree.
2852 INFO is a plist holding contextual information."
2857 "Non-nil when HEADLINE is considered as low level.
2859 INFO is a plist used as a communication channel.
2861 A low level headlines has a relative level greater than
2862 `:headline-levels' property value.
2864 Return value is the difference between HEADLINE relative level
2865 and the last level being considered as high enough, or nil."
2872 "Return HEADLINE numbering as a list of numbers.
2873 INFO is a plist holding contextual information."
2877 "Return a non-nil value if HEADLINE element should be numbered.
2878 INFO is a plist used as a communication channel."
2884 "Convert integer N into a roman numeral."
2897 res)))
2900 "Return list of tags associated to ELEMENT.
2902 ELEMENT has either an `headline' or an `inlinetask' type. INFO
2903 is a plist used as a communication channel.
2905 Select tags (see `org-export-select-tags') and exclude tags (see
2906 `org-export-exclude-tags') are removed from the list.
2908 When non-nil, optional argument TAGS should be a list of strings.
2909 Any tag belonging to this list will also be removed."
2916 "Non-nil when HEADLINE is the first sibling in its sub-tree."
2921 "Non-nil when HEADLINE is the last sibling in its sub-tree."
2925 ;;;; For Links
2926 ;;
2927 ;; `org-export-solidify-link-text' turns a string into a safer version
2928 ;; for links, replacing most non-standard characters with hyphens.
2929 ;;
2930 ;; `org-export-get-coderef-format' returns an appropriate format
2931 ;; string for coderefs.
2932 ;;
2933 ;; `org-export-inline-image-p' returns a non-nil value when the link
2934 ;; provided should be considered as an inline image.
2935 ;;
2936 ;; `org-export-resolve-fuzzy-link' searches destination of fuzzy links
2937 ;; (i.e. links with "fuzzy" as type) within the parsed tree, and
2938 ;; returns an appropriate unique identifier when found, or nil.
2939 ;;
2940 ;; `org-export-resolve-id-link' returns the first headline with
2941 ;; specified id or custom-id in parse tree, the path to the external
2942 ;; file with the id or nil when neither was found.
2943 ;;
2944 ;; `org-export-resolve-coderef' associates a reference to a line
2945 ;; number in the element it belongs, or returns the reference itself
2946 ;; when the element isn't numbered.
2949 "Take link text S and make a safe target out of it."
2954 "Return format string for code reference link.
2955 PATH is the link path. DESC is its description."
2963 "Non-nil if LINK object points to an inline image.
2965 Optional argument is a set of RULES defining inline images. It
2966 is an alist where associations have the following shape:
2968 \(TYPE . REGEXP)
2970 Applying a rule means apply REGEXP against LINK's path when its
2971 type is TYPE. The function will return a non-nil value if any of
2972 the provided rules is non-nil. The default rule is
2973 `org-export-default-inline-image-rule'.
2975 This only applies to links without a description."
2986 rules)
2987 ;; Return nil if no rule matched.
2988 nil))))
2991 "Resolve a code reference REF.
2993 INFO is a plist used as a communication channel.
2995 Return associated line number in source code, or REF itself,
2996 depending on src-block or example element's switches."
3004 org-coderef-label-format)))
3008 ;; Element containing REF is found. Resolve it to either
3009 ;; a label or a line number, as needed.
3019 "Return LINK destination.
3021 INFO is a plist holding contextual information.
3023 Return value can be an object, an element, or nil:
3025 - If LINK path matches a target object (i.e. <<path>>) or
3028 - If LINK path exactly matches the name affiliated keyword
3029 \(i.e. #+NAME: path) of an element, return that element.
3031 - If LINK path exactly matches any headline name, return that
3032 element. If more than one headline share that name, priority
3033 will be given to the one with the closest common ancestor, if
3034 any, or the first one in the parse tree otherwise.
3036 - Otherwise, return nil.
3042 ;; First try to find a matching "<<path>>" unless user specified
3043 ;; he was looking for an headline (path starts with a *
3044 ;; character).
3048 return target)))
3049 ;; Then try to find an element with a matching "#+NAME: path"
3050 ;; affiliated keyword.
3057 ;; Last case: link either points to an headline or to
3058 ;; nothingness. Try to find the source, with priority given to
3059 ;; headlines with the closest common ancestor. If such candidate
3060 ;; is found, return it, otherwise return nil.
3064 ;; Return first headline whose `:raw-value' property
3065 ;; is NAME in parse tree DATA, or nil.
3068 data 'headline
3072 name)
3073 headline))
3075 ;; Search among headlines sharing an ancestor with link,
3076 ;; from closest to farthest.
3084 ;; No match with a common ancestor: try the full parse-tree.
3090 "Return headline referenced as LINK destination.
3092 INFO is a plist used as a communication channel.
3094 Return value can be the headline element matched in current parse
3098 ;; First check if id is within the current parse tree.
3104 headline))
3106 ;; Otherwise, look for external files.
3110 "Return radio-target object referenced as LINK destination.
3112 INFO is a plist used as a communication channel.
3114 Return value can be a radio-target object or nil. Assume LINK
3124 ;;;; For Macros
3125 ;;
3126 ;; `org-export-expand-macro' simply takes care of expanding macros.
3129 "Expand MACRO and return it as a string.
3130 INFO is a plist holding export options."
3133 ;; User's macros are stored in the communication channel with
3134 ;; a ":macro-" prefix. Replace arguments in VALUE. Also
3135 ;; expand recursively macros within.
3144 obj)))
3146 info)))
3147 ;; VALUE starts with "(eval": it is a s-exp, `eval' it.
3149 ;; Return string.
3153 ;;;; For References
3154 ;;
3155 ;; `org-export-get-ordinal' associates a sequence number to any object
3156 ;; or element.
3159 "Return ordinal number of an element or object.
3161 ELEMENT is the element or object considered. INFO is the plist
3162 used as a communication channel.
3164 Optional argument TYPES, when non-nil, is a list of element or
3165 object types, as symbols, that should also be counted in.
3166 Otherwise, only provided element's type is considered.
3168 Optional argument PREDICATE is a function returning a non-nil
3169 value if the current element or object should be counted in. It
3170 accepts two arguments: the element or object being considered and
3171 the plist used as a communication channel. This allows to count
3172 only a certain type of objects (i.e. inline images).
3174 Return value is a list of numbers if ELEMENT is an headline or an
3175 item. It is nil for keywords. It represents the footnote number
3176 for footnote definitions and footnote references. If ELEMENT is
3177 a target, return the same value as if ELEMENT was the closest
3178 table, item or headline containing the target. In any other
3179 case, return the sequence number of ELEMENT among elements or
3180 objects of the same type."
3181 ;; A target keyword, representing an invisible target, never has
3182 ;; a sequence number.
3184 ;; Ordinal of a target object refer to the ordinal of the closest
3185 ;; table, item, or headline containing the object.
3189 when
3193 table))
3194 return parent)))
3196 ;; Special case 1: An headline returns its number as a list.
3198 ;; Special case 2: An item returns its number as a list.
3202 struct
3209 ;; Increment counter until ELEMENT is found again.
3220 ;;;; For Src-Blocks
3221 ;;
3222 ;; `org-export-get-loc' counts number of code lines accumulated in
3223 ;; src-block or example-block elements with a "+n" switch until
3224 ;; a given element, excluded. Note: "-n" switches reset that count.
3225 ;;
3226 ;; `org-export-unravel-code' extracts source code (along with a code
3227 ;; references alist) from an `element-block' or `src-block' type
3228 ;; element.
3229 ;;
3230 ;; `org-export-format-code' applies a formatting function to each line
3231 ;; of code, providing relative line number and code reference when
3232 ;; appropriate. Since it doesn't access the original element from
3233 ;; which the source code is coming, it expects from the code calling
3234 ;; it to know if lines should be numbered and if code references
3235 ;; should appear.
3236 ;;
3237 ;; Eventually, `org-export-format-code-default' is a higher-level
3238 ;; function (it makes use of the two previous functions) which handles
3239 ;; line numbering and code references inclusion, and returns source
3240 ;; code in a format suitable for plain text or verbatim output.
3243 "Return accumulated lines of code up to ELEMENT.
3245 INFO is the plist used as a communication channel.
3247 ELEMENT is excluded from count."
3254 ;; ELEMENT is reached: Quit the loop.
3256 ;; Only count lines from src-block and example-block elements
3257 ;; with a "+n" or "-n" switch. A "-n" switch resets counter.
3261 ;; Accumulate locs or reset them.
3265 ;; Return nil to stay in the loop.
3266 nil)))
3268 ;; Return value.
3269 loc))
3272 "Clean source code and extract references out of it.
3274 ELEMENT has either a `src-block' an `example-block' type.
3276 Return a cons cell whose CAR is the source code, cleaned from any
3277 reference and protective comma and CDR is an alist between
3278 relative line number (integer) and name of code reference on that
3279 line (string)."
3281 ;; Get code and clean it. Remove blank lines at its
3282 ;; beginning and end. Also remove protective commas.
3288 ;; If appropriate, remove global indentation.
3292 ;; Free up the protected lines. Note: Org blocks
3293 ;; have commas at the beginning or every line.
3298 ;; Get format used for references.
3301 org-coderef-label-format)))
3302 ;; Build a regexp matching a loc with a reference.
3307 ;; Return value.
3309 ;; Code with references removed.
3315 ;; Ref line: remove ref, and signal its position in REFS.
3319 ;; Reference alist.
3320 refs)))
3323 "Format CODE by applying FUN line-wise and return it.
3325 CODE is a string representing the code to format. FUN is
3326 a function. It must accept three arguments: a line of
3327 code (string), the current line number (integer) or nil and the
3328 reference associated to the current line (string) or nil.
3330 Optional argument NUM-LINES can be an integer representing the
3331 number of code lines accumulated until the current code. Line
3332 numbers passed to FUN will take it into account. If it is nil,
3333 FUN's second argument will always be nil. This number can be
3334 obtained with `org-export-get-loc' function.
3336 Optional argument REF-ALIST can be an alist between relative line
3337 number (i.e. ignoring NUM-LINES) and the name of the code
3338 reference on it. If it is nil, FUN's third argument will always
3339 be nil. It can be obtained through the use of
3340 `org-export-unravel-code' function."
3352 "Return source code from ELEMENT, formatted in a standard way.
3354 ELEMENT is either a `src-block' or `example-block' element. INFO
3355 is a plist used as a communication channel.
3357 This function takes care of line numbering and code references
3358 inclusion. Line numbers, when applicable, appear at the
3359 beginning of the line, separated from the code by two white
3360 spaces. Code references, on the other hand, appear flushed to
3361 the right, separated by six white spaces from the widest line of
3362 code."
3363 ;; Extract code and references.
3369 ;; Handle line numbering.
3378 ;; Prepare references display, if required. Any reference
3379 ;; should start six columns after the widest line of code,
3380 ;; wrapped with parenthesis.
3385 code
3389 number-str
3390 loc
3396 num-start refs)))
3399 ;;;; For Tables
3400 ;;
3401 ;; `org-export-table-has-special-column-p' and and
3402 ;; `org-export-table-row-is-special-p' are predicates used to look for
3403 ;; meta-information about the table structure.
3404 ;;
3405 ;; `org-table-has-header-p' tells when the rows before the first rule
3406 ;; should be considered as table's header.
3407 ;;
3408 ;; `org-export-table-cell-width', `org-export-table-cell-alignment'
3409 ;; and `org-export-table-cell-borders' extract information from
3410 ;; a table-cell element.
3411 ;;
3412 ;; `org-export-table-dimensions' gives the number on rows and columns
3413 ;; in the table, ignoring horizontal rules and special columns.
3414 ;; `org-export-table-cell-address', given a table-cell object, returns
3415 ;; the absolute address of a cell. On the other hand,
3416 ;; `org-export-get-table-cell-at' does the contrary.
3417 ;;
3418 ;; `org-export-table-cell-starts-colgroup-p',
3419 ;; `org-export-table-cell-ends-colgroup-p',
3420 ;; `org-export-table-row-starts-rowgroup-p',
3421 ;; `org-export-table-row-ends-rowgroup-p',
3422 ;; `org-export-table-row-starts-header-p' and
3423 ;; `org-export-table-row-ends-header-p' indicate position of current
3424 ;; row or cell within the table.
3427 "Non-nil when TABLE has a special column.
3428 All special columns will be ignored during export."
3429 ;; The table has a special column when every first cell of every row
3430 ;; has an empty value or contains a symbol among "/", "#", "!", "$",
3431 ;; "*" "_" and "^". Though, do not consider a first row containing
3432 ;; only empty cells as special.
3448 "Non-nil when TABLE has an header.
3450 INFO is a plist used as a communication channel.
3452 A table has an header when it contains at least two row groups."
3455 table 'table-row
3463 info)))
3466 "Non-nil if TABLE-ROW is considered special.
3468 INFO is a plist used as the communication channel.
3470 All special rows will be ignored during export."
3474 ;; A row is special either when...
3476 ;; ... it starts with a field only containing "/",
3478 ;; ... the table contains a special column and the row start
3479 ;; with a marking character among, "^", "_", "$" or "!",
3483 ;; ... it contains only alignment cookies and empty cells.
3489 ;; Since VALUE is a secondary string, the following
3490 ;; checks avoid expanding it with `org-export-data'.
3502 "Return TABLE-ROW's group.
3504 INFO is a plist used as the communication channel.
3506 Return value is the group number, as an integer, or nil special
3507 rows and table rules. Group 1 is also table's header."
3524 "Return TABLE-CELL contents width.
3526 INFO is a plist used as the communication channel.
3528 Return value is the width given by the last width cookie in the
3529 same column as TABLE-CELL, or nil."
3534 cookie-width)
3538 ;; In a special row, try to find a width cookie at COLUMN.
3542 ;; The following checks avoid expanding unnecessarily the
3543 ;; cell with `org-export-data'
3551 ;; Ignore table rules.
3554 ;; Return value.
3555 cookie-width))
3558 "Return TABLE-CELL contents alignment.
3560 INFO is a plist used as the communication channel.
3562 Return alignment as specified by the last alignment cookie in the
3563 same column as TABLE-CELL. If no such cookie is found, a default
3564 alignment value will be deduced from fraction of numbers in the
3565 column (see `org-table-number-fraction' for more information).
3566 Possible values are `left', `right' and `center'."
3573 cookie-align)
3577 ;; In a special row, try to find an alignment cookie at
3578 ;; COLUMN.
3582 ;; Since VALUE is a secondary string, the following checks
3583 ;; avoid useless expansion through `org-export-data'.
3591 ;; Ignore table rules.
3593 ;; In a standard row, check if cell's contents are expressing
3594 ;; some kind of number. Increase NUMBER-CELLS accordingly.
3595 ;; Though, don't bother if an alignment cookie has already
3596 ;; defined cell's alignment.
3601 info)))
3606 ;; Return value. Alignment specified by cookies has precedence
3607 ;; over alignment deduced from cells contents.
3616 "Return TABLE-CELL borders.
3618 INFO is a plist used as a communication channel.
3620 Return value is a list of symbols, or nil. Possible values are:
3621 `top', `bottom', `above', `below', `left' and `right'. Note:
3622 `top' (resp. `bottom') only happen for a cell in the first
3623 row (resp. last row) of the table, ignoring table rules, if any.
3625 Returned borders ignore special rows."
3628 borders)
3629 ;; Top/above border? TABLE-CELL has a border above when a rule
3630 ;; used to demarcate row groups can be found above. Hence,
3631 ;; finding a rule isn't sufficient to push `above' in BORDERS:
3632 ;; another regular row has to be found above that rule.
3641 ;; Look at every row before the current one.
3643 ;; No rule above, or rule found starts the table (ignoring any
3644 ;; special row): TABLE-CELL is at the top of the table.
3647 ;; Bottom/below border? TABLE-CELL has a border below when next
3648 ;; non-regular row below is a rule.
3657 ;; Look at every row after the current one.
3659 ;; No rule below, or rule found ends the table (modulo some
3660 ;; special row): TABLE-CELL is at the bottom of the table.
3663 ;; Right/left borders? They can only be specified by column
3664 ;; groups. Column groups are defined in a row starting with "/".
3665 ;; Also a column groups row only contains "<", "<>", ">" or blank
3666 ;; cells.
3683 ;; There's a left border when previous cell, if
3684 ;; any, ends a group, or current one starts one.
3690 ;; There's a right border when next cell, if any,
3691 ;; starts a group, or current one ends one.
3698 ;; Table rows are read in reverse order so last column groups
3699 ;; row has precedence over any previous one.
3701 ;; Return value.
3702 borders))
3705 "Non-nil when TABLE-CELL is at the beginning of a row group.
3706 INFO is a plist used as a communication channel."
3707 ;; A cell starts a column group either when it is at the beginning
3708 ;; of a row (or after the special column, if any) or when it has
3709 ;; a left border.
3713 table-cell)
3717 "Non-nil when TABLE-CELL is at the end of a row group.
3718 INFO is a plist used as a communication channel."
3719 ;; A cell ends a column group either when it is at the end of a row
3720 ;; or when it has a right border.
3723 table-cell)
3727 "Non-nil when TABLE-ROW is at the beginning of a column group.
3728 INFO is a plist used as a communication channel."
3736 "Non-nil when TABLE-ROW is at the end of a column group.
3737 INFO is a plist used as a communication channel."
3745 "Non-nil when TABLE-ROW is the first table header's row.
3746 INFO is a plist used as a communication channel."
3753 "Non-nil when TABLE-ROW is the last table header's row.
3754 INFO is a plist used as a communication channel."
3761 "Return TABLE dimensions.
3763 INFO is a plist used as a communication channel.
3765 Return value is a CONS like (ROWS . COLUMNS) where
3766 ROWS (resp. COLUMNS) is the number of exportable
3767 rows (resp. columns)."
3769 ;; Set number of rows, and extract first one.
3771 table 'table-row
3776 ;; Set number of columns.
3778 ;; Return value.
3782 "Return address of a regular TABLE-CELL object.
3784 TABLE-CELL is the cell considered. INFO is a plist used as
3785 a communication channel.
3787 Address is a CONS cell (ROW . COLUMN), where ROW and COLUMN are
3788 zero-based index. Only exportable cells are considered. The
3789 function returns nil for other cells."
3792 ;; Ignore cells in special rows or in special column.
3797 ;; Row number.
3800 table 'table-row
3806 ;; Column number.
3809 table-row 'table-cell
3816 "Return regular table-cell object at ADDRESS in TABLE.
3818 Address is a CONS cell (ROW . COLUMN), where ROW and COLUMN are
3819 zero-based index. TABLE is a table type element. INFO is
3820 a plist used as a communication channel.
3822 If no table-cell, among exportable cells, is found at ADDRESS,
3823 return nil."
3826 ;; Row at (car address) or nil.
3829 table 'table-row
3835 'table-cell
3842 ;;;; For Tables Of Contents
3843 ;;
3844 ;; `org-export-collect-headlines' builds a list of all exportable
3845 ;; headline elements, maybe limited to a certain depth. One can then
3846 ;; easily parse it and transcode it.
3847 ;;
3848 ;; Building lists of tables, figures or listings is quite similar.
3849 ;; Once the generic function `org-export-collect-elements' is defined,
3850 ;; `org-export-collect-tables', `org-export-collect-figures' and
3851 ;; `org-export-collect-listings' can be derived from it.
3854 "Collect headlines in order to build a table of contents.
3856 INFO is a plist used as a communication channel.
3858 When non-nil, optional argument N must be an integer. It
3859 specifies the depth of the table of contents.
3861 Return a list of all exportable headlines as parsed elements."
3864 'headline
3866 ;; Strip contents from HEADLINE.
3869 info))
3872 "Collect referenceable elements of a determined type.
3874 TYPE can be a symbol or a list of symbols specifying element
3875 types to search. Only elements with a caption are collected.
3877 INFO is a plist used as a communication channel.
3879 When non-nil, optional argument PREDICATE is a function accepting
3880 one argument, an element of type TYPE. It returns a non-nil
3881 value when that element should be collected.
3883 Return a list of all elements found, in order of appearance."
3889 element))
3890 info))
3893 "Build a list of tables.
3894 INFO is a plist used as a communication channel.
3896 Return a list of table elements with a caption."
3900 "Build a list of figures.
3902 INFO is a plist used as a communication channel. PREDICATE is
3903 a function which accepts one argument: a paragraph element and
3904 whose return value is non-nil when that element should be
3905 collected.
3907 A figure is a paragraph type element, with a caption, verifying
3909 a vague concept that may depend on back-end.
3911 Return a list of elements recognized as figures."
3915 "Build a list of src blocks.
3917 INFO is a plist used as a communication channel.
3919 Return a list of src-block elements with a caption."
3923 ;;;; Topology
3924 ;;
3925 ;; Here are various functions to retrieve information about the
3926 ;; neighbourhood of a given element or object. Neighbours of interest
3927 ;; are direct parent (`org-export-get-parent'), parent headline
3928 ;; (`org-export-get-parent-headline'), first element containing an
3929 ;; object, (`org-export-get-parent-element'), parent table
3930 ;; (`org-export-get-parent-table'), previous element or object
3931 ;; (`org-export-get-previous-element') and next element or object
3932 ;; (`org-export-get-next-element').
3933 ;;
3934 ;; `org-export-get-genealogy' returns the full genealogy of a given
3935 ;; element or object, from closest parent to full parse tree.
3938 "Return BLOB parent or nil.
3939 BLOB is the element or object considered."
3943 "Return full genealogy relative to a given element or object.
3944 BLOB is the element or object being considered."
3951 "Return BLOB parent headline or nil.
3952 BLOB is the element or object being considered."
3956 parent))
3959 "Return first element containing OBJECT or nil.
3960 OBJECT is the object to consider."
3964 parent))
3967 "Return OBJECT parent table or nil.
3968 OBJECT is either a `table-cell' or `table-element' type object."
3972 parent))
3975 "Return previous element or object.
3976 BLOB is an element or object. Return previous element or object,
3977 a string, or nil."
3982 "Return next element or object.
3983 BLOB is an element or object. Return next element or object,
3984 a string, or nil."
3989 \f
3990 ;;; The Dispatcher
3991 ;;
3992 ;; `org-export-dispatch' is the standard interactive way to start an
3993 ;; export process. It uses `org-export-dispatch-ui' as a subroutine
3994 ;; for its interface. Most commons back-ends should have an entry in
3995 ;; it.
3998 "Export dispatcher for Org mode.
4000 It provides an access to common export related tasks in a buffer.
4001 Its interface comes in two flavours: standard and expert. While
4002 both share the same set of bindings, only the former displays the
4003 valid keys associations. Set `org-export-dispatch-use-expert-ui'
4004 to switch to one or the other.
4006 Return an error if key pressed has no associated command."
4011 org-export-dispatch-use-expert-ui))
4014 ;; Translate "C-a", "C-b"... into "a", "b"... Then take action
4015 ;; depending on user's key pressed.
4017 ;; Allow to quit with "q" key.
4019 ;; Export with `e-ascii' back-end.
4026 `(:ascii-charset
4036 ;; Export with `e-latex' back-end.
4037 (?L
4046 (?l
4050 (?p
4054 (?d
4059 ;; Export with `e-html' back-end.
4060 (?H
4066 ;; set major mode
4071 (?h
4075 (?b
4080 ;; Export with `e-odt' back-end.
4081 (?o
4085 (?O
4090 ;; Publishing facilities
4091 (?F
4094 (?P
4097 (?X
4102 org-e-publish-project-alist)))
4104 (?E
4107 ;; Undefined command.
4112 "Handle interface for `org-export-dispatch'.
4114 OPTIONS is a list containing current interactive options set for
4115 export. It can contain any of the following symbols:
4116 `body' toggles a body-only export
4117 `subtree' restricts export to current subtree
4118 `visible' restricts export to visible part of buffer.
4119 `force' force publishing files.
4121 EXPERTP, when non-nil, triggers expert UI. In that case, no help
4122 buffer is provided, but indications about currently active
4123 options are given in the prompt. Moreover, \[?] allows to switch
4124 back to standard interface.
4126 Return value is a list with key pressed as CAR and a list of
4127 final interactive export options as CDR."
4131 \[1] Body only: %s [2] Export scope: %s
4132 \[3] Visible only: %s [4] Force publishing: %s
4135 --- (ASCII/Latin-1/UTF-8 Export) -------------------------
4137 \[a/n/u] to TXT file [A/N/U] to temporary buffer
4139 --- (HTML Export) ----------------------------------------
4141 \[h] to HTML file [b] ... and open it
4142 \[H] to temporary buffer
4144 --- (LaTeX Export) ---------------------------------------
4146 \[l] to TEX file [L] to temporary buffer
4147 \[p] to PDF file [d] ... and open it
4149 --- (ODF Export) -----------------------------------------
4151 \[o] to ODT file [O] ... and open it
4153 --- (Publish) --------------------------------------------
4155 \[F] current file [P] current project
4156 \[X] a project [E] every project"
4169 ;; Read a character from command input, toggling interactive
4170 ;; options when applicable. PROMPT is the displayed prompt,
4171 ;; as a string.
4175 ;; Ignore non-standard characters (i.e. "M-a").
4177 ;; Help key: Switch back to standard interface if
4178 ;; expert UI was active.
4180 ;; Toggle export options.
4187 expertp))
4188 ;; Action selected: Send key and options back to
4189 ;; `org-export-dispatch'.
4191 ;; With expert UI, just read key with a fancy prompt. In standard
4192 ;; UI, display an intrusive help buffer.
4203 ;;; org-export.el ends here