| blob | b9294e59aceadbe639e1982ca6f2c703ebb74f3c |
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.
45 ;;
46 ;; The core function is `org-export-as'. It returns the transcoded
47 ;; buffer as a string.
48 ;;
49 ;; In order to implement a back-end for this generic exporter, up to
50 ;; three steps may be needed:
51 ;;
52 ;; 1. Define a variable, `org-BACKEND-translate-alist' where elements
53 ;; and objects types are associated to translator functions.
54 ;;
55 ;; These functions should return a string without any trailing
56 ;; space, or nil. They must accept three arguments: the object or
57 ;; element itself, its contents or nil when it isn't recursive and
58 ;; the property list used as a communication channel.
59 ;;
60 ;; Contents, when not nil, are stripped from any global indentation
61 ;; (although the relative one is preserved). They also always end
62 ;; with a single newline character.
63 ;;
64 ;; If, for a given type, no function is found, that element or
65 ;; object type will simply be ignored, along with any blank line or
66 ;; white space at its end. The same will happen if the function
67 ;; returns the nil value. If that function returns the empty
68 ;; string, the type will be ignored, but the blank lines or white
69 ;; 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. The former returns the final transcoded
74 ;; string, and can be used to add a preamble and a postamble to
75 ;; document's body. It must accept two arguments: the transcoded
76 ;; string and the property list containing export options. The
77 ;; latter, when defined, is to be called on every text not
78 ;; recognized as an element or an object. It must accept two
79 ;; arguments: the text string and the information channel.
80 ;;
81 ;; 2. Optionally define a variable, `org-BACKEND-options-alist', in
82 ;; order to support new export options, buffer keywords or
83 ;; "#+OPTIONS:" items specific to the back-end. See
84 ;; `org-export-options-alist' for supported defaults and syntax.
85 ;;
86 ;; 3. Optionally define a variable, `org-BACKEND-filters-alist', in
87 ;; order to apply developer filters. See "The Filter System"
88 ;; section in this file for more information.
89 ;;
90 ;; If the new back-end shares most properties with another one,
91 ;; `org-export-define-derived-backend' can be used to simplify the
92 ;; process.
93 ;;
94 ;; Any back-end can define its own variables. Among them, those
95 ;; customizables should belong to the `org-export-BACKEND' group.
96 ;;
97 ;; Tools for common tasks across back-ends are implemented in the
98 ;; penultimate part of this file. A dispatcher for standard back-ends
99 ;; is provided in the last one.
101 ;;; Code:
107 \f
108 ;;; Internal Variables
109 ;;
110 ;; Among internal variables, the most important is
111 ;; `org-export-options-alist'. This variable define the global export
112 ;; options, shared between every exporter, and how they are acquired.
152 "Alist between export properties and ways to set them.
154 The CAR of the alist is the property name, and the CDR is a list
155 like (KEYWORD OPTION DEFAULT BEHAVIOUR) where:
157 KEYWORD is a string representing a buffer keyword, or nil.
158 OPTION is a string that could be found in an #+OPTIONS: line.
159 DEFAULT is the default value for the property.
160 BEHAVIOUR determine how Org should handle multiple keywords for
161 the same property. It is a symbol among:
162 nil Keep old value and discard the new one.
163 t Replace old value with the new one.
164 `space' Concatenate the values, separating them with a space.
165 `newline' Concatenate the values, separating them with
166 a newline.
167 `split' Split values at white spaces, and cons them to the
168 previous list.
170 KEYWORD and OPTION have precedence over DEFAULT.
172 All these properties should be back-end agnostic. For back-end
173 specific properties, define a similar variable named
174 `org-BACKEND-options-alist', replacing BACKEND with the name of
175 the appropriate back-end. You can also redefine properties
180 "List of in-buffer keywords that require special treatment.
181 These keywords are not directly associated to a property. The
182 way they are handled must be hard-coded into
240 "Alist between filters properties and initial values.
242 The key of each association is a property name accessible through
243 the communication channel its value is a configurable global
244 variable defining initial filters.
246 This list is meant to install user specified filters. Back-end
247 developers may install their own filters using
248 `org-BACKEND-filters-alist', where BACKEND is the name of the
249 considered back-end. Filters defined there will always be
250 prepended to the current list, so they always get applied
259 "Default rule for link matching an inline image.
260 This rule applies to links with no description. By default, it
261 will be considered as an inline image if it targets a local file
264 See `org-export-inline-image-p' for more information about
268 \f
269 ;;; User-configurable Variables
270 ;;
271 ;; Configuration for the masses.
272 ;;
273 ;; They should never be accessed directly, as their value is to be
274 ;; stored in a property list (cf. `org-export-options-alist').
275 ;; Back-ends will read their value from there instead.
278 "Options for exporting Org mode files."
283 "General options for export engine."
288 "Whether sub-trees with the ARCHIVE tag should be exported.
290 This can have three different values:
291 nil Do not export, pretend this tree is not present.
292 t Do export the entire tree.
293 `headline' Only export the headline, but skip the tree below it.
295 This option can also be set with the #+OPTIONS line,
304 "Non-nil means insert author name into the exported file.
305 This option can also be set with the #+OPTIONS line,
311 "Non-nil means export CLOCK keywords.
312 This option can also be set with the #+OPTIONS line,
318 "Non-nil means the postamble should contain a creator sentence.
320 The sentence can be set in `org-export-creator-string' and
323 If the value is `comment' insert it as a comment."
333 emacs-version)
334 "String to insert at the end of the generated document."
339 "Non-nil means export contents of standard drawers.
341 When t, all drawers are exported. This may also be a list of
342 drawer names to export. This variable doesn't apply to
343 properties drawers.
345 This option can also be set with the #+OPTIONS line,
355 "Non-nil means insert author email into the exported file.
356 This option can also be set with the #+OPTIONS line,
362 "Non-nil means interpret *word*, /word/, and _word_ as emphasized text.
364 If the export target supports emphasizing text, the word will be
365 typeset in bold, italic, or underlined, respectively. Not all
366 export backends support this.
373 "Tags that exclude a tree from export.
375 All trees carrying any of these tags will be excluded from
376 export. This is without condition, so even subtrees inside that
377 carry one of the `org-export-select-tags' will be removed.
379 This option can also be set with the #+EXPORT_EXCLUDE_TAGS:
380 keyword."
387 This can be used to have pre-formatted text, fragments of code
388 etc. For example:
389 : ;; Some Lisp examples
390 : (while (defc cnt)
391 : (ding))
392 will be looking just like this in also HTML. See also the QUOTE
393 keyword. Not all export backends support this.
400 "Non-nil means Org footnotes should be exported.
401 This option can also be set with the #+OPTIONS line,
407 "The last level which is still exported as a headline.
409 Inferior levels will produce itemize lists when exported. Note
410 that a numeric prefix argument to an exporter function overrides
411 this setting.
418 "The default language for export and clocktable translations, as a string.
419 This may have an association in
420 `org-clock-clocktable-language-setup'."
425 "Non-nil means preserve all line breaks when exporting.
427 Normally, in HTML output paragraphs will be reformatted.
429 This option can also be set with the #+OPTIONS line,
435 "Non-nil means interpret entities when exporting.
438 Å.
440 For a list of supported names, see the constant `org-entities'
441 and the user option `org-entities-user'.
443 This option can also be set with the #+OPTIONS line,
449 "Non-nil means include planning info in export.
450 This option can also be set with the #+OPTIONS: line,
456 "Non-nil means include priority cookies in export.
458 When nil, remove priority cookies for export.
460 This option can also be set with the #+OPTIONS line,
466 "Non-nil means add section numbers to headlines when exporting.
468 When set to an integer n, numbering will only happen for
469 headlines whose relative level is higher or equal to n.
471 This option can also be set with the #+OPTIONS line,
477 "Tags that select a tree for export.
479 If any such tag is found in a buffer, all trees that do not carry
480 one of these tags will be ignored during export. Inside trees
481 that are selected like this, you can still deselect a subtree by
482 tagging it with one of the `org-export-exclude-tags'.
484 This option can also be set with the #+EXPORT_SELECT_TAGS:
485 keyword."
492 When this option is turned on, these strings will be exported as:
494 Org HTML LaTeX
495 -----+----------+--------
497 -- – --
498 --- — ---
499 ... … \ldots
501 This option can also be set with the #+OPTIONS line,
509 When this option is turned on, you can use TeX-like syntax for
511 will be considered as a single item - so grouping with {} is
512 normally not needed. For example, the following things will be
513 parsed as single sub- or superscripts.
515 10^24 or 10^tau several digits will be considered 1 item.
516 10^-12 or 10^-tau a leading sign with digits or a word
517 x^2-y^3 will be read as x^2 - y^3, because items are
518 terminated by almost any nonword/nondigit char.
519 x_{i^2} or x^(2-i) braces or parenthesis do grouping.
521 Still, ambiguity is possible - so when in doubt use {} to enclose
522 the sub/superscript. If you set this variable to the symbol
523 `{}', the braces are *required* in order to trigger
524 interpretations as sub/superscript. This can be helpful in
527 This option can also be set with the #+OPTIONS line,
536 "Non-nil means create a table of contents in exported files.
538 The TOC contains headlines with levels up
539 to`org-export-headline-levels'. When an integer, include levels
540 up to N in the toc, this may then be different from
541 `org-export-headline-levels', but it will not be allowed to be
542 larger than the number of headline levels. When nil, no table of
543 contents is made.
545 This option can also be set with the #+OPTIONS line,
555 For example:
557 | Name | Address | Birthday |
558 |-------------+----------+-----------|
559 | Arthur Dent | England | 29.2.2100 |
566 "If nil, do not export tags, just remove them from headlines.
568 If this is the symbol `not-in-toc', tags will be removed from
569 table of contents entries, but still be shown in the headlines of
570 the document.
572 This option can also be set with the #+OPTIONS line,
581 "Non-nil means include TODO items for export.
582 This may have the following values:
583 t include tasks independent of state.
584 todo include only tasks that are not yet done.
585 done include only tasks that are already done.
586 nil remove all tasks before export
587 list of keywords keep only tasks with these keywords"
598 "Non-nil means insert a time stamp into the exported file.
599 The time stamp shows when the file was created.
601 This option can also be set with the #+OPTIONS line,
607 "Non nil means allow timestamps in export.
609 It can be set to `active', `inactive', t or nil, in order to
610 export, respectively, only active timestamps, only inactive ones,
611 all of them or none.
613 This option can also be set with the #+OPTIONS line, e.g.
623 "Non-nil means include TODO keywords in export.
624 When nil, remove all these keywords from the export."
629 "Non-nil means allow #+BIND to define local variable values for export.
630 This is a potential security risk, which is why the user must
631 confirm the use of these lines."
639 "Alist between export snippets back-ends and exporter back-ends.
641 This variable allows to provide shortcuts for export snippets.
645 while every other back-end will ignore it."
653 "Coding system for the exported file."
658 "Non-nil means exported stuff will also be pushed onto the kill ring."
663 "The initial scope when exporting with `org-export-dispatch'.
664 This variable can be either set to `buffer' or `subtree'."
671 "Non-nil means show buffer after exporting to temp buffer.
672 When Org exports to a file, the buffer visiting that file is ever
673 shown, but remains buried. However, when exporting to
674 a temporary buffer, that buffer is popped up in a second window.
675 When this variable is nil, the buffer remains buried also in
676 these cases."
681 "Non-nil means using a non-intrusive `org-export-dispatch'.
682 In that case, no help buffer is displayed. Though, an indicator
686 considered for export\). Also, \[?] allows to switch back to
687 standard mode."
692 \f
693 ;;; Defining New Back-ends
696 "Create a new back-end as a variant of an existing one.
698 CHILD is the name of the derived back-end. PARENT is the name of
699 the parent back-end.
701 BODY can start with pre-defined keyword arguments. The following
702 keywords are understood:
704 `:filters-alist'
706 Alist of filters that will overwrite or complete filters
707 defined in PARENT back-end, if any.
709 `:options-alist'
711 Alist of buffer keywords or #+OPTIONS items that will
712 overwrite or complete those defined in PARENT back-end, if
713 any.
715 `:translate-alist'
717 Alist of element and object types and transcoders that will
718 overwrite or complete transcode table from PARENT back-end.
721 as a variant of `e-latex' back-end with a custom template
722 function:
724 \(org-export-define-derived-backend my-latex e-latex
725 :translate-alist ((template . my-latex-template-fun)))
727 The back-end could then be called with, for example:
740 ;; Define filters.
747 "Alist between filters keywords and back-end specific filters.
749 ;; Define options.
756 "Alist between LaTeX export properties and ways to set them.
757 See `org-export-options-alist' for more information on the
759 ;; Define translators.
766 ;; Splice in the body, if any.
770 \f
771 ;;; The Communication Channel
772 ;;
773 ;; During export process, every function has access to a number of
774 ;; properties. They are of two types:
775 ;;
776 ;; 1. Environment options are collected once at the very beginning of
777 ;; the process, out of the original buffer and configuration.
778 ;; Collecting them is handled by `org-export-get-environment'
779 ;; function.
780 ;;
781 ;; Most environment options are defined through the
782 ;; `org-export-options-alist' variable.
783 ;;
784 ;; 2. Tree properties are extracted directly from the parsed tree,
785 ;; just before export, by `org-export-collect-tree-properties'.
786 ;;
787 ;; Here is the full list of properties available during transcode
788 ;; process, with their category (option, tree or local) and their
789 ;; value type.
790 ;;
791 ;; + `:author' :: Author's name.
792 ;; - category :: option
793 ;; - type :: string
794 ;;
795 ;; + `:back-end' :: Current back-end used for transcoding.
796 ;; - category :: tree
797 ;; - type :: symbol
798 ;;
799 ;; + `:creator' :: String to write as creation information.
800 ;; - category :: option
801 ;; - type :: string
802 ;;
803 ;; + `:date' :: String to use as date.
804 ;; - category :: option
805 ;; - type :: string
806 ;;
807 ;; + `:description' :: Description text for the current data.
808 ;; - category :: option
809 ;; - type :: string
810 ;;
811 ;; + `:email' :: Author's email.
812 ;; - category :: option
813 ;; - type :: string
814 ;;
815 ;; + `:exclude-tags' :: Tags for exclusion of subtrees from export
816 ;; process.
817 ;; - category :: option
818 ;; - type :: list of strings
819 ;;
820 ;; + `:footnote-definition-alist' :: Alist between footnote labels and
821 ;; their definition, as parsed data. Only non-inlined footnotes
822 ;; are represented in this alist. Also, every definition isn't
823 ;; guaranteed to be referenced in the parse tree. The purpose of
824 ;; this property is to preserve definitions from oblivion
825 ;; (i.e. when the parse tree comes from a part of the original
826 ;; buffer), it isn't meant for direct use in a back-end. To
827 ;; retrieve a definition relative to a reference, use
828 ;; `org-export-get-footnote-definition' instead.
829 ;; - category :: option
830 ;; - type :: alist (STRING . LIST)
831 ;;
832 ;; + `:headline-levels' :: Maximum level being exported as an
833 ;; headline. Comparison is done with the relative level of
834 ;; headlines in the parse tree, not necessarily with their
835 ;; actual level.
836 ;; - category :: option
837 ;; - type :: integer
838 ;;
839 ;; + `:headline-offset' :: Difference between relative and real level
840 ;; of headlines in the parse tree. For example, a value of -1
841 ;; means a level 2 headline should be considered as level
842 ;; 1 (cf. `org-export-get-relative-level').
843 ;; - category :: tree
844 ;; - type :: integer
845 ;;
846 ;; + `:headline-numbering' :: Alist between headlines and their
847 ;; numbering, as a list of numbers
848 ;; (cf. `org-export-get-headline-number').
849 ;; - category :: tree
850 ;; - type :: alist (INTEGER . LIST)
851 ;;
852 ;; + `:ignore-list' :: List of elements and objects that should be
853 ;; ignored during export.
854 ;; - category :: tree
855 ;; - type :: list of elements and objects
856 ;;
857 ;; + `:input-file' :: Full path to input file, if any.
858 ;; - category :: option
859 ;; - type :: string or nil
860 ;;
861 ;; + `:keywords' :: List of keywords attached to data.
862 ;; - category :: option
863 ;; - type :: string
864 ;;
865 ;; + `:language' :: Default language used for translations.
866 ;; - category :: option
867 ;; - type :: string
868 ;;
869 ;; + `:parse-tree' :: Whole parse tree, available at any time during
870 ;; transcoding.
871 ;; - category :: option
872 ;; - type :: list (as returned by `org-element-parse-buffer')
873 ;;
874 ;; + `:preserve-breaks' :: Non-nil means transcoding should preserve
875 ;; all line breaks.
876 ;; - category :: option
877 ;; - type :: symbol (nil, t)
878 ;;
879 ;; + `:section-numbers' :: Non-nil means transcoding should add
880 ;; section numbers to headlines.
881 ;; - category :: option
882 ;; - type :: symbol (nil, t)
883 ;;
884 ;; + `:select-tags' :: List of tags enforcing inclusion of sub-trees
885 ;; in transcoding. When such a tag is present, subtrees without
886 ;; it are de facto excluded from the process. See
887 ;; `use-select-tags'.
888 ;; - category :: option
889 ;; - type :: list of strings
890 ;;
891 ;; + `:target-list' :: List of targets encountered in the parse tree.
892 ;; This is used to partly resolve "fuzzy" links
893 ;; (cf. `org-export-resolve-fuzzy-link').
894 ;; - category :: tree
895 ;; - type :: list of strings
896 ;;
897 ;; + `:time-stamp-file' :: Non-nil means transcoding should insert
898 ;; a time stamp in the output.
899 ;; - category :: option
900 ;; - type :: symbol (nil, t)
901 ;;
902 ;; + `:translate-alist' :: Alist between element and object types and
903 ;; transcoding functions relative to the current back-end.
904 ;; Special keys `template' and `plain-text' are also possible.
905 ;; - category :: option
906 ;; - type :: alist (SYMBOL . FUNCTION)
907 ;;
908 ;; + `:with-archived-trees' :: Non-nil when archived subtrees should
909 ;; also be transcoded. If it is set to the `headline' symbol,
910 ;; only the archived headline's name is retained.
911 ;; - category :: option
912 ;; - type :: symbol (nil, t, `headline')
913 ;;
914 ;; + `:with-author' :: Non-nil means author's name should be included
915 ;; in the output.
916 ;; - category :: option
917 ;; - type :: symbol (nil, t)
918 ;;
919 ;; + `:with-clocks' :: Non-nild means clock keywords should be exported.
920 ;; - category :: option
921 ;; - type :: symbol (nil, t)
922 ;;
923 ;; + `:with-creator' :: Non-nild means a creation sentence should be
924 ;; inserted at the end of the transcoded string. If the value
925 ;; is `comment', it should be commented.
926 ;; - category :: option
927 ;; - type :: symbol (`comment', nil, t)
928 ;;
929 ;; + `:with-drawers' :: Non-nil means drawers should be exported. If
930 ;; its value is a list of names, only drawers with such names
931 ;; will be transcoded.
932 ;; - category :: option
933 ;; - type :: symbol (nil, t) or list of strings
934 ;;
935 ;; + `:with-email' :: Non-nil means output should contain author's
936 ;; email.
937 ;; - category :: option
938 ;; - type :: symbol (nil, t)
939 ;;
940 ;; + `:with-emphasize' :: Non-nil means emphasized text should be
941 ;; interpreted.
942 ;; - category :: option
943 ;; - type :: symbol (nil, t)
944 ;;
945 ;; + `:with-fixed-width' :: Non-nil if transcoder should interpret
946 ;; strings starting with a colon as a fixed-with (verbatim) area.
947 ;; - category :: option
948 ;; - type :: symbol (nil, t)
949 ;;
950 ;; + `:with-footnotes' :: Non-nil if transcoder should interpret
951 ;; footnotes.
952 ;; - category :: option
953 ;; - type :: symbol (nil, t)
954 ;;
955 ;; + `:with-plannings' :: Non-nil means transcoding should include
956 ;; planning info.
957 ;; - category :: option
958 ;; - type :: symbol (nil, t)
959 ;;
960 ;; + `:with-priority' :: Non-nil means transcoding should include
961 ;; priority cookies.
962 ;; - category :: option
963 ;; - type :: symbol (nil, t)
964 ;;
965 ;; + `:with-special-strings' :: Non-nil means transcoding should
966 ;; interpret special strings in plain text.
967 ;; - category :: option
968 ;; - type :: symbol (nil, t)
969 ;;
970 ;; + `:with-sub-superscript' :: Non-nil means transcoding should
971 ;; interpret subscript and superscript. With a value of "{}",
972 ;; only interpret those using curly brackets.
973 ;; - category :: option
974 ;; - type :: symbol (nil, {}, t)
975 ;;
976 ;; + `:with-tables' :: Non-nil means transcoding should interpret
977 ;; tables.
978 ;; - category :: option
979 ;; - type :: symbol (nil, t)
980 ;;
981 ;; + `:with-tags' :: Non-nil means transcoding should keep tags in
982 ;; headlines. A `not-in-toc' value will remove them from the
983 ;; table of contents, if any, nonetheless.
984 ;; - category :: option
985 ;; - type :: symbol (nil, t, `not-in-toc')
986 ;;
987 ;; + `:with-tasks' :: Non-nil means transcoding should include
988 ;; headlines with a TODO keyword. A `todo' value will only
989 ;; include headlines with a todo type keyword while a `done'
990 ;; value will do the contrary. If a list of strings is provided,
991 ;; only tasks with keywords belonging to that list will be kept.
992 ;; - category :: option
993 ;; - type :: symbol (t, todo, done, nil) or list of strings
994 ;;
995 ;; + `:with-timestamps' :: Non-nil means transcoding should include
996 ;; time stamps. Special value `active' (resp. `inactive') ask to
997 ;; export only active (resp. inactive) timestamps. Otherwise,
998 ;; completely remove them.
999 ;; - category :: option
1000 ;; - type :: symbol: (`active', `inactive', t, nil)
1001 ;;
1002 ;; + `:with-toc' :: Non-nil means that a table of contents has to be
1003 ;; added to the output. An integer value limits its depth.
1004 ;; - category :: option
1005 ;; - type :: symbol (nil, t or integer)
1006 ;;
1007 ;; + `:with-todo-keywords' :: Non-nil means transcoding should
1008 ;; include TODO keywords.
1009 ;; - category :: option
1010 ;; - type :: symbol (nil, t)
1013 ;;;; Environment Options
1014 ;;
1015 ;; Environment options encompass all parameters defined outside the
1016 ;; scope of the parsed data. They come from five sources, in
1017 ;; increasing precedence order:
1018 ;;
1019 ;; - Global variables,
1020 ;; - Buffer's attributes,
1021 ;; - Options keyword symbols,
1022 ;; - Buffer keywords,
1023 ;; - Subtree properties.
1024 ;;
1025 ;; The central internal function with regards to environment options
1026 ;; is `org-export-get-environment'. It updates global variables with
1027 ;; "#+BIND:" keywords, then retrieve and prioritize properties from
1028 ;; the different sources.
1029 ;;
1030 ;; The internal functions doing the retrieval are:
1031 ;; `org-export-get-global-options',
1032 ;; `org-export-get-buffer-attributes',
1033 ;; `org-export-parse-option-keyword',
1034 ;; `org-export-get-subtree-options' and
1035 ;; `org-export-get-inbuffer-options'
1036 ;;
1037 ;; Also, `org-export-confirm-letbind' and `org-export-install-letbind'
1038 ;; take care of the part relative to "#+BIND:" keywords.
1041 "Collect export options from the current buffer.
1043 Optional argument BACKEND is a symbol specifying which back-end
1044 specific options to read, if any.
1046 When optional argument SUBTREEP is non-nil, assume the export is
1047 done against the current sub-tree.
1049 Third optional argument EXT-PLIST is a property list with
1050 external parameters overriding Org default settings, but still
1051 inferior to file-local settings."
1052 ;; First install #+BIND variables.
1054 ;; Get and prioritize export options...
1056 ;; ... from global variables...
1058 ;; ... from buffer's attributes...
1060 ;; ... from an external property list...
1061 ext-plist
1062 ;; ... from in-buffer settings...
1064 backend
1066 ;; ... and from subtree, when appropriate.
1068 ;; Also install back-end symbol and its translation table.
1069 `(:back-end
1070 ,backend
1071 :translate-alist
1076 "Parse an OPTIONS line and return values as a plist.
1077 Optional argument BACKEND is a symbol specifying which back-end
1078 specific items to read, if any."
1085 ;; Build an alist between #+OPTION: item and property-name.
1090 all)))
1091 plist)
1096 options)
1101 alist)
1102 plist))
1105 "Get export options in subtree at point.
1107 Assume point is at subtree's beginning.
1109 Return options as a plist."
1117 plist :title
1119 prop
1129 plist))
1132 "Return current buffer export options, as a plist.
1134 Optional argument BACKEND, when non-nil, is a symbol specifying
1135 which back-end specific options should also be read in the
1136 process.
1138 Optional argument FILES is a list of setup files names read so
1139 far, used to avoid circular dependencies.
1141 Assume buffer is in Org mode. Narrowing, if any, is ignored."
1145 ;; 1. Special keywords, as in `org-export-special-keywords'.
1158 ;; Avoid circular dependencies.
1170 val)
1178 ;; Value will be evaled: do not parse it.
1181 ;; Value has to be parsed for nested
1182 ;; macros.
1185 key
1188 ;; If user explicitly asks for
1189 ;; a newline, be sure to preserve it
1190 ;; from further filling with
1191 ;; `hard-newline'. Also replace
1192 ;; "\\n" with "\n", "\\\n" with "\\n"
1193 ;; and so on...
1200 restr)))))))))))
1202 ;; 2. Standard options, as in `org-export-options-alist'.
1204 ;; Also look for back-end specific options
1205 ;; if BACKEND is defined.
1211 ;; Build alist between keyword name and property name.
1215 all)))
1216 ;; Build regexp matching all keywords associated to export
1217 ;; options. Note: the search is case insensitive.
1230 plist prop
1231 ;; Handle value depending on specified BEHAVIOUR.
1244 ;; Parse keywords specified in `org-element-parsed-keywords'.
1252 plist prop
1255 org-element-parsed-keywords))
1256 ;; 3. Return final value.
1257 plist)))
1260 "Return properties related to buffer attributes, as a plist."
1263 ;; Store full path of input file name, or nil. For internal use.
1264 :input-file visited-file
1269 :macro-modification-time
1275 ;; Store input file name as a macro.
1277 ;; `:macro-date', `:macro-time' and `:macro-property' could as
1278 ;; well be initialized as tree properties, since they don't
1279 ;; depend on buffer properties. Though, it may be more logical
1280 ;; to keep them close to other ":macro-" properties.
1286 "Return global export options as a plist.
1288 Optional argument BACKEND, if non-nil, is a symbol specifying
1289 which back-end specific export options should also be read in the
1290 process."
1296 ;; Output value.
1297 plist)
1300 all)
1301 ;; Return value.
1302 plist))
1305 "Collect and store footnote definitions from current buffer in INFO.
1307 INFO is a plist containing export options.
1309 Footnotes definitions are stored as a alist whose CAR is
1310 footnote's label, as a string, and CDR the contents, as a parse
1311 tree. This alist will be consed to the value of
1312 `:footnote-definition-alist' in INFO, if any.
1314 The new plist is returned; use
1316 \(setq info (org-export-store-footnote-definitions info))
1318 to be sure to use the new value. INFO is modified by side
1319 effects."
1320 ;; Footnotes definitions must be collected in the original buffer,
1321 ;; as there's no insurance that they will still be in the parse
1322 ;; tree, due to some narrowing.
1324 info :footnote-definition-alist
1335 ;; Like `org-element-parse-buffer', but
1336 ;; makes sure the definition doesn't start
1337 ;; with a section element.
1342 alist))))
1343 alist))))
1347 "Can we use #+BIND values during export?
1348 By default this will ask for confirmation by the user, to divert
1349 possible security risks."
1358 "Install the values from #+BIND lines as local variables.
1359 Variables must be installed before in-buffer options are
1360 retrieved."
1367 letbind))))
1372 ;;;; Tree Properties
1373 ;;
1374 ;; Tree properties are infromation extracted from parse tree. They
1375 ;; are initialized at the beginning of the transcoding process by
1376 ;; `org-export-collect-tree-properties'.
1377 ;;
1378 ;; Dedicated functions focus on computing the value of specific tree
1379 ;; properties during initialization. Thus,
1380 ;; `org-export-populate-ignore-list' lists elements and objects that
1381 ;; should be skipped during export, `org-export-get-min-level' gets
1382 ;; the minimal exportable level, used as a basis to compute relative
1383 ;; level for headlines. Eventually
1384 ;; `org-export-collect-headline-numbering' builds an alist between
1385 ;; headlines and their numbering.
1388 "Extract tree properties from parse tree.
1390 DATA is the parse tree from which information is retrieved. INFO
1391 is a list holding export options.
1393 Following tree properties are set or updated:
1394 `:footnote-definition-alist' List of footnotes definitions in
1395 original buffer and current parse tree.
1397 `:headline-offset' Offset between true level of headlines and
1398 local level. An offset of -1 means an headline
1399 of level 2 should be considered as a level
1400 1 headline in the context.
1402 `:headline-numbering' Alist of all headlines as key an the
1403 associated numbering as value.
1405 `:ignore-list' List of elements that should be ignored during
1406 export.
1408 `:target-list' List of all targets in the parse tree."
1409 ;; Install the parse tree in the communication channel, in order to
1410 ;; use `org-export-get-genealogy' and al.
1412 ;; Get the list of elements and objects to ignore, and put it into
1413 ;; `:ignore-list'. Do not overwrite any user ignore that might have
1414 ;; been done during parse tree filtering.
1417 :ignore-list
1420 ;; Compute `:headline-offset' in order to be able to use
1421 ;; `org-export-get-relative-level'.
1425 ;; Update footnotes definitions list with definitions in parse tree.
1426 ;; This is required since buffer expansion might have modified
1427 ;; boundaries of footnote definitions contained in the parse tree.
1428 ;; This way, definitions in `footnote-definition-alist' are bound to
1429 ;; match those in the parse tree.
1432 data 'footnote-definition
1436 defs)))
1438 ;; Properties order doesn't matter: get the rest of the tree
1439 ;; properties.
1441 `(:target-list
1449 info))
1452 "Return minimum exportable headline's level in DATA.
1453 DATA is parsed tree as returned by `org-element-parse-buffer'.
1454 OPTIONS is a plist holding export options."
1465 ;; If no headline was found, for the sake of consistency, set
1466 ;; minimum level to 1 nonetheless.
1470 "Return numbering of all exportable headlines in a parse tree.
1472 DATA is the parse tree. OPTIONS is the plist holding export
1473 options.
1475 Return an alist whose key is an headline and value is its
1476 associated numbering \(in the shape of a list of numbers\)."
1479 data
1480 'headline
1485 headline
1487 for idx from 0 to org-export-max-depth
1491 options)))
1494 "Return list of elements and objects to ignore during export.
1495 DATA is the parse tree to traverse. OPTIONS is the plist holding
1496 export options."
1501 ;; Collect ignored elements or objects into IGNORE-LIST.
1509 ;; If headline is archived but tree below has
1510 ;; to be skipped, add it to ignore list.
1513 ;; Move into recursive objects/elements.
1517 ;; Main call. First find trees containing a select tag, if any.
1519 ;; Return value.
1520 ignore))
1523 "Return list of headlines containing a select tag in their tree.
1524 DATA is parsed data as returned by `org-element-parse-buffer'.
1525 INFO is a plist holding export options."
1537 ;; When a select tag is found, mark full
1538 ;; genealogy and every headline within the tree
1539 ;; as acceptable.
1542 genealogy
1544 selected-trees))
1545 ;; Else, continue searching in tree, recursively.
1552 "Non-nil when element or object BLOB should be skipped during export.
1553 OPTIONS is the plist holding export options. SELECTED, when
1554 non-nil, is a list of headlines belonging to a tree with a select
1555 tag."
1557 ;; Check headline.
1565 ;; Ignore subtrees with an exclude tag.
1568 ;; When a select tag is present in the buffer, ignore any tree
1569 ;; without it.
1571 ;; Ignore commented sub-trees.
1573 ;; Ignore archived subtrees if `:with-archived-trees' is nil.
1575 ;; Ignore tasks, if specified by `:with-tasks' property.
1581 ;; Check timestamp.
1584 ;; No timestamp allowed.
1586 ;; Only active timestamps allowed and the current one isn't
1587 ;; active.
1591 ;; Only inactive timestamps allowed and the current one isn't
1592 ;; inactive.
1596 ;; Check drawer.
1602 ;; Check table-row.
1604 ;; Check table-cell.
1609 ;; Check clock.
1611 ;; Check planning.
1615 \f
1616 ;;; The Transcoder
1617 ;;
1618 ;; `org-export-data' reads a parse tree (obtained with, i.e.
1619 ;; `org-element-parse-buffer') and transcodes it into a specified
1620 ;; back-end output. It takes care of filtering out elements or
1621 ;; objects according to export options and organizing the output blank
1622 ;; lines and white space are preserved.
1623 ;;
1624 ;; Internally, three functions handle the filtering of objects and
1625 ;; elements during the export. In particular,
1626 ;; `org-export-ignore-element' marks an element or object so future
1627 ;; parse tree traversals skip it, `org-export-interpret-p' tells which
1628 ;; elements or objects should be seen as real Org syntax and
1629 ;; `org-export-expand' transforms the others back into their original
1630 ;; shape
1631 ;;
1632 ;; `org-export-transcoder' is an accessor returning appropriate
1633 ;; translator function for a given element or object.
1636 "Return appropriate transcoder for BLOB.
1637 INFO is a plist containing export directives."
1639 ;; Return contents only for complete parse trees.
1645 "Convert DATA into current back-end format.
1647 DATA is a parse tree, an element or an object or a secondary
1648 string. INFO is a plist holding export options.
1650 Return transcoded string."
1654 ;; Ignored element/object.
1656 ;; Plain text.
1662 info))
1663 ;; Uninterpreted element/object: change it back to Org
1664 ;; syntax and export again resulting raw string.
1668 data
1672 info))
1673 ;; Secondary string.
1676 ;; Element/Object without contents or, as a special case,
1677 ;; headline with archive tag and archived trees restricted
1678 ;; to title only.
1685 ;; Element/Object with contents.
1697 ;; Elements directly containing objects
1698 ;; must have their indentation normalized
1699 ;; first.
1701 data
1702 ;; When normalizing contents of the first
1703 ;; paragraph in an item or a footnote
1704 ;; definition, ignore first line's
1705 ;; indentation: there is none and it
1706 ;; might be misleading.
1710 data)
1716 contents)
1717 info))))))))
1721 ;; Append the same white space between elements or objects as in
1722 ;; the original buffer, and call appropriate filters.
1732 info)))
1733 ;; Eventually return string.
1734 results)))))
1737 "Non-nil if element or object BLOB should be interpreted as Org syntax.
1738 Check is done according to export options INFO, stored as
1739 a plist."
1741 ;; ... entities...
1743 ;; ... emphasis...
1745 ;; ... fixed-width areas.
1747 ;; ... footnotes...
1750 ;; ... sub/superscripts...
1756 ;; ... tables...
1761 "Expand a parsed element or object to its original state.
1762 BLOB is either an element or an object. CONTENTS is its
1763 contents, as a string or nil."
1766 blob contents))
1769 "Add ELEMENT to `:ignore-list' in INFO.
1771 Any element in `:ignore-list' will be skipped when using
1772 `org-element-map'. INFO is modified by side effects."
1776 \f
1777 ;;; The Filter System
1778 ;;
1779 ;; Filters allow end-users to tweak easily the transcoded output.
1780 ;; They are the functional counterpart of hooks, as every filter in
1781 ;; a set is applied to the return value of the previous one.
1782 ;;
1783 ;; Every set is back-end agnostic. Although, a filter is always
1784 ;; called, in addition to the string it applies to, with the back-end
1785 ;; used as argument, so it's easy enough for the end-user to add
1786 ;; back-end specific filters in the set. The communication channel,
1787 ;; as a plist, is required as the third argument.
1788 ;;
1789 ;; Filters sets are defined below. There are of four types:
1790 ;;
1791 ;; - `org-export-filter-parse-tree-functions' applies directly on the
1792 ;; complete parsed tree. It's the only filters set that doesn't
1793 ;; apply to a string.
1794 ;; - `org-export-filter-final-output-functions' applies to the final
1795 ;; transcoded string.
1796 ;; - `org-export-filter-plain-text-functions' applies to any string
1797 ;; not recognized as Org syntax.
1798 ;; - `org-export-filter-TYPE-functions' applies on the string returned
1799 ;; after an element or object of type TYPE has been transcoded.
1800 ;;
1801 ;; All filters sets are applied through
1802 ;; `org-export-filter-apply-functions' function. Filters in a set are
1803 ;; applied in a LIFO fashion. It allows developers to be sure that
1804 ;; their filters will be applied first.
1805 ;;
1806 ;; Filters properties are installed in communication channel with
1807 ;; `org-export-install-filters' function.
1808 ;;
1809 ;; Eventually, a hook (`org-export-before-parsing-hook') is run just
1810 ;; before parsing to allow for heavy structure modifications.
1813 ;;;; Before Parsing Hook
1816 "Hook run before parsing an export buffer.
1817 This is run after include keywords have been expanded and Babel
1818 code executed, on a copy of original buffer's area being
1819 exported. Visibility is the same as in the original one. Point
1823 ;;;; Special Filters
1826 "List of functions applied to the parsed tree.
1827 Each filter is called with three arguments: the parse tree, as
1828 returned by `org-element-parse-buffer', the back-end, as
1829 a symbol, and the communication channel, as a plist. It must
1833 "List of functions applied to the transcoded string.
1834 Each filter is called with three arguments: the full transcoded
1835 string, the back-end, as a symbol, and the communication channel,
1836 as a plist. It must return a string that will be used as the
1840 "List of functions applied to plain text.
1841 Each filter is called with three arguments: a string which
1842 contains no Org syntax, the back-end, as a symbol, and the
1843 communication channel, as a plist. It must return a string or
1847 ;;;; Elements Filters
1850 "List of functions applied to a transcoded center block.
1851 Each filter is called with three arguments: the transcoded data,
1852 as a string, the back-end, as a symbol, and the communication
1856 "List of functions applied to a transcoded clock.
1857 Each filter is called with three arguments: the transcoded data,
1858 as a string, the back-end, as a symbol, and the communication
1862 "List of functions applied to a transcoded drawer.
1863 Each filter is called with three arguments: the transcoded data,
1864 as a string, the back-end, as a symbol, and the communication
1868 "List of functions applied to a transcoded dynamic-block.
1869 Each filter is called with three arguments: the transcoded data,
1870 as a string, the back-end, as a symbol, and the communication
1874 "List of functions applied to a transcoded headline.
1875 Each filter is called with three arguments: the transcoded data,
1876 as a string, the back-end, as a symbol, and the communication
1880 "List of functions applied to a transcoded inlinetask.
1881 Each filter is called with three arguments: the transcoded data,
1882 as a string, the back-end, as a symbol, and the communication
1886 "List of functions applied to a transcoded plain-list.
1887 Each filter is called with three arguments: the transcoded data,
1888 as a string, the back-end, as a symbol, and the communication
1892 "List of functions applied to a transcoded item.
1893 Each filter is called with three arguments: the transcoded data,
1894 as a string, the back-end, as a symbol, and the communication
1898 "List of functions applied to a transcoded comment.
1899 Each filter is called with three arguments: the transcoded data,
1900 as a string, the back-end, as a symbol, and the communication
1904 "List of functions applied to a transcoded comment-comment.
1905 Each filter is called with three arguments: the transcoded data,
1906 as a string, the back-end, as a symbol, and the communication
1910 "List of functions applied to a transcoded example-block.
1911 Each filter is called with three arguments: the transcoded data,
1912 as a string, the back-end, as a symbol, and the communication
1916 "List of functions applied to a transcoded export-block.
1917 Each filter is called with three arguments: the transcoded data,
1918 as a string, the back-end, as a symbol, and the communication
1922 "List of functions applied to a transcoded fixed-width.
1923 Each filter is called with three arguments: the transcoded data,
1924 as a string, the back-end, as a symbol, and the communication
1928 "List of functions applied to a transcoded footnote-definition.
1929 Each filter is called with three arguments: the transcoded data,
1930 as a string, the back-end, as a symbol, and the communication
1934 "List of functions applied to a transcoded horizontal-rule.
1935 Each filter is called with three arguments: the transcoded data,
1936 as a string, the back-end, as a symbol, and the communication
1940 "List of functions applied to a transcoded keyword.
1941 Each filter is called with three arguments: the transcoded data,
1942 as a string, the back-end, as a symbol, and the communication
1946 "List of functions applied to a transcoded latex-environment.
1947 Each filter is called with three arguments: the transcoded data,
1948 as a string, the back-end, as a symbol, and the communication
1952 "List of functions applied to a transcoded babel-call.
1953 Each filter is called with three arguments: the transcoded data,
1954 as a string, the back-end, as a symbol, and the communication
1958 "List of functions applied to a transcoded paragraph.
1959 Each filter is called with three arguments: the transcoded data,
1960 as a string, the back-end, as a symbol, and the communication
1964 "List of functions applied to a transcoded planning.
1965 Each filter is called with three arguments: the transcoded data,
1966 as a string, the back-end, as a symbol, and the communication
1970 "List of functions applied to a transcoded property-drawer.
1971 Each filter is called with three arguments: the transcoded data,
1972 as a string, the back-end, as a symbol, and the communication
1976 "List of functions applied to a transcoded quote block.
1977 Each filter is called with three arguments: the transcoded quote
1978 data, as a string, the back-end, as a symbol, and the
1979 communication channel, as a plist. It must return a string or
1983 "List of functions applied to a transcoded quote-section.
1984 Each filter is called with three arguments: the transcoded data,
1985 as a string, the back-end, as a symbol, and the communication
1989 "List of functions applied to a transcoded section.
1990 Each filter is called with three arguments: the transcoded data,
1991 as a string, the back-end, as a symbol, and the communication
1995 "List of functions applied to a transcoded special block.
1996 Each filter is called with three arguments: the transcoded data,
1997 as a string, the back-end, as a symbol, and the communication
2001 "List of functions applied to a transcoded src-block.
2002 Each filter is called with three arguments: the transcoded data,
2003 as a string, the back-end, as a symbol, and the communication
2007 "List of functions applied to a transcoded table.
2008 Each filter is called with three arguments: the transcoded data,
2009 as a string, the back-end, as a symbol, and the communication
2013 "List of functions applied to a transcoded table-cell.
2014 Each filter is called with three arguments: the transcoded data,
2015 as a string, the back-end, as a symbol, and the communication
2019 "List of functions applied to a transcoded table-row.
2020 Each filter is called with three arguments: the transcoded data,
2021 as a string, the back-end, as a symbol, and the communication
2025 "List of functions applied to a transcoded verse block.
2026 Each filter is called with three arguments: the transcoded data,
2027 as a string, the back-end, as a symbol, and the communication
2031 ;;;; Objects Filters
2034 "List of functions applied to transcoded bold text.
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 transcoded code text.
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 entity.
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 export-snippet.
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 "List of functions applied to a transcoded footnote-reference.
2059 Each filter is called with three arguments: the transcoded data,
2060 as a string, the back-end, as a symbol, and the communication
2064 "List of functions applied to a transcoded inline-babel-call.
2065 Each filter is called with three arguments: the transcoded data,
2066 as a string, the back-end, as a symbol, and the communication
2070 "List of functions applied to a transcoded inline-src-block.
2071 Each filter is called with three arguments: the transcoded data,
2072 as a string, the back-end, as a symbol, and the communication
2076 "List of functions applied to transcoded italic text.
2077 Each filter is called with three arguments: the transcoded data,
2078 as a string, the back-end, as a symbol, and the communication
2082 "List of functions applied to a transcoded latex-fragment.
2083 Each filter is called with three arguments: the transcoded data,
2084 as a string, the back-end, as a symbol, and the communication
2088 "List of functions applied to a transcoded line-break.
2089 Each filter is called with three arguments: the transcoded data,
2090 as a string, the back-end, as a symbol, and the communication
2094 "List of functions applied to a transcoded link.
2095 Each filter is called with three arguments: the transcoded data,
2096 as a string, the back-end, as a symbol, and the communication
2100 "List of functions applied to a transcoded macro.
2101 Each filter is called with three arguments: the transcoded data,
2102 as a string, the back-end, as a symbol, and the communication
2106 "List of functions applied to a transcoded radio-target.
2107 Each filter is called with three arguments: the transcoded data,
2108 as a string, the back-end, as a symbol, and the communication
2112 "List of functions applied to a transcoded statistics-cookie.
2113 Each filter is called with three arguments: the transcoded data,
2114 as a string, the back-end, as a symbol, and the communication
2118 "List of functions applied to transcoded strike-through text.
2119 Each filter is called with three arguments: the transcoded data,
2120 as a string, the back-end, as a symbol, and the communication
2124 "List of functions applied to a transcoded subscript.
2125 Each filter is called with three arguments: the transcoded data,
2126 as a string, the back-end, as a symbol, and the communication
2130 "List of functions applied to a transcoded superscript.
2131 Each filter is called with three arguments: the transcoded data,
2132 as a string, the back-end, as a symbol, and the communication
2136 "List of functions applied to a transcoded target.
2137 Each filter is called with three arguments: the transcoded data,
2138 as a string, the back-end, as a symbol, and the communication
2142 "List of functions applied to a transcoded timestamp.
2143 Each filter is called with three arguments: the transcoded data,
2144 as a string, the back-end, as a symbol, and the communication
2148 "List of functions applied to transcoded underline text.
2149 Each filter is called with three arguments: the transcoded data,
2150 as a string, the back-end, as a symbol, and the communication
2154 "List of functions applied to transcoded verbatim text.
2155 Each filter is called with three arguments: the transcoded data,
2156 as a string, the back-end, as a symbol, and the communication
2160 "Call every function in FILTERS.
2161 Functions are called with arguments VALUE, current export
2162 back-end and INFO. Call is done in a LIFO fashion, to be sure
2163 that developer specified filters, if any, are called first."
2167 value)
2170 "Install filters properties in communication channel.
2172 INFO is a plist containing the current communication channel.
2174 Return the updated communication channel."
2176 ;; Install user defined filters with `org-export-filters-alist'.
2179 org-export-filters-alist)
2180 ;; Prepend back-end specific filters to that list.
2185 ;; Single values get consed, lists are prepended.
2190 plist key
2194 ;; Return new communication channel.
2198 \f
2199 ;;; Core functions
2200 ;;
2201 ;; This is the room for the main function, `org-export-as', along with
2202 ;; its derivatives, `org-export-to-buffer' and `org-export-to-file'.
2203 ;; They differ only by the way they output the resulting code.
2204 ;;
2205 ;; `org-export-output-file-name' is an auxiliary function meant to be
2206 ;; used with `org-export-to-file'. With a given extension, it tries
2207 ;; to provide a canonical file name to write export output to.
2208 ;;
2209 ;; Note that `org-export-as' doesn't really parse the current buffer,
2210 ;; but a copy of it (with the same buffer-local variables and
2211 ;; visibility), where include keywords are expanded and Babel blocks
2212 ;; are executed, if appropriate.
2213 ;; `org-export-with-current-buffer-copy' macro prepares that copy.
2214 ;;
2215 ;; File inclusion is taken care of by
2216 ;; `org-export-expand-include-keyword' and
2217 ;; `org-export-prepare-file-contents'. Structure wise, including
2218 ;; a whole Org file in a buffer often makes little sense. For
2219 ;; example, if the file contains an headline and the include keyword
2220 ;; was within an item, the item should contain the headline. That's
2221 ;; why file inclusion should be done before any structure can be
2222 ;; associated to the file, that is before parsing.
2228 "Transcode current Org buffer into BACKEND code.
2230 If narrowing is active in the current buffer, only transcode its
2231 narrowed part.
2233 If a region is active, transcode that region.
2235 When optional argument SUBTREEP is non-nil, transcode the
2236 sub-tree at point, extracting information from the headline
2237 properties first.
2239 When optional argument VISIBLE-ONLY is non-nil, don't export
2240 contents of hidden elements.
2242 When optional argument BODY-ONLY is non-nil, only return body
2243 code, without preamble nor postamble.
2245 Optional argument EXT-PLIST, when provided, is a property list
2246 with external parameters overriding Org default settings, but
2247 still inferior to file-local settings.
2249 Optional argument NOEXPAND, when non-nil, prevents included files
2250 to be expanded and Babel code to be executed.
2252 Return code as a string."
2255 ;; Narrow buffer to an appropriate region or subtree for
2256 ;; parsing. If parsing subtree, be sure to remove main headline
2257 ;; too.
2265 ;; 1. Get export environment from original buffer. Store
2266 ;; original footnotes definitions in communication channel as
2267 ;; they might not be accessible anymore in a narrowed parse
2268 ;; tree. Also install user's and developer's filters.
2272 ;; 2. Get parse tree. Buffer isn't parsed directly.
2273 ;; Instead, a temporary copy is created, where include
2274 ;; keywords are expanded and code blocks are evaluated.
2280 ;; Setting `org-current-export-file' is
2281 ;; required by Org Babel to properly resolve
2282 ;; noweb references.
2286 ;; Run hook with `org-export-current-backend' set
2287 ;; to BACKEND.
2290 ;; Eventually parse buffer.
2292 ;; 3. Call parse-tree filters to get the final tree.
2296 ;; 4. Now tree is complete, compute its properties and add
2297 ;; them to communication channel.
2301 ;; 5. Eventually transcode TREE. Wrap the resulting string
2302 ;; into a template, if required. Eventually call
2303 ;; final-output filter.
2310 info)))
2311 ;; Maybe add final OUTPUT to kill ring, then return it.
2313 output)))))
2317 "Call `org-export-as' with output to a specified buffer.
2319 BACKEND is the back-end used for transcoding, as a symbol.
2321 BUFFER is the output buffer. If it already exists, it will be
2322 erased first, otherwise, it will be created.
2324 Optional arguments SUBTREEP, VISIBLE-ONLY, BODY-ONLY, EXT-PLIST
2325 and NOEXPAND are similar to those used in `org-export-as', which
2326 see.
2328 Return buffer."
2330 backend subtreep visible-only body-only ext-plist noexpand))
2336 buffer))
2340 "Call `org-export-as' with output to a specified file.
2342 BACKEND is the back-end used for transcoding, as a symbol. FILE
2343 is the name of the output file, as a string.
2345 Optional arguments SUBTREEP, VISIBLE-ONLY, BODY-ONLY, EXT-PLIST
2346 and NOEXPAND are similar to those used in `org-export-as', which
2347 see.
2349 Return output file's name."
2350 ;; Checks for FILE permissions. `write-file' would do the same, but
2351 ;; we'd rather avoid needless transcoding of parse tree.
2353 ;; Insert contents to a temporary buffer and write it to FILE.
2355 backend subtreep visible-only body-only ext-plist noexpand)))
2360 ;; Return full path.
2361 file)
2364 "Return output file's name according to buffer specifications.
2366 EXTENSION is a string representing the output file extension,
2367 with the leading dot.
2369 With a non-nil optional argument SUBTREEP, try to determine
2371 of subtree at point.
2373 When optional argument PUB-DIR is set, use it as the publishing
2374 directory.
2376 Return file name as a string, or nil if it couldn't be
2377 determined."
2379 ;; File name may come from EXPORT_FILE_NAME subtree property,
2380 ;; assuming point is at beginning of said sub-tree.
2388 ;; File name may be extracted from buffer's associated
2389 ;; file, if any.
2391 ;; Can't determine file name on our own: Ask user.
2395 "Output file: " pub-dir nil nil nil
2398 ;; Build file name. Enforce EXTENSION over whatever user may have
2399 ;; come up with. PUB-DIR, if defined, always has precedence over
2400 ;; any provided path.
2405 extension))
2411 "Apply BODY in a copy of the current buffer.
2413 The copy preserves local variables and visibility of the original
2414 buffer.
2416 Point is at buffer's beginning when BODY is applied."
2426 ,original-buffer
2431 ov
2441 "Expand every include keyword in buffer.
2442 Optional argument INCLUDED is a list of included file names along
2443 with their line restriction, when appropriate. It is used to
2444 avoid infinite recursion. Optional argument DIR is the current
2445 working directory. It is used to properly resolve relative
2446 paths."
2453 ;; Extract arguments from keyword's value.
2467 ;; Minimal level of included file defaults to the child
2468 ;; level of the current headline, if any, or one. It
2469 ;; only applies is the file is meant to be included as
2470 ;; an Org one.
2478 ;; Remove keyword.
2482 ;; Check if files has already been parsed. Look after
2483 ;; inclusion lines too, as different parts of the same file
2484 ;; can be included too.
2493 ;; Protect sensitive contents with commas.
2499 ind-str contents ind-str))))
2504 ;; Protect sensitive contents with commas.
2511 ind-str env contents ind-str))))
2524 "Prepare the contents of FILE for inclusion and return them as a string.
2526 When optional argument LINES is a string specifying a range of
2527 lines, include only those lines.
2529 Optional argument IND, when non-nil, is an integer specifying the
2530 global indentation of returned contents. Since its purpose is to
2531 allow an included file to stay in the same environment it was
2532 created \(i.e. a list item), it doesn't apply past the first
2533 headline encountered.
2535 Optional argument MINLEVEL, when non-nil, is an integer
2536 specifying the level that any top-level headline in the included
2537 file should have."
2553 ;; Remove blank lines at beginning and end of contents. The logic
2554 ;; behind that removal is that blank lines around include keyword
2555 ;; override blank lines in included file.
2564 ;; If IND is set, preserve indentation of include keyword until
2565 ;; the first headline encountered.
2571 ;; Do not move footnote definitions out of column 0.
2577 ;; When MINLEVEL is specified, compute minimal level for headlines
2578 ;; in the file (CUR-MIN), and remove stars to each headline so
2579 ;; that headlines with minimal level have a level of MINLEVEL.
2588 ;; Only change stars, don't bother moving whole
2589 ;; sections.
2595 \f
2596 ;;; Tools For Back-Ends
2597 ;;
2598 ;; A whole set of tools is available to help build new exporters. Any
2599 ;; function general enough to have its use across many back-ends
2600 ;; should be added here.
2601 ;;
2602 ;; As of now, functions operating on footnotes, headlines, links,
2603 ;; macros, references, src-blocks, tables and tables of contents are
2604 ;; implemented.
2606 ;;;; For Export Snippets
2607 ;;
2608 ;; Every export snippet is transmitted to the back-end. Though, the
2609 ;; latter will only retain one type of export-snippet, ignoring
2610 ;; others, based on the former's target back-end. The function
2611 ;; `org-export-snippet-backend' returns that back-end for a given
2612 ;; export-snippet.
2615 "Return EXPORT-SNIPPET targeted back-end as a symbol.
2616 Translation, with `org-export-snippet-translation-alist', is
2617 applied."
2621 back-end))))
2624 ;;;; For Footnotes
2625 ;;
2626 ;; `org-export-collect-footnote-definitions' is a tool to list
2627 ;; actually used footnotes definitions in the whole parse tree, or in
2628 ;; an headline, in order to add footnote listings throughout the
2629 ;; transcoded data.
2630 ;;
2631 ;; `org-export-footnote-first-reference-p' is a predicate used by some
2632 ;; back-ends, when they need to attach the footnote definition only to
2633 ;; the first occurrence of the corresponding label.
2634 ;;
2635 ;; `org-export-get-footnote-definition' and
2636 ;; `org-export-get-footnote-number' provide easier access to
2637 ;; additional information relative to a footnote reference.
2640 "Return an alist between footnote numbers, labels and definitions.
2642 DATA is the parse tree from which definitions are collected.
2643 INFO is the plist used as a communication channel.
2645 Definitions are sorted by order of references. They either
2646 appear as Org data or as a secondary string for inlined
2647 footnotes. Unreferenced definitions are ignored."
2652 ;; Collect footnote number, label and definition in DATA.
2654 data 'footnote-reference
2661 def)
2662 num-alist)
2663 ;; Also search in definition for nested footnotes.
2666 ;; Don't enter footnote definitions since it will happen
2667 ;; when their first reference is found.
2673 "Non-nil when a footnote reference is the first one for its label.
2675 FOOTNOTE-REFERENCE is the footnote reference being considered.
2676 INFO is the plist used as a communication channel."
2678 ;; Anonymous footnotes are always a first reference.
2680 ;; Otherwise, return the first footnote with the same LABEL and
2681 ;; test if it is equal to FOOTNOTE-REFERENCE.
2686 data 'footnote-reference
2691 ;; If FN isn't inlined, be sure to traverse its
2692 ;; definition before resuming search. See
2693 ;; comments in `org-export-get-footnote-number'
2694 ;; for more information.
2698 ;; Don't enter footnote definitions since it will
2699 ;; happen when their first reference is found.
2702 footnote-reference)))))
2705 "Return definition of FOOTNOTE-REFERENCE as parsed data.
2706 INFO is the plist used as a communication channel."
2712 "Return number associated to a footnote.
2714 FOOTNOTE is either a footnote reference or a footnote definition.
2715 INFO is the plist used as a communication channel."
2717 seen-refs
2721 ;; Search footnote references through DATA, filling
2722 ;; SEEN-REFS along the way.
2724 data 'footnote-reference
2728 ;; Anonymous footnote match: return number.
2731 ;; Labels match: return number.
2734 ;; Anonymous footnote: it's always a new one. Also,
2735 ;; be sure to return nil from the `cond' so
2736 ;; `first-match' doesn't get us out of the loop.
2738 ;; Label not seen so far: add it so SEEN-REFS.
2739 ;;
2740 ;; Also search for subsequent references in footnote
2741 ;; definition so numbering following reading logic.
2742 ;; Note that we don't have to care about inline
2743 ;; definitions, since `org-element-map' already
2744 ;; traverse them at the right time.
2745 ;;
2746 ;; Once again, return nil to stay in the loop.
2751 nil))))
2752 ;; Don't enter footnote definitions since it will happen
2753 ;; when their first reference is found.
2758 ;;;; For Headlines
2759 ;;
2760 ;; `org-export-get-relative-level' is a shortcut to get headline
2761 ;; level, relatively to the lower headline level in the parsed tree.
2762 ;;
2763 ;; `org-export-get-headline-number' returns the section number of an
2764 ;; headline, while `org-export-number-to-roman' allows to convert it
2765 ;; to roman numbers.
2766 ;;
2767 ;; `org-export-low-level-p', `org-export-first-sibling-p' and
2768 ;; `org-export-last-sibling-p' are three useful predicates when it
2769 ;; comes to fulfill the `:headline-levels' property.
2772 "Return HEADLINE relative level within current parsed tree.
2773 INFO is a plist holding contextual information."
2778 "Non-nil when HEADLINE is considered as low level.
2780 INFO is a plist used as a communication channel.
2782 A low level headlines has a relative level greater than
2783 `:headline-levels' property value.
2785 Return value is the difference between HEADLINE relative level
2786 and the last level being considered as high enough, or nil."
2793 "Return HEADLINE numbering as a list of numbers.
2794 INFO is a plist holding contextual information."
2798 "Return a non-nil value if HEADLINE element should be numbered.
2799 INFO is a plist used as a communication channel."
2805 "Convert integer N into a roman numeral."
2818 res)))
2821 "Return list of tags associated to ELEMENT.
2823 ELEMENT has either an `headline' or an `inlinetask' type. INFO
2824 is a plist used as a communication channel.
2826 Select tags (see `org-export-select-tags') and exclude tags (see
2827 `org-export-exclude-tags') are removed from the list.
2829 When non-nil, optional argument TAGS should be a list of strings.
2830 Any tag belonging to this list will also be removed."
2837 "Non-nil when HEADLINE is the first sibling in its sub-tree.
2838 INFO is the plist used as a communication channel."
2843 "Non-nil when HEADLINE is the last sibling in its sub-tree.
2844 INFO is the plist used as a communication channel."
2848 ;;;; For Links
2849 ;;
2850 ;; `org-export-solidify-link-text' turns a string into a safer version
2851 ;; for links, replacing most non-standard characters with hyphens.
2852 ;;
2853 ;; `org-export-get-coderef-format' returns an appropriate format
2854 ;; string for coderefs.
2855 ;;
2856 ;; `org-export-inline-image-p' returns a non-nil value when the link
2857 ;; provided should be considered as an inline image.
2858 ;;
2859 ;; `org-export-resolve-fuzzy-link' searches destination of fuzzy links
2860 ;; (i.e. links with "fuzzy" as type) within the parsed tree, and
2861 ;; returns an appropriate unique identifier when found, or nil.
2862 ;;
2863 ;; `org-export-resolve-id-link' returns the first headline with
2864 ;; specified id or custom-id in parse tree, or nil when none was
2865 ;; found.
2866 ;;
2867 ;; `org-export-resolve-coderef' associates a reference to a line
2868 ;; number in the element it belongs, or returns the reference itself
2869 ;; when the element isn't numbered.
2872 "Take link text S and make a safe target out of it."
2877 "Return format string for code reference link.
2878 PATH is the link path. DESC is its description."
2886 "Non-nil if LINK object points to an inline image.
2888 Optional argument is a set of RULES defining inline images. It
2889 is an alist where associations have the following shape:
2891 \(TYPE . REGEXP)
2893 Applying a rule means apply REGEXP against LINK's path when its
2894 type is TYPE. The function will return a non-nil value if any of
2895 the provided rules is non-nil. The default rule is
2896 `org-export-default-inline-image-rule'.
2898 This only applies to links without a description."
2907 rules))))
2910 "Resolve a code reference REF.
2912 INFO is a plist used as a communication channel.
2914 Return associated line number in source code, or REF itself,
2915 depending on src-block or example element's switches."
2923 org-coderef-label-format)))
2927 ;; Element containing REF is found. Resolve it to either
2928 ;; a label or a line number, as needed.
2938 "Return LINK destination.
2940 INFO is a plist holding contextual information.
2942 Return value can be an object, an element, or nil:
2944 - If LINK path matches a target object (i.e. <<path>>) or
2947 - If LINK path exactly matches the name affiliated keyword
2948 \(i.e. #+NAME: path) of an element, return that element.
2950 - If LINK path exactly matches any headline name, return that
2951 element. If more than one headline share that name, priority
2952 will be given to the one with the closest common ancestor, if
2953 any, or the first one in the parse tree otherwise.
2955 - Otherwise, return nil.
2960 ;; First try to find a matching "<<path>>" unless user specified
2961 ;; he was looking for an headline (path starts with a *
2962 ;; character).
2966 return target)))
2967 ;; Then try to find an element with a matching "#+NAME: path"
2968 ;; affiliated keyword.
2975 ;; Last case: link either points to an headline or to
2976 ;; nothingness. Try to find the source, with priority given to
2977 ;; headlines with the closest common ancestor. If such candidate
2978 ;; is found, return it, otherwise return nil.
2982 ;; Return first headline whose `:raw-value' property
2983 ;; is NAME in parse tree DATA, or nil.
2986 data 'headline
2990 name)
2991 headline))
2993 ;; Search among headlines sharing an ancestor with link,
2994 ;; from closest to farthest.
3002 ;; No match with a common ancestor: try the full parse-tree.
3006 "Return headline referenced as LINK destination.
3008 INFO is a plist used as a communication channel.
3010 Return value can be an headline element or nil. Assume LINK type
3018 headline))
3022 "Return radio-target object referenced as LINK destination.
3024 INFO is a plist used as a communication channel.
3026 Return value can be a radio-target object or nil. Assume LINK
3036 ;;;; For Macros
3037 ;;
3038 ;; `org-export-expand-macro' simply takes care of expanding macros.
3041 "Expand MACRO and return it as a string.
3042 INFO is a plist holding export options."
3045 ;; User's macros are stored in the communication channel with
3046 ;; a ":macro-" prefix. Replace arguments in VALUE. Also
3047 ;; expand recursively macros within.
3056 obj)))
3058 info)))
3059 ;; VALUE starts with "(eval": it is a s-exp, `eval' it.
3061 ;; Return string.
3065 ;;;; For References
3066 ;;
3067 ;; `org-export-get-ordinal' associates a sequence number to any object
3068 ;; or element.
3071 "Return ordinal number of an element or object.
3073 ELEMENT is the element or object considered. INFO is the plist
3074 used as a communication channel.
3076 Optional argument TYPES, when non-nil, is a list of element or
3077 object types, as symbols, that should also be counted in.
3078 Otherwise, only provided element's type is considered.
3080 Optional argument PREDICATE is a function returning a non-nil
3081 value if the current element or object should be counted in. It
3082 accepts two arguments: the element or object being considered and
3083 the plist used as a communication channel. This allows to count
3084 only a certain type of objects (i.e. inline images).
3086 Return value is a list of numbers if ELEMENT is an headline or an
3087 item. It is nil for keywords. It represents the footnote number
3088 for footnote definitions and footnote references. If ELEMENT is
3089 a target, return the same value as if ELEMENT was the closest
3090 table, item or headline containing the target. In any other
3091 case, return the sequence number of ELEMENT among elements or
3092 objects of the same type."
3093 ;; A target keyword, representing an invisible target, never has
3094 ;; a sequence number.
3096 ;; Ordinal of a target object refer to the ordinal of the closest
3097 ;; table, item, or headline containing the object.
3101 when
3105 table))
3106 return parent)))
3108 ;; Special case 1: An headline returns its number as a list.
3110 ;; Special case 2: An item returns its number as a list.
3114 struct
3121 ;; Increment counter until ELEMENT is found again.
3132 ;;;; For Src-Blocks
3133 ;;
3134 ;; `org-export-get-loc' counts number of code lines accumulated in
3135 ;; src-block or example-block elements with a "+n" switch until
3136 ;; a given element, excluded. Note: "-n" switches reset that count.
3137 ;;
3138 ;; `org-export-unravel-code' extracts source code (along with a code
3139 ;; references alist) from an `element-block' or `src-block' type
3140 ;; element.
3141 ;;
3142 ;; `org-export-format-code' applies a formatting function to each line
3143 ;; of code, providing relative line number and code reference when
3144 ;; appropriate. Since it doesn't access the original element from
3145 ;; which the source code is coming, it expects from the code calling
3146 ;; it to know if lines should be numbered and if code references
3147 ;; should appear.
3148 ;;
3149 ;; Eventually, `org-export-format-code-default' is a higher-level
3150 ;; function (it makes use of the two previous functions) which handles
3151 ;; line numbering and code references inclusion, and returns source
3152 ;; code in a format suitable for plain text or verbatim output.
3155 "Return accumulated lines of code up to ELEMENT.
3157 INFO is the plist used as a communication channel.
3159 ELEMENT is excluded from count."
3166 ;; ELEMENT is reached: Quit the loop.
3168 ;; Only count lines from src-block and example-block elements
3169 ;; with a "+n" or "-n" switch. A "-n" switch resets counter.
3173 ;; Accumulate locs or reset them.
3177 ;; Return nil to stay in the loop.
3178 nil)))
3180 ;; Return value.
3181 loc))
3184 "Clean source code and extract references out of it.
3186 ELEMENT has either a `src-block' an `example-block' type.
3188 Return a cons cell whose CAR is the source code, cleaned from any
3189 reference and protective comma and CDR is an alist between
3190 relative line number (integer) and name of code reference on that
3191 line (string)."
3193 ;; Get code and clean it. Remove blank lines at its
3194 ;; beginning and end. Also remove protective commas.
3200 ;; If appropriate, remove global indentation.
3204 ;; Free up the protected lines. Note: Org blocks
3205 ;; have commas at the beginning or every line.
3210 ;; Get format used for references.
3213 org-coderef-label-format)))
3214 ;; Build a regexp matching a loc with a reference.
3219 ;; Return value.
3221 ;; Code with references removed.
3227 ;; Ref line: remove ref, and signal its position in REFS.
3231 ;; Reference alist.
3232 refs)))
3235 "Format CODE by applying FUN line-wise and return it.
3237 CODE is a string representing the code to format. FUN is
3238 a function. It must accept three arguments: a line of
3239 code (string), the current line number (integer) or nil and the
3240 reference associated to the current line (string) or nil.
3242 Optional argument NUM-LINES can be an integer representing the
3243 number of code lines accumulated until the current code. Line
3244 numbers passed to FUN will take it into account. If it is nil,
3245 FUN's second argument will always be nil. This number can be
3246 obtained with `org-export-get-loc' function.
3248 Optional argument REF-ALIST can be an alist between relative line
3249 number (i.e. ignoring NUM-LINES) and the name of the code
3250 reference on it. If it is nil, FUN's third argument will always
3251 be nil. It can be obtained through the use of
3252 `org-export-unravel-code' function."
3264 "Return source code from ELEMENT, formatted in a standard way.
3266 ELEMENT is either a `src-block' or `example-block' element. INFO
3267 is a plist used as a communication channel.
3269 This function takes care of line numbering and code references
3270 inclusion. Line numbers, when applicable, appear at the
3271 beginning of the line, separated from the code by two white
3272 spaces. Code references, on the other hand, appear flushed to
3273 the right, separated by six white spaces from the widest line of
3274 code."
3275 ;; Extract code and references.
3281 ;; Handle line numbering.
3290 ;; Prepare references display, if required. Any reference
3291 ;; should start six columns after the widest line of code,
3292 ;; wrapped with parenthesis.
3297 code
3301 number-str
3302 loc
3308 num-start refs)))
3311 ;;;; For Tables
3312 ;;
3313 ;; `org-export-table-has-special-column-p' and and
3314 ;; `org-export-table-row-is-special-p' are predicates used to look for
3315 ;; meta-information about the table structure.
3316 ;;
3317 ;; `org-table-has-header-p' tells when the rows before the first rule
3318 ;; should be considered as table's header.
3319 ;;
3320 ;; `org-export-table-cell-width', `org-export-table-cell-alignment'
3321 ;; and `org-export-table-cell-borders' extract information from
3322 ;; a table-cell element.
3323 ;;
3324 ;; `org-export-table-dimensions' gives the number on rows and columns
3325 ;; in the table, ignoring horizontal rules and special columns.
3326 ;; `org-export-table-cell-address', given a table-cell object, returns
3327 ;; the absolute address of a cell. On the other hand,
3328 ;; `org-export-get-table-cell-at' does the contrary.
3329 ;;
3330 ;; `org-export-table-cell-starts-colgroup-p',
3331 ;; `org-export-table-cell-ends-colgroup-p',
3332 ;; `org-export-table-row-starts-rowgroup-p',
3333 ;; `org-export-table-row-ends-rowgroup-p',
3334 ;; `org-export-table-row-starts-header-p' and
3335 ;; `org-export-table-row-ends-header-p' indicate position of current
3336 ;; row or cell within the table.
3339 "Non-nil when TABLE has a special column.
3340 All special columns will be ignored during export."
3341 ;; The table has a special column when every first cell of every row
3342 ;; has an empty value or contains a symbol among "/", "#", "!", "$",
3343 ;; "*" "_" and "^". Though, do not consider a first row containing
3344 ;; only empty cells as special.
3360 "Non-nil when TABLE has an header.
3362 INFO is a plist used as a communication channel.
3364 A table has an header when it contains at least two row groups."
3367 table 'table-row
3375 info)))
3378 "Non-nil if TABLE-ROW is considered special.
3380 INFO is a plist used as the communication channel.
3382 All special rows will be ignored during export."
3386 ;; A row is special either when...
3388 ;; ... it starts with a field only containing "/",
3390 ;; ... the table contains a special column and the row start
3391 ;; with a marking character among, "^", "_", "$" or "!",
3395 ;; ... it contains only alignment cookies and empty cells.
3401 ;; Since VALUE is a secondary string, the following
3402 ;; checks avoid expanding it with `org-export-data'.
3414 "Return TABLE-ROW's group.
3416 INFO is a plist used as the communication channel.
3418 Return value is the group number, as an integer, or nil special
3419 rows and table rules. Group 1 is also table's header."
3436 "Return TABLE-CELL contents width.
3438 INFO is a plist used as the communication channel.
3440 Return value is the width given by the last width cookie in the
3441 same column as TABLE-CELL, or nil."
3447 cookie-width)
3451 ;; In a special row, try to find a width cookie at COLUMN.
3455 ;; The following checks avoid expanding unnecessarily the
3456 ;; cell with `org-export-data'
3464 ;; Ignore table rules.
3467 ;; Return value.
3468 cookie-width))
3471 "Return TABLE-CELL contents alignment.
3473 INFO is a plist used as the communication channel.
3475 Return alignment as specified by the last alignment cookie in the
3476 same column as TABLE-CELL. If no such cookie is found, a default
3477 alignment value will be deduced from fraction of numbers in the
3478 column (see `org-table-number-fraction' for more information).
3479 Possible values are `left', `right' and `center'."
3487 cookie-align)
3491 ;; In a special row, try to find an alignment cookie at
3492 ;; COLUMN.
3496 ;; Since VALUE is a secondary string, the following checks
3497 ;; avoid useless expansion through `org-export-data'.
3505 ;; Ignore table rules.
3507 ;; In a standard row, check if cell's contents are expressing
3508 ;; some kind of number. Increase NUMBER-CELLS accordingly.
3509 ;; Though, don't bother if an alignment cookie has already
3510 ;; defined cell's alignment.
3515 info)))
3520 ;; Return value. Alignment specified by cookies has precedence
3521 ;; over alignment deduced from cells contents.
3530 "Return TABLE-CELL borders.
3532 INFO is a plist used as a communication channel.
3534 Return value is a list of symbols, or nil. Possible values are:
3535 `top', `bottom', `above', `below', `left' and `right'. Note:
3536 `top' (resp. `bottom') only happen for a cell in the first
3537 row (resp. last row) of the table, ignoring table rules, if any.
3539 Returned borders ignore special rows."
3543 borders)
3544 ;; Top/above border? TABLE-CELL has a border above when a rule
3545 ;; used to demarcate row groups can be found above. Hence,
3546 ;; finding a rule isn't sufficient to push `above' in BORDERS:
3547 ;; another regular row has to be found above that rule.
3556 ;; Look at every row before the current one.
3558 ;; No rule above, or rule found starts the table (ignoring any
3559 ;; special row): TABLE-CELL is at the top of the table.
3562 ;; Bottom/below border? TABLE-CELL has a border below when next
3563 ;; non-regular row below is a rule.
3572 ;; Look at every row after the current one.
3574 ;; No rule below, or rule found ends the table (modulo some
3575 ;; special row): TABLE-CELL is at the bottom of the table.
3578 ;; Right/left borders? They can only be specified by column
3579 ;; groups. Column groups are defined in a row starting with "/".
3580 ;; Also a column groups row only contains "<", "<>", ">" or blank
3581 ;; cells.
3598 ;; There's a left border when previous cell, if
3599 ;; any, ends a group, or current one starts one.
3605 ;; There's a right border when next cell, if any,
3606 ;; starts a group, or current one ends one.
3613 ;; Table rows are read in reverse order so last column groups
3614 ;; row has precedence over any previous one.
3616 ;; Return value.
3617 borders))
3620 "Non-nil when TABLE-CELL is at the beginning of a row group.
3621 INFO is a plist used as a communication channel."
3622 ;; A cell starts a column group either when it is at the beginning
3623 ;; of a row (or after the special column, if any) or when it has
3624 ;; a left border.
3628 table-cell)
3632 "Non-nil when TABLE-CELL is at the end of a row group.
3633 INFO is a plist used as a communication channel."
3634 ;; A cell ends a column group either when it is at the end of a row
3635 ;; or when it has a right border.
3638 table-cell)
3642 "Non-nil when TABLE-ROW is at the beginning of a column group.
3643 INFO is a plist used as a communication channel."
3651 "Non-nil when TABLE-ROW is at the end of a column group.
3652 INFO is a plist used as a communication channel."
3660 "Non-nil when TABLE-ROW is the first table header's row.
3661 INFO is a plist used as a communication channel."
3668 "Non-nil when TABLE-ROW is the last table header's row.
3669 INFO is a plist used as a communication channel."
3676 "Return TABLE dimensions.
3678 INFO is a plist used as a communication channel.
3680 Return value is a CONS like (ROWS . COLUMNS) where
3681 ROWS (resp. COLUMNS) is the number of exportable
3682 rows (resp. columns)."
3684 ;; Set number of rows, and extract first one.
3686 table 'table-row
3691 ;; Set number of columns.
3693 ;; Return value.
3697 "Return address of a regular TABLE-CELL object.
3699 TABLE-CELL is the cell considered. INFO is a plist used as
3700 a communication channel.
3702 Address is a CONS cell (ROW . COLUMN), where ROW and COLUMN are
3703 zero-based index. Only exportable cells are considered. The
3704 function returns nil for other cells."
3707 ;; Ignore cells in special rows or in special column.
3712 ;; Row number.
3715 table 'table-row
3721 ;; Column number.
3724 table-row 'table-cell
3731 "Return regular table-cell object at ADDRESS in TABLE.
3733 Address is a CONS cell (ROW . COLUMN), where ROW and COLUMN are
3734 zero-based index. TABLE is a table type element. INFO is
3735 a plist used as a communication channel.
3737 If no table-cell, among exportable cells, is found at ADDRESS,
3738 return nil."
3741 ;; Row at (car address) or nil.
3744 table 'table-row
3750 'table-cell
3757 ;;;; For Tables Of Contents
3758 ;;
3759 ;; `org-export-collect-headlines' builds a list of all exportable
3760 ;; headline elements, maybe limited to a certain depth. One can then
3761 ;; easily parse it and transcode it.
3762 ;;
3763 ;; Building lists of tables, figures or listings is quite similar.
3764 ;; Once the generic function `org-export-collect-elements' is defined,
3765 ;; `org-export-collect-tables', `org-export-collect-figures' and
3766 ;; `org-export-collect-listings' can be derived from it.
3769 "Collect headlines in order to build a table of contents.
3771 INFO is a plist used as a communication channel.
3773 When non-nil, optional argument N must be an integer. It
3774 specifies the depth of the table of contents.
3776 Return a list of all exportable headlines as parsed elements."
3779 'headline
3781 ;; Strip contents from HEADLINE.
3784 info))
3787 "Collect referenceable elements of a determined type.
3789 TYPE can be a symbol or a list of symbols specifying element
3790 types to search. Only elements with a caption are collected.
3792 INFO is a plist used as a communication channel.
3794 When non-nil, optional argument PREDICATE is a function accepting
3795 one argument, an element of type TYPE. It returns a non-nil
3796 value when that element should be collected.
3798 Return a list of all elements found, in order of appearance."
3804 element))
3805 info))
3808 "Build a list of tables.
3809 INFO is a plist used as a communication channel.
3811 Return a list of table elements with a caption."
3815 "Build a list of figures.
3817 INFO is a plist used as a communication channel. PREDICATE is
3818 a function which accepts one argument: a paragraph element and
3819 whose return value is non-nil when that element should be
3820 collected.
3822 A figure is a paragraph type element, with a caption, verifying
3824 a vague concept that may depend on back-end.
3826 Return a list of elements recognized as figures."
3830 "Build a list of src blocks.
3832 INFO is a plist used as a communication channel.
3834 Return a list of src-block elements with a caption."
3838 ;;;; Topology
3839 ;;
3840 ;; Here are various functions to retrieve information about the
3841 ;; neighbourhood of a given element or object. Neighbours of interest
3842 ;; are direct parent (`org-export-get-parent'), parent headline
3843 ;; (`org-export-get-parent-headline'), parent paragraph
3844 ;; (`org-export-get-parent-paragraph'), previous element or object
3845 ;; (`org-export-get-previous-element') and next element or object
3846 ;; (`org-export-get-next-element').
3847 ;;
3848 ;; All of these functions are just a specific use of the more generic
3849 ;; `org-export-get-genealogy', which returns the genealogy relative to
3850 ;; the element or object.
3853 "Return genealogy relative to a given element or object.
3854 BLOB is the element or object being considered. INFO is a plist
3855 used as a communication channel."
3860 ;; Walk DATA, looking for BLOB. GENEALOGY is the list of
3861 ;; parents of all elements in DATA.
3868 ;; If BLOB is an object and EL contains a secondary
3869 ;; string, be sure to check it.
3873 org-element-secondary-value-alist))))
3876 walk-data
3885 "Return BLOB parent or nil.
3886 BLOB is the element or object considered. INFO is a plist used
3887 as a communication channel."
3891 "Return BLOB parent headline or nil.
3892 BLOB is the element or object being considered. INFO is a plist
3893 used as a communication channel."
3898 nil))
3901 "Return OBJECT parent paragraph or nil.
3902 OBJECT is the object to consider. INFO is a plist used as
3903 a communication channel."
3908 nil))
3911 "Return OBJECT parent table or nil.
3912 OBJECT is either a `table-cell' or `table-element' type object.
3913 INFO is a plist used as a communication channel."
3918 nil))
3921 "Return previous element or object.
3923 BLOB is an element or object. INFO is a plist used as
3924 a communication channel.
3926 Return previous element or object, a string, or nil."
3931 "Return next element or object.
3933 BLOB is an element or object. INFO is a plist used as
3934 a communication channel.
3936 Return next element or object, a string, or nil."
3941 \f
3942 ;;; The Dispatcher
3943 ;;
3944 ;; `org-export-dispatch' is the standard interactive way to start an
3945 ;; export process. It uses `org-export-dispatch-ui' as a subroutine
3946 ;; for its interface. Most commons back-ends should have an entry in
3947 ;; it.
3950 "Export dispatcher for Org mode.
3952 It provides an access to common export related tasks in a buffer.
3953 Its interface comes in two flavours: standard and expert. While
3954 both share the same set of bindings, only the former displays the
3955 valid keys associations. Set `org-export-dispatch-use-expert-ui'
3956 to switch to one or the other.
3958 Return an error if key pressed has no associated command."
3963 org-export-dispatch-use-expert-ui))
3966 ;; Translate "C-a", "C-b"... into "a", "b"... Then take action
3967 ;; depending on user's key pressed.
3969 ;; Allow to quit with "q" key.
3971 ;; Export with `e-ascii' back-end.
3978 `(:ascii-charset
3988 ;; Export with `e-latex' back-end.
3989 (?L
3998 (?l
4003 (?p
4007 (?d
4012 ;; Export with `e-html' back-end.
4013 (?H
4019 ;; set major mode
4024 (?h
4028 (?b
4033 ;; Export with `e-odt' back-end.
4034 (?o
4038 (?O
4043 ;; Publishing facilities
4044 (?F
4047 (?P
4050 (?X
4055 org-e-publish-project-alist)))
4057 (?E
4060 ;; Undefined command.
4065 "Handle interface for `org-export-dispatch'.
4067 OPTIONS is a list containing current interactive options set for
4068 export. It can contain any of the following symbols:
4069 `body' toggles a body-only export
4070 `subtree' restricts export to current subtree
4071 `visible' restricts export to visible part of buffer.
4072 `force' force publishing files.
4074 EXPERTP, when non-nil, triggers expert UI. In that case, no help
4075 buffer is provided, but indications about currently active
4076 options are given in the prompt. Moreover, \[?] allows to switch
4077 back to standard interface.
4079 Return value is a list with key pressed as CAR and a list of
4080 final interactive export options as CDR."
4084 \[1] Body only: %s [2] Export scope: %s
4085 \[3] Visible only: %s [4] Force publishing: %s
4088 --- (ASCII/Latin-1/UTF-8 Export) -------------------------
4090 \[a/n/u] to TXT file [A/N/U] to temporary buffer
4092 --- (HTML Export) ----------------------------------------
4094 \[h] to HTML file [b] ... and open it
4095 \[H] to temporary buffer
4097 --- (LaTeX Export) ---------------------------------------
4099 \[l] to TEX file [L] to temporary buffer
4100 \[p] to PDF file [d] ... and open it
4102 --- (ODF Export) -----------------------------------------
4104 \[o] to ODT file [O] ... and open it
4106 --- (Publish) --------------------------------------------
4108 \[F] current file [P] current project
4109 \[X] a project [E] every project"
4122 ;; Read a character from command input, toggling interactive
4123 ;; options when applicable. PROMPT is the displayed prompt,
4124 ;; as a string.
4128 ;; Ignore non-standard characters (i.e. "M-a").
4130 ;; Help key: Switch back to standard interface if
4131 ;; expert UI was active.
4133 ;; Toggle export options.
4140 expertp))
4141 ;; Action selected: Send key and options back to
4142 ;; `org-export-dispatch'.
4144 ;; With expert UI, just read key with a fancy prompt. In standard
4145 ;; UI, display an intrusive help buffer.
4156 ;;; org-export.el ends here