| blob | 4d4adc029d6c64ba81091b51c153c9184e591f2c |
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 derive an exporter out of this generic implementation,
50 ;; one can define a transcode function for each element or object.
51 ;; Such function should return a string for the corresponding element,
52 ;; without any trailing space, or nil. It must accept three
53 ;; arguments:
54 ;; 1. the element or object itself,
55 ;; 2. its contents, or nil when it isn't recursive,
56 ;; 3. the property list used as a communication channel.
57 ;;
58 ;; If no such function is found, that element or object type will
59 ;; simply be ignored, along with any separating blank line. The same
60 ;; will happen if the function returns the nil value. If that
61 ;; function returns the empty string, the type will be ignored, but
62 ;; the blank lines will be kept.
63 ;;
64 ;; Contents, when not nil, are stripped from any global indentation
65 ;; (although the relative one is preserved). They also always end
66 ;; with a single newline character.
67 ;;
68 ;; These functions must follow a strict naming convention:
69 ;; `org-BACKEND-TYPE' where, obviously, BACKEND is the name of the
70 ;; export back-end and TYPE the type of the element or object handled.
71 ;;
72 ;; Moreover, two additional functions can be defined. On the one
73 ;; hand, `org-BACKEND-template' returns the final transcoded string,
74 ;; and can be used to add a preamble and a postamble to document's
75 ;; body. It must accept two arguments: the transcoded string and the
76 ;; property list containing export options. On the other hand,
77 ;; `org-BACKEND-plain-text', when defined, is to be called on every
78 ;; text not recognized as an element or an object. It must accept two
79 ;; arguments: the text string and the information channel.
80 ;;
81 ;; Any back-end can define its own variables. Among them, those
82 ;; customizables should belong to the `org-export-BACKEND' group.
83 ;; Also, a special variable, `org-BACKEND-option-alist', allows to
84 ;; define buffer keywords and "#+options:" items specific to that
85 ;; back-end. See `org-export-option-alist' for supported defaults and
86 ;; syntax.
87 ;;
88 ;; Tools for common tasks across back-ends are implemented in the
89 ;; penultimate part of this file. A dispatcher for standard back-ends
90 ;; is provided in the last one.
92 ;;; Code:
95 ;; Require major back-ends and publishing tools
103 \f
104 ;;; Internal Variables
105 ;;
106 ;; Among internal variables, the most important is
107 ;; `org-export-option-alist'. This variable define the global export
108 ;; options, shared between every exporter, and how they are acquired.
148 "Alist between export properties and ways to set them.
150 The CAR of the alist is the property name, and the CDR is a list
151 like (KEYWORD OPTION DEFAULT BEHAVIOUR) where:
153 KEYWORD is a string representing a buffer keyword, or nil.
154 OPTION is a string that could be found in an #+OPTIONS: line.
155 DEFAULT is the default value for the property.
156 BEHAVIOUR determine how Org should handle multiple keywords for
157 the same property. It is a symbol among:
158 nil Keep old value and discard the new one.
159 t Replace old value with the new one.
160 `space' Concatenate the values, separating them with a space.
161 `newline' Concatenate the values, separating them with
162 a newline.
163 `split' Split values at white spaces, and cons them to the
164 previous list.
166 KEYWORD and OPTION have precedence over DEFAULT.
168 All these properties should be back-end agnostic. For back-end
169 specific properties, define a similar variable named
170 `org-BACKEND-option-alist', replacing BACKEND with the name of
171 the appropriate back-end. You can also redefine properties
176 "List of in-buffer keywords that require special treatment.
177 These keywords are not directly associated to a property. The
178 way they are handled must be hard-coded into
236 "Alist between filters properties and initial values.
238 The key of each association is a property name accessible through
239 the communication channel its value is a configurable global
240 variable defining initial filters.
242 This list is meant to install user specified filters. Back-end
243 developers may install their own filters using
244 `org-BACKEND-filters-alist', where BACKEND is the name of the
245 considered back-end. Filters defined there will always be
246 prepended to the current list, so they always get applied
255 "Default rule for link matching an inline image.
256 This rule applies to links with no description. By default, it
257 will be considered as an inline image if it targets a local file
260 See `org-export-inline-image-p' for more information about
264 \f
265 ;;; User-configurable Variables
266 ;;
267 ;; Configuration for the masses.
268 ;;
269 ;; They should never be accessed directly, as their value is to be
270 ;; stored in a property list (cf. `org-export-option-alist').
271 ;; Back-ends will read their value from there instead.
274 "Options for exporting Org mode files."
279 "General options for export engine."
284 "Whether sub-trees with the ARCHIVE tag should be exported.
286 This can have three different values:
287 nil Do not export, pretend this tree is not present.
288 t Do export the entire tree.
289 `headline' Only export the headline, but skip the tree below it.
291 This option can also be set with the #+OPTIONS line,
300 "Non-nil means insert author name into the exported file.
301 This option can also be set with the #+OPTIONS line,
307 "Non-nil means export CLOCK keywords.
308 This option can also be set with the #+OPTIONS line,
314 "Non-nil means the postamble should contain a creator sentence.
316 The sentence can be set in `org-export-creator-string' and
319 If the value is `comment' insert it as a comment."
329 emacs-version)
330 "String to insert at the end of the generated document."
335 "Non-nil means export contents of standard drawers.
337 When t, all drawers are exported. This may also be a list of
338 drawer names to export. This variable doesn't apply to
339 properties drawers.
341 This option can also be set with the #+OPTIONS line,
351 "Non-nil means insert author email into the exported file.
352 This option can also be set with the #+OPTIONS line,
358 "Non-nil means interpret *word*, /word/, and _word_ as emphasized text.
360 If the export target supports emphasizing text, the word will be
361 typeset in bold, italic, or underlined, respectively. Not all
362 export backends support this.
369 "Tags that exclude a tree from export.
371 All trees carrying any of these tags will be excluded from
372 export. This is without condition, so even subtrees inside that
373 carry one of the `org-export-select-tags' will be removed.
375 This option can also be set with the #+EXPORT_EXCLUDE_TAGS:
376 keyword."
383 This can be used to have pre-formatted text, fragments of code
384 etc. For example:
385 : ;; Some Lisp examples
386 : (while (defc cnt)
387 : (ding))
388 will be looking just like this in also HTML. See also the QUOTE
389 keyword. Not all export backends support this.
396 "Non-nil means Org footnotes should be exported.
397 This option can also be set with the #+OPTIONS line,
403 "The last level which is still exported as a headline.
405 Inferior levels will produce itemize lists when exported. Note
406 that a numeric prefix argument to an exporter function overrides
407 this setting.
414 "The default language for export and clocktable translations, as a string.
415 This may have an association in
416 `org-clock-clocktable-language-setup'."
421 "Non-nil means preserve all line breaks when exporting.
423 Normally, in HTML output paragraphs will be reformatted.
425 This option can also be set with the #+OPTIONS line,
431 "Non-nil means interpret entities when exporting.
434 Å.
436 For a list of supported names, see the constant `org-entities'
437 and the user option `org-entities-user'.
439 This option can also be set with the #+OPTIONS line,
445 "Non-nil means include planning info in export.
446 This option can also be set with the #+OPTIONS: line,
452 "Non-nil means include priority cookies in export.
454 When nil, remove priority cookies for export.
456 This option can also be set with the #+OPTIONS line,
462 "Non-nil means add section numbers to headlines when exporting.
464 When set to an integer n, numbering will only happen for
465 headlines whose relative level is higher or equal to n.
467 This option can also be set with the #+OPTIONS line,
473 "Tags that select a tree for export.
475 If any such tag is found in a buffer, all trees that do not carry
476 one of these tags will be ignored during export. Inside trees
477 that are selected like this, you can still deselect a subtree by
478 tagging it with one of the `org-export-exclude-tags'.
480 This option can also be set with the #+EXPORT_SELECT_TAGS:
481 keyword."
488 When this option is turned on, these strings will be exported as:
490 Org HTML LaTeX
491 -----+----------+--------
493 -- – --
494 --- — ---
495 ... … \ldots
497 This option can also be set with the #+OPTIONS line,
505 When this option is turned on, you can use TeX-like syntax for
507 will be considered as a single item - so grouping with {} is
508 normally not needed. For example, the following things will be
509 parsed as single sub- or superscripts.
511 10^24 or 10^tau several digits will be considered 1 item.
512 10^-12 or 10^-tau a leading sign with digits or a word
513 x^2-y^3 will be read as x^2 - y^3, because items are
514 terminated by almost any nonword/nondigit char.
515 x_{i^2} or x^(2-i) braces or parenthesis do grouping.
517 Still, ambiguity is possible - so when in doubt use {} to enclose
518 the sub/superscript. If you set this variable to the symbol
519 `{}', the braces are *required* in order to trigger
520 interpretations as sub/superscript. This can be helpful in
523 This option can also be set with the #+OPTIONS line,
532 "Non-nil means create a table of contents in exported files.
534 The TOC contains headlines with levels up
535 to`org-export-headline-levels'. When an integer, include levels
536 up to N in the toc, this may then be different from
537 `org-export-headline-levels', but it will not be allowed to be
538 larger than the number of headline levels. When nil, no table of
539 contents is made.
541 This option can also be set with the #+OPTIONS line,
551 For example:
553 | Name | Address | Birthday |
554 |-------------+----------+-----------|
555 | Arthur Dent | England | 29.2.2100 |
562 "If nil, do not export tags, just remove them from headlines.
564 If this is the symbol `not-in-toc', tags will be removed from
565 table of contents entries, but still be shown in the headlines of
566 the document.
568 This option can also be set with the #+OPTIONS line,
577 "Non-nil means include TODO items for export.
578 This may have the following values:
579 t include tasks independent of state.
580 todo include only tasks that are not yet done.
581 done include only tasks that are already done.
582 nil remove all tasks before export
583 list of keywords keep only tasks with these keywords"
594 "Non-nil means insert a time stamp into the exported file.
595 The time stamp shows when the file was created.
597 This option can also be set with the #+OPTIONS line,
603 "Non nil means allow timestamps in export.
605 It can be set to `active', `inactive', t or nil, in order to
606 export, respectively, only active timestamps, only inactive ones,
607 all of them or none.
609 This option can also be set with the #+OPTIONS line, e.g.
619 "Non-nil means include TODO keywords in export.
620 When nil, remove all these keywords from the export."
625 "Non-nil means allow #+BIND to define local variable values for export.
626 This is a potential security risk, which is why the user must
627 confirm the use of these lines."
635 "Alist between export snippets back-ends and exporter back-ends.
637 This variable allows to provide shortcuts for export snippets.
641 while every other back-end will ignore it."
649 "Coding system for the exported file."
654 "Non-nil means exported stuff will also be pushed onto the kill ring."
659 "The initial scope when exporting with `org-export-dispatch'.
660 This variable can be either set to `buffer' or `subtree'."
667 "Non-nil means show buffer after exporting to temp buffer.
668 When Org exports to a file, the buffer visiting that file is ever
669 shown, but remains buried. However, when exporting to
670 a temporary buffer, that buffer is popped up in a second window.
671 When this variable is nil, the buffer remains buried also in
672 these cases."
677 "Non-nil means using a non-intrusive `org-export-dispatch'.
678 In that case, no help buffer is displayed. Though, an indicator
682 considered for export\). Also, \[?] allows to switch back to
683 standard mode."
688 \f
689 ;;; The Communication Channel
690 ;;
691 ;; During export process, every function has access to a number of
692 ;; properties. They are of three types:
693 ;;
694 ;; 1. Environment options are collected once at the very beginning of
695 ;; the process, out of the original buffer and configuration.
696 ;; Collecting them is handled by `org-export-get-environment'
697 ;; function.
698 ;;
699 ;; Most environment options are defined through the
700 ;; `org-export-option-alist' variable.
701 ;;
702 ;; 2. Tree properties are extracted directly from the parsed tree,
703 ;; just before export, by `org-export-collect-tree-properties'.
704 ;;
705 ;; 3. Local options are updated during parsing, and their value
706 ;; depends on the level of recursion. For now, only `:ignore-list'
707 ;; belongs to that category.
708 ;;
709 ;; Here is the full list of properties available during transcode
710 ;; process, with their category (option, tree or local) and their
711 ;; value type.
712 ;;
713 ;; + `:author' :: Author's name.
714 ;; - category :: option
715 ;; - type :: string
716 ;;
717 ;; + `:back-end' :: Current back-end used for transcoding.
718 ;; - category :: tree
719 ;; - type :: symbol
720 ;;
721 ;; + `:creator' :: String to write as creation information.
722 ;; - category :: option
723 ;; - type :: string
724 ;;
725 ;; + `:date' :: String to use as date.
726 ;; - category :: option
727 ;; - type :: string
728 ;;
729 ;; + `:description' :: Description text for the current data.
730 ;; - category :: option
731 ;; - type :: string
732 ;;
733 ;; + `:email' :: Author's email.
734 ;; - category :: option
735 ;; - type :: string
736 ;;
737 ;; + `:exclude-tags' :: Tags for exclusion of subtrees from export
738 ;; process.
739 ;; - category :: option
740 ;; - type :: list of strings
741 ;;
742 ;; + `:footnote-definition-alist' :: Alist between footnote labels and
743 ;; their definition, as parsed data. Only non-inlined footnotes
744 ;; are represented in this alist. Also, every definition isn't
745 ;; guaranteed to be referenced in the parse tree. The purpose of
746 ;; this property is to preserve definitions from oblivion
747 ;; (i.e. when the parse tree comes from a part of the original
748 ;; buffer), it isn't meant for direct use in a back-end. To
749 ;; retrieve a definition relative to a reference, use
750 ;; `org-export-get-footnote-definition' instead.
751 ;; - category :: option
752 ;; - type :: alist (STRING . LIST)
753 ;;
754 ;; + `:headline-levels' :: Maximum level being exported as an
755 ;; headline. Comparison is done with the relative level of
756 ;; headlines in the parse tree, not necessarily with their
757 ;; actual level.
758 ;; - category :: option
759 ;; - type :: integer
760 ;;
761 ;; + `:headline-offset' :: Difference between relative and real level
762 ;; of headlines in the parse tree. For example, a value of -1
763 ;; means a level 2 headline should be considered as level
764 ;; 1 (cf. `org-export-get-relative-level').
765 ;; - category :: tree
766 ;; - type :: integer
767 ;;
768 ;; + `:headline-numbering' :: Alist between headlines and their
769 ;; numbering, as a list of numbers
770 ;; (cf. `org-export-get-headline-number').
771 ;; - category :: tree
772 ;; - type :: alist (INTEGER . LIST)
773 ;;
774 ;; + `:ignore-list' :: List of elements and objects that should be
775 ;; ignored during export.
776 ;; - category :: local
777 ;; - type :: list of elements and objects
778 ;;
779 ;; + `:input-file' :: Full path to input file, if any.
780 ;; - category :: option
781 ;; - type :: string or nil
782 ;;
783 ;; + `:keywords' :: List of keywords attached to data.
784 ;; - category :: option
785 ;; - type :: string
786 ;;
787 ;; + `:language' :: Default language used for translations.
788 ;; - category :: option
789 ;; - type :: string
790 ;;
791 ;; + `:parse-tree' :: Whole parse tree, available at any time during
792 ;; transcoding.
793 ;; - category :: global
794 ;; - type :: list (as returned by `org-element-parse-buffer')
795 ;;
796 ;; + `:preserve-breaks' :: Non-nil means transcoding should preserve
797 ;; all line breaks.
798 ;; - category :: option
799 ;; - type :: symbol (nil, t)
800 ;;
801 ;; + `:section-numbers' :: Non-nil means transcoding should add
802 ;; section numbers to headlines.
803 ;; - category :: option
804 ;; - type :: symbol (nil, t)
805 ;;
806 ;; + `:select-tags' :: List of tags enforcing inclusion of sub-trees
807 ;; in transcoding. When such a tag is present, subtrees without
808 ;; it are de facto excluded from the process. See
809 ;; `use-select-tags'.
810 ;; - category :: option
811 ;; - type :: list of strings
812 ;;
813 ;; + `:target-list' :: List of targets encountered in the parse tree.
814 ;; This is used to partly resolve "fuzzy" links
815 ;; (cf. `org-export-resolve-fuzzy-link').
816 ;; - category :: tree
817 ;; - type :: list of strings
818 ;;
819 ;; + `:time-stamp-file' :: Non-nil means transcoding should insert
820 ;; a time stamp in the output.
821 ;; - category :: option
822 ;; - type :: symbol (nil, t)
823 ;;
824 ;; + `:with-archived-trees' :: Non-nil when archived subtrees should
825 ;; also be transcoded. If it is set to the `headline' symbol,
826 ;; only the archived headline's name is retained.
827 ;; - category :: option
828 ;; - type :: symbol (nil, t, `headline')
829 ;;
830 ;; + `:with-author' :: Non-nil means author's name should be included
831 ;; in the output.
832 ;; - category :: option
833 ;; - type :: symbol (nil, t)
834 ;;
835 ;; + `:with-clocks' :: Non-nild means clock keywords should be exported.
836 ;; - category :: option
837 ;; - type :: symbol (nil, t)
838 ;;
839 ;; + `:with-creator' :: Non-nild means a creation sentence should be
840 ;; inserted at the end of the transcoded string. If the value
841 ;; is `comment', it should be commented.
842 ;; - category :: option
843 ;; - type :: symbol (`comment', nil, t)
844 ;;
845 ;; + `:with-drawers' :: Non-nil means drawers should be exported. If
846 ;; its value is a list of names, only drawers with such names
847 ;; will be transcoded.
848 ;; - category :: option
849 ;; - type :: symbol (nil, t) or list of strings
850 ;;
851 ;; + `:with-email' :: Non-nil means output should contain author's
852 ;; email.
853 ;; - category :: option
854 ;; - type :: symbol (nil, t)
855 ;;
856 ;; + `:with-emphasize' :: Non-nil means emphasized text should be
857 ;; interpreted.
858 ;; - category :: option
859 ;; - type :: symbol (nil, t)
860 ;;
861 ;; + `:with-fixed-width' :: Non-nil if transcoder should interpret
862 ;; strings starting with a colon as a fixed-with (verbatim) area.
863 ;; - category :: option
864 ;; - type :: symbol (nil, t)
865 ;;
866 ;; + `:with-footnotes' :: Non-nil if transcoder should interpret
867 ;; footnotes.
868 ;; - category :: option
869 ;; - type :: symbol (nil, t)
870 ;;
871 ;; + `:with-plannings' :: Non-nil means transcoding should include
872 ;; planning info.
873 ;; - category :: option
874 ;; - type :: symbol (nil, t)
875 ;;
876 ;; + `:with-priority' :: Non-nil means transcoding should include
877 ;; priority cookies.
878 ;; - category :: option
879 ;; - type :: symbol (nil, t)
880 ;;
881 ;; + `:with-special-strings' :: Non-nil means transcoding should
882 ;; interpret special strings in plain text.
883 ;; - category :: option
884 ;; - type :: symbol (nil, t)
885 ;;
886 ;; + `:with-sub-superscript' :: Non-nil means transcoding should
887 ;; interpret subscript and superscript. With a value of "{}",
888 ;; only interpret those using curly brackets.
889 ;; - category :: option
890 ;; - type :: symbol (nil, {}, t)
891 ;;
892 ;; + `:with-tables' :: Non-nil means transcoding should interpret
893 ;; tables.
894 ;; - category :: option
895 ;; - type :: symbol (nil, t)
896 ;;
897 ;; + `:with-tags' :: Non-nil means transcoding should keep tags in
898 ;; headlines. A `not-in-toc' value will remove them from the
899 ;; table of contents, if any, nonetheless.
900 ;; - category :: option
901 ;; - type :: symbol (nil, t, `not-in-toc')
902 ;;
903 ;; + `:with-tasks' :: Non-nil means transcoding should include
904 ;; headlines with a TODO keyword. A `todo' value will only
905 ;; include headlines with a todo type keyword while a `done'
906 ;; value will do the contrary. If a list of strings is provided,
907 ;; only tasks with keywords belonging to that list will be kept.
908 ;; - category :: option
909 ;; - type :: symbol (t, todo, done, nil) or list of strings
910 ;;
911 ;; + `:with-timestamps' :: Non-nil means transcoding should include
912 ;; time stamps. Special value `active' (resp. `inactive') ask to
913 ;; export only active (resp. inactive) timestamps. Otherwise,
914 ;; completely remove them.
915 ;; - category :: option
916 ;; - type :: symbol: (`active', `inactive', t, nil)
917 ;;
918 ;; + `:with-toc' :: Non-nil means that a table of contents has to be
919 ;; added to the output. An integer value limits its depth.
920 ;; - category :: option
921 ;; - type :: symbol (nil, t or integer)
922 ;;
923 ;; + `:with-todo-keywords' :: Non-nil means transcoding should
924 ;; include TODO keywords.
925 ;; - category :: option
926 ;; - type :: symbol (nil, t)
929 ;;;; Environment Options
930 ;;
931 ;; Environment options encompass all parameters defined outside the
932 ;; scope of the parsed data. They come from five sources, in
933 ;; increasing precedence order:
934 ;;
935 ;; - Global variables,
936 ;; - Buffer's attributes,
937 ;; - Options keyword symbols,
938 ;; - Buffer keywords,
939 ;; - Subtree properties.
940 ;;
941 ;; The central internal function with regards to environment options
942 ;; is `org-export-get-environment'. It updates global variables with
943 ;; "#+BIND:" keywords, then retrieve and prioritize properties from
944 ;; the different sources.
945 ;;
946 ;; The internal functions doing the retrieval are:
947 ;; `org-export-get-global-options',
948 ;; `org-export-get-buffer-attributes',
949 ;; `org-export-parse-option-keyword',
950 ;; `org-export-get-subtree-options' and
951 ;; `org-export-get-inbuffer-options'
952 ;;
953 ;; Also, `org-export-confirm-letbind' and `org-export-install-letbind'
954 ;; take care of the part relative to "#+BIND:" keywords.
957 "Collect export options from the current buffer.
959 Optional argument BACKEND is a symbol specifying which back-end
960 specific options to read, if any.
962 When optional argument SUBTREEP is non-nil, assume the export is
963 done against the current sub-tree.
965 Third optional argument EXT-PLIST is a property list with
966 external parameters overriding Org default settings, but still
967 inferior to file-local settings."
968 ;; First install #+BIND variables.
970 ;; Get and prioritize export options...
972 ;; ... from global variables...
974 ;; ... from buffer's attributes...
976 ;; ... from an external property list...
977 ext-plist
978 ;; ... from in-buffer settings...
980 backend
983 ;; ... and from subtree, when appropriate.
985 ;; Also install back-end symbol.
987 ;; Return plist.
988 options))
991 "Parse an OPTIONS line and return values as a plist.
992 Optional argument BACKEND is a symbol specifying which back-end
993 specific items to read, if any."
1000 ;; Build an alist between #+OPTION: item and property-name.
1005 all)))
1006 plist)
1011 options)
1016 alist)
1017 plist))
1020 "Get export options in subtree at point.
1022 Assume point is at subtree's beginning.
1024 Return options as a plist."
1032 plist :title
1034 prop
1044 plist))
1047 "Return current buffer export options, as a plist.
1049 Optional argument BACKEND, when non-nil, is a symbol specifying
1050 which back-end specific options should also be read in the
1051 process.
1053 Optional argument FILES is a list of setup files names read so
1054 far, used to avoid circular dependencies.
1056 Assume buffer is in Org mode. Narrowing, if any, is ignored."
1060 ;; 1. Special keywords, as in `org-export-special-keywords'.
1073 ;; Avoid circular dependencies.
1085 val)
1093 ;; Value will be evaled. Leave it as-is.
1096 ;; Value has to be parsed for nested
1097 ;; macros.
1100 key
1103 ;; If user explicitly asks for
1104 ;; a newline, be sure to preserve it
1105 ;; from further filling with
1106 ;; `hard-newline'. Also replace
1107 ;; "\\n" with "\n", "\\\n" with "\\n"
1108 ;; and so on...
1115 restr)))))))))))
1117 ;; 2. Standard options, as in `org-export-option-alist'.
1119 ;; Also look for back-end specific options
1120 ;; if BACKEND is defined.
1126 ;; Build alist between keyword name and property name.
1130 all)))
1131 ;; Build regexp matching all keywords associated to export
1132 ;; options. Note: the search is case insensitive.
1145 plist prop
1146 ;; Handle value depending on specified BEHAVIOUR.
1159 ;; Parse keywords specified in `org-element-parsed-keywords'.
1167 plist prop
1170 org-element-parsed-keywords))
1171 ;; 3. Return final value.
1172 plist)))
1175 "Return properties related to buffer attributes, as a plist."
1178 ;; Store full path of input file name, or nil. For internal use.
1179 :input-file visited-file
1184 :macro-modification-time
1190 ;; Store input file name as a macro.
1192 ;; `:macro-date', `:macro-time' and `:macro-property' could as
1193 ;; well be initialized as tree properties, since they don't
1194 ;; depend on buffer properties. Though, it may be more logical
1195 ;; to keep them close to other ":macro-" properties.
1201 "Return global export options as a plist.
1203 Optional argument BACKEND, if non-nil, is a symbol specifying
1204 which back-end specific export options should also be read in the
1205 process."
1211 ;; Output value.
1212 plist)
1215 all)
1216 ;; Return value.
1217 plist))
1220 "Collect and store footnote definitions from current buffer in INFO.
1222 INFO is a plist containing export options.
1224 Footnotes definitions are stored as a alist whose CAR is
1225 footnote's label, as a string, and CDR the contents, as a parse
1226 tree. This alist will be consed to the value of
1227 `:footnote-definition-alist' in INFO, if any.
1229 The new plist is returned; use
1231 \(setq info (org-export-store-footnote-definitions info))
1233 to be sure to use the new value. INFO is modified by side
1234 effects."
1235 ;; Footnotes definitions must be collected in the original buffer,
1236 ;; as there's no insurance that they will still be in the parse
1237 ;; tree, due to some narrowing.
1239 info :footnote-definition-alist
1250 ;; Like `org-element-parse-buffer', but
1251 ;; makes sure the definition doesn't start
1252 ;; with a section element.
1257 alist))))
1258 alist))))
1262 "Can we use #+BIND values during export?
1263 By default this will ask for confirmation by the user, to divert
1264 possible security risks."
1273 "Install the values from #+BIND lines as local variables.
1274 Variables must be installed before in-buffer options are
1275 retrieved."
1282 letbind))))
1287 ;;;; Tree Properties
1288 ;;
1289 ;; Tree properties are infromation extracted from parse tree. They
1290 ;; are initialized at the beginning of the transcoding process by
1291 ;; `org-export-collect-tree-properties'.
1292 ;;
1293 ;; Dedicated functions focus on computing the value of specific tree
1294 ;; properties during initialization. Thus,
1295 ;; `org-export-populate-ignore-list' lists elements and objects that
1296 ;; should be skipped during export, `org-export-get-min-level' gets
1297 ;; the minimal exportable level, used as a basis to compute relative
1298 ;; level for headlines. Eventually
1299 ;; `org-export-collect-headline-numbering' builds an alist between
1300 ;; headlines and their numbering.
1303 "Extract tree properties from parse tree.
1305 DATA is the parse tree from which information is retrieved. INFO
1306 is a list holding export options.
1308 Following tree properties are set or updated:
1309 `:footnote-definition-alist' List of footnotes definitions in
1310 original buffer and current parse tree.
1312 `:headline-offset' Offset between true level of headlines and
1313 local level. An offset of -1 means an headline
1314 of level 2 should be considered as a level
1315 1 headline in the context.
1317 `:headline-numbering' Alist of all headlines as key an the
1318 associated numbering as value.
1320 `:ignore-list' List of elements that should be ignored during
1321 export.
1323 `:target-list' List of all targets in the parse tree."
1324 ;; Install the parse tree in the communication channel, in order to
1325 ;; use `org-export-get-genealogy' and al.
1327 ;; Get the list of elements and objects to ignore, and put it into
1328 ;; `:ignore-list'. Do not overwrite any user ignore that might have
1329 ;; been done during parse tree filtering.
1332 :ignore-list
1335 ;; Compute `:headline-offset' in order to be able to use
1336 ;; `org-export-get-relative-level'.
1340 ;; Update footnotes definitions list with definitions in parse tree.
1341 ;; This is required since buffer expansion might have modified
1342 ;; boundaries of footnote definitions contained in the parse tree.
1343 ;; This way, definitions in `footnote-definition-alist' are bound to
1344 ;; match those in the parse tree.
1347 data 'footnote-definition
1351 defs)))
1353 ;; Properties order doesn't matter: get the rest of the tree
1354 ;; properties.
1356 `(:target-list
1364 info))
1367 "Return minimum exportable headline's level in DATA.
1368 DATA is parsed tree as returned by `org-element-parse-buffer'.
1369 OPTIONS is a plist holding export options."
1380 ;; If no headline was found, for the sake of consistency, set
1381 ;; minimum level to 1 nonetheless.
1385 "Return numbering of all exportable headlines in a parse tree.
1387 DATA is the parse tree. OPTIONS is the plist holding export
1388 options.
1390 Return an alist whose key is an headline and value is its
1391 associated numbering \(in the shape of a list of numbers\)."
1394 data
1395 'headline
1400 headline
1402 for idx from 0 to org-export-max-depth
1406 options)))
1409 "Return list of elements and objects to ignore during export.
1411 DATA is the parse tree to traverse. OPTIONS is the plist holding
1412 export options.
1414 Return elements or objects to ignore as a list."
1419 ;; Collect ignored elements or objects into IGNORE-LIST.
1427 ;; If headline is archived but tree below has
1428 ;; to be skipped, add it to ignore list.
1431 ;; Move into recursive objects/elements.
1435 ;; Main call. First find trees containing a select tag, if any.
1437 ;; Return value.
1438 ignore))
1441 "Return list of headlines containing a select tag in their tree.
1442 DATA is parsed data as returned by `org-element-parse-buffer'.
1443 INFO is a plist holding export options."
1455 ;; When a select tag is found, mark as acceptable
1456 ;; full genealogy and every headline within the
1457 ;; tree.
1462 selected-trees))
1463 ;; Else, continue searching in tree, recursively.
1468 "Non-nil when element or object BLOB should be skipped during export.
1469 OPTIONS is the plist holding export options. SELECT-TAGS, when
1470 non-nil, is a list of tags marking a subtree as exportable."
1472 ;; Check headline.
1480 ;; Ignore subtrees with an exclude tag.
1483 ;; Ignore subtrees without a select tag, when such tag is
1484 ;; found in the buffer.
1486 ;; Ignore commented sub-trees.
1488 ;; Ignore archived subtrees if `:with-archived-trees' is nil.
1490 ;; Ignore tasks, if specified by `:with-tasks' property.
1496 ;; Check timestamp.
1499 ;; No timestamp allowed.
1501 ;; Only active timestamps allowed and the current one isn't
1502 ;; active.
1506 ;; Only inactive timestamps allowed and the current one isn't
1507 ;; inactive.
1511 ;; Check drawer.
1517 ;; Check table-row.
1519 ;; Check table-cell.
1524 ;; Check clock.
1526 ;; Check planning.
1530 \f
1531 ;;; The Transcoder
1532 ;;
1533 ;; `org-export-data' reads a parse tree (obtained with, i.e.
1534 ;; `org-element-parse-buffer') and transcodes it into a specified
1535 ;; back-end output. It takes care of filtering out elements or
1536 ;; objects according to export options and organizing the output blank
1537 ;; lines and white space are preserved.
1538 ;;
1539 ;; Internally, three functions handle the filtering of objects and
1540 ;; elements during the export. In particular,
1541 ;; `org-export-ignore-element' marks an element or object so future
1542 ;; parse tree traversals skip it, `org-export-interpret-p' tells which
1543 ;; elements or objects should be seen as real Org syntax and
1544 ;; `org-export-expand' transforms the others back into their original
1545 ;; shape.
1548 "Return appropriate transcoder for BLOB.
1549 INFO is a plist containing export directives."
1551 ;; Return contents only for complete parse trees.
1558 "Convert DATA into current back-end format.
1560 DATA is a parse tree, an element or an object or a secondary
1561 string. INFO is a plist holding export options.
1563 Return transcoded string."
1567 ;; Ignored element/object.
1569 ;; Plain text.
1575 info))
1576 ;; Uninterpreted element/object: change it back to Org
1577 ;; syntax.
1580 data
1585 ;; Secondary string.
1588 ;; Element/Object without contents or, as a special case,
1589 ;; headline with archive tag and archived trees restricted
1590 ;; to title only.
1597 ;; Element/Object with contents.
1609 ;; Elements directly containing objects
1610 ;; must have their indentation normalized
1611 ;; first.
1613 data
1614 ;; When normalizing contents of the first
1615 ;; paragraph in an item or a footnote
1616 ;; definition, ignore first line's
1617 ;; indentation: there is none and it
1618 ;; might be misleading.
1622 data)
1628 contents)
1629 info))))))))
1633 ;; Append the same white space between elements or objects as in
1634 ;; the original buffer, and call appropriate filters.
1644 info)))
1645 ;; Eventually return string.
1646 results)))))
1649 "Non-nil if element or object BLOB should be interpreted as Org syntax.
1650 Check is done according to export options INFO, stored as
1651 a plist."
1653 ;; ... entities...
1655 ;; ... emphasis...
1657 ;; ... fixed-width areas.
1659 ;; ... footnotes...
1662 ;; ... sub/superscripts...
1668 ;; ... tables...
1673 "Expand a parsed element or object to its original state.
1674 BLOB is either an element or an object. CONTENTS is its
1675 contents, as a string or nil."
1678 blob contents))
1681 "Add ELEMENT to `:ignore-list' in INFO.
1683 Any element in `:ignore-list' will be skipped when using
1684 `org-element-map'. INFO is modified by side effects."
1688 \f
1689 ;;; The Filter System
1690 ;;
1691 ;; Filters allow end-users to tweak easily the transcoded output.
1692 ;; They are the functional counterpart of hooks, as every filter in
1693 ;; a set is applied to the return value of the previous one.
1694 ;;
1695 ;; Every set is back-end agnostic. Although, a filter is always
1696 ;; called, in addition to the string it applies to, with the back-end
1697 ;; used as argument, so it's easy enough for the end-user to add
1698 ;; back-end specific filters in the set. The communication channel,
1699 ;; as a plist, is required as the third argument.
1700 ;;
1701 ;; Filters sets are defined below. There are of four types:
1702 ;;
1703 ;; - `org-export-filter-parse-tree-functions' applies directly on the
1704 ;; complete parsed tree. It's the only filters set that doesn't
1705 ;; apply to a string.
1706 ;; - `org-export-filter-final-output-functions' applies to the final
1707 ;; transcoded string.
1708 ;; - `org-export-filter-plain-text-functions' applies to any string
1709 ;; not recognized as Org syntax.
1710 ;; - `org-export-filter-TYPE-functions' applies on the string returned
1711 ;; after an element or object of type TYPE has been transcoded.
1712 ;;
1713 ;; All filters sets are applied through
1714 ;; `org-export-filter-apply-functions' function. Filters in a set are
1715 ;; applied in a LIFO fashion. It allows developers to be sure that
1716 ;; their filters will be applied first.
1717 ;;
1718 ;; Filters properties are installed in communication channel with
1719 ;; `org-export-install-filters' function.
1720 ;;
1721 ;; Eventually, a hook (`org-export-before-parsing-hook') is run just
1722 ;; before parsing to allow for heavy structure modifications.
1725 ;;;; Before Parsing Hook
1728 "Hook run before parsing an export buffer.
1729 This is run after include keywords have been expanded and Babel
1730 code executed, on a copy of original buffer's area being
1731 exported. Visibility is the same as in the original one. Point
1735 ;;;; Special Filters
1738 "List of functions applied to the parsed tree.
1739 Each filter is called with three arguments: the parse tree, as
1740 returned by `org-element-parse-buffer', the back-end, as
1741 a symbol, and the communication channel, as a plist. It must
1745 "List of functions applied to the transcoded string.
1746 Each filter is called with three arguments: the full transcoded
1747 string, the back-end, as a symbol, and the communication channel,
1748 as a plist. It must return a string that will be used as the
1752 "List of functions applied to plain text.
1753 Each filter is called with three arguments: a string which
1754 contains no Org syntax, the back-end, as a symbol, and the
1755 communication channel, as a plist. It must return a string or
1759 ;;;; Elements Filters
1762 "List of functions applied to a transcoded center block.
1763 Each filter is called with three arguments: the transcoded data,
1764 as a string, the back-end, as a symbol, and the communication
1768 "List of functions applied to a transcoded clock.
1769 Each filter is called with three arguments: the transcoded data,
1770 as a string, the back-end, as a symbol, and the communication
1774 "List of functions applied to a transcoded drawer.
1775 Each filter is called with three arguments: the transcoded data,
1776 as a string, the back-end, as a symbol, and the communication
1780 "List of functions applied to a transcoded dynamic-block.
1781 Each filter is called with three arguments: the transcoded data,
1782 as a string, the back-end, as a symbol, and the communication
1786 "List of functions applied to a transcoded headline.
1787 Each filter is called with three arguments: the transcoded data,
1788 as a string, the back-end, as a symbol, and the communication
1792 "List of functions applied to a transcoded inlinetask.
1793 Each filter is called with three arguments: the transcoded data,
1794 as a string, the back-end, as a symbol, and the communication
1798 "List of functions applied to a transcoded plain-list.
1799 Each filter is called with three arguments: the transcoded data,
1800 as a string, the back-end, as a symbol, and the communication
1804 "List of functions applied to a transcoded item.
1805 Each filter is called with three arguments: the transcoded data,
1806 as a string, the back-end, as a symbol, and the communication
1810 "List of functions applied to a transcoded comment.
1811 Each filter is called with three arguments: the transcoded data,
1812 as a string, the back-end, as a symbol, and the communication
1816 "List of functions applied to a transcoded comment-comment.
1817 Each filter is called with three arguments: the transcoded data,
1818 as a string, the back-end, as a symbol, and the communication
1822 "List of functions applied to a transcoded example-block.
1823 Each filter is called with three arguments: the transcoded data,
1824 as a string, the back-end, as a symbol, and the communication
1828 "List of functions applied to a transcoded export-block.
1829 Each filter is called with three arguments: the transcoded data,
1830 as a string, the back-end, as a symbol, and the communication
1834 "List of functions applied to a transcoded fixed-width.
1835 Each filter is called with three arguments: the transcoded data,
1836 as a string, the back-end, as a symbol, and the communication
1840 "List of functions applied to a transcoded footnote-definition.
1841 Each filter is called with three arguments: the transcoded data,
1842 as a string, the back-end, as a symbol, and the communication
1846 "List of functions applied to a transcoded horizontal-rule.
1847 Each filter is called with three arguments: the transcoded data,
1848 as a string, the back-end, as a symbol, and the communication
1852 "List of functions applied to a transcoded keyword.
1853 Each filter is called with three arguments: the transcoded data,
1854 as a string, the back-end, as a symbol, and the communication
1858 "List of functions applied to a transcoded latex-environment.
1859 Each filter is called with three arguments: the transcoded data,
1860 as a string, the back-end, as a symbol, and the communication
1864 "List of functions applied to a transcoded babel-call.
1865 Each filter is called with three arguments: the transcoded data,
1866 as a string, the back-end, as a symbol, and the communication
1870 "List of functions applied to a transcoded paragraph.
1871 Each filter is called with three arguments: the transcoded data,
1872 as a string, the back-end, as a symbol, and the communication
1876 "List of functions applied to a transcoded planning.
1877 Each filter is called with three arguments: the transcoded data,
1878 as a string, the back-end, as a symbol, and the communication
1882 "List of functions applied to a transcoded property-drawer.
1883 Each filter is called with three arguments: the transcoded data,
1884 as a string, the back-end, as a symbol, and the communication
1888 "List of functions applied to a transcoded quote block.
1889 Each filter is called with three arguments: the transcoded quote
1890 data, as a string, the back-end, as a symbol, and the
1891 communication channel, as a plist. It must return a string or
1895 "List of functions applied to a transcoded quote-section.
1896 Each filter is called with three arguments: the transcoded data,
1897 as a string, the back-end, as a symbol, and the communication
1901 "List of functions applied to a transcoded section.
1902 Each filter is called with three arguments: the transcoded data,
1903 as a string, the back-end, as a symbol, and the communication
1907 "List of functions applied to a transcoded special block.
1908 Each filter is called with three arguments: the transcoded data,
1909 as a string, the back-end, as a symbol, and the communication
1913 "List of functions applied to a transcoded src-block.
1914 Each filter is called with three arguments: the transcoded data,
1915 as a string, the back-end, as a symbol, and the communication
1919 "List of functions applied to a transcoded table.
1920 Each filter is called with three arguments: the transcoded data,
1921 as a string, the back-end, as a symbol, and the communication
1925 "List of functions applied to a transcoded table-cell.
1926 Each filter is called with three arguments: the transcoded data,
1927 as a string, the back-end, as a symbol, and the communication
1931 "List of functions applied to a transcoded table-row.
1932 Each filter is called with three arguments: the transcoded data,
1933 as a string, the back-end, as a symbol, and the communication
1937 "List of functions applied to a transcoded verse block.
1938 Each filter is called with three arguments: the transcoded data,
1939 as a string, the back-end, as a symbol, and the communication
1943 ;;;; Objects Filters
1946 "List of functions applied to transcoded bold text.
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 transcoded code text.
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 entity.
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 export-snippet.
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 footnote-reference.
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 inline-babel-call.
1977 Each filter is called with three arguments: the transcoded data,
1978 as a string, the back-end, as a symbol, and the communication
1982 "List of functions applied to a transcoded inline-src-block.
1983 Each filter is called with three arguments: the transcoded data,
1984 as a string, the back-end, as a symbol, and the communication
1988 "List of functions applied to transcoded italic text.
1989 Each filter is called with three arguments: the transcoded data,
1990 as a string, the back-end, as a symbol, and the communication
1994 "List of functions applied to a transcoded latex-fragment.
1995 Each filter is called with three arguments: the transcoded data,
1996 as a string, the back-end, as a symbol, and the communication
2000 "List of functions applied to a transcoded line-break.
2001 Each filter is called with three arguments: the transcoded data,
2002 as a string, the back-end, as a symbol, and the communication
2006 "List of functions applied to a transcoded link.
2007 Each filter is called with three arguments: the transcoded data,
2008 as a string, the back-end, as a symbol, and the communication
2012 "List of functions applied to a transcoded macro.
2013 Each filter is called with three arguments: the transcoded data,
2014 as a string, the back-end, as a symbol, and the communication
2018 "List of functions applied to a transcoded radio-target.
2019 Each filter is called with three arguments: the transcoded data,
2020 as a string, the back-end, as a symbol, and the communication
2024 "List of functions applied to a transcoded statistics-cookie.
2025 Each filter is called with three arguments: the transcoded data,
2026 as a string, the back-end, as a symbol, and the communication
2030 "List of functions applied to transcoded strike-through text.
2031 Each filter is called with three arguments: the transcoded data,
2032 as a string, the back-end, as a symbol, and the communication
2036 "List of functions applied to a transcoded subscript.
2037 Each filter is called with three arguments: the transcoded data,
2038 as a string, the back-end, as a symbol, and the communication
2042 "List of functions applied to a transcoded superscript.
2043 Each filter is called with three arguments: the transcoded data,
2044 as a string, the back-end, as a symbol, and the communication
2048 "List of functions applied to a transcoded target.
2049 Each filter is called with three arguments: the transcoded data,
2050 as a string, the back-end, as a symbol, and the communication
2054 "List of functions applied to a transcoded timestamp.
2055 Each filter is called with three arguments: the transcoded data,
2056 as a string, the back-end, as a symbol, and the communication
2060 "List of functions applied to transcoded underline text.
2061 Each filter is called with three arguments: the transcoded data,
2062 as a string, the back-end, as a symbol, and the communication
2066 "List of functions applied to transcoded verbatim text.
2067 Each filter is called with three arguments: the transcoded data,
2068 as a string, the back-end, as a symbol, and the communication
2072 "Call every function in FILTERS.
2073 Functions are called with arguments VALUE, current export
2074 back-end and INFO. Call is done in a LIFO fashion, to be sure
2075 that developer specified filters, if any, are called first."
2079 value)
2082 "Install filters properties in communication channel.
2084 INFO is a plist containing the current communication channel.
2086 Return the updated communication channel."
2088 ;; Install user defined filters with `org-export-filters-alist'.
2091 org-export-filters-alist)
2092 ;; Prepend back-end specific filters to that list.
2097 ;; Single values get consed, lists are prepended.
2102 plist key
2106 ;; Return new communication channel.
2110 \f
2111 ;;; Core functions
2112 ;;
2113 ;; This is the room for the main function, `org-export-as', along with
2114 ;; its derivatives, `org-export-to-buffer' and `org-export-to-file'.
2115 ;; They differ only by the way they output the resulting code.
2116 ;;
2117 ;; `org-export-output-file-name' is an auxiliary function meant to be
2118 ;; used with `org-export-to-file'. With a given extension, it tries
2119 ;; to provide a canonical file name to write export output to.
2120 ;;
2121 ;; Note that `org-export-as' doesn't really parse the current buffer,
2122 ;; but a copy of it (with the same buffer-local variables and
2123 ;; visibility), where include keywords are expanded and Babel blocks
2124 ;; are executed, if appropriate.
2125 ;; `org-export-with-current-buffer-copy' macro prepares that copy.
2126 ;;
2127 ;; File inclusion is taken care of by
2128 ;; `org-export-expand-include-keyword' and
2129 ;; `org-export-prepare-file-contents'. Structure wise, including
2130 ;; a whole Org file in a buffer often makes little sense. For
2131 ;; example, if the file contains an headline and the include keyword
2132 ;; was within an item, the item should contain the headline. That's
2133 ;; why file inclusion should be done before any structure can be
2134 ;; associated to the file, that is before parsing.
2138 "Transcode current Org buffer into BACKEND code.
2140 If narrowing is active in the current buffer, only transcode its
2141 narrowed part.
2143 If a region is active, transcode that region.
2145 When optional argument SUBTREEP is non-nil, transcode the
2146 sub-tree at point, extracting information from the headline
2147 properties first.
2149 When optional argument VISIBLE-ONLY is non-nil, don't export
2150 contents of hidden elements.
2152 When optional argument BODY-ONLY is non-nil, only return body
2153 code, without preamble nor postamble.
2155 Optional argument EXT-PLIST, when provided, is a property list
2156 with external parameters overriding Org default settings, but
2157 still inferior to file-local settings.
2159 Optional argument NOEXPAND, when non-nil, prevents included files
2160 to be expanded and Babel code to be executed.
2162 Return code as a string."
2165 ;; Narrow buffer to an appropriate region or subtree for
2166 ;; parsing. If parsing subtree, be sure to remove main headline
2167 ;; too.
2175 ;; 1. Get export environment from original buffer. Store
2176 ;; original footnotes definitions in communication channel as
2177 ;; they might not be accessible anymore in a narrowed parse
2178 ;; tree. Also install user's and developer's filters.
2182 ;; 2. Get parse tree. Buffer isn't parsed directly.
2183 ;; Instead, a temporary copy is created, where include
2184 ;; keywords are expanded and code blocks are evaluated.
2190 ;; Setting `org-current-export-file' is
2191 ;; required by Org Babel to properly resolve
2192 ;; noweb references.
2198 ;; 3. Call parse-tree filters to get the final tree.
2202 ;; 4. Now tree is complete, compute its properties and add
2203 ;; them to communication channel.
2207 ;; 5. Eventually transcode TREE. Wrap the resulting string
2208 ;; into a template, if required. Eventually call
2209 ;; final-output filter.
2216 info)))
2217 ;; Maybe add final OUTPUT to kill ring, then return it.
2219 output)))))
2223 "Call `org-export-as' with output to a specified buffer.
2225 BACKEND is the back-end used for transcoding, as a symbol.
2227 BUFFER is the output buffer. If it already exists, it will be
2228 erased first, otherwise, it will be created.
2230 Optional arguments SUBTREEP, VISIBLE-ONLY, BODY-ONLY, EXT-PLIST
2231 and NOEXPAND are similar to those used in `org-export-as', which
2232 see.
2234 Return buffer."
2236 backend subtreep visible-only body-only ext-plist noexpand))
2242 buffer))
2246 "Call `org-export-as' with output to a specified file.
2248 BACKEND is the back-end used for transcoding, as a symbol. FILE
2249 is the name of the output file, as a string.
2251 Optional arguments SUBTREEP, VISIBLE-ONLY, BODY-ONLY, EXT-PLIST
2252 and NOEXPAND are similar to those used in `org-export-as', which
2253 see.
2255 Return output file's name."
2256 ;; Checks for FILE permissions. `write-file' would do the same, but
2257 ;; we'd rather avoid needless transcoding of parse tree.
2259 ;; Insert contents to a temporary buffer and write it to FILE.
2261 backend subtreep visible-only body-only ext-plist noexpand)))
2266 ;; Return full path.
2267 file)
2270 "Return output file's name according to buffer specifications.
2272 EXTENSION is a string representing the output file extension,
2273 with the leading dot.
2275 With a non-nil optional argument SUBTREEP, try to determine
2277 of subtree at point.
2279 When optional argument PUB-DIR is set, use it as the publishing
2280 directory.
2282 Return file name as a string, or nil if it couldn't be
2283 determined."
2285 ;; File name may come from EXPORT_FILE_NAME subtree property,
2286 ;; assuming point is at beginning of said sub-tree.
2294 ;; File name may be extracted from buffer's associated
2295 ;; file, if any.
2297 ;; Can't determine file name on our own: Ask user.
2301 "Output file: " pub-dir nil nil nil
2304 ;; Build file name. Enforce EXTENSION over whatever user may have
2305 ;; come up with. PUB-DIR, if defined, always has precedence over
2306 ;; any provided path.
2311 extension))
2317 "Apply BODY in a copy of the current buffer.
2319 The copy preserves local variables and visibility of the original
2320 buffer.
2322 Point is at buffer's beginning when BODY is applied."
2332 ,original-buffer
2337 ov
2347 "Expand every include keyword in buffer.
2348 Optional argument INCLUDED is a list of included file names along
2349 with their line restriction, when appropriate. It is used to
2350 avoid infinite recursion. Optional argument DIR is the current
2351 working directory. It is used to properly resolve relative
2352 paths."
2359 ;; Extract arguments from keyword's value.
2373 ;; Minimal level of included file defaults to the child
2374 ;; level of the current headline, if any, or one. It
2375 ;; only applies is the file is meant to be included as
2376 ;; an Org one.
2384 ;; Remove keyword.
2388 ;; Check if files has already been parsed. Look after
2389 ;; inclusion lines too, as different parts of the same file
2390 ;; can be included too.
2399 ;; Protect sensitive contents with commas.
2405 ind-str contents ind-str))))
2410 ;; Protect sensitive contents with commas.
2417 ind-str env contents ind-str))))
2430 "Prepare the contents of FILE for inclusion and return them as a string.
2432 When optional argument LINES is a string specifying a range of
2433 lines, include only those lines.
2435 Optional argument IND, when non-nil, is an integer specifying the
2436 global indentation of returned contents. Since its purpose is to
2437 allow an included file to stay in the same environment it was
2438 created \(i.e. a list item), it doesn't apply past the first
2439 headline encountered.
2441 Optional argument MINLEVEL, when non-nil, is an integer
2442 specifying the level that any top-level headline in the included
2443 file should have."
2459 ;; Remove blank lines at beginning and end of contents. The logic
2460 ;; behind that removal is that blank lines around include keyword
2461 ;; override blank lines in included file.
2470 ;; If IND is set, preserve indentation of include keyword until
2471 ;; the first headline encountered.
2477 ;; Do not move footnote definitions out of column 0.
2483 ;; When MINLEVEL is specified, compute minimal level for headlines
2484 ;; in the file (CUR-MIN), and remove stars to each headline so
2485 ;; that headlines with minimal level have a level of MINLEVEL.
2494 ;; Only change stars, don't bother moving whole
2495 ;; sections.
2501 \f
2502 ;;; Tools For Back-Ends
2503 ;;
2504 ;; A whole set of tools is available to help build new exporters. Any
2505 ;; function general enough to have its use across many back-ends
2506 ;; should be added here.
2507 ;;
2508 ;; As of now, functions operating on footnotes, headlines, links,
2509 ;; macros, references, src-blocks, tables and tables of contents are
2510 ;; implemented.
2512 ;;;; For Export Snippets
2513 ;;
2514 ;; Every export snippet is transmitted to the back-end. Though, the
2515 ;; latter will only retain one type of export-snippet, ignoring
2516 ;; others, based on the former's target back-end. The function
2517 ;; `org-export-snippet-backend' returns that back-end for a given
2518 ;; export-snippet.
2521 "Return EXPORT-SNIPPET targeted back-end as a symbol.
2522 Translation, with `org-export-snippet-translation-alist', is
2523 applied."
2527 back-end))))
2530 ;;;; For Footnotes
2531 ;;
2532 ;; `org-export-collect-footnote-definitions' is a tool to list
2533 ;; actually used footnotes definitions in the whole parse tree, or in
2534 ;; an headline, in order to add footnote listings throughout the
2535 ;; transcoded data.
2536 ;;
2537 ;; `org-export-footnote-first-reference-p' is a predicate used by some
2538 ;; back-ends, when they need to attach the footnote definition only to
2539 ;; the first occurrence of the corresponding label.
2540 ;;
2541 ;; `org-export-get-footnote-definition' and
2542 ;; `org-export-get-footnote-number' provide easier access to
2543 ;; additional information relative to a footnote reference.
2546 "Return an alist between footnote numbers, labels and definitions.
2548 DATA is the parse tree from which definitions are collected.
2549 INFO is the plist used as a communication channel.
2551 Definitions are sorted by order of references. They either
2552 appear as Org data or as a secondary string for inlined
2553 footnotes. Unreferenced definitions are ignored."
2558 ;; Collect footnote number, label and definition in DATA.
2560 data 'footnote-reference
2567 def)
2568 num-alist)
2569 ;; Also search in definition for nested footnotes.
2572 ;; Don't enter footnote definitions since it will happen
2573 ;; when their first reference is found.
2579 "Non-nil when a footnote reference is the first one for its label.
2581 FOOTNOTE-REFERENCE is the footnote reference being considered.
2582 INFO is the plist used as a communication channel."
2584 ;; Anonymous footnotes are always a first reference.
2586 ;; Otherwise, return the first footnote with the same LABEL and
2587 ;; test if it is equal to FOOTNOTE-REFERENCE.
2592 data 'footnote-reference
2597 ;; If FN isn't inlined, be sure to traverse its
2598 ;; definition before resuming search. See
2599 ;; comments in `org-export-get-footnote-number'
2600 ;; for more information.
2604 ;; Don't enter footnote definitions since it will
2605 ;; happen when their first reference is found.
2608 footnote-reference)))))
2611 "Return definition of FOOTNOTE-REFERENCE as parsed data.
2612 INFO is the plist used as a communication channel."
2618 "Return number associated to a footnote.
2620 FOOTNOTE is either a footnote reference or a footnote definition.
2621 INFO is the plist used as a communication channel."
2623 seen-refs
2627 ;; Search footnote references through DATA, filling
2628 ;; SEEN-REFS along the way.
2630 data 'footnote-reference
2634 ;; Anonymous footnote match: return number.
2637 ;; Labels match: return number.
2640 ;; Anonymous footnote: it's always a new one. Also,
2641 ;; be sure to return nil from the `cond' so
2642 ;; `first-match' doesn't get us out of the loop.
2644 ;; Label not seen so far: add it so SEEN-REFS.
2645 ;;
2646 ;; Also search for subsequent references in footnote
2647 ;; definition so numbering following reading logic.
2648 ;; Note that we don't have to care about inline
2649 ;; definitions, since `org-element-map' already
2650 ;; traverse them at the right time.
2651 ;;
2652 ;; Once again, return nil to stay in the loop.
2657 nil))))
2658 ;; Don't enter footnote definitions since it will happen
2659 ;; when their first reference is found.
2664 ;;;; For Headlines
2665 ;;
2666 ;; `org-export-get-relative-level' is a shortcut to get headline
2667 ;; level, relatively to the lower headline level in the parsed tree.
2668 ;;
2669 ;; `org-export-get-headline-number' returns the section number of an
2670 ;; headline, while `org-export-number-to-roman' allows to convert it
2671 ;; to roman numbers.
2672 ;;
2673 ;; `org-export-low-level-p', `org-export-first-sibling-p' and
2674 ;; `org-export-last-sibling-p' are three useful predicates when it
2675 ;; comes to fulfill the `:headline-levels' property.
2678 "Return HEADLINE relative level within current parsed tree.
2679 INFO is a plist holding contextual information."
2684 "Non-nil when HEADLINE is considered as low level.
2686 INFO is a plist used as a communication channel.
2688 A low level headlines has a relative level greater than
2689 `:headline-levels' property value.
2691 Return value is the difference between HEADLINE relative level
2692 and the last level being considered as high enough, or nil."
2699 "Return HEADLINE numbering as a list of numbers.
2700 INFO is a plist holding contextual information."
2704 "Return a non-nil value if HEADLINE element should be numbered.
2705 INFO is a plist used as a communication channel."
2711 "Convert integer N into a roman numeral."
2724 res)))
2727 "Non-nil when HEADLINE is the first sibling in its sub-tree.
2728 INFO is the plist used as a communication channel."
2733 "Non-nil when HEADLINE is the last sibling in its sub-tree.
2734 INFO is the plist used as a communication channel."
2738 ;;;; For Links
2739 ;;
2740 ;; `org-export-solidify-link-text' turns a string into a safer version
2741 ;; for links, replacing most non-standard characters with hyphens.
2742 ;;
2743 ;; `org-export-get-coderef-format' returns an appropriate format
2744 ;; string for coderefs.
2745 ;;
2746 ;; `org-export-inline-image-p' returns a non-nil value when the link
2747 ;; provided should be considered as an inline image.
2748 ;;
2749 ;; `org-export-resolve-fuzzy-link' searches destination of fuzzy links
2750 ;; (i.e. links with "fuzzy" as type) within the parsed tree, and
2751 ;; returns an appropriate unique identifier when found, or nil.
2752 ;;
2753 ;; `org-export-resolve-id-link' returns the first headline with
2754 ;; specified id or custom-id in parse tree, or nil when none was
2755 ;; found.
2756 ;;
2757 ;; `org-export-resolve-coderef' associates a reference to a line
2758 ;; number in the element it belongs, or returns the reference itself
2759 ;; when the element isn't numbered.
2762 "Take link text S and make a safe target out of it."
2767 "Return format string for code reference link.
2768 PATH is the link path. DESC is its description."
2776 "Non-nil if LINK object points to an inline image.
2778 Optional argument is a set of RULES defining inline images. It
2779 is an alist where associations have the following shape:
2781 \(TYPE . REGEXP)
2783 Applying a rule means apply REGEXP against LINK's path when its
2784 type is TYPE. The function will return a non-nil value if any of
2785 the provided rules is non-nil. The default rule is
2786 `org-export-default-inline-image-rule'.
2788 This only applies to links without a description."
2797 rules))))
2800 "Return LINK destination.
2802 INFO is a plist holding contextual information.
2804 Return value can be an object, an element, or nil:
2806 - If LINK path matches a target object (i.e. <<path>>) or
2809 - If LINK path exactly matches the name affiliated keyword
2810 \(i.e. #+NAME: path) of an element, return that element.
2812 - If LINK path exactly matches any headline name, return that
2813 element. If more than one headline share that name, priority
2814 will be given to the one with the closest common ancestor, if
2815 any, or the first one in the parse tree otherwise.
2817 - Otherwise, return nil.
2822 ;; First try to find a matching "<<path>>" unless user specified
2823 ;; he was looking for an headline (path starts with a *
2824 ;; character).
2828 return target)))
2829 ;; Then try to find an element with a matching "#+NAME: path"
2830 ;; affiliated keyword.
2837 ;; Last case: link either points to an headline or to
2838 ;; nothingness. Try to find the source, with priority given to
2839 ;; headlines with the closest common ancestor. If such candidate
2840 ;; is found, return its beginning position as an unique
2841 ;; identifier, otherwise return nil.
2845 ;; Return first headline whose `:raw-value' property
2846 ;; is NAME in parse tree DATA, or nil.
2849 data 'headline
2853 name)
2854 headline))
2856 ;; Search among headlines sharing an ancestor with link,
2857 ;; from closest to farthest.
2865 ;; No match with a common ancestor: try the full parse-tree.
2869 "Return headline referenced as LINK destination.
2871 INFO is a plist used as a communication channel.
2873 Return value can be an headline element or nil. Assume LINK type
2881 headline))
2885 "Resolve a code reference REF.
2887 INFO is a plist used as a communication channel.
2889 Return associated line number in source code, or REF itself,
2890 depending on src-block or example element's switches."
2898 org-coderef-label-format)))
2902 ;; Element containing REF is found. Resolve it to either
2903 ;; a label or a line number, as needed.
2913 ;;;; For Macros
2914 ;;
2915 ;; `org-export-expand-macro' simply takes care of expanding macros.
2918 "Expand MACRO and return it as a string.
2919 INFO is a plist holding export options."
2922 ;; User's macros are stored in the communication channel with
2923 ;; a ":macro-" prefix.
2926 ;; Replace arguments in VALUE.
2933 ;; VALUE starts with "(eval": it is a s-exp, `eval' it.
2936 ;; Return string.
2940 ;;;; For References
2941 ;;
2942 ;; `org-export-get-ordinal' associates a sequence number to any object
2943 ;; or element.
2946 "Return ordinal number of an element or object.
2948 ELEMENT is the element or object considered. INFO is the plist
2949 used as a communication channel.
2951 Optional argument TYPES, when non-nil, is a list of element or
2952 object types, as symbols, that should also be counted in.
2953 Otherwise, only provided element's type is considered.
2955 Optional argument PREDICATE is a function returning a non-nil
2956 value if the current element or object should be counted in. It
2957 accepts two arguments: the element or object being considered and
2958 the plist used as a communication channel. This allows to count
2959 only a certain type of objects (i.e. inline images).
2961 Return value is a list of numbers if ELEMENT is an headline or an
2962 item. It is nil for keywords. It represents the footnote number
2963 for footnote definitions and footnote references. If ELEMENT is
2964 a target, return the same value as if ELEMENT was the closest
2965 table, item or headline containing the target. In any other
2966 case, return the sequence number of ELEMENT among elements or
2967 objects of the same type."
2968 ;; A target keyword, representing an invisible target, never has
2969 ;; a sequence number.
2971 ;; Ordinal of a target object refer to the ordinal of the closest
2972 ;; table, item, or headline containing the object.
2976 when
2980 table))
2981 return parent)))
2983 ;; Special case 1: An headline returns its number as a list.
2985 ;; Special case 2: An item returns its number as a list.
2989 struct
2996 ;; Increment counter until ELEMENT is found again.
3007 ;;;; For Src-Blocks
3008 ;;
3009 ;; `org-export-get-loc' counts number of code lines accumulated in
3010 ;; src-block or example-block elements with a "+n" switch until
3011 ;; a given element, excluded. Note: "-n" switches reset that count.
3012 ;;
3013 ;; `org-export-unravel-code' extracts source code (along with a code
3014 ;; references alist) from an `element-block' or `src-block' type
3015 ;; element.
3016 ;;
3017 ;; `org-export-format-code' applies a formatting function to each line
3018 ;; of code, providing relative line number and code reference when
3019 ;; appropriate. Since it doesn't access the original element from
3020 ;; which the source code is coming, it expects from the code calling
3021 ;; it to know if lines should be numbered and if code references
3022 ;; should appear.
3023 ;;
3024 ;; Eventually, `org-export-format-code-default' is a higher-level
3025 ;; function (it makes use of the two previous functions) which handles
3026 ;; line numbering and code references inclusion, and returns source
3027 ;; code in a format suitable for plain text or verbatim output.
3030 "Return accumulated lines of code up to ELEMENT.
3032 INFO is the plist used as a communication channel.
3034 ELEMENT is excluded from count."
3041 ;; ELEMENT is reached: Quit the loop.
3043 ;; Only count lines from src-block and example-block elements
3044 ;; with a "+n" or "-n" switch. A "-n" switch resets counter.
3048 ;; Accumulate locs or reset them.
3052 ;; Return nil to stay in the loop.
3053 nil)))
3055 ;; Return value.
3056 loc))
3059 "Clean source code and extract references out of it.
3061 ELEMENT has either a `src-block' an `example-block' type.
3063 Return a cons cell whose CAR is the source code, cleaned from any
3064 reference and protective comma and CDR is an alist between
3065 relative line number (integer) and name of code reference on that
3066 line (string)."
3068 ;; Get code and clean it. Remove blank lines at its
3069 ;; beginning and end. Also remove protective commas.
3075 ;; If appropriate, remove global indentation.
3079 ;; Free up the protected lines. Note: Org blocks
3080 ;; have commas at the beginning or every line.
3085 ;; Get format used for references.
3088 org-coderef-label-format)))
3089 ;; Build a regexp matching a loc with a reference.
3094 ;; Return value.
3096 ;; Code with references removed.
3102 ;; Ref line: remove ref, and signal its position in REFS.
3106 ;; Reference alist.
3107 refs)))
3110 "Format CODE by applying FUN line-wise and return it.
3112 CODE is a string representing the code to format. FUN is
3113 a function. It must accept three arguments: a line of
3114 code (string), the current line number (integer) or nil and the
3115 reference associated to the current line (string) or nil.
3117 Optional argument NUM-LINES can be an integer representing the
3118 number of code lines accumulated until the current code. Line
3119 numbers passed to FUN will take it into account. If it is nil,
3120 FUN's second argument will always be nil. This number can be
3121 obtained with `org-export-get-loc' function.
3123 Optional argument REF-ALIST can be an alist between relative line
3124 number (i.e. ignoring NUM-LINES) and the name of the code
3125 reference on it. If it is nil, FUN's third argument will always
3126 be nil. It can be obtained through the use of
3127 `org-export-unravel-code' function."
3139 "Return source code from ELEMENT, formatted in a standard way.
3141 ELEMENT is either a `src-block' or `example-block' element. INFO
3142 is a plist used as a communication channel.
3144 This function takes care of line numbering and code references
3145 inclusion. Line numbers, when applicable, appear at the
3146 beginning of the line, separated from the code by two white
3147 spaces. Code references, on the other hand, appear flushed to
3148 the right, separated by six white spaces from the widest line of
3149 code."
3150 ;; Extract code and references.
3156 ;; Handle line numbering.
3165 ;; Prepare references display, if required. Any reference
3166 ;; should start six columns after the widest line of code,
3167 ;; wrapped with parenthesis.
3172 code
3176 number-str
3177 loc
3183 num-start refs)))
3186 ;;;; For Tables
3187 ;;
3188 ;; `org-export-table-has-special-column-p' and
3189 ;; `org-export-table-row-is-special-p' are predicates used to look for
3190 ;; meta-information about the table structure.
3191 ;;
3192 ;; `org-export-table-cell-width', `org-export-table-cell-alignment'
3193 ;; and `org-export-table-cell-borders' extract information from
3194 ;; a table-cell element.
3195 ;;
3196 ;; `org-export-table-dimensions' gives the number on rows and columns
3197 ;; in the table, ignoring horizontal rules and special columns.
3198 ;; `org-export-table-cell-address', given a table-cell object, returns
3199 ;; the absolute address of a cell. On the other hand,
3200 ;; `org-export-get-table-cell-at' does the contrary.
3203 "Non-nil when TABLE has a special column.
3204 All special columns will be ignored during export."
3205 ;; The table has a special column when every first cell of every row
3206 ;; has an empty value or contains a symbol among "/", "#", "!", "$",
3207 ;; "*" "_" and "^". Though, do not consider a first row containing
3208 ;; only empty cells as special.
3224 "Non-nil when TABLE has an header.
3226 INFO is a plist used as a communication channel.
3228 A table has an header when it contains at least two row groups."
3231 table 'table-row
3239 info)))
3242 "Non-nil if TABLE-ROW is considered special.
3244 INFO is a plist used as the communication channel.
3246 All special rows will be ignored during export."
3250 ;; A row is special either when...
3252 ;; ... it starts with a field only containing "/",
3254 ;; ... the table contains a special column and the row start
3255 ;; with a marking character among, "^", "_", "$" or "!",
3259 ;; ... it contains only alignment cookies and empty cells.
3275 "Return TABLE-ROW's group.
3277 INFO is a plist used as the communication channel.
3279 Return value is the group number, as an integer, or nil special
3280 rows and table rules. Group 1 is also table's header."
3297 "Return TABLE-CELL contents width.
3299 INFO is a plist used as the communication channel.
3301 Return value is the width given by the last width cookie in the
3302 same column as TABLE-CELL, or nil."
3308 cookie-width)
3312 ;; In a special row, try to find a width cookie at COLUMN.
3323 ;; Ignore table rules.
3326 ;; Return value.
3327 cookie-width))
3330 "Return TABLE-CELL contents alignment.
3332 INFO is a plist used as the communication channel.
3334 Return alignment as specified by the last alignment cookie in the
3335 same column as TABLE-CELL. If no such cookie is found, a default
3336 alignment value will be deduced from fraction of numbers in the
3337 column (see `org-table-number-fraction' for more information).
3338 Possible values are `left', `right' and `center'."
3346 cookie-align)
3350 ;; In a special row, try to find an alignment cookie at
3351 ;; COLUMN.
3362 ;; Ignore table rules.
3364 ;; In a standard row, check if cell's contents are expressing
3365 ;; some kind of number. Increase NUMBER-CELLS accordingly.
3366 ;; Though, don't bother if an alignment cookie has already
3367 ;; defined cell's alignment.
3376 ;; Return value. Alignment specified by cookies has precedence
3377 ;; over alignment deduced from cells contents.
3386 "Return TABLE-CELL borders.
3388 INFO is a plist used as a communication channel.
3390 Return value is a list of symbols, or nil. Possible values are:
3391 `top', `bottom', `above', `below', `left' and `right'. Note:
3392 `top' (resp. `bottom') only happen for a cell in the first
3393 row (resp. last row) of the table, ignoring table rules, if any.
3395 Returned borders ignore special rows."
3399 borders)
3400 ;; Top/above border? TABLE-CELL has a border above when a rule
3401 ;; used to demarcate row groups can be found above. Hence,
3402 ;; finding a rule isn't sufficient to push `above' in BORDERS:
3403 ;; another regular row has to be found above that rule.
3412 ;; Look at every row before the current one.
3414 ;; No rule above, or rule found starts the table (ignoring any
3415 ;; special row): TABLE-CELL is at the top of the table.
3418 ;; Bottom/below border? TABLE-CELL has a border below when next
3419 ;; non-regular row below is a rule.
3428 ;; Look at every row after the current one.
3430 ;; No rule below, or rule found ends the table (modulo some
3431 ;; special row): TABLE-CELL is at the bottom of the table.
3434 ;; Right/left borders? They can only be specified by column
3435 ;; groups. Column groups are defined in a row starting with "/".
3436 ;; Also a column groups row only contains "<", "<>", ">" or blank
3437 ;; cells.
3454 ;; There's a left border when previous cell, if
3455 ;; any, ends a group, or current one starts one.
3461 ;; There's a right border when next cell, if any,
3462 ;; starts a group, or current one ends one.
3469 ;; Table rows are read in reverse order so last column groups
3470 ;; row has precedence over any previous one.
3472 ;; Return value.
3473 borders))
3476 "Non-nil when TABLE-CELL is at the beginning of a row group.
3477 INFO is a plist used as a communication channel."
3478 ;; A cell starts a column group either when it is at the beginning
3479 ;; of a row (or after the special column, if any) or when it has
3480 ;; a left border.
3484 table-cell)
3488 "Non-nil when TABLE-CELL is at the end of a row group.
3489 INFO is a plist used as a communication channel."
3490 ;; A cell ends a column group either when it is at the end of a row
3491 ;; or when it has a right border.
3494 table-cell)
3498 "Non-nil when TABLE-ROW is at the beginning of a column group.
3499 INFO is a plist used as a communication channel."
3507 "Non-nil when TABLE-ROW is at the end of a column group.
3508 INFO is a plist used as a communication channel."
3516 "Non-nil when TABLE-ROW is the first table header's row.
3517 INFO is a plist used as a communication channel."
3524 "Non-nil when TABLE-ROW is the last table header's row.
3525 INFO is a plist used as a communication channel."
3532 "Return TABLE dimensions.
3534 INFO is a plist used as a communication channel.
3536 Return value is a CONS like (ROWS . COLUMNS) where
3537 ROWS (resp. COLUMNS) is the number of exportable
3538 rows (resp. columns)."
3540 ;; Set number of rows, and extract first one.
3542 table 'table-row
3547 ;; Set number of columns.
3549 ;; Return value.
3553 "Return address of a regular TABLE-CELL object.
3555 TABLE-CELL is the cell considered. INFO is a plist used as
3556 a communication channel.
3558 Address is a CONS cell (ROW . COLUMN), where ROW and COLUMN are
3559 zero-based index. Only exportable cells are considered. The
3560 function returns nil for other cells."
3563 ;; Ignore cells in special rows or in special column.
3568 ;; Row number.
3571 table 'table-row
3577 ;; Column number.
3580 table-row 'table-cell
3587 "Return regular table-cell object at ADDRESS in TABLE.
3589 Address is a CONS cell (ROW . COLUMN), where ROW and COLUMN are
3590 zero-based index. TABLE is a table type element. INFO is
3591 a plist used as a communication channel.
3593 If no table-cell, among exportable cells, is found at ADDRESS,
3594 return nil."
3597 ;; Row at (car address) or nil.
3600 table 'table-row
3606 'table-cell
3613 ;;;; For Tables Of Contents
3614 ;;
3615 ;; `org-export-collect-headlines' builds a list of all exportable
3616 ;; headline elements, maybe limited to a certain depth. One can then
3617 ;; easily parse it and transcode it.
3618 ;;
3619 ;; Building lists of tables, figures or listings is quite similar.
3620 ;; Once the generic function `org-export-collect-elements' is defined,
3621 ;; `org-export-collect-tables', `org-export-collect-figures' and
3622 ;; `org-export-collect-listings' can be derived from it.
3625 "Collect headlines in order to build a table of contents.
3627 INFO is a plist used as a communication channel.
3629 When non-nil, optional argument N must be an integer. It
3630 specifies the depth of the table of contents.
3632 Return a list of all exportable headlines as parsed elements."
3635 'headline
3637 ;; Strip contents from HEADLINE.
3640 info))
3643 "Collect referenceable elements of a determined type.
3645 TYPE can be a symbol or a list of symbols specifying element
3646 types to search. Only elements with a caption or a name are
3647 collected.
3649 INFO is a plist used as a communication channel.
3651 When non-nil, optional argument PREDICATE is a function accepting
3652 one argument, an element of type TYPE. It returns a non-nil
3653 value when that element should be collected.
3655 Return a list of all elements found, in order of appearance."
3665 "Build a list of tables.
3667 INFO is a plist used as a communication channel.
3669 Return a list of table elements with a caption or a name
3670 affiliated keyword."
3674 "Build a list of figures.
3676 INFO is a plist used as a communication channel. PREDICATE is
3677 a function which accepts one argument: a paragraph element and
3678 whose return value is non-nil when that element should be
3679 collected.
3681 A figure is a paragraph type element, with a caption or a name,
3682 verifying PREDICATE. The latter has to be provided since
3685 Return a list of elements recognized as figures."
3689 "Build a list of src blocks.
3691 INFO is a plist used as a communication channel.
3693 Return a list of src-block elements with a caption or a name
3694 affiliated keyword."
3698 ;;;; Topology
3699 ;;
3700 ;; Here are various functions to retrieve information about the
3701 ;; neighbourhood of a given element or object. Neighbours of interest
3702 ;; are direct parent (`org-export-get-parent'), parent headline
3703 ;; (`org-export-get-parent-headline'), parent paragraph
3704 ;; (`org-export-get-parent-paragraph'), previous element or object
3705 ;; (`org-export-get-previous-element') and next element or object
3706 ;; (`org-export-get-next-element').
3707 ;;
3708 ;; All of these functions are just a specific use of the more generic
3709 ;; `org-export-get-genealogy', which returns the genealogy relative to
3710 ;; the element or object.
3713 "Return genealogy relative to a given element or object.
3714 BLOB is the element or object being considered. INFO is a plist
3715 used as a communication channel."
3720 ;; Walk DATA, looking for BLOB. GENEALOGY is the list of
3721 ;; parents of all elements in DATA.
3728 ;; If BLOB is an object and EL contains a secondary
3729 ;; string, be sure to check it.
3733 org-element-secondary-value-alist))))
3736 walk-data
3745 "Return BLOB parent or nil.
3746 BLOB is the element or object considered. INFO is a plist used
3747 as a communication channel."
3751 "Return BLOB parent headline or nil.
3752 BLOB is the element or object being considered. INFO is a plist
3753 used as a communication channel."
3758 nil))
3761 "Return OBJECT parent paragraph or nil.
3762 OBJECT is the object to consider. INFO is a plist used as
3763 a communication channel."
3768 nil))
3771 "Return OBJECT parent table or nil.
3772 OBJECT is either a `table-cell' or `table-element' type object.
3773 INFO is a plist used as a communication channel."
3778 nil))
3781 "Return previous element or object.
3783 BLOB is an element or object. INFO is a plist used as
3784 a communication channel.
3786 Return previous element or object, a string, or nil."
3791 "Return next element or object.
3793 BLOB is an element or object. INFO is a plist used as
3794 a communication channel.
3796 Return next element or object, a string, or nil."
3801 \f
3802 ;;; The Dispatcher
3803 ;;
3804 ;; `org-export-dispatch' is the standard interactive way to start an
3805 ;; export process. It uses `org-export-dispatch-ui' as a subroutine
3806 ;; for its interface. Most commons back-ends should have an entry in
3807 ;; it.
3810 "Export dispatcher for Org mode.
3812 It provides an access to common export related tasks in a buffer.
3813 Its interface comes in two flavours: standard and expert. While
3814 both share the same set of bindings, only the former displays the
3815 valid keys associations. Set `org-export-dispatch-use-expert-ui'
3816 to switch to one or the other.
3818 Return an error if key pressed has no associated command."
3823 org-export-dispatch-use-expert-ui))
3826 ;; Translate "C-a", "C-b"... into "a", "b"... Then take action
3827 ;; depending on user's key pressed.
3829 ;; Allow to quit with "q" key.
3831 ;; Export with `e-ascii' back-end.
3837 `(:ascii-charset
3846 ;; Export with `e-latex' back-end.
3847 (?L
3862 ;; Export with `e-html' back-end.
3863 (?H
3868 ;; set major mode
3878 ;; Export with `e-odt' back-end.
3884 ;; Publishing facilities
3890 org-e-publish-project-alist)))
3893 ;; Undefined command.
3898 "Handle interface for `org-export-dispatch'.
3900 OPTIONS is a list containing current interactive options set for
3901 export. It can contain any of the following symbols:
3902 `body' toggles a body-only export
3903 `subtree' restricts export to current subtree
3904 `visible' restricts export to visible part of buffer.
3905 `force' force publishing files.
3907 EXPERTP, when non-nil, triggers expert UI. In that case, no help
3908 buffer is provided, but indications about currently active
3909 options are given in the prompt. Moreover, \[?] allows to switch
3910 back to standard interface.
3912 Return value is a list with key pressed as CAR and a list of
3913 final interactive export options as CDR."
3917 \[1] Body only: %s [2] Export scope: %s
3918 \[3] Visible only: %s [4] Force publishing: %s
3921 --- (ASCII/Latin-1/UTF-8 Export) -------------------------
3923 \[a/n/u] to TXT file [A/N/U] to temporary buffer
3925 --- (HTML Export) ----------------------------------------
3927 \[h] to HTML file [b] ... and open it
3928 \[H] to temporary buffer
3930 --- (LaTeX Export) ---------------------------------------
3932 \[l] to TEX file [L] to temporary buffer
3933 \[p] to PDF file [d] ... and open it
3935 --- (ODF Export) -----------------------------------------
3937 \[o] to ODT file [O] ... and open it
3939 --- (Publish) --------------------------------------------
3941 \[F] current file [P] current project
3942 \[X] a project [E] every project"
3955 ;; Read a character from command input, toggling interactive
3956 ;; options when applicable. PROMPT is the displayed prompt,
3957 ;; as a string.
3961 ;; Ignore non-standard characters (i.e. "M-a").
3963 ;; Help key: Switch back to standard interface if
3964 ;; expert UI was active.
3966 ;; Toggle export options.
3973 expertp))
3974 ;; Action selected: Send key and options back to
3975 ;; `org-export-dispatch'.
3977 ;; With expert UI, just read key with a fancy prompt. In standard
3978 ;; UI, display an intrusive help buffer.
3989 ;;; org-export.el ends here