1 ;;; ox.el --- Generic Export Engine for Org Mode
3 ;; Copyright (C) 2012-2014 Free Software Foundation, Inc.
5 ;; Author: Nicolas Goaziou <n.goaziou at gmail dot com>
6 ;; Keywords: outlines, hypermedia, calendar, wp
8 ;; This file is part of GNU Emacs.
10 ;; GNU Emacs is free software: you can redistribute it and/or modify
11 ;; it under the terms of the GNU General Public License as published by
12 ;; the Free Software Foundation, either version 3 of the License, or
13 ;; (at your option) any later version.
15 ;; GNU Emacs is distributed in the hope that it will be useful,
16 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
17 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 ;; GNU General Public License for more details.
20 ;; You should have received a copy of the GNU General Public License
21 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
25 ;; This library implements a generic export engine for Org, built on
26 ;; its syntactical parser: Org Elements.
28 ;; Besides that parser, the generic exporter is made of three distinct
31 ;; - The communication channel consists of a property list, which is
32 ;; created and updated during the process. Its use is to offer
33 ;; every piece of information, would it be about initial environment
34 ;; or contextual data, all in a single place.
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.
41 ;; - The filter system is activated at the very beginning and the very
42 ;; end of the export process, and each time an element or an object
43 ;; has been converted. It is the entry point to fine-tune standard
44 ;; output from back-end transcoders. See "The Filter System"
45 ;; section for more information.
47 ;; The core functions is `org-export-as'. It returns the transcoded
48 ;; buffer as a string. Its derivatives are `org-export-to-buffer' and
49 ;; `org-export-to-file'.
51 ;; An export back-end is defined with `org-export-define-backend'.
52 ;; This function can also support specific buffer keywords, OPTION
53 ;; keyword's items and filters. Refer to function's documentation for
56 ;; If the new back-end shares most properties with another one,
57 ;; `org-export-define-derived-backend' can be used to simplify the
60 ;; Any back-end can define its own variables. Among them, those
61 ;; customizable should belong to the `org-export-BACKEND' group.
63 ;; Tools for common tasks across back-ends are implemented in the
64 ;; following part of the file.
66 ;; Eventually, a dispatcher (`org-export-dispatch') is provided in the
69 ;; See <http://orgmode.org/worg/dev/org-export-reference.html> for
74 (eval-when-compile (require 'cl
))
75 (require 'org-element
)
79 (declare-function org-publish
"ox-publish" (project &optional force async
))
80 (declare-function org-publish-all
"ox-publish" (&optional force async
))
82 org-publish-current-file
"ox-publish" (&optional force async
))
83 (declare-function org-publish-current-project
"ox-publish"
84 (&optional force async
))
86 (defvar org-publish-project-alist
)
87 (defvar org-table-number-fraction
)
88 (defvar org-table-number-regexp
)
91 ;;; Internal Variables
93 ;; Among internal variables, the most important is
94 ;; `org-export-options-alist'. This variable define the global export
95 ;; options, shared between every exporter, and how they are acquired.
97 (defconst org-export-max-depth
19
98 "Maximum nesting depth for headlines, counting from 0.")
100 (defconst org-export-options-alist
101 '((:title
"TITLE" nil nil space
)
102 (:date
"DATE" nil nil t
)
103 (:author
"AUTHOR" nil user-full-name t
)
104 (:email
"EMAIL" nil user-mail-address t
)
105 (:description
"DESCRIPTION" nil nil newline
)
106 (:keywords
"KEYWORDS" nil nil space
)
107 (:language
"LANGUAGE" nil org-export-default-language t
)
108 (:select-tags
"SELECT_TAGS" nil org-export-select-tags split
)
109 (:exclude-tags
"EXCLUDE_TAGS" nil org-export-exclude-tags split
)
110 (:creator
"CREATOR" nil org-export-creator-string
)
111 (:headline-levels nil
"H" org-export-headline-levels
)
112 (:preserve-breaks nil
"\\n" org-export-preserve-breaks
)
113 (:section-numbers nil
"num" org-export-with-section-numbers
)
114 (:time-stamp-file nil
"timestamp" org-export-time-stamp-file
)
115 (:with-archived-trees nil
"arch" org-export-with-archived-trees
)
116 (:with-author nil
"author" org-export-with-author
)
117 (:with-clocks nil
"c" org-export-with-clocks
)
118 (:with-creator nil
"creator" org-export-with-creator
)
119 (:with-date nil
"date" org-export-with-date
)
120 (:with-drawers nil
"d" org-export-with-drawers
)
121 (:with-email nil
"email" org-export-with-email
)
122 (:with-emphasize nil
"*" org-export-with-emphasize
)
123 (:with-entities nil
"e" org-export-with-entities
)
124 (:with-fixed-width nil
":" org-export-with-fixed-width
)
125 (:with-footnotes nil
"f" org-export-with-footnotes
)
126 (:with-inlinetasks nil
"inline" org-export-with-inlinetasks
)
127 (:with-latex nil
"tex" org-export-with-latex
)
128 (:with-planning nil
"p" org-export-with-planning
)
129 (:with-priority nil
"pri" org-export-with-priority
)
130 (:with-properties nil
"prop" org-export-with-properties
)
131 (:with-smart-quotes nil
"'" org-export-with-smart-quotes
)
132 (:with-special-strings nil
"-" org-export-with-special-strings
)
133 (:with-statistics-cookies nil
"stat" org-export-with-statistics-cookies
)
134 (:with-sub-superscript nil
"^" org-export-with-sub-superscripts
)
135 (:with-toc nil
"toc" org-export-with-toc
)
136 (:with-tables nil
"|" org-export-with-tables
)
137 (:with-tags nil
"tags" org-export-with-tags
)
138 (:with-tasks nil
"tasks" org-export-with-tasks
)
139 (:with-timestamps nil
"<" org-export-with-timestamps
)
140 (:with-todo-keywords nil
"todo" org-export-with-todo-keywords
))
141 "Alist between export properties and ways to set them.
143 The CAR of the alist is the property name, and the CDR is a list
144 like (KEYWORD OPTION DEFAULT BEHAVIOR) where:
146 KEYWORD is a string representing a buffer keyword, or nil. Each
147 property defined this way can also be set, during subtree
148 export, through a headline property named after the keyword
149 with the \"EXPORT_\" prefix (i.e. DATE keyword and EXPORT_DATE
151 OPTION is a string that could be found in an #+OPTIONS: line.
152 DEFAULT is the default value for the property.
153 BEHAVIOR determines how Org should handle multiple keywords for
154 the same property. It is a symbol among:
155 nil Keep old value and discard the new one.
156 t Replace old value with the new one.
157 `space' Concatenate the values, separating them with a space.
158 `newline' Concatenate the values, separating them with
160 `split' Split values at white spaces, and cons them to the
163 Values set through KEYWORD and OPTION have precedence over
166 All these properties should be back-end agnostic. Back-end
167 specific properties are set through `org-export-define-backend'.
168 Properties redefined there have precedence over these.")
170 (defconst org-export-special-keywords
'("FILETAGS" "SETUPFILE" "OPTIONS")
171 "List of in-buffer keywords that require special treatment.
172 These keywords are not directly associated to a property. The
173 way they are handled must be hard-coded into
174 `org-export--get-inbuffer-options' function.")
176 (defconst org-export-filters-alist
177 '((:filter-body . org-export-filter-body-functions
)
178 (:filter-bold . org-export-filter-bold-functions
)
179 (:filter-babel-call . org-export-filter-babel-call-functions
)
180 (:filter-center-block . org-export-filter-center-block-functions
)
181 (:filter-clock . org-export-filter-clock-functions
)
182 (:filter-code . org-export-filter-code-functions
)
183 (:filter-comment . org-export-filter-comment-functions
)
184 (:filter-comment-block . org-export-filter-comment-block-functions
)
185 (:filter-diary-sexp . org-export-filter-diary-sexp-functions
)
186 (:filter-drawer . org-export-filter-drawer-functions
)
187 (:filter-dynamic-block . org-export-filter-dynamic-block-functions
)
188 (:filter-entity . org-export-filter-entity-functions
)
189 (:filter-example-block . org-export-filter-example-block-functions
)
190 (:filter-export-block . org-export-filter-export-block-functions
)
191 (:filter-export-snippet . org-export-filter-export-snippet-functions
)
192 (:filter-final-output . org-export-filter-final-output-functions
)
193 (:filter-fixed-width . org-export-filter-fixed-width-functions
)
194 (:filter-footnote-definition . org-export-filter-footnote-definition-functions
)
195 (:filter-footnote-reference . org-export-filter-footnote-reference-functions
)
196 (:filter-headline . org-export-filter-headline-functions
)
197 (:filter-horizontal-rule . org-export-filter-horizontal-rule-functions
)
198 (:filter-inline-babel-call . org-export-filter-inline-babel-call-functions
)
199 (:filter-inline-src-block . org-export-filter-inline-src-block-functions
)
200 (:filter-inlinetask . org-export-filter-inlinetask-functions
)
201 (:filter-italic . org-export-filter-italic-functions
)
202 (:filter-item . org-export-filter-item-functions
)
203 (:filter-keyword . org-export-filter-keyword-functions
)
204 (:filter-latex-environment . org-export-filter-latex-environment-functions
)
205 (:filter-latex-fragment . org-export-filter-latex-fragment-functions
)
206 (:filter-line-break . org-export-filter-line-break-functions
)
207 (:filter-link . org-export-filter-link-functions
)
208 (:filter-node-property . org-export-filter-node-property-functions
)
209 (:filter-options . org-export-filter-options-functions
)
210 (:filter-paragraph . org-export-filter-paragraph-functions
)
211 (:filter-parse-tree . org-export-filter-parse-tree-functions
)
212 (:filter-plain-list . org-export-filter-plain-list-functions
)
213 (:filter-plain-text . org-export-filter-plain-text-functions
)
214 (:filter-planning . org-export-filter-planning-functions
)
215 (:filter-property-drawer . org-export-filter-property-drawer-functions
)
216 (:filter-quote-block . org-export-filter-quote-block-functions
)
217 (:filter-radio-target . org-export-filter-radio-target-functions
)
218 (:filter-section . org-export-filter-section-functions
)
219 (:filter-special-block . org-export-filter-special-block-functions
)
220 (:filter-src-block . org-export-filter-src-block-functions
)
221 (:filter-statistics-cookie . org-export-filter-statistics-cookie-functions
)
222 (:filter-strike-through . org-export-filter-strike-through-functions
)
223 (:filter-subscript . org-export-filter-subscript-functions
)
224 (:filter-superscript . org-export-filter-superscript-functions
)
225 (:filter-table . org-export-filter-table-functions
)
226 (:filter-table-cell . org-export-filter-table-cell-functions
)
227 (:filter-table-row . org-export-filter-table-row-functions
)
228 (:filter-target . org-export-filter-target-functions
)
229 (:filter-timestamp . org-export-filter-timestamp-functions
)
230 (:filter-underline . org-export-filter-underline-functions
)
231 (:filter-verbatim . org-export-filter-verbatim-functions
)
232 (:filter-verse-block . org-export-filter-verse-block-functions
))
233 "Alist between filters properties and initial values.
235 The key of each association is a property name accessible through
236 the communication channel. Its value is a configurable global
237 variable defining initial filters.
239 This list is meant to install user specified filters. Back-end
240 developers may install their own filters using
241 `org-export-define-backend'. Filters defined there will always
242 be prepended to the current list, so they always get applied
245 (defconst org-export-default-inline-image-rule
249 '("png" "jpeg" "jpg" "gif" "tiff" "tif" "xbm"
250 "xpm" "pbm" "pgm" "ppm") t
))))
251 "Default rule for link matching an inline image.
252 This rule applies to links with no description. By default, it
253 will be considered as an inline image if it targets a local file
254 whose extension is either \"png\", \"jpeg\", \"jpg\", \"gif\",
255 \"tiff\", \"tif\", \"xbm\", \"xpm\", \"pbm\", \"pgm\" or \"ppm\".
256 See `org-export-inline-image-p' for more information about
259 (defconst org-export-ignored-local-variables
260 '(org-font-lock-keywords
261 org-element--cache org-element--cache-objects org-element--cache-sync-keys
262 org-element--cache-sync-requests org-element--cache-sync-timer
)
263 "List of variables not copied through upon buffer duplication.
264 Export process takes place on a copy of the original buffer.
265 When this copy is created, all Org related local variables not in
266 this list are copied to the new buffer. Variables with an
267 unreadable value are also ignored.")
269 (defvar org-export-async-debug nil
270 "Non-nil means asynchronous export process should leave data behind.
272 This data is found in the appropriate \"*Org Export Process*\"
273 buffer, and in files prefixed with \"org-export-process\" and
274 located in `temporary-file-directory'.
276 When non-nil, it will also set `debug-on-error' to a non-nil
277 value in the external process.")
279 (defvar org-export-stack-contents nil
280 "Record asynchronously generated export results and processes.
281 This is an alist: its CAR is the source of the
282 result (destination file or buffer for a finished process,
283 original buffer for a running one) and its CDR is a list
284 containing the back-end used, as a symbol, and either a process
285 or the time at which it finished. It is used to build the menu
286 from `org-export-stack'.")
288 (defvar org-export--registered-backends nil
289 "List of backends currently available in the exporter.
290 This variable is set with `org-export-define-backend' and
291 `org-export-define-derived-backend' functions.")
293 (defvar org-export-dispatch-last-action nil
294 "Last command called from the dispatcher.
295 The value should be a list. Its CAR is the action, as a symbol,
296 and its CDR is a list of export options.")
298 (defvar org-export-dispatch-last-position
(make-marker)
299 "The position where the last export command was created using the dispatcher.
300 This marker will be used with `C-u C-c C-e' to make sure export repetition
301 uses the same subtree if the previous command was restricted to a subtree.")
303 ;; For compatibility with Org < 8
304 (defvar org-export-current-backend nil
305 "Name, if any, of the back-end used during an export process.
307 Its value is a symbol such as `html', `latex', `ascii', or nil if
308 the back-end is anonymous (see `org-export-create-backend') or if
309 there is no export process in progress.
311 It can be used to teach Babel blocks how to act differently
312 according to the back-end used.")
316 ;;; User-configurable Variables
318 ;; Configuration for the masses.
320 ;; They should never be accessed directly, as their value is to be
321 ;; stored in a property list (cf. `org-export-options-alist').
322 ;; Back-ends will read their value from there instead.
324 (defgroup org-export nil
325 "Options for exporting Org mode files."
329 (defgroup org-export-general nil
330 "General options for export engine."
331 :tag
"Org Export General"
334 (defcustom org-export-with-archived-trees
'headline
335 "Whether sub-trees with the ARCHIVE tag should be exported.
337 This can have three different values:
338 nil Do not export, pretend this tree is not present.
339 t Do export the entire tree.
340 `headline' Only export the headline, but skip the tree below it.
342 This option can also be set with the OPTIONS keyword,
344 :group
'org-export-general
346 (const :tag
"Not at all" nil
)
347 (const :tag
"Headline only" headline
)
348 (const :tag
"Entirely" t
)))
350 (defcustom org-export-with-author t
351 "Non-nil means insert author name into the exported file.
352 This option can also be set with the OPTIONS keyword,
353 e.g. \"author:nil\"."
354 :group
'org-export-general
357 (defcustom org-export-with-clocks nil
358 "Non-nil means export CLOCK keywords.
359 This option can also be set with the OPTIONS keyword,
361 :group
'org-export-general
364 (defcustom org-export-with-creator
'comment
365 "Non-nil means the postamble should contain a creator sentence.
367 The sentence can be set in `org-export-creator-string' and
368 defaults to \"Generated by Org mode XX in Emacs XXX.\".
370 If the value is `comment' insert it as a comment."
371 :group
'org-export-general
373 (const :tag
"No creator sentence" nil
)
374 (const :tag
"Sentence as a comment" comment
)
375 (const :tag
"Insert the sentence" t
)))
377 (defcustom org-export-with-date t
378 "Non-nil means insert date in the exported document.
379 This option can also be set with the OPTIONS keyword,
381 :group
'org-export-general
384 (defcustom org-export-date-timestamp-format nil
385 "Time-stamp format string to use for DATE keyword.
387 The format string, when specified, only applies if date consists
388 in a single time-stamp. Otherwise its value will be ignored.
390 See `format-time-string' for details on how to build this
392 :group
'org-export-general
394 (string :tag
"Time-stamp format string")
395 (const :tag
"No format string" nil
)))
397 (defcustom org-export-creator-string
398 (format "Emacs %s (Org mode %s)"
400 (if (fboundp 'org-version
) (org-version) "unknown version"))
401 "Information about the creator of the document.
402 This option can also be set on with the CREATOR keyword."
403 :group
'org-export-general
404 :type
'(string :tag
"Creator string"))
406 (defcustom org-export-with-drawers
'(not "LOGBOOK")
407 "Non-nil means export contents of standard drawers.
409 When t, all drawers are exported. This may also be a list of
410 drawer names to export, as strings. If that list starts with
411 `not', only drawers with such names will be ignored.
413 This variable doesn't apply to properties drawers. See
414 `org-export-with-properties' instead.
416 This option can also be set with the OPTIONS keyword,
418 :group
'org-export-general
420 :package-version
'(Org .
"8.0")
422 (const :tag
"All drawers" t
)
423 (const :tag
"None" nil
)
424 (repeat :tag
"Selected drawers"
425 (string :tag
"Drawer name"))
426 (list :tag
"Ignored drawers"
427 (const :format
"" not
)
428 (repeat :tag
"Specify names of drawers to ignore during export"
430 (string :tag
"Drawer name")))))
432 (defcustom org-export-with-email nil
433 "Non-nil means insert author email into the exported file.
434 This option can also be set with the OPTIONS keyword,
436 :group
'org-export-general
439 (defcustom org-export-with-emphasize t
440 "Non-nil means interpret *word*, /word/, _word_ and +word+.
442 If the export target supports emphasizing text, the word will be
443 typeset in bold, italic, with an underline or strike-through,
446 This option can also be set with the OPTIONS keyword,
448 :group
'org-export-general
451 (defcustom org-export-exclude-tags
'("noexport")
452 "Tags that exclude a tree from export.
454 All trees carrying any of these tags will be excluded from
455 export. This is without condition, so even subtrees inside that
456 carry one of the `org-export-select-tags' will be removed.
458 This option can also be set with the EXCLUDE_TAGS keyword."
459 :group
'org-export-general
460 :type
'(repeat (string :tag
"Tag")))
462 (defcustom org-export-with-fixed-width t
463 "Non-nil means export lines starting with \":\".
464 This option can also be set with the OPTIONS keyword,
466 :group
'org-export-general
468 :package-version
'(Org .
"8.0")
471 (defcustom org-export-with-footnotes t
472 "Non-nil means Org footnotes should be exported.
473 This option can also be set with the OPTIONS keyword,
475 :group
'org-export-general
478 (defcustom org-export-with-latex t
479 "Non-nil means process LaTeX environments and fragments.
481 This option can also be set with the OPTIONS line,
482 e.g. \"tex:verbatim\". Allowed values are:
484 nil Ignore math snippets.
485 `verbatim' Keep everything in verbatim.
486 t Allow export of math snippets."
487 :group
'org-export-general
489 :package-version
'(Org .
"8.0")
491 (const :tag
"Do not process math in any way" nil
)
492 (const :tag
"Interpret math snippets" t
)
493 (const :tag
"Leave math verbatim" verbatim
)))
495 (defcustom org-export-headline-levels
3
496 "The last level which is still exported as a headline.
498 Inferior levels will usually produce itemize or enumerate lists
499 when exported, but back-end behaviour may differ.
501 This option can also be set with the OPTIONS keyword,
503 :group
'org-export-general
506 (defcustom org-export-default-language
"en"
507 "The default language for export and clocktable translations, as a string.
508 This may have an association in
509 `org-clock-clocktable-language-setup',
510 `org-export-smart-quotes-alist' and `org-export-dictionary'.
511 This option can also be set with the LANGUAGE keyword."
512 :group
'org-export-general
513 :type
'(string :tag
"Language"))
515 (defcustom org-export-preserve-breaks nil
516 "Non-nil means preserve all line breaks when exporting.
517 This option can also be set with the OPTIONS keyword,
519 :group
'org-export-general
522 (defcustom org-export-with-entities t
523 "Non-nil means interpret entities when exporting.
525 For example, HTML export converts \\alpha to α and \\AA to
528 For a list of supported names, see the constant `org-entities'
529 and the user option `org-entities-user'.
531 This option can also be set with the OPTIONS keyword,
533 :group
'org-export-general
536 (defcustom org-export-with-inlinetasks t
537 "Non-nil means inlinetasks should be exported.
538 This option can also be set with the OPTIONS keyword,
539 e.g. \"inline:nil\"."
540 :group
'org-export-general
542 :package-version
'(Org .
"8.0")
545 (defcustom org-export-with-planning nil
546 "Non-nil means include planning info in export.
548 Planning info is the line containing either SCHEDULED:,
549 DEADLINE:, CLOSED: time-stamps, or a combination of them.
551 This option can also be set with the OPTIONS keyword,
553 :group
'org-export-general
555 :package-version
'(Org .
"8.0")
558 (defcustom org-export-with-priority nil
559 "Non-nil means include priority cookies in export.
560 This option can also be set with the OPTIONS keyword,
562 :group
'org-export-general
565 (defcustom org-export-with-properties nil
566 "Non-nil means export contents of properties drawers.
568 When t, all properties are exported. This may also be a list of
569 properties to export, as strings.
571 This option can also be set with the OPTIONS keyword,
573 :group
'org-export-general
575 :package-version
'(Org .
"8.3")
577 (const :tag
"All properties" t
)
578 (const :tag
"None" nil
)
579 (repeat :tag
"Selected properties"
580 (string :tag
"Property name"))))
582 (defcustom org-export-with-section-numbers t
583 "Non-nil means add section numbers to headlines when exporting.
585 When set to an integer n, numbering will only happen for
586 headlines whose relative level is higher or equal to n.
588 This option can also be set with the OPTIONS keyword,
590 :group
'org-export-general
593 (defcustom org-export-select-tags
'("export")
594 "Tags that select a tree for export.
596 If any such tag is found in a buffer, all trees that do not carry
597 one of these tags will be ignored during export. Inside trees
598 that are selected like this, you can still deselect a subtree by
599 tagging it with one of the `org-export-exclude-tags'.
601 This option can also be set with the SELECT_TAGS keyword."
602 :group
'org-export-general
603 :type
'(repeat (string :tag
"Tag")))
605 (defcustom org-export-with-smart-quotes nil
606 "Non-nil means activate smart quotes during export.
607 This option can also be set with the OPTIONS keyword,
610 When setting this to non-nil, you need to take care of
611 using the correct Babel package when exporting to LaTeX.
612 E.g., you can load Babel for french like this:
614 #+LATEX_HEADER: \\usepackage[french]{babel}"
615 :group
'org-export-general
617 :package-version
'(Org .
"8.0")
620 (defcustom org-export-with-special-strings t
621 "Non-nil means interpret \"\\-\", \"--\" and \"---\" for export.
623 When this option is turned on, these strings will be exported as:
626 -----+----------+--------+-------
630 ... … \\ldots …
632 This option can also be set with the OPTIONS keyword,
634 :group
'org-export-general
637 (defcustom org-export-with-statistics-cookies t
638 "Non-nil means include statistics cookies in export.
639 This option can also be set with the OPTIONS keyword,
641 :group
'org-export-general
643 :package-version
'(Org .
"8.0")
646 (defcustom org-export-with-sub-superscripts t
647 "Non-nil means interpret \"_\" and \"^\" for export.
649 If you want to control how Org displays those characters, see
650 `org-use-sub-superscripts'. `org-export-with-sub-superscripts'
651 used to be an alias for `org-use-sub-superscripts' in Org <8.0,
654 When this option is turned on, you can use TeX-like syntax for
655 sub- and superscripts and see them exported correctly.
657 You can also set the option with #+OPTIONS: ^:t
659 Several characters after \"_\" or \"^\" will be considered as a
660 single item - so grouping with {} is normally not needed. For
661 example, the following things will be parsed as single sub- or
664 10^24 or 10^tau several digits will be considered 1 item.
665 10^-12 or 10^-tau a leading sign with digits or a word
666 x^2-y^3 will be read as x^2 - y^3, because items are
667 terminated by almost any nonword/nondigit char.
668 x_{i^2} or x^(2-i) braces or parenthesis do grouping.
670 Still, ambiguity is possible. So when in doubt, use {} to enclose
671 the sub/superscript. If you set this variable to the symbol `{}',
672 the braces are *required* in order to trigger interpretations as
673 sub/superscript. This can be helpful in documents that need \"_\"
674 frequently in plain text."
675 :group
'org-export-general
677 :package-version
'(Org .
"8.0")
679 (const :tag
"Interpret them" t
)
680 (const :tag
"Curly brackets only" {})
681 (const :tag
"Do not interpret them" nil
)))
683 (defcustom org-export-with-toc t
684 "Non-nil means create a table of contents in exported files.
686 The TOC contains headlines with levels up
687 to`org-export-headline-levels'. When an integer, include levels
688 up to N in the toc, this may then be different from
689 `org-export-headline-levels', but it will not be allowed to be
690 larger than the number of headline levels. When nil, no table of
693 This option can also be set with the OPTIONS keyword,
694 e.g. \"toc:nil\" or \"toc:3\"."
695 :group
'org-export-general
697 (const :tag
"No Table of Contents" nil
)
698 (const :tag
"Full Table of Contents" t
)
699 (integer :tag
"TOC to level")))
701 (defcustom org-export-with-tables t
702 "Non-nil means export tables.
703 This option can also be set with the OPTIONS keyword,
705 :group
'org-export-general
707 :package-version
'(Org .
"8.0")
710 (defcustom org-export-with-tags t
711 "If nil, do not export tags, just remove them from headlines.
713 If this is the symbol `not-in-toc', tags will be removed from
714 table of contents entries, but still be shown in the headlines of
717 This option can also be set with the OPTIONS keyword,
719 :group
'org-export-general
721 (const :tag
"Off" nil
)
722 (const :tag
"Not in TOC" not-in-toc
)
723 (const :tag
"On" t
)))
725 (defcustom org-export-with-tasks t
726 "Non-nil means include TODO items for export.
728 This may have the following values:
729 t include tasks independent of state.
730 `todo' include only tasks that are not yet done.
731 `done' include only tasks that are already done.
732 nil ignore all tasks.
733 list of keywords include tasks with these keywords.
735 This option can also be set with the OPTIONS keyword,
737 :group
'org-export-general
739 (const :tag
"All tasks" t
)
740 (const :tag
"No tasks" nil
)
741 (const :tag
"Not-done tasks" todo
)
742 (const :tag
"Only done tasks" done
)
743 (repeat :tag
"Specific TODO keywords"
744 (string :tag
"Keyword"))))
746 (defcustom org-export-time-stamp-file t
747 "Non-nil means insert a time stamp into the exported file.
748 The time stamp shows when the file was created. This option can
749 also be set with the OPTIONS keyword, e.g. \"timestamp:nil\"."
750 :group
'org-export-general
753 (defcustom org-export-with-timestamps t
754 "Non nil means allow timestamps in export.
756 It can be set to any of the following values:
757 t export all timestamps.
758 `active' export active timestamps only.
759 `inactive' export inactive timestamps only.
760 nil do not export timestamps
762 This only applies to timestamps isolated in a paragraph
763 containing only timestamps. Other timestamps are always
766 This option can also be set with the OPTIONS keyword, e.g.
768 :group
'org-export-general
770 (const :tag
"All timestamps" t
)
771 (const :tag
"Only active timestamps" active
)
772 (const :tag
"Only inactive timestamps" inactive
)
773 (const :tag
"No timestamp" nil
)))
775 (defcustom org-export-with-todo-keywords t
776 "Non-nil means include TODO keywords in export.
777 When nil, remove all these keywords from the export. This option
778 can also be set with the OPTIONS keyword, e.g. \"todo:nil\"."
779 :group
'org-export-general
782 (defcustom org-export-allow-bind-keywords nil
783 "Non-nil means BIND keywords can define local variable values.
784 This is a potential security risk, which is why the default value
785 is nil. You can also allow them through local buffer variables."
786 :group
'org-export-general
788 :package-version
'(Org .
"8.0")
791 (defcustom org-export-snippet-translation-alist nil
792 "Alist between export snippets back-ends and exporter back-ends.
794 This variable allows to provide shortcuts for export snippets.
796 For example, with a value of '\(\(\"h\" . \"html\"\)\), the
797 HTML back-end will recognize the contents of \"@@h:<b>@@\" as
798 HTML code while every other back-end will ignore it."
799 :group
'org-export-general
801 :package-version
'(Org .
"8.0")
803 (cons (string :tag
"Shortcut")
804 (string :tag
"Back-end"))))
806 (defcustom org-export-coding-system nil
807 "Coding system for the exported file."
808 :group
'org-export-general
810 :package-version
'(Org .
"8.0")
811 :type
'coding-system
)
813 (defcustom org-export-copy-to-kill-ring nil
814 "Non-nil means pushing export output to the kill ring.
815 This variable is ignored during asynchronous export."
816 :group
'org-export-general
818 :package-version
'(Org .
"8.3")
820 (const :tag
"Always" t
)
821 (const :tag
"When export is done interactively" if-interactive
)
822 (const :tag
"Never" nil
)))
824 (defcustom org-export-initial-scope
'buffer
825 "The initial scope when exporting with `org-export-dispatch'.
826 This variable can be either set to `buffer' or `subtree'."
827 :group
'org-export-general
829 (const :tag
"Export current buffer" buffer
)
830 (const :tag
"Export current subtree" subtree
)))
832 (defcustom org-export-show-temporary-export-buffer t
833 "Non-nil means show buffer after exporting to temp buffer.
834 When Org exports to a file, the buffer visiting that file is never
835 shown, but remains buried. However, when exporting to
836 a temporary buffer, that buffer is popped up in a second window.
837 When this variable is nil, the buffer remains buried also in
839 :group
'org-export-general
842 (defcustom org-export-in-background nil
843 "Non-nil means export and publishing commands will run in background.
844 Results from an asynchronous export are never displayed
845 automatically. But you can retrieve them with \\[org-export-stack]."
846 :group
'org-export-general
848 :package-version
'(Org .
"8.0")
851 (defcustom org-export-async-init-file nil
852 "File used to initialize external export process.
854 Value must be either nil or an absolute file name. When nil, the
855 external process is launched like a regular Emacs session,
856 loading user's initialization file and any site specific
857 configuration. If a file is provided, it, and only it, is loaded
860 Therefore, using a specific configuration makes the process to
861 load faster and the export more portable."
862 :group
'org-export-general
864 :package-version
'(Org .
"8.0")
866 (const :tag
"Regular startup" nil
)
867 (file :tag
"Specific start-up file" :must-match t
)))
869 (defcustom org-export-dispatch-use-expert-ui nil
870 "Non-nil means using a non-intrusive `org-export-dispatch'.
871 In that case, no help buffer is displayed. Though, an indicator
872 for current export scope is added to the prompt (\"b\" when
873 output is restricted to body only, \"s\" when it is restricted to
874 the current subtree, \"v\" when only visible elements are
875 considered for export, \"f\" when publishing functions should be
876 passed the FORCE argument and \"a\" when the export should be
877 asynchronous). Also, \[?] allows to switch back to standard
879 :group
'org-export-general
881 :package-version
'(Org .
"8.0")
886 ;;; Defining Back-ends
888 ;; An export back-end is a structure with `org-export-backend' type
889 ;; and `name', `parent', `transcoders', `options', `filters', `blocks'
892 ;; At the lowest level, a back-end is created with
893 ;; `org-export-create-backend' function.
895 ;; A named back-end can be registered with
896 ;; `org-export-register-backend' function. A registered back-end can
897 ;; later be referred to by its name, with `org-export-get-backend'
898 ;; function. Also, such a back-end can become the parent of a derived
899 ;; back-end from which slot values will be inherited by default.
900 ;; `org-export-derived-backend-p' can check if a given back-end is
901 ;; derived from a list of back-end names.
903 ;; `org-export-get-all-transcoders', `org-export-get-all-options' and
904 ;; `org-export-get-all-filters' return the full alist of transcoders,
905 ;; options and filters, including those inherited from ancestors.
907 ;; At a higher level, `org-export-define-backend' is the standard way
908 ;; to define an export back-end. If the new back-end is similar to
909 ;; a registered back-end, `org-export-define-derived-backend' may be
912 ;; Eventually `org-export-barf-if-invalid-backend' returns an error
913 ;; when a given back-end hasn't been registered yet.
915 (defstruct (org-export-backend (:constructor org-export-create-backend
)
917 name parent transcoders options filters blocks menu
)
919 (defun org-export-get-backend (name)
920 "Return export back-end named after NAME.
921 NAME is a symbol. Return nil if no such back-end is found."
923 (dolist (b org-export--registered-backends
)
924 (when (eq (org-export-backend-name b
) name
)
927 (defun org-export-register-backend (backend)
928 "Register BACKEND as a known export back-end.
929 BACKEND is a structure with `org-export-backend' type."
930 ;; Refuse to register an unnamed back-end.
931 (unless (org-export-backend-name backend
)
932 (error "Cannot register a unnamed export back-end"))
933 ;; Refuse to register a back-end with an unknown parent.
934 (let ((parent (org-export-backend-parent backend
)))
935 (when (and parent
(not (org-export-get-backend parent
)))
936 (error "Cannot use unknown \"%s\" back-end as a parent" parent
)))
937 ;; Register dedicated export blocks in the parser.
938 (dolist (name (org-export-backend-blocks backend
))
939 (add-to-list 'org-element-block-name-alist
940 (cons name
'org-element-export-block-parser
)))
941 ;; If a back-end with the same name as BACKEND is already
942 ;; registered, replace it with BACKEND. Otherwise, simply add
943 ;; BACKEND to the list of registered back-ends.
944 (let ((old (org-export-get-backend (org-export-backend-name backend
))))
945 (if old
(setcar (memq old org-export--registered-backends
) backend
)
946 (push backend org-export--registered-backends
))))
948 (defun org-export-barf-if-invalid-backend (backend)
949 "Signal an error if BACKEND isn't defined."
950 (unless (org-export-backend-p backend
)
951 (error "Unknown \"%s\" back-end: Aborting export" backend
)))
953 (defun org-export-derived-backend-p (backend &rest backends
)
954 "Non-nil if BACKEND is derived from one of BACKENDS.
955 BACKEND is an export back-end, as returned by, e.g.,
956 `org-export-create-backend', or a symbol referring to
957 a registered back-end. BACKENDS is constituted of symbols."
958 (when (symbolp backend
) (setq backend
(org-export-get-backend backend
)))
961 (while (org-export-backend-parent backend
)
962 (when (memq (org-export-backend-name backend
) backends
)
965 (org-export-get-backend (org-export-backend-parent backend
))))
966 (memq (org-export-backend-name backend
) backends
))))
968 (defun org-export-get-all-transcoders (backend)
969 "Return full translation table for BACKEND.
971 BACKEND is an export back-end, as return by, e.g,,
972 `org-export-create-backend'. Return value is an alist where
973 keys are element or object types, as symbols, and values are
976 Unlike to `org-export-backend-transcoders', this function
977 also returns transcoders inherited from parent back-ends,
979 (when (symbolp backend
) (setq backend
(org-export-get-backend backend
)))
981 (let ((transcoders (org-export-backend-transcoders backend
))
983 (while (setq parent
(org-export-backend-parent backend
))
984 (setq backend
(org-export-get-backend parent
))
986 (append transcoders
(org-export-backend-transcoders backend
))))
989 (defun org-export-get-all-options (backend)
990 "Return export options for BACKEND.
992 BACKEND is an export back-end, as return by, e.g,,
993 `org-export-create-backend'. See `org-export-options-alist'
994 for the shape of the return value.
996 Unlike to `org-export-backend-options', this function also
997 returns options inherited from parent back-ends, if any."
998 (when (symbolp backend
) (setq backend
(org-export-get-backend backend
)))
1000 (let ((options (org-export-backend-options backend
))
1002 (while (setq parent
(org-export-backend-parent backend
))
1003 (setq backend
(org-export-get-backend parent
))
1004 (setq options
(append options
(org-export-backend-options backend
))))
1007 (defun org-export-get-all-filters (backend)
1008 "Return complete list of filters for BACKEND.
1010 BACKEND is an export back-end, as return by, e.g,,
1011 `org-export-create-backend'. Return value is an alist where
1012 keys are symbols and values lists of functions.
1014 Unlike to `org-export-backend-filters', this function also
1015 returns filters inherited from parent back-ends, if any."
1016 (when (symbolp backend
) (setq backend
(org-export-get-backend backend
)))
1018 (let ((filters (org-export-backend-filters backend
))
1020 (while (setq parent
(org-export-backend-parent backend
))
1021 (setq backend
(org-export-get-backend parent
))
1022 (setq filters
(append filters
(org-export-backend-filters backend
))))
1025 (defun org-export-define-backend (backend transcoders
&rest body
)
1026 "Define a new back-end BACKEND.
1028 TRANSCODERS is an alist between object or element types and
1029 functions handling them.
1031 These functions should return a string without any trailing
1032 space, or nil. They must accept three arguments: the object or
1033 element itself, its contents or nil when it isn't recursive and
1034 the property list used as a communication channel.
1036 Contents, when not nil, are stripped from any global indentation
1037 \(although the relative one is preserved). They also always end
1038 with a single newline character.
1040 If, for a given type, no function is found, that element or
1041 object type will simply be ignored, along with any blank line or
1042 white space at its end. The same will happen if the function
1043 returns the nil value. If that function returns the empty
1044 string, the type will be ignored, but the blank lines or white
1045 spaces will be kept.
1047 In addition to element and object types, one function can be
1048 associated to the `template' (or `inner-template') symbol and
1049 another one to the `plain-text' symbol.
1051 The former returns the final transcoded string, and can be used
1052 to add a preamble and a postamble to document's body. It must
1053 accept two arguments: the transcoded string and the property list
1054 containing export options. A function associated to `template'
1055 will not be applied if export has option \"body-only\".
1056 A function associated to `inner-template' is always applied.
1058 The latter, when defined, is to be called on every text not
1059 recognized as an element or an object. It must accept two
1060 arguments: the text string and the information channel. It is an
1061 appropriate place to protect special chars relative to the
1064 BODY can start with pre-defined keyword arguments. The following
1065 keywords are understood:
1069 String, or list of strings, representing block names that
1070 will not be parsed. This is used to specify blocks that will
1071 contain raw code specific to the back-end. These blocks
1072 still have to be handled by the relative `export-block' type
1077 Alist between filters and function, or list of functions,
1078 specific to the back-end. See `org-export-filters-alist' for
1079 a list of all allowed filters. Filters defined here
1080 shouldn't make a back-end test, as it may prevent back-ends
1081 derived from this one to behave properly.
1085 Menu entry for the export dispatcher. It should be a list
1088 '(KEY DESCRIPTION-OR-ORDINAL ACTION-OR-MENU)
1092 KEY is a free character selecting the back-end.
1094 DESCRIPTION-OR-ORDINAL is either a string or a number.
1096 If it is a string, is will be used to name the back-end in
1097 its menu entry. If it is a number, the following menu will
1098 be displayed as a sub-menu of the back-end with the same
1099 KEY. Also, the number will be used to determine in which
1100 order such sub-menus will appear (lowest first).
1102 ACTION-OR-MENU is either a function or an alist.
1104 If it is an action, it will be called with four
1105 arguments (booleans): ASYNC, SUBTREEP, VISIBLE-ONLY and
1106 BODY-ONLY. See `org-export-as' for further explanations on
1109 If it is an alist, associations should follow the
1112 '(KEY DESCRIPTION ACTION)
1114 where KEY, DESCRIPTION and ACTION are described above.
1116 Valid values include:
1118 '(?m \"My Special Back-end\" my-special-export-function)
1122 '(?l \"Export to LaTeX\"
1123 \(?p \"As PDF file\" org-latex-export-to-pdf)
1124 \(?o \"As PDF file and open\"
1126 \(if a (org-latex-export-to-pdf t s v b)
1128 \(org-latex-export-to-pdf nil s v b)))))))
1130 or the following, which will be added to the previous
1134 \((?B \"As TEX buffer (Beamer)\" org-beamer-export-as-latex)
1135 \(?P \"As PDF file (Beamer)\" org-beamer-export-to-pdf)))
1139 Alist between back-end specific properties introduced in
1140 communication channel and how their value are acquired. See
1141 `org-export-options-alist' for more information about
1142 structure of the values."
1143 (declare (indent 1))
1144 (let (blocks filters menu-entry options contents
)
1145 (while (keywordp (car body
))
1146 (let ((keyword (pop body
)))
1148 (:export-block
(let ((names (pop body
)))
1149 (setq blocks
(if (consp names
) (mapcar 'upcase names
)
1150 (list (upcase names
))))))
1151 (:filters-alist
(setq filters
(pop body
)))
1152 (:menu-entry
(setq menu-entry
(pop body
)))
1153 (:options-alist
(setq options
(pop body
)))
1154 (t (error "Unknown keyword: %s" keyword
)))))
1155 (org-export-register-backend
1156 (org-export-create-backend :name backend
1157 :transcoders transcoders
1161 :menu menu-entry
))))
1163 (defun org-export-define-derived-backend (child parent
&rest body
)
1164 "Create a new back-end as a variant of an existing one.
1166 CHILD is the name of the derived back-end. PARENT is the name of
1167 the parent back-end.
1169 BODY can start with pre-defined keyword arguments. The following
1170 keywords are understood:
1174 String, or list of strings, representing block names that
1175 will not be parsed. This is used to specify blocks that will
1176 contain raw code specific to the back-end. These blocks
1177 still have to be handled by the relative `export-block' type
1182 Alist of filters that will overwrite or complete filters
1183 defined in PARENT back-end. See `org-export-filters-alist'
1184 for a list of allowed filters.
1188 Menu entry for the export dispatcher. See
1189 `org-export-define-backend' for more information about the
1194 Alist of back-end specific properties that will overwrite or
1195 complete those defined in PARENT back-end. Refer to
1196 `org-export-options-alist' for more information about
1197 structure of the values.
1201 Alist of element and object types and transcoders that will
1202 overwrite or complete transcode table from PARENT back-end.
1203 Refer to `org-export-define-backend' for detailed information
1206 As an example, here is how one could define \"my-latex\" back-end
1207 as a variant of `latex' back-end with a custom template function:
1209 \(org-export-define-derived-backend 'my-latex 'latex
1210 :translate-alist '((template . my-latex-template-fun)))
1212 The back-end could then be called with, for example:
1214 \(org-export-to-buffer 'my-latex \"*Test my-latex*\")"
1215 (declare (indent 2))
1216 (let (blocks filters menu-entry options transcoders contents
)
1217 (while (keywordp (car body
))
1218 (let ((keyword (pop body
)))
1220 (:export-block
(let ((names (pop body
)))
1221 (setq blocks
(if (consp names
) (mapcar 'upcase names
)
1222 (list (upcase names
))))))
1223 (:filters-alist
(setq filters
(pop body
)))
1224 (:menu-entry
(setq menu-entry
(pop body
)))
1225 (:options-alist
(setq options
(pop body
)))
1226 (:translate-alist
(setq transcoders
(pop body
)))
1227 (t (error "Unknown keyword: %s" keyword
)))))
1228 (org-export-register-backend
1229 (org-export-create-backend :name child
1231 :transcoders transcoders
1235 :menu menu-entry
))))
1239 ;;; The Communication Channel
1241 ;; During export process, every function has access to a number of
1242 ;; properties. They are of two types:
1244 ;; 1. Environment options are collected once at the very beginning of
1245 ;; the process, out of the original buffer and configuration.
1246 ;; Collecting them is handled by `org-export-get-environment'
1249 ;; Most environment options are defined through the
1250 ;; `org-export-options-alist' variable.
1252 ;; 2. Tree properties are extracted directly from the parsed tree,
1253 ;; just before export, by `org-export-collect-tree-properties'.
1255 ;;;; Environment Options
1257 ;; Environment options encompass all parameters defined outside the
1258 ;; scope of the parsed data. They come from five sources, in
1259 ;; increasing precedence order:
1261 ;; - Global variables,
1262 ;; - Buffer's attributes,
1263 ;; - Options keyword symbols,
1264 ;; - Buffer keywords,
1265 ;; - Subtree properties.
1267 ;; The central internal function with regards to environment options
1268 ;; is `org-export-get-environment'. It updates global variables with
1269 ;; "#+BIND:" keywords, then retrieve and prioritize properties from
1270 ;; the different sources.
1272 ;; The internal functions doing the retrieval are:
1273 ;; `org-export--get-global-options',
1274 ;; `org-export--get-buffer-attributes',
1275 ;; `org-export--parse-option-keyword',
1276 ;; `org-export--get-subtree-options' and
1277 ;; `org-export--get-inbuffer-options'
1279 ;; Also, `org-export--list-bound-variables' collects bound variables
1280 ;; along with their value in order to set them as buffer local
1281 ;; variables later in the process.
1283 (defun org-export-get-environment (&optional backend subtreep ext-plist
)
1284 "Collect export options from the current buffer.
1286 Optional argument BACKEND is an export back-end, as returned by
1287 `org-export-create-backend'.
1289 When optional argument SUBTREEP is non-nil, assume the export is
1290 done against the current sub-tree.
1292 Third optional argument EXT-PLIST is a property list with
1293 external parameters overriding Org default settings, but still
1294 inferior to file-local settings."
1295 ;; First install #+BIND variables since these must be set before
1296 ;; global options are read.
1297 (dolist (pair (org-export--list-bound-variables))
1298 (org-set-local (car pair
) (nth 1 pair
)))
1299 ;; Get and prioritize export options...
1301 ;; ... from global variables...
1302 (org-export--get-global-options backend
)
1303 ;; ... from an external property list...
1305 ;; ... from in-buffer settings...
1306 (org-export--get-inbuffer-options backend
)
1307 ;; ... and from subtree, when appropriate.
1308 (and subtreep
(org-export--get-subtree-options backend
))
1309 ;; Eventually add misc. properties.
1313 :translate-alist
(org-export-get-all-transcoders backend
)
1314 :footnote-definition-alist
1315 ;; Footnotes definitions must be collected in the original
1316 ;; buffer, as there's no insurance that they will still be in
1317 ;; the parse tree, due to possible narrowing.
1319 (org-with-wide-buffer
1320 (goto-char (point-min))
1321 (while (re-search-forward org-footnote-re nil t
)
1323 (let ((fn (save-match-data (org-element-context))))
1324 (case (org-element-type fn
)
1325 (footnote-definition
1327 (cons (org-element-property :label fn
)
1328 (let ((cbeg (org-element-property :contents-begin fn
)))
1330 (org-element--parse-elements
1331 cbeg
(org-element-property :contents-end fn
)
1332 nil nil nil nil
(list 'org-data nil
)))))
1335 (let ((label (org-element-property :label fn
))
1336 (cbeg (org-element-property :contents-begin fn
)))
1337 (when (and label cbeg
1338 (eq (org-element-property :type fn
) 'inline
))
1341 (org-element-parse-secondary-string
1343 cbeg
(org-element-property :contents-end fn
))
1344 (org-element-restriction 'footnote-reference
)))
1348 ;; Collect id references.
1350 (org-with-wide-buffer
1351 (goto-char (point-min))
1352 (while (re-search-forward "\\[\\[id:\\S-+?\\]" nil t
)
1353 (let ((link (org-element-context)))
1354 (when (eq (org-element-type link
) 'link
)
1355 (let* ((id (org-element-property :path link
))
1356 (file (org-id-find-id-file id
)))
1358 (push (cons id
(file-relative-name file
)) alist
)))))))
1361 (defun org-export--parse-option-keyword (options &optional backend
)
1362 "Parse an OPTIONS line and return values as a plist.
1363 Optional argument BACKEND is an export back-end, as returned by,
1364 e.g., `org-export-create-backend'. It specifies which back-end
1365 specific items to read, if any."
1367 ;; Priority is given to back-end specific options.
1368 (append (and backend
(org-export-get-all-options backend
))
1369 org-export-options-alist
))
1371 (dolist (option all
)
1372 (let ((property (car option
))
1373 (item (nth 2 option
)))
1375 (not (plist-member plist property
))
1376 (string-match (concat "\\(\\`\\|[ \t]\\)"
1378 ":\\(([^)\n]+)\\|[^ \t\n\r;,.]*\\)")
1380 (setq plist
(plist-put plist
1382 (car (read-from-string
1383 (match-string 2 options
))))))))
1386 (defun org-export--get-subtree-options (&optional backend
)
1387 "Get export options in subtree at point.
1388 Optional argument BACKEND is an export back-end, as returned by,
1389 e.g., `org-export-create-backend'. It specifies back-end used
1390 for export. Return options as a plist."
1391 ;; For each buffer keyword, create a headline property setting the
1392 ;; same property in communication channel. The name for the property
1393 ;; is the keyword with "EXPORT_" appended to it.
1394 (org-with-wide-buffer
1396 ;; Make sure point is at a heading.
1397 (if (org-at-heading-p) (org-up-heading-safe) (org-back-to-heading t
))
1398 ;; Take care of EXPORT_TITLE. If it isn't defined, use headline's
1399 ;; title (with no todo keyword, priority cookie or tag) as its
1401 (when (setq prop
(or (org-entry-get (point) "EXPORT_TITLE")
1402 (progn (looking-at org-complex-heading-regexp
)
1403 (org-match-string-no-properties 4))))
1407 (org-element-parse-secondary-string
1408 prop
(org-element-restriction 'keyword
)))))
1409 ;; EXPORT_OPTIONS are parsed in a non-standard way.
1410 (when (setq prop
(org-entry-get (point) "EXPORT_OPTIONS"))
1412 (nconc plist
(org-export--parse-option-keyword prop backend
))))
1413 ;; Handle other keywords. TITLE keyword is excluded as it has
1414 ;; been handled already.
1415 (let ((seen '("TITLE")))
1418 (let ((property (car option
))
1419 (keyword (nth 1 option
)))
1420 (when (and keyword
(not (member keyword seen
)))
1421 (let* ((subtree-prop (concat "EXPORT_" keyword
))
1422 ;; Export properties are not case-sensitive.
1423 (value (let ((case-fold-search t
))
1424 (org-entry-get (point) subtree-prop
))))
1426 (when (and value
(not (plist-member plist property
)))
1432 ;; Parse VALUE if required.
1433 ((member keyword org-element-document-properties
)
1434 (org-element-parse-secondary-string
1435 value
(org-element-restriction 'keyword
)))
1436 ;; If BEHAVIOR is `split' expected value is
1437 ;; a list of strings, not a string.
1438 ((eq (nth 4 option
) 'split
) (org-split-string value
))
1440 ;; Look for both general keywords and back-end specific
1441 ;; options, with priority given to the latter.
1442 (append (and backend
(org-export-get-all-options backend
))
1443 org-export-options-alist
)))
1447 (defun org-export--get-inbuffer-options (&optional backend
)
1448 "Return current buffer export options, as a plist.
1450 Optional argument BACKEND, when non-nil, is an export back-end,
1451 as returned by, e.g., `org-export-create-backend'. It specifies
1452 which back-end specific options should also be read in the
1455 Assume buffer is in Org mode. Narrowing, if any, is ignored."
1457 get-options
; For byte-compiler.
1458 (case-fold-search t
)
1460 ;; Priority is given to back-end specific options.
1461 (and backend
(org-export-get-all-options backend
))
1462 org-export-options-alist
))
1463 (regexp (format "^[ \t]*#\\+%s:"
1464 (regexp-opt (nconc (delq nil
(mapcar 'cadr options
))
1465 org-export-special-keywords
))))
1468 ;; Return all properties associated to KEYWORD.
1470 (dolist (option options properties
)
1471 (when (equal (nth 1 option
) keyword
)
1472 (pushnew (car option
) properties
))))))
1474 (lambda (&optional files plist
)
1475 ;; Recursively read keywords in buffer. FILES is a list
1476 ;; of files read so far. PLIST is the current property
1478 (org-with-wide-buffer
1479 (goto-char (point-min))
1480 (while (re-search-forward regexp nil t
)
1481 (let ((element (org-element-at-point)))
1482 (when (eq (org-element-type element
) 'keyword
)
1483 (let ((key (org-element-property :key element
))
1484 (val (org-element-property :value element
)))
1486 ;; Options in `org-export-special-keywords'.
1487 ((equal key
"SETUPFILE")
1488 (let ((file (expand-file-name
1489 (org-remove-double-quotes (org-trim val
)))))
1490 ;; Avoid circular dependencies.
1491 (unless (member file files
)
1493 (insert (org-file-contents file
'noerror
))
1494 (let ((org-inhibit-startup t
)) (org-mode))
1495 (setq plist
(funcall get-options
1496 (cons file files
) plist
))))))
1497 ((equal key
"OPTIONS")
1501 (org-export--parse-option-keyword val backend
))))
1502 ((equal key
"FILETAGS")
1508 (append (org-split-string val
":")
1509 (plist-get plist
:filetags
)))))))
1511 ;; Options in `org-export-options-alist'.
1512 (dolist (property (funcall find-properties key
))
1513 (let ((behaviour (nth 4 (assq property options
))))
1517 ;; Handle value depending on specified
1521 (if (not (plist-get plist property
))
1523 (concat (plist-get plist property
)
1528 (concat (plist-get plist property
)
1531 (split `(,@(plist-get plist property
)
1532 ,@(org-split-string val
)))
1535 (if (not (plist-member plist property
)) val
1536 (plist-get plist property
))))))))))))))
1537 ;; Return final value.
1539 ;; Read options in the current buffer.
1540 (setq plist
(funcall get-options
1541 (and buffer-file-name
(list buffer-file-name
)) nil
))
1542 ;; Parse keywords specified in `org-element-document-properties'
1543 ;; and return PLIST.
1544 (dolist (keyword org-element-document-properties plist
)
1545 (dolist (property (funcall find-properties keyword
))
1546 (let ((value (plist-get plist property
)))
1547 (when (stringp value
)
1549 (plist-put plist property
1550 (org-element-parse-secondary-string
1551 value
(org-element-restriction 'keyword
))))))))))
1553 (defun org-export--get-buffer-attributes ()
1554 "Return properties related to buffer attributes, as a plist."
1555 (list :input-buffer
(buffer-name (buffer-base-buffer))
1556 :input-file
(buffer-file-name (buffer-base-buffer))))
1558 (defun org-export--get-global-options (&optional backend
)
1559 "Return global export options as a plist.
1560 Optional argument BACKEND, if non-nil, is an export back-end, as
1561 returned by, e.g., `org-export-create-backend'. It specifies
1562 which back-end specific export options should also be read in the
1565 ;; Priority is given to back-end specific options.
1566 (all (append (and backend
(org-export-get-all-options backend
))
1567 org-export-options-alist
)))
1568 (dolist (cell all plist
)
1569 (let ((prop (car cell
)))
1570 (unless (plist-member plist prop
)
1575 ;; Evaluate default value provided. If keyword is
1576 ;; a member of `org-element-document-properties',
1577 ;; parse it as a secondary string before storing it.
1578 (let ((value (eval (nth 3 cell
))))
1579 (if (and (stringp value
)
1580 (member (nth 1 cell
)
1581 org-element-document-properties
))
1582 (org-element-parse-secondary-string
1583 value
(org-element-restriction 'keyword
))
1586 (defun org-export--list-bound-variables ()
1587 "Return variables bound from BIND keywords in current buffer.
1588 Also look for BIND keywords in setup files. The return value is
1589 an alist where associations are (VARIABLE-NAME VALUE)."
1590 (when org-export-allow-bind-keywords
1591 (let* (collect-bind ; For byte-compiler.
1593 (lambda (files alist
)
1594 ;; Return an alist between variable names and their
1595 ;; value. FILES is a list of setup files names read so
1596 ;; far, used to avoid circular dependencies. ALIST is
1597 ;; the alist collected so far.
1598 (let ((case-fold-search t
))
1599 (org-with-wide-buffer
1600 (goto-char (point-min))
1601 (while (re-search-forward
1602 "^[ \t]*#\\+\\(BIND\\|SETUPFILE\\):" nil t
)
1603 (let ((element (org-element-at-point)))
1604 (when (eq (org-element-type element
) 'keyword
)
1605 (let ((val (org-element-property :value element
)))
1606 (if (equal (org-element-property :key element
) "BIND")
1607 (push (read (format "(%s)" val
)) alist
)
1608 ;; Enter setup file.
1609 (let ((file (expand-file-name
1610 (org-remove-double-quotes val
))))
1611 (unless (member file files
)
1613 (let ((org-inhibit-startup t
)) (org-mode))
1614 (insert (org-file-contents file
'noerror
))
1616 (funcall collect-bind
1620 ;; Return value in appropriate order of appearance.
1621 (nreverse (funcall collect-bind nil nil
)))))
1623 ;; defsubst org-export-get-parent must be defined before first use,
1624 ;; was originally defined in the topology section
1626 (defsubst org-export-get-parent
(blob)
1627 "Return BLOB parent or nil.
1628 BLOB is the element or object considered."
1629 (org-element-property :parent blob
))
1631 ;;;; Tree Properties
1633 ;; Tree properties are information extracted from parse tree. They
1634 ;; are initialized at the beginning of the transcoding process by
1635 ;; `org-export-collect-tree-properties'.
1637 ;; Dedicated functions focus on computing the value of specific tree
1638 ;; properties during initialization. Thus,
1639 ;; `org-export--populate-ignore-list' lists elements and objects that
1640 ;; should be skipped during export, `org-export--get-min-level' gets
1641 ;; the minimal exportable level, used as a basis to compute relative
1642 ;; level for headlines. Eventually
1643 ;; `org-export--collect-headline-numbering' builds an alist between
1644 ;; headlines and their numbering.
1646 (defun org-export-collect-tree-properties (data info
)
1647 "Extract tree properties from parse tree.
1649 DATA is the parse tree from which information is retrieved. INFO
1650 is a list holding export options.
1652 Following tree properties are set or updated:
1654 `:exported-data' Hash table used to memoize results from
1657 `:footnote-definition-alist' List of footnotes definitions in
1658 original buffer and current parse tree.
1660 `:headline-offset' Offset between true level of headlines and
1661 local level. An offset of -1 means a headline
1662 of level 2 should be considered as a level
1663 1 headline in the context.
1665 `:headline-numbering' Alist of all headlines as key an the
1666 associated numbering as value.
1668 `:ignore-list' List of elements that should be ignored during
1671 Return updated plist."
1672 ;; Install the parse tree in the communication channel, in order to
1673 ;; use `org-export-get-genealogy' and al.
1674 (setq info
(plist-put info
:parse-tree data
))
1675 ;; Get the list of elements and objects to ignore, and put it into
1676 ;; `:ignore-list'. Do not overwrite any user ignore that might have
1677 ;; been done during parse tree filtering.
1681 (append (org-export--populate-ignore-list data info
)
1682 (plist-get info
:ignore-list
))))
1683 ;; Compute `:headline-offset' in order to be able to use
1684 ;; `org-export-get-relative-level'.
1688 (- 1 (org-export--get-min-level data info
))))
1689 ;; Footnote definitions in parse tree override those stored in
1690 ;; `:footnote-definition-alist'. This way, any change to
1691 ;; a definition in the parse tree (e.g., through a parse tree
1692 ;; filter) propagates into the alist.
1693 (let ((defs (plist-get info
:footnote-definition-alist
)))
1694 (org-element-map data
'(footnote-definition footnote-reference
)
1696 (cond ((eq (org-element-type fn
) 'footnote-definition
)
1697 (push (cons (org-element-property :label fn
)
1698 (append '(org-data nil
) (org-element-contents fn
)))
1700 ((eq (org-element-property :type fn
) 'inline
)
1701 (push (cons (org-element-property :label fn
)
1702 (org-element-contents fn
))
1704 (setq info
(plist-put info
:footnote-definition-alist defs
)))
1705 ;; Properties order doesn't matter: get the rest of the tree
1708 `(:headline-numbering
,(org-export--collect-headline-numbering data info
)
1709 :unnumbered-headline-id
,(org-export--collect-unnumbered-headline-id data info
)
1710 :exported-data
,(make-hash-table :test
'eq
:size
4001))
1713 (defun org-export--get-min-level (data options
)
1714 "Return minimum exportable headline's level in DATA.
1715 DATA is parsed tree as returned by `org-element-parse-buffer'.
1716 OPTIONS is a plist holding export options."
1718 (let ((min-level 10000))
1721 (when (and (eq (org-element-type blob
) 'headline
)
1722 (not (org-element-property :footnote-section-p blob
))
1723 (not (memq blob
(plist-get options
:ignore-list
))))
1724 (setq min-level
(min (org-element-property :level blob
) min-level
)))
1725 (when (= min-level
1) (throw 'exit
1)))
1726 (org-element-contents data
))
1727 ;; If no headline was found, for the sake of consistency, set
1728 ;; minimum level to 1 nonetheless.
1729 (if (= min-level
10000) 1 min-level
))))
1731 (defun org-export--collect-headline-numbering (data options
)
1732 "Return numbering of all exportable, numbered headlines in a parse tree.
1734 DATA is the parse tree. OPTIONS is the plist holding export
1737 Return an alist whose key is a headline and value is its
1738 associated numbering \(in the shape of a list of numbers\) or nil
1739 for a footnotes section."
1740 (let ((numbering (make-vector org-export-max-depth
0)))
1741 (org-element-map data
'headline
1743 (when (and (org-export-numbered-headline-p headline options
)
1744 (not (org-element-property :footnote-section-p headline
)))
1745 (let ((relative-level
1746 (1- (org-export-get-relative-level headline options
))))
1749 (loop for n across numbering
1750 for idx from
0 to org-export-max-depth
1751 when
(< idx relative-level
) collect n
1752 when
(= idx relative-level
) collect
(aset numbering idx
(1+ n
))
1753 when
(> idx relative-level
) do
(aset numbering idx
0))))))
1756 (defun org-export--collect-unnumbered-headline-id (data options
)
1757 "Return numbering of all exportable, unnumbered headlines.
1758 DATA is the parse tree. OPTIONS is the plist holding export
1759 options. Unnumbered headlines are numbered as a function of
1762 (org-element-map data
'headline
1764 (unless (org-export-numbered-headline-p headline options
)
1765 (list headline
(incf num
)))))))
1767 (defun org-export--populate-ignore-list (data options
)
1768 "Return list of elements and objects to ignore during export.
1769 DATA is the parse tree to traverse. OPTIONS is the plist holding
1772 ;; First find trees containing a select tag, if any.
1773 (selected (org-export--selected-trees data options
))
1774 ;; If a select tag is active, also ignore the section before
1775 ;; the first headline, if any.
1776 (ignore (and selected
1777 (let ((first-element (car (org-element-contents data
))))
1778 (and (eq (org-element-type first-element
) 'section
)
1782 ;; Collect ignored elements or objects into IGNORE-LIST.
1783 (let ((type (org-element-type data
)))
1784 (if (org-export--skip-p data options selected
) (push data ignore
)
1785 (if (and (eq type
'headline
)
1786 (eq (plist-get options
:with-archived-trees
) 'headline
)
1787 (org-element-property :archivedp data
))
1788 ;; If headline is archived but tree below has
1789 ;; to be skipped, add it to ignore list.
1790 (dolist (element (org-element-contents data
))
1791 (push element ignore
))
1792 ;; Move into secondary string, if any.
1794 (cdr (assq type org-element-secondary-value-alist
))))
1796 (mapc walk-data
(org-element-property sec-prop data
))))
1797 ;; Move into recursive objects/elements.
1798 (mapc walk-data
(org-element-contents data
))))))))
1800 (funcall walk-data data
)
1804 (defun org-export--selected-trees (data info
)
1805 "Return list of headlines and inlinetasks with a select tag in their tree.
1806 DATA is parsed data as returned by `org-element-parse-buffer'.
1807 INFO is a plist holding export options."
1808 (let* (selected-trees
1809 walk-data
; For byte-compiler.
1812 (lambda (data genealogy
)
1813 (let ((type (org-element-type data
)))
1815 ((memq type
'(headline inlinetask
))
1816 (let ((tags (org-element-property :tags data
)))
1817 (if (loop for tag in
(plist-get info
:select-tags
)
1818 thereis
(member tag tags
))
1819 ;; When a select tag is found, mark full
1820 ;; genealogy and every headline within the tree
1822 (setq selected-trees
1825 (org-element-map data
'(headline inlinetask
)
1828 ;; If at a headline, continue searching in tree,
1830 (when (eq type
'headline
)
1832 (funcall walk-data el
(cons data genealogy
)))
1833 (org-element-contents data
))))))
1834 ((or (eq type
'org-data
)
1835 (memq type org-element-greater-elements
))
1836 (mapc (lambda (el) (funcall walk-data el genealogy
))
1837 (org-element-contents data
)))))))))
1838 (funcall walk-data data nil
)
1841 (defun org-export--skip-p (blob options selected
)
1842 "Non-nil when element or object BLOB should be skipped during export.
1843 OPTIONS is the plist holding export options. SELECTED, when
1844 non-nil, is a list of headlines or inlinetasks belonging to
1845 a tree with a select tag."
1846 (case (org-element-type blob
)
1847 (clock (not (plist-get options
:with-clocks
)))
1849 (let ((with-drawers-p (plist-get options
:with-drawers
)))
1850 (or (not with-drawers-p
)
1851 (and (consp with-drawers-p
)
1852 ;; If `:with-drawers' value starts with `not', ignore
1853 ;; every drawer whose name belong to that list.
1854 ;; Otherwise, ignore drawers whose name isn't in that
1856 (let ((name (org-element-property :drawer-name blob
)))
1857 (if (eq (car with-drawers-p
) 'not
)
1858 (member-ignore-case name
(cdr with-drawers-p
))
1859 (not (member-ignore-case name with-drawers-p
))))))))
1860 (fixed-width (not (plist-get options
:with-fixed-width
)))
1861 ((footnote-definition footnote-reference
)
1862 (not (plist-get options
:with-footnotes
)))
1863 ((headline inlinetask
)
1864 (let ((with-tasks (plist-get options
:with-tasks
))
1865 (todo (org-element-property :todo-keyword blob
))
1866 (todo-type (org-element-property :todo-type blob
))
1867 (archived (plist-get options
:with-archived-trees
))
1868 (tags (org-element-property :tags blob
)))
1870 (and (eq (org-element-type blob
) 'inlinetask
)
1871 (not (plist-get options
:with-inlinetasks
)))
1872 ;; Ignore subtrees with an exclude tag.
1873 (loop for k in
(plist-get options
:exclude-tags
)
1874 thereis
(member k tags
))
1875 ;; When a select tag is present in the buffer, ignore any tree
1877 (and selected
(not (memq blob selected
)))
1878 ;; Ignore commented sub-trees.
1879 (org-element-property :commentedp blob
)
1880 ;; Ignore archived subtrees if `:with-archived-trees' is nil.
1881 (and (not archived
) (org-element-property :archivedp blob
))
1882 ;; Ignore tasks, if specified by `:with-tasks' property.
1884 (or (not with-tasks
)
1885 (and (memq with-tasks
'(todo done
))
1886 (not (eq todo-type with-tasks
)))
1887 (and (consp with-tasks
) (not (member todo with-tasks
))))))))
1888 ((latex-environment latex-fragment
) (not (plist-get options
:with-latex
)))
1890 (let ((properties-set (plist-get options
:with-properties
)))
1891 (cond ((null properties-set
) t
)
1892 ((consp properties-set
)
1893 (not (member-ignore-case (org-element-property :key blob
)
1894 properties-set
))))))
1895 (planning (not (plist-get options
:with-planning
)))
1896 (property-drawer (not (plist-get options
:with-properties
)))
1897 (statistics-cookie (not (plist-get options
:with-statistics-cookies
)))
1898 (table (not (plist-get options
:with-tables
)))
1900 (and (org-export-table-has-special-column-p
1901 (org-export-get-parent-table blob
))
1902 (not (org-export-get-previous-element blob options
))))
1903 (table-row (org-export-table-row-is-special-p blob options
))
1905 ;; `:with-timestamps' only applies to isolated timestamps
1906 ;; objects, i.e. timestamp objects in a paragraph containing only
1907 ;; timestamps and whitespaces.
1908 (when (let ((parent (org-export-get-parent-element blob
)))
1909 (and (memq (org-element-type parent
) '(paragraph verse-block
))
1910 (not (org-element-map parent
1912 (remq 'timestamp org-element-all-objects
))
1914 (or (not (stringp obj
)) (org-string-nw-p obj
)))
1916 (case (plist-get options
:with-timestamps
)
1919 (not (memq (org-element-property :type blob
) '(active active-range
))))
1921 (not (memq (org-element-property :type blob
)
1922 '(inactive inactive-range
)))))))))
1927 ;; `org-export-data' reads a parse tree (obtained with, i.e.
1928 ;; `org-element-parse-buffer') and transcodes it into a specified
1929 ;; back-end output. It takes care of filtering out elements or
1930 ;; objects according to export options and organizing the output blank
1931 ;; lines and white space are preserved. The function memoizes its
1932 ;; results, so it is cheap to call it within transcoders.
1934 ;; It is possible to modify locally the back-end used by
1935 ;; `org-export-data' or even use a temporary back-end by using
1936 ;; `org-export-data-with-backend'.
1938 ;; Internally, three functions handle the filtering of objects and
1939 ;; elements during the export. In particular,
1940 ;; `org-export-ignore-element' marks an element or object so future
1941 ;; parse tree traversals skip it and `org-export-expand' transforms
1942 ;; the others back into their original shape.
1944 ;; `org-export-transcoder' is an accessor returning appropriate
1945 ;; translator function for a given element or object.
1947 (defun org-export-transcoder (blob info
)
1948 "Return appropriate transcoder for BLOB.
1949 INFO is a plist containing export directives."
1950 (let ((type (org-element-type blob
)))
1951 ;; Return contents only for complete parse trees.
1952 (if (eq type
'org-data
) (lambda (blob contents info
) contents
)
1953 (let ((transcoder (cdr (assq type
(plist-get info
:translate-alist
)))))
1954 (and (functionp transcoder
) transcoder
)))))
1956 (defun org-export-data (data info
)
1957 "Convert DATA into current back-end format.
1959 DATA is a parse tree, an element or an object or a secondary
1960 string. INFO is a plist holding export options.
1963 (or (gethash data
(plist-get info
:exported-data
))
1964 (let* ((type (org-element-type data
))
1967 ;; Ignored element/object.
1968 ((memq data
(plist-get info
:ignore-list
)) nil
)
1970 ((eq type
'plain-text
)
1971 (org-export-filter-apply-functions
1972 (plist-get info
:filter-plain-text
)
1973 (let ((transcoder (org-export-transcoder data info
)))
1974 (if transcoder
(funcall transcoder data info
) data
))
1976 ;; Secondary string.
1978 (mapconcat (lambda (obj) (org-export-data obj info
)) data
""))
1979 ;; Element/Object without contents or, as a special
1980 ;; case, headline with archive tag and archived trees
1981 ;; restricted to title only.
1982 ((or (not (org-element-contents data
))
1983 (and (eq type
'headline
)
1984 (eq (plist-get info
:with-archived-trees
) 'headline
)
1985 (org-element-property :archivedp data
)))
1986 (let ((transcoder (org-export-transcoder data info
)))
1987 (or (and (functionp transcoder
)
1988 (funcall transcoder data nil info
))
1989 ;; Export snippets never return a nil value so
1990 ;; that white spaces following them are never
1992 (and (eq type
'export-snippet
) ""))))
1993 ;; Element/Object with contents.
1995 (let ((transcoder (org-export-transcoder data info
)))
1997 (let* ((greaterp (memq type org-element-greater-elements
))
2000 (memq type org-element-recursive-objects
)))
2003 (lambda (element) (org-export-data element info
))
2004 (org-element-contents
2005 (if (or greaterp objectp
) data
2006 ;; Elements directly containing
2007 ;; objects must have their indentation
2008 ;; normalized first.
2009 (org-element-normalize-contents
2011 ;; When normalizing contents of the
2012 ;; first paragraph in an item or
2013 ;; a footnote definition, ignore
2014 ;; first line's indentation: there is
2015 ;; none and it might be misleading.
2016 (when (eq type
'paragraph
)
2017 (let ((parent (org-export-get-parent data
)))
2019 (eq (car (org-element-contents parent
))
2021 (memq (org-element-type parent
)
2022 '(footnote-definition item
))))))))
2024 (funcall transcoder data
2025 (if (not greaterp
) contents
2026 (org-element-normalize-string contents
))
2028 ;; Final result will be memoized before being returned.
2033 ((memq type
'(org-data plain-text nil
)) results
)
2034 ;; Append the same white space between elements or objects
2035 ;; as in the original buffer, and call appropriate filters.
2038 (org-export-filter-apply-functions
2039 (plist-get info
(intern (format ":filter-%s" type
)))
2040 (let ((post-blank (or (org-element-property :post-blank data
)
2042 (if (memq type org-element-all-elements
)
2043 (concat (org-element-normalize-string results
)
2044 (make-string post-blank ?
\n))
2045 (concat results
(make-string post-blank ?\s
))))
2048 (plist-get info
:exported-data
)))))
2050 (defun org-export-data-with-backend (data backend info
)
2051 "Convert DATA into BACKEND format.
2053 DATA is an element, an object, a secondary string or a string.
2054 BACKEND is a symbol. INFO is a plist used as a communication
2057 Unlike to `org-export-with-backend', this function will
2058 recursively convert DATA using BACKEND translation table."
2059 (when (symbolp backend
) (setq backend
(org-export-get-backend backend
)))
2062 ;; Set-up a new communication channel with translations defined in
2063 ;; BACKEND as the translate table and a new hash table for
2067 (list :back-end backend
2068 :translate-alist
(org-export-get-all-transcoders backend
)
2069 ;; Size of the hash table is reduced since this function
2070 ;; will probably be used on small trees.
2071 :exported-data
(make-hash-table :test
'eq
:size
401)))))
2073 (defun org-export-remove-uninterpreted-data (data info
)
2074 "Change uninterpreted elements back into Org syntax.
2075 DATA is the parse tree. INFO is a plist containing export
2076 options. Each uninterpreted element or object is changed back
2077 into a string. Contents, if any, are not modified. The parse
2078 tree is modified by side effect and returned by the function."
2079 (org-export--remove-uninterpreted-data-1 data info
)
2080 (dolist (prop '(:author
:date
:title
))
2083 (org-export--remove-uninterpreted-data-1
2084 (plist-get info prop
)
2087 (defun org-export--remove-uninterpreted-data-1 (data info
)
2088 "Change uninterpreted elements back into Org syntax.
2089 DATA is a parse tree or a secondary string. INFO is a plist
2090 containing export options. It is modified by side effect and
2091 returned by the function."
2092 (org-element-map data
2093 '(entity bold italic latex-environment latex-fragment strike-through
2094 subscript superscript underline
)
2097 (case (org-element-type blob
)
2100 (and (not (plist-get info
:with-entities
))
2102 (org-export-expand blob nil
)
2104 (or (org-element-property :post-blank blob
) 0)
2107 ((bold italic strike-through underline
)
2108 (and (not (plist-get info
:with-emphasize
))
2109 (let ((marker (case (org-element-type blob
)
2112 (strike-through "+")
2116 (org-element-contents blob
)
2120 (or (org-element-property :post-blank blob
)
2123 ;; ... LaTeX environments and fragments...
2124 ((latex-environment latex-fragment
)
2125 (and (eq (plist-get info
:with-latex
) 'verbatim
)
2126 (list (org-export-expand blob nil
))))
2127 ;; ... sub/superscripts...
2128 ((subscript superscript
)
2129 (let ((sub/super-p
(plist-get info
:with-sub-superscript
))
2130 (bracketp (org-element-property :use-brackets-p blob
)))
2131 (and (or (not sub
/super-p
)
2132 (and (eq sub
/super-p
'{}) (not bracketp
)))
2135 (if (eq (org-element-type blob
) 'subscript
)
2138 (and bracketp
"{")))
2139 (org-element-contents blob
)
2142 (and (org-element-property :post-blank blob
)
2144 (org-element-property :post-blank blob
)
2147 ;; Splice NEW at BLOB location in parse tree.
2148 (dolist (e new
(org-element-extract-element blob
))
2149 (unless (string= e
"") (org-element-insert-before e blob
))))))
2151 ;; Return modified parse tree.
2154 (defun org-export-expand (blob contents
&optional with-affiliated
)
2155 "Expand a parsed element or object to its original state.
2157 BLOB is either an element or an object. CONTENTS is its
2158 contents, as a string or nil.
2160 When optional argument WITH-AFFILIATED is non-nil, add affiliated
2161 keywords before output."
2162 (let ((type (org-element-type blob
)))
2163 (concat (and with-affiliated
(memq type org-element-all-elements
)
2164 (org-element--interpret-affiliated-keywords blob
))
2165 (funcall (intern (format "org-element-%s-interpreter" type
))
2168 (defun org-export-ignore-element (element info
)
2169 "Add ELEMENT to `:ignore-list' in INFO.
2171 Any element in `:ignore-list' will be skipped when using
2172 `org-element-map'. INFO is modified by side effects."
2173 (plist-put info
:ignore-list
(cons element
(plist-get info
:ignore-list
))))
2177 ;;; The Filter System
2179 ;; Filters allow end-users to tweak easily the transcoded output.
2180 ;; They are the functional counterpart of hooks, as every filter in
2181 ;; a set is applied to the return value of the previous one.
2183 ;; Every set is back-end agnostic. Although, a filter is always
2184 ;; called, in addition to the string it applies to, with the back-end
2185 ;; used as argument, so it's easy for the end-user to add back-end
2186 ;; specific filters in the set. The communication channel, as
2187 ;; a plist, is required as the third argument.
2189 ;; From the developer side, filters sets can be installed in the
2190 ;; process with the help of `org-export-define-backend', which
2191 ;; internally stores filters as an alist. Each association has a key
2192 ;; among the following symbols and a function or a list of functions
2195 ;; - `:filter-options' applies to the property list containing export
2196 ;; options. Unlike to other filters, functions in this list accept
2197 ;; two arguments instead of three: the property list containing
2198 ;; export options and the back-end. Users can set its value through
2199 ;; `org-export-filter-options-functions' variable.
2201 ;; - `:filter-parse-tree' applies directly to the complete parsed
2202 ;; tree. Users can set it through
2203 ;; `org-export-filter-parse-tree-functions' variable.
2205 ;; - `:filter-body' applies to the body of the output, before template
2206 ;; translator chimes in. Users can set it through
2207 ;; `org-export-filter-body-functions' variable.
2209 ;; - `:filter-final-output' applies to the final transcoded string.
2210 ;; Users can set it with `org-export-filter-final-output-functions'
2213 ;; - `:filter-plain-text' applies to any string not recognized as Org
2214 ;; syntax. `org-export-filter-plain-text-functions' allows users to
2217 ;; - `:filter-TYPE' applies on the string returned after an element or
2218 ;; object of type TYPE has been transcoded. A user can modify
2219 ;; `org-export-filter-TYPE-functions' to install these filters.
2221 ;; All filters sets are applied with
2222 ;; `org-export-filter-apply-functions' function. Filters in a set are
2223 ;; applied in a LIFO fashion. It allows developers to be sure that
2224 ;; their filters will be applied first.
2226 ;; Filters properties are installed in communication channel with
2227 ;; `org-export-install-filters' function.
2229 ;; Eventually, two hooks (`org-export-before-processing-hook' and
2230 ;; `org-export-before-parsing-hook') are run at the beginning of the
2231 ;; export process and just before parsing to allow for heavy structure
2237 (defvar org-export-before-processing-hook nil
2238 "Hook run at the beginning of the export process.
2240 This is run before include keywords and macros are expanded and
2241 Babel code blocks executed, on a copy of the original buffer
2242 being exported. Visibility and narrowing are preserved. Point
2243 is at the beginning of the buffer.
2245 Every function in this hook will be called with one argument: the
2246 back-end currently used, as a symbol.")
2248 (defvar org-export-before-parsing-hook nil
2249 "Hook run before parsing an export buffer.
2251 This is run after include keywords and macros have been expanded
2252 and Babel code blocks executed, on a copy of the original buffer
2253 being exported. Visibility and narrowing are preserved. Point
2254 is at the beginning of the buffer.
2256 Every function in this hook will be called with one argument: the
2257 back-end currently used, as a symbol.")
2260 ;;;; Special Filters
2262 (defvar org-export-filter-options-functions nil
2263 "List of functions applied to the export options.
2264 Each filter is called with two arguments: the export options, as
2265 a plist, and the back-end, as a symbol. It must return
2266 a property list containing export options.")
2268 (defvar org-export-filter-parse-tree-functions nil
2269 "List of functions applied to the parsed tree.
2270 Each filter is called with three arguments: the parse tree, as
2271 returned by `org-element-parse-buffer', the back-end, as
2272 a symbol, and the communication channel, as a plist. It must
2273 return the modified parse tree to transcode.")
2275 (defvar org-export-filter-plain-text-functions nil
2276 "List of functions applied to plain text.
2277 Each filter is called with three arguments: a string which
2278 contains no Org syntax, the back-end, as a symbol, and the
2279 communication channel, as a plist. It must return a string or
2282 (defvar org-export-filter-body-functions nil
2283 "List of functions applied to transcoded body.
2284 Each filter is called with three arguments: a string which
2285 contains no Org syntax, the back-end, as a symbol, and the
2286 communication channel, as a plist. It must return a string or
2289 (defvar org-export-filter-final-output-functions nil
2290 "List of functions applied to the transcoded string.
2291 Each filter is called with three arguments: the full transcoded
2292 string, the back-end, as a symbol, and the communication channel,
2293 as a plist. It must return a string that will be used as the
2294 final export output.")
2297 ;;;; Elements Filters
2299 (defvar org-export-filter-babel-call-functions nil
2300 "List of functions applied to a transcoded babel-call.
2301 Each filter is called with three arguments: the transcoded data,
2302 as a string, the back-end, as a symbol, and the communication
2303 channel, as a plist. It must return a string or nil.")
2305 (defvar org-export-filter-center-block-functions nil
2306 "List of functions applied to a transcoded center block.
2307 Each filter is called with three arguments: the transcoded data,
2308 as a string, the back-end, as a symbol, and the communication
2309 channel, as a plist. It must return a string or nil.")
2311 (defvar org-export-filter-clock-functions nil
2312 "List of functions applied to a transcoded clock.
2313 Each filter is called with three arguments: the transcoded data,
2314 as a string, the back-end, as a symbol, and the communication
2315 channel, as a plist. It must return a string or nil.")
2317 (defvar org-export-filter-comment-functions nil
2318 "List of functions applied to a transcoded comment.
2319 Each filter is called with three arguments: the transcoded data,
2320 as a string, the back-end, as a symbol, and the communication
2321 channel, as a plist. It must return a string or nil.")
2323 (defvar org-export-filter-comment-block-functions nil
2324 "List of functions applied to a transcoded comment-block.
2325 Each filter is called with three arguments: the transcoded data,
2326 as a string, the back-end, as a symbol, and the communication
2327 channel, as a plist. It must return a string or nil.")
2329 (defvar org-export-filter-diary-sexp-functions nil
2330 "List of functions applied to a transcoded diary-sexp.
2331 Each filter is called with three arguments: the transcoded data,
2332 as a string, the back-end, as a symbol, and the communication
2333 channel, as a plist. It must return a string or nil.")
2335 (defvar org-export-filter-drawer-functions nil
2336 "List of functions applied to a transcoded drawer.
2337 Each filter is called with three arguments: the transcoded data,
2338 as a string, the back-end, as a symbol, and the communication
2339 channel, as a plist. It must return a string or nil.")
2341 (defvar org-export-filter-dynamic-block-functions nil
2342 "List of functions applied to a transcoded dynamic-block.
2343 Each filter is called with three arguments: the transcoded data,
2344 as a string, the back-end, as a symbol, and the communication
2345 channel, as a plist. It must return a string or nil.")
2347 (defvar org-export-filter-example-block-functions nil
2348 "List of functions applied to a transcoded example-block.
2349 Each filter is called with three arguments: the transcoded data,
2350 as a string, the back-end, as a symbol, and the communication
2351 channel, as a plist. It must return a string or nil.")
2353 (defvar org-export-filter-export-block-functions nil
2354 "List of functions applied to a transcoded export-block.
2355 Each filter is called with three arguments: the transcoded data,
2356 as a string, the back-end, as a symbol, and the communication
2357 channel, as a plist. It must return a string or nil.")
2359 (defvar org-export-filter-fixed-width-functions nil
2360 "List of functions applied to a transcoded fixed-width.
2361 Each filter is called with three arguments: the transcoded data,
2362 as a string, the back-end, as a symbol, and the communication
2363 channel, as a plist. It must return a string or nil.")
2365 (defvar org-export-filter-footnote-definition-functions nil
2366 "List of functions applied to a transcoded footnote-definition.
2367 Each filter is called with three arguments: the transcoded data,
2368 as a string, the back-end, as a symbol, and the communication
2369 channel, as a plist. It must return a string or nil.")
2371 (defvar org-export-filter-headline-functions nil
2372 "List of functions applied to a transcoded headline.
2373 Each filter is called with three arguments: the transcoded data,
2374 as a string, the back-end, as a symbol, and the communication
2375 channel, as a plist. It must return a string or nil.")
2377 (defvar org-export-filter-horizontal-rule-functions nil
2378 "List of functions applied to a transcoded horizontal-rule.
2379 Each filter is called with three arguments: the transcoded data,
2380 as a string, the back-end, as a symbol, and the communication
2381 channel, as a plist. It must return a string or nil.")
2383 (defvar org-export-filter-inlinetask-functions nil
2384 "List of functions applied to a transcoded inlinetask.
2385 Each filter is called with three arguments: the transcoded data,
2386 as a string, the back-end, as a symbol, and the communication
2387 channel, as a plist. It must return a string or nil.")
2389 (defvar org-export-filter-item-functions nil
2390 "List of functions applied to a transcoded item.
2391 Each filter is called with three arguments: the transcoded data,
2392 as a string, the back-end, as a symbol, and the communication
2393 channel, as a plist. It must return a string or nil.")
2395 (defvar org-export-filter-keyword-functions nil
2396 "List of functions applied to a transcoded keyword.
2397 Each filter is called with three arguments: the transcoded data,
2398 as a string, the back-end, as a symbol, and the communication
2399 channel, as a plist. It must return a string or nil.")
2401 (defvar org-export-filter-latex-environment-functions nil
2402 "List of functions applied to a transcoded latex-environment.
2403 Each filter is called with three arguments: the transcoded data,
2404 as a string, the back-end, as a symbol, and the communication
2405 channel, as a plist. It must return a string or nil.")
2407 (defvar org-export-filter-node-property-functions nil
2408 "List of functions applied to a transcoded node-property.
2409 Each filter is called with three arguments: the transcoded data,
2410 as a string, the back-end, as a symbol, and the communication
2411 channel, as a plist. It must return a string or nil.")
2413 (defvar org-export-filter-paragraph-functions nil
2414 "List of functions applied to a transcoded paragraph.
2415 Each filter is called with three arguments: the transcoded data,
2416 as a string, the back-end, as a symbol, and the communication
2417 channel, as a plist. It must return a string or nil.")
2419 (defvar org-export-filter-plain-list-functions nil
2420 "List of functions applied to a transcoded plain-list.
2421 Each filter is called with three arguments: the transcoded data,
2422 as a string, the back-end, as a symbol, and the communication
2423 channel, as a plist. It must return a string or nil.")
2425 (defvar org-export-filter-planning-functions nil
2426 "List of functions applied to a transcoded planning.
2427 Each filter is called with three arguments: the transcoded data,
2428 as a string, the back-end, as a symbol, and the communication
2429 channel, as a plist. It must return a string or nil.")
2431 (defvar org-export-filter-property-drawer-functions nil
2432 "List of functions applied to a transcoded property-drawer.
2433 Each filter is called with three arguments: the transcoded data,
2434 as a string, the back-end, as a symbol, and the communication
2435 channel, as a plist. It must return a string or nil.")
2437 (defvar org-export-filter-quote-block-functions nil
2438 "List of functions applied to a transcoded quote block.
2439 Each filter is called with three arguments: the transcoded quote
2440 data, as a string, the back-end, as a symbol, and the
2441 communication channel, as a plist. It must return a string or
2444 (defvar org-export-filter-section-functions nil
2445 "List of functions applied to a transcoded section.
2446 Each filter is called with three arguments: the transcoded data,
2447 as a string, the back-end, as a symbol, and the communication
2448 channel, as a plist. It must return a string or nil.")
2450 (defvar org-export-filter-special-block-functions nil
2451 "List of functions applied to a transcoded special block.
2452 Each filter is called with three arguments: the transcoded data,
2453 as a string, the back-end, as a symbol, and the communication
2454 channel, as a plist. It must return a string or nil.")
2456 (defvar org-export-filter-src-block-functions nil
2457 "List of functions applied to a transcoded src-block.
2458 Each filter is called with three arguments: the transcoded data,
2459 as a string, the back-end, as a symbol, and the communication
2460 channel, as a plist. It must return a string or nil.")
2462 (defvar org-export-filter-table-functions nil
2463 "List of functions applied to a transcoded table.
2464 Each filter is called with three arguments: the transcoded data,
2465 as a string, the back-end, as a symbol, and the communication
2466 channel, as a plist. It must return a string or nil.")
2468 (defvar org-export-filter-table-cell-functions nil
2469 "List of functions applied to a transcoded table-cell.
2470 Each filter is called with three arguments: the transcoded data,
2471 as a string, the back-end, as a symbol, and the communication
2472 channel, as a plist. It must return a string or nil.")
2474 (defvar org-export-filter-table-row-functions nil
2475 "List of functions applied to a transcoded table-row.
2476 Each filter is called with three arguments: the transcoded data,
2477 as a string, the back-end, as a symbol, and the communication
2478 channel, as a plist. It must return a string or nil.")
2480 (defvar org-export-filter-verse-block-functions nil
2481 "List of functions applied to a transcoded verse block.
2482 Each filter is called with three arguments: the transcoded data,
2483 as a string, the back-end, as a symbol, and the communication
2484 channel, as a plist. It must return a string or nil.")
2487 ;;;; Objects Filters
2489 (defvar org-export-filter-bold-functions nil
2490 "List of functions applied to transcoded bold text.
2491 Each filter is called with three arguments: the transcoded data,
2492 as a string, the back-end, as a symbol, and the communication
2493 channel, as a plist. It must return a string or nil.")
2495 (defvar org-export-filter-code-functions nil
2496 "List of functions applied to transcoded code text.
2497 Each filter is called with three arguments: the transcoded data,
2498 as a string, the back-end, as a symbol, and the communication
2499 channel, as a plist. It must return a string or nil.")
2501 (defvar org-export-filter-entity-functions nil
2502 "List of functions applied to a transcoded entity.
2503 Each filter is called with three arguments: the transcoded data,
2504 as a string, the back-end, as a symbol, and the communication
2505 channel, as a plist. It must return a string or nil.")
2507 (defvar org-export-filter-export-snippet-functions nil
2508 "List of functions applied to a transcoded export-snippet.
2509 Each filter is called with three arguments: the transcoded data,
2510 as a string, the back-end, as a symbol, and the communication
2511 channel, as a plist. It must return a string or nil.")
2513 (defvar org-export-filter-footnote-reference-functions nil
2514 "List of functions applied to a transcoded footnote-reference.
2515 Each filter is called with three arguments: the transcoded data,
2516 as a string, the back-end, as a symbol, and the communication
2517 channel, as a plist. It must return a string or nil.")
2519 (defvar org-export-filter-inline-babel-call-functions nil
2520 "List of functions applied to a transcoded inline-babel-call.
2521 Each filter is called with three arguments: the transcoded data,
2522 as a string, the back-end, as a symbol, and the communication
2523 channel, as a plist. It must return a string or nil.")
2525 (defvar org-export-filter-inline-src-block-functions nil
2526 "List of functions applied to a transcoded inline-src-block.
2527 Each filter is called with three arguments: the transcoded data,
2528 as a string, the back-end, as a symbol, and the communication
2529 channel, as a plist. It must return a string or nil.")
2531 (defvar org-export-filter-italic-functions nil
2532 "List of functions applied to transcoded italic text.
2533 Each filter is called with three arguments: the transcoded data,
2534 as a string, the back-end, as a symbol, and the communication
2535 channel, as a plist. It must return a string or nil.")
2537 (defvar org-export-filter-latex-fragment-functions nil
2538 "List of functions applied to a transcoded latex-fragment.
2539 Each filter is called with three arguments: the transcoded data,
2540 as a string, the back-end, as a symbol, and the communication
2541 channel, as a plist. It must return a string or nil.")
2543 (defvar org-export-filter-line-break-functions nil
2544 "List of functions applied to a transcoded line-break.
2545 Each filter is called with three arguments: the transcoded data,
2546 as a string, the back-end, as a symbol, and the communication
2547 channel, as a plist. It must return a string or nil.")
2549 (defvar org-export-filter-link-functions nil
2550 "List of functions applied to a transcoded link.
2551 Each filter is called with three arguments: the transcoded data,
2552 as a string, the back-end, as a symbol, and the communication
2553 channel, as a plist. It must return a string or nil.")
2555 (defvar org-export-filter-radio-target-functions nil
2556 "List of functions applied to a transcoded radio-target.
2557 Each filter is called with three arguments: the transcoded data,
2558 as a string, the back-end, as a symbol, and the communication
2559 channel, as a plist. It must return a string or nil.")
2561 (defvar org-export-filter-statistics-cookie-functions nil
2562 "List of functions applied to a transcoded statistics-cookie.
2563 Each filter is called with three arguments: the transcoded data,
2564 as a string, the back-end, as a symbol, and the communication
2565 channel, as a plist. It must return a string or nil.")
2567 (defvar org-export-filter-strike-through-functions nil
2568 "List of functions applied to transcoded strike-through text.
2569 Each filter is called with three arguments: the transcoded data,
2570 as a string, the back-end, as a symbol, and the communication
2571 channel, as a plist. It must return a string or nil.")
2573 (defvar org-export-filter-subscript-functions nil
2574 "List of functions applied to a transcoded subscript.
2575 Each filter is called with three arguments: the transcoded data,
2576 as a string, the back-end, as a symbol, and the communication
2577 channel, as a plist. It must return a string or nil.")
2579 (defvar org-export-filter-superscript-functions nil
2580 "List of functions applied to a transcoded superscript.
2581 Each filter is called with three arguments: the transcoded data,
2582 as a string, the back-end, as a symbol, and the communication
2583 channel, as a plist. It must return a string or nil.")
2585 (defvar org-export-filter-target-functions nil
2586 "List of functions applied to a transcoded target.
2587 Each filter is called with three arguments: the transcoded data,
2588 as a string, the back-end, as a symbol, and the communication
2589 channel, as a plist. It must return a string or nil.")
2591 (defvar org-export-filter-timestamp-functions nil
2592 "List of functions applied to a transcoded timestamp.
2593 Each filter is called with three arguments: the transcoded data,
2594 as a string, the back-end, as a symbol, and the communication
2595 channel, as a plist. It must return a string or nil.")
2597 (defvar org-export-filter-underline-functions nil
2598 "List of functions applied to transcoded underline text.
2599 Each filter is called with three arguments: the transcoded data,
2600 as a string, the back-end, as a symbol, and the communication
2601 channel, as a plist. It must return a string or nil.")
2603 (defvar org-export-filter-verbatim-functions nil
2604 "List of functions applied to transcoded verbatim text.
2605 Each filter is called with three arguments: the transcoded data,
2606 as a string, the back-end, as a symbol, and the communication
2607 channel, as a plist. It must return a string or nil.")
2612 ;; Internal function `org-export-install-filters' installs filters
2613 ;; hard-coded in back-ends (developer filters) and filters from global
2614 ;; variables (user filters) in the communication channel.
2616 ;; Internal function `org-export-filter-apply-functions' takes care
2617 ;; about applying each filter in order to a given data. It ignores
2618 ;; filters returning a nil value but stops whenever a filter returns
2621 (defun org-export-filter-apply-functions (filters value info
)
2622 "Call every function in FILTERS.
2624 Functions are called with arguments VALUE, current export
2625 back-end's name and INFO. A function returning a nil value will
2626 be skipped. If it returns the empty string, the process ends and
2629 Call is done in a LIFO fashion, to be sure that developer
2630 specified filters, if any, are called first."
2632 (let* ((backend (plist-get info
:back-end
))
2633 (backend-name (and backend
(org-export-backend-name backend
))))
2634 (dolist (filter filters value
)
2635 (let ((result (funcall filter value backend-name info
)))
2636 (cond ((not result
) value
)
2637 ((equal value
"") (throw 'exit nil
))
2638 (t (setq value result
))))))))
2640 (defun org-export-install-filters (info)
2641 "Install filters properties in communication channel.
2642 INFO is a plist containing the current communication channel.
2643 Return the updated communication channel."
2645 ;; Install user-defined filters with `org-export-filters-alist'
2646 ;; and filters already in INFO (through ext-plist mechanism).
2648 (let* ((prop (car p
))
2649 (info-value (plist-get info prop
))
2650 (default-value (symbol-value (cdr p
))))
2652 (plist-put plist prop
2653 ;; Filters in INFO will be called
2654 ;; before those user provided.
2655 (append (if (listp info-value
) info-value
2658 org-export-filters-alist
)
2659 ;; Prepend back-end specific filters to that list.
2661 ;; Single values get consed, lists are appended.
2662 (let ((key (car p
)) (value (cdr p
)))
2667 (if (atom value
) (cons value
(plist-get plist key
))
2668 (append value
(plist-get plist key
))))))))
2669 (org-export-get-all-filters (plist-get info
:back-end
)))
2670 ;; Return new communication channel.
2671 (org-combine-plists info plist
)))
2677 ;; This is the room for the main function, `org-export-as', along with
2678 ;; its derivative, `org-export-string-as'.
2679 ;; `org-export--copy-to-kill-ring-p' determines if output of these
2680 ;; function should be added to kill ring.
2682 ;; Note that `org-export-as' doesn't really parse the current buffer,
2683 ;; but a copy of it (with the same buffer-local variables and
2684 ;; visibility), where macros and include keywords are expanded and
2685 ;; Babel blocks are executed, if appropriate.
2686 ;; `org-export-with-buffer-copy' macro prepares that copy.
2688 ;; File inclusion is taken care of by
2689 ;; `org-export-expand-include-keyword' and
2690 ;; `org-export--prepare-file-contents'. Structure wise, including
2691 ;; a whole Org file in a buffer often makes little sense. For
2692 ;; example, if the file contains a headline and the include keyword
2693 ;; was within an item, the item should contain the headline. That's
2694 ;; why file inclusion should be done before any structure can be
2695 ;; associated to the file, that is before parsing.
2697 ;; `org-export-insert-default-template' is a command to insert
2698 ;; a default template (or a back-end specific template) at point or in
2701 (defun org-export-copy-buffer ()
2702 "Return a copy of the current buffer.
2703 The copy preserves Org buffer-local variables, visibility and
2705 (let ((copy-buffer-fun (org-export--generate-copy-script (current-buffer)))
2706 (new-buf (generate-new-buffer (buffer-name))))
2707 (with-current-buffer new-buf
2708 (funcall copy-buffer-fun
)
2709 (set-buffer-modified-p nil
))
2712 (defmacro org-export-with-buffer-copy
(&rest body
)
2713 "Apply BODY in a copy of the current buffer.
2714 The copy preserves local variables, visibility and contents of
2715 the original buffer. Point is at the beginning of the buffer
2716 when BODY is applied."
2718 (org-with-gensyms (buf-copy)
2719 `(let ((,buf-copy
(org-export-copy-buffer)))
2721 (with-current-buffer ,buf-copy
2722 (goto-char (point-min))
2724 (and (buffer-live-p ,buf-copy
)
2725 ;; Kill copy without confirmation.
2726 (progn (with-current-buffer ,buf-copy
2727 (restore-buffer-modified-p nil
))
2728 (kill-buffer ,buf-copy
)))))))
2730 (defun org-export--generate-copy-script (buffer)
2731 "Generate a function duplicating BUFFER.
2733 The copy will preserve local variables, visibility, contents and
2734 narrowing of the original buffer. If a region was active in
2735 BUFFER, contents will be narrowed to that region instead.
2737 The resulting function can be evaluated at a later time, from
2738 another buffer, effectively cloning the original buffer there.
2740 The function assumes BUFFER's major mode is `org-mode'."
2741 (with-current-buffer buffer
2743 (let ((inhibit-modification-hooks t
))
2744 ;; Set major mode. Ignore `org-mode-hook' as it has been run
2745 ;; already in BUFFER.
2746 (let ((org-mode-hook nil
) (org-inhibit-startup t
)) (org-mode))
2747 ;; Copy specific buffer local variables and variables set
2748 ;; through BIND keywords.
2749 ,@(let ((bound-variables (org-export--list-bound-variables))
2751 (dolist (entry (buffer-local-variables (buffer-base-buffer)) vars
)
2753 (let ((var (car entry
))
2755 (and (not (memq var org-export-ignored-local-variables
))
2759 buffer-file-coding-system
))
2760 (assq var bound-variables
)
2761 (string-match "^\\(org-\\|orgtbl-\\)"
2763 ;; Skip unreadable values, as they cannot be
2764 ;; sent to external process.
2765 (or (not val
) (ignore-errors (read (format "%S" val
))))
2766 (push `(set (make-local-variable (quote ,var
))
2769 ;; Whole buffer contents.
2771 ,(org-with-wide-buffer
2772 (buffer-substring-no-properties
2773 (point-min) (point-max))))
2775 ,(if (org-region-active-p)
2776 `(narrow-to-region ,(region-beginning) ,(region-end))
2777 `(narrow-to-region ,(point-min) ,(point-max)))
2778 ;; Current position of point.
2779 (goto-char ,(point))
2780 ;; Overlays with invisible property.
2784 (let ((invis-prop (overlay-get ov
'invisible
)))
2787 (make-overlay ,(overlay-start ov
)
2789 'invisible
(quote ,invis-prop
))
2791 (overlays-in (point-min) (point-max)))
2795 (defun org-export-as
2796 (backend &optional subtreep visible-only body-only ext-plist
)
2797 "Transcode current Org buffer into BACKEND code.
2799 BACKEND is either an export back-end, as returned by, e.g.,
2800 `org-export-create-backend', or a symbol referring to
2801 a registered back-end.
2803 If narrowing is active in the current buffer, only transcode its
2806 If a region is active, transcode that region.
2808 When optional argument SUBTREEP is non-nil, transcode the
2809 sub-tree at point, extracting information from the headline
2812 When optional argument VISIBLE-ONLY is non-nil, don't export
2813 contents of hidden elements.
2815 When optional argument BODY-ONLY is non-nil, only return body
2816 code, without surrounding template.
2818 Optional argument EXT-PLIST, when provided, is a property list
2819 with external parameters overriding Org default settings, but
2820 still inferior to file-local settings.
2822 Return code as a string."
2823 (when (symbolp backend
) (setq backend
(org-export-get-backend backend
)))
2824 (org-export-barf-if-invalid-backend backend
)
2827 ;; Narrow buffer to an appropriate region or subtree for
2828 ;; parsing. If parsing subtree, be sure to remove main headline
2830 (cond ((org-region-active-p)
2831 (narrow-to-region (region-beginning) (region-end)))
2833 (org-narrow-to-subtree)
2834 (goto-char (point-min))
2836 (narrow-to-region (point) (point-max))))
2837 ;; Initialize communication channel with original buffer
2838 ;; attributes, unavailable in its copy.
2839 (let* ((org-export-current-backend (org-export-backend-name backend
))
2840 (info (org-combine-plists
2841 (list :export-options
2843 (list (and subtreep
'subtree
)
2844 (and visible-only
'visible-only
)
2845 (and body-only
'body-only
))))
2846 (org-export--get-buffer-attributes)))
2848 ;; Update communication channel and get parse tree. Buffer
2849 ;; isn't parsed directly. Instead, a temporary copy is
2850 ;; created, where include keywords, macros are expanded and
2851 ;; code blocks are evaluated.
2852 (org-export-with-buffer-copy
2853 ;; Run first hook with current back-end's name as argument.
2854 (run-hook-with-args 'org-export-before-processing-hook
2855 (org-export-backend-name backend
))
2856 (org-export-expand-include-keyword)
2857 ;; Update macro templates since #+INCLUDE keywords might have
2858 ;; added some new ones.
2859 (org-macro-initialize-templates)
2860 (org-macro-replace-all org-macro-templates
)
2861 (org-export-execute-babel-code)
2862 ;; Update radio targets since keyword inclusion might have
2864 (org-update-radio-target-regexp)
2865 ;; Run last hook with current back-end's name as argument.
2866 (goto-char (point-min))
2868 (run-hook-with-args 'org-export-before-parsing-hook
2869 (org-export-backend-name backend
)))
2870 ;; Update communication channel with environment. Also
2871 ;; install user's and developer's filters.
2873 (org-export-install-filters
2875 info
(org-export-get-environment backend subtreep ext-plist
))))
2876 ;; Expand export-specific set of macros: {{{author}}},
2877 ;; {{{date}}}, {{{email}}} and {{{title}}}. It must be done
2878 ;; once regular macros have been expanded, since document
2879 ;; keywords may contain one of them.
2880 (org-macro-replace-all
2881 (list (cons "author"
2882 (org-element-interpret-data (plist-get info
:author
)))
2884 (org-element-interpret-data (plist-get info
:date
)))
2885 ;; EMAIL is not a parsed keyword: store it as-is.
2886 (cons "email" (or (plist-get info
:email
) ""))
2888 (org-element-interpret-data (plist-get info
:title
))))
2891 (setq tree
(org-element-parse-buffer nil visible-only
))
2892 ;; Handle left-over uninterpreted elements or objects in
2893 ;; parse tree and communication channel.
2894 (org-export-remove-uninterpreted-data tree info
)
2895 ;; Call options filters and update export options. We do not
2896 ;; use `org-export-filter-apply-functions' here since the
2897 ;; arity of such filters is different.
2898 (let ((backend-name (org-export-backend-name backend
)))
2899 (dolist (filter (plist-get info
:filter-options
))
2900 (let ((result (funcall filter info backend-name
)))
2901 (when result
(setq info result
)))))
2902 ;; Parse buffer, handle uninterpreted elements or objects,
2903 ;; then call parse-tree filters.
2905 (org-export-filter-apply-functions
2906 (plist-get info
:filter-parse-tree
) tree info
))
2907 ;; Now tree is complete, compute its properties and add them
2908 ;; to communication channel.
2911 info
(org-export-collect-tree-properties tree info
)))
2912 ;; Eventually transcode TREE. Wrap the resulting string into
2914 (let* ((body (org-element-normalize-string
2915 (or (org-export-data tree info
) "")))
2916 (inner-template (cdr (assq 'inner-template
2917 (plist-get info
:translate-alist
))))
2918 (full-body (org-export-filter-apply-functions
2919 (plist-get info
:filter-body
)
2920 (if (not (functionp inner-template
)) body
2921 (funcall inner-template body info
))
2923 (template (cdr (assq 'template
2924 (plist-get info
:translate-alist
)))))
2925 ;; Remove all text properties since they cannot be
2926 ;; retrieved from an external process. Finally call
2927 ;; final-output filter and return result.
2929 (org-export-filter-apply-functions
2930 (plist-get info
:filter-final-output
)
2931 (if (or (not (functionp template
)) body-only
) full-body
2932 (funcall template full-body info
))
2936 (defun org-export-string-as (string backend
&optional body-only ext-plist
)
2937 "Transcode STRING into BACKEND code.
2939 BACKEND is either an export back-end, as returned by, e.g.,
2940 `org-export-create-backend', or a symbol referring to
2941 a registered back-end.
2943 When optional argument BODY-ONLY is non-nil, only return body
2944 code, without preamble nor postamble.
2946 Optional argument EXT-PLIST, when provided, is a property list
2947 with external parameters overriding Org default settings, but
2948 still inferior to file-local settings.
2950 Return code as a string."
2953 (let ((org-inhibit-startup t
)) (org-mode))
2954 (org-export-as backend nil nil body-only ext-plist
)))
2957 (defun org-export-replace-region-by (backend)
2958 "Replace the active region by its export to BACKEND.
2959 BACKEND is either an export back-end, as returned by, e.g.,
2960 `org-export-create-backend', or a symbol referring to
2961 a registered back-end."
2962 (if (not (org-region-active-p))
2963 (user-error "No active region to replace")
2964 (let* ((beg (region-beginning))
2966 (str (buffer-substring beg end
)) rpl
)
2967 (setq rpl
(org-export-string-as str backend t
))
2968 (delete-region beg end
)
2972 (defun org-export-insert-default-template (&optional backend subtreep
)
2973 "Insert all export keywords with default values at beginning of line.
2975 BACKEND is a symbol referring to the name of a registered export
2976 back-end, for which specific export options should be added to
2977 the template, or `default' for default template. When it is nil,
2978 the user will be prompted for a category.
2980 If SUBTREEP is non-nil, export configuration will be set up
2981 locally for the subtree through node properties."
2983 (unless (derived-mode-p 'org-mode
) (user-error "Not in an Org mode buffer"))
2984 (when (and subtreep
(org-before-first-heading-p))
2985 (user-error "No subtree to set export options for"))
2986 (let ((node (and subtreep
(save-excursion (org-back-to-heading t
) (point))))
2990 (org-completing-read
2991 "Options category: "
2993 (mapcar #'(lambda (b)
2994 (symbol-name (org-export-backend-name b
)))
2995 org-export--registered-backends
))
2998 ;; Populate OPTIONS and KEYWORDS.
2999 (dolist (entry (cond ((eq backend
'default
) org-export-options-alist
)
3000 ((org-export-backend-p backend
)
3001 (org-export-backend-options backend
))
3002 (t (org-export-backend-options
3003 (org-export-get-backend backend
)))))
3004 (let ((keyword (nth 1 entry
))
3005 (option (nth 2 entry
)))
3007 (keyword (unless (assoc keyword keywords
)
3009 (if (eq (nth 4 entry
) 'split
)
3010 (mapconcat #'identity
(eval (nth 3 entry
)) " ")
3011 (eval (nth 3 entry
)))))
3012 (push (cons keyword value
) keywords
))))
3013 (option (unless (assoc option options
)
3014 (push (cons option
(eval (nth 3 entry
))) options
))))))
3015 ;; Move to an appropriate location in order to insert options.
3016 (unless subtreep
(beginning-of-line))
3017 ;; First (multiple) OPTIONS lines. Never go past fill-column.
3021 #'(lambda (opt) (format "%s:%S" (car opt
) (cdr opt
)))
3022 (sort options
(lambda (k1 k2
) (string< (car k1
) (car k2
)))))))
3025 node
"EXPORT_OPTIONS" (mapconcat 'identity items
" "))
3027 (insert "#+OPTIONS:")
3030 (< (+ width
(length (car items
)) 1) fill-column
))
3031 (let ((item (pop items
)))
3033 (incf width
(1+ (length item
))))))
3035 ;; Then the rest of keywords, in the order specified in either
3036 ;; `org-export-options-alist' or respective export back-ends.
3037 (dolist (key (nreverse keywords
))
3038 (let ((val (cond ((equal (car key
) "DATE")
3041 (org-insert-time-stamp (current-time)))))
3042 ((equal (car key
) "TITLE")
3043 (or (let ((visited-file
3044 (buffer-file-name (buffer-base-buffer))))
3046 (file-name-sans-extension
3047 (file-name-nondirectory visited-file
))))
3048 (buffer-name (buffer-base-buffer))))
3050 (if subtreep
(org-entry-put node
(concat "EXPORT_" (car key
)) val
)
3054 (if (org-string-nw-p val
) (format " %s" val
) ""))))))))
3056 (defun org-export-expand-include-keyword (&optional included dir
)
3057 "Expand every include keyword in buffer.
3058 Optional argument INCLUDED is a list of included file names along
3059 with their line restriction, when appropriate. It is used to
3060 avoid infinite recursion. Optional argument DIR is the current
3061 working directory. It is used to properly resolve relative
3063 (let ((case-fold-search t
)
3064 (file-prefix (make-hash-table :test
#'equal
))
3066 (goto-char (point-min))
3067 (while (re-search-forward "^[ \t]*#\\+INCLUDE:" nil t
)
3068 (let ((element (save-match-data (org-element-at-point))))
3069 (when (eq (org-element-type element
) 'keyword
)
3071 ;; Extract arguments from keyword's value.
3072 (let* ((value (org-element-property :value element
))
3073 (ind (org-get-indentation))
3075 (file (and (string-match
3076 "^\\(\".+?\"\\|\\S-+\\)\\(?:\\s-+\\|$\\)" value
)
3079 (let ((matched (match-string 1 value
)))
3080 (when (string-match "\\(::\\(.*?\\)\\)\"?\\'" matched
)
3081 (setq location
(match-string 2 matched
))
3083 (replace-match "" nil nil matched
1)))
3085 (org-remove-double-quotes
3088 (setq value
(replace-match "" nil nil value
)))))
3090 (and (string-match ":only-contents *\\([^: \r\t\n]\\S-*\\)?" value
)
3091 (prog1 (org-not-nil (match-string 1 value
))
3092 (setq value
(replace-match "" nil nil value
)))))
3095 ":lines +\"\\(\\(?:[0-9]+\\)?-\\(?:[0-9]+\\)?\\)\""
3097 (prog1 (match-string 1 value
)
3098 (setq value
(replace-match "" nil nil value
)))))
3099 (env (cond ((string-match "\\<example\\>" value
)
3101 ((string-match "\\<src\\(?: +\\(.*\\)\\)?" value
)
3103 ;; Minimal level of included file defaults to the child
3104 ;; level of the current headline, if any, or one. It
3105 ;; only applies is the file is meant to be included as
3109 (if (string-match ":minlevel +\\([0-9]+\\)" value
)
3110 (prog1 (string-to-number (match-string 1 value
))
3111 (setq value
(replace-match "" nil nil value
)))
3112 (let ((cur (org-current-level)))
3113 (if cur
(1+ (org-reduced-level cur
)) 1)))))
3114 (src-args (and (eq env
'literal
)
3115 (match-string 1 value
)))
3116 (block (and (string-match "\\<\\(\\S-+\\)\\>" value
)
3117 (match-string 1 value
))))
3119 (delete-region (point) (progn (forward-line) (point)))
3122 ((not (file-readable-p file
))
3123 (error "Cannot include file %s" file
))
3124 ;; Check if files has already been parsed. Look after
3125 ;; inclusion lines too, as different parts of the same file
3126 ;; can be included too.
3127 ((member (list file lines
) included
)
3128 (error "Recursive file inclusion: %s" file
))
3133 (let ((ind-str (make-string ind ?
))
3134 (arg-str (if (stringp src-args
)
3135 (format " %s" src-args
)
3138 (org-escape-code-in-string
3139 (org-export--prepare-file-contents file lines
))))
3140 (format "%s#+BEGIN_%s%s\n%s%s#+END_%s\n"
3141 ind-str block arg-str contents ind-str block
))))
3144 (let ((ind-str (make-string ind ?
))
3146 (org-export--prepare-file-contents file lines
)))
3147 (format "%s#+BEGIN_%s\n%s%s#+END_%s\n"
3148 ind-str block contents ind-str block
))))
3152 (let ((org-inhibit-startup t
)
3155 (org-export--inclusion-absolute-lines
3156 file location only-contents lines
)
3160 (org-export--prepare-file-contents
3161 file lines ind minlevel
3162 (or (gethash file file-prefix
)
3163 (puthash file
(incf current-prefix
) file-prefix
)))))
3164 (org-export-expand-include-keyword
3165 (cons (list file lines
) included
)
3166 (file-name-directory file
))
3167 (buffer-string)))))))))))))
3169 (defun org-export--inclusion-absolute-lines (file location only-contents lines
)
3170 "Resolve absolute lines for an included file with file-link.
3172 FILE is string file-name of the file to include. LOCATION is a
3173 string name within FILE to be included (located via
3174 `org-link-search'). If ONLY-CONTENTS is non-nil only the
3175 contents of the named element will be included, as determined
3176 Org-Element. If LINES is non-nil only those lines are included.
3178 Return a string of lines to be included in the format expected by
3179 `org-export--prepare-file-contents'."
3181 (insert-file-contents file
)
3182 (unless (eq major-mode
'org-mode
)
3183 (let ((org-inhibit-startup t
)) (org-mode)))
3185 ;; Enforce consistent search.
3186 (let ((org-link-search-must-match-exact-headline t
))
3187 (org-link-search location
))
3189 (error (format "%s for %s::%s" (error-message-string err
) file location
))))
3190 (let* ((element (org-element-at-point))
3192 (and only-contents
(org-element-property :contents-begin element
))))
3194 (or contents-begin
(org-element-property :begin element
))
3195 (org-element-property (if contents-begin
:contents-end
:end
) element
))
3196 (when (and only-contents
3197 (memq (org-element-type element
) '(headline inlinetask
)))
3198 ;; Skip planning line and property-drawer.
3199 (goto-char (point-min))
3200 (when (org-looking-at-p org-planning-line-re
) (forward-line))
3201 (when (looking-at org-property-drawer-re
) (goto-char (match-end 0)))
3202 (unless (bolp) (forward-line))
3203 (narrow-to-region (point) (point-max))))
3205 (org-skip-whitespace)
3207 (let* ((lines (split-string lines
"-"))
3208 (lbeg (string-to-number (car lines
)))
3209 (lend (string-to-number (cadr lines
)))
3210 (beg (if (zerop lbeg
) (point-min)
3211 (goto-char (point-min))
3212 (forward-line (1- lbeg
))
3214 (end (if (zerop lend
) (point-max)
3216 (forward-line (1- lend
))
3218 (narrow-to-region beg end
)))
3219 (let ((end (point-max)))
3220 (goto-char (point-min))
3222 (let ((start-line (line-number-at-pos)))
3228 (while (< (point) end
) (incf counter
) (forward-line))
3231 (defun org-export--prepare-file-contents (file &optional lines ind minlevel id
)
3232 "Prepare the contents of FILE for inclusion and return them as a string.
3234 When optional argument LINES is a string specifying a range of
3235 lines, include only those lines.
3237 Optional argument IND, when non-nil, is an integer specifying the
3238 global indentation of returned contents. Since its purpose is to
3239 allow an included file to stay in the same environment it was
3240 created \(i.e. a list item), it doesn't apply past the first
3241 headline encountered.
3243 Optional argument MINLEVEL, when non-nil, is an integer
3244 specifying the level that any top-level headline in the included
3247 Optional argument ID is an integer that will be inserted before
3248 each footnote definition and reference if FILE is an Org file.
3249 This is useful to avoid conflicts when more than one Org file
3250 with footnotes is included in a document."
3252 (insert-file-contents file
)
3254 (let* ((lines (split-string lines
"-"))
3255 (lbeg (string-to-number (car lines
)))
3256 (lend (string-to-number (cadr lines
)))
3257 (beg (if (zerop lbeg
) (point-min)
3258 (goto-char (point-min))
3259 (forward-line (1- lbeg
))
3261 (end (if (zerop lend
) (point-max)
3262 (goto-char (point-min))
3263 (forward-line (1- lend
))
3265 (narrow-to-region beg end
)))
3266 ;; Remove blank lines at beginning and end of contents. The logic
3267 ;; behind that removal is that blank lines around include keyword
3268 ;; override blank lines in included file.
3269 (goto-char (point-min))
3270 (org-skip-whitespace)
3272 (delete-region (point-min) (point))
3273 (goto-char (point-max))
3274 (skip-chars-backward " \r\t\n")
3276 (delete-region (point) (point-max))
3277 ;; If IND is set, preserve indentation of include keyword until
3278 ;; the first headline encountered.
3280 (unless (eq major-mode
'org-mode
)
3281 (let ((org-inhibit-startup t
)) (org-mode)))
3282 (goto-char (point-min))
3283 (let ((ind-str (make-string ind ?
)))
3284 (while (not (or (eobp) (looking-at org-outline-regexp-bol
)))
3285 ;; Do not move footnote definitions out of column 0.
3286 (unless (and (looking-at org-footnote-definition-re
)
3287 (eq (org-element-type (org-element-at-point))
3288 'footnote-definition
))
3291 ;; When MINLEVEL is specified, compute minimal level for headlines
3292 ;; in the file (CUR-MIN), and remove stars to each headline so
3293 ;; that headlines with minimal level have a level of MINLEVEL.
3295 (unless (eq major-mode
'org-mode
)
3296 (let ((org-inhibit-startup t
)) (org-mode)))
3297 (org-with-limited-levels
3298 (let ((levels (org-map-entries
3299 (lambda () (org-reduced-level (org-current-level))))))
3301 (let ((offset (- minlevel
(apply 'min levels
))))
3302 (unless (zerop offset
)
3303 (when org-odd-levels-only
(setq offset
(* offset
2)))
3304 ;; Only change stars, don't bother moving whole
3307 (lambda () (if (< offset
0) (delete-char (abs offset
))
3308 (insert (make-string offset ?
*)))))))))))
3309 ;; Append ID to all footnote references and definitions, so they
3310 ;; become file specific and cannot collide with footnotes in other
3313 (goto-char (point-min))
3314 (while (re-search-forward org-footnote-re nil t
)
3315 (let ((reference (org-element-context)))
3316 (when (memq (org-element-type reference
)
3317 '(footnote-reference footnote-definition
))
3318 (goto-char (org-element-property :begin reference
))
3320 (let ((label (org-element-property :label reference
)))
3322 ((org-string-match-p "\\`[0-9]+\\'" label
)
3323 (insert (format "fn:%d-" id
)))
3324 (t (forward-char 3) (insert (format "%d-" id
)))))))))
3325 (org-element-normalize-string (buffer-string))))
3327 (defun org-export-execute-babel-code ()
3328 "Execute every Babel code in the visible part of current buffer."
3329 ;; Get a pristine copy of current buffer so Babel references can be
3330 ;; properly resolved.
3331 (let ((reference (org-export-copy-buffer)))
3332 (unwind-protect (org-babel-exp-process-buffer reference
)
3333 (kill-buffer reference
))))
3335 (defun org-export--copy-to-kill-ring-p ()
3336 "Return a non-nil value when output should be added to the kill ring.
3337 See also `org-export-copy-to-kill-ring'."
3338 (if (eq org-export-copy-to-kill-ring
'if-interactive
)
3339 (not (or executing-kbd-macro noninteractive
))
3340 (eq org-export-copy-to-kill-ring t
)))
3344 ;;; Tools For Back-Ends
3346 ;; A whole set of tools is available to help build new exporters. Any
3347 ;; function general enough to have its use across many back-ends
3348 ;; should be added here.
3350 ;;;; For Affiliated Keywords
3352 ;; `org-export-read-attribute' reads a property from a given element
3353 ;; as a plist. It can be used to normalize affiliated keywords'
3356 ;; Since captions can span over multiple lines and accept dual values,
3357 ;; their internal representation is a bit tricky. Therefore,
3358 ;; `org-export-get-caption' transparently returns a given element's
3359 ;; caption as a secondary string.
3361 (defun org-export-read-attribute (attribute element
&optional property
)
3362 "Turn ATTRIBUTE property from ELEMENT into a plist.
3364 When optional argument PROPERTY is non-nil, return the value of
3365 that property within attributes.
3367 This function assumes attributes are defined as \":keyword
3368 value\" pairs. It is appropriate for `:attr_html' like
3371 All values will become strings except the empty string and
3372 \"nil\", which will become nil. Also, values containing only
3373 double quotes will be read as-is, which means that \"\" value
3374 will become the empty string."
3375 (let* ((prepare-value
3378 (cond ((member str
'(nil "" "nil")) nil
)
3379 ((string-match "^\"\\(\"+\\)?\"$" str
)
3380 (or (match-string 1 str
) ""))
3383 (let ((value (org-element-property attribute element
)))
3385 (let ((s (mapconcat 'identity value
" ")) result
)
3386 (while (string-match
3387 "\\(?:^\\|[ \t]+\\)\\(:[-a-zA-Z0-9_]+\\)\\([ \t]+\\|$\\)"
3389 (let ((value (substring s
0 (match-beginning 0))))
3390 (push (funcall prepare-value value
) result
))
3391 (push (intern (match-string 1 s
)) result
)
3392 (setq s
(substring s
(match-end 0))))
3393 ;; Ignore any string before first property with `cdr'.
3394 (cdr (nreverse (cons (funcall prepare-value s
) result
))))))))
3395 (if property
(plist-get attributes property
) attributes
)))
3397 (defun org-export-get-caption (element &optional shortp
)
3398 "Return caption from ELEMENT as a secondary string.
3400 When optional argument SHORTP is non-nil, return short caption,
3401 as a secondary string, instead.
3403 Caption lines are separated by a white space."
3404 (let ((full-caption (org-element-property :caption element
)) caption
)
3405 (dolist (line full-caption
(cdr caption
))
3406 (let ((cap (funcall (if shortp
'cdr
'car
) line
)))
3408 (setq caption
(nconc (list " ") (copy-sequence cap
) caption
)))))))
3411 ;;;; For Derived Back-ends
3413 ;; `org-export-with-backend' is a function allowing to locally use
3414 ;; another back-end to transcode some object or element. In a derived
3415 ;; back-end, it may be used as a fall-back function once all specific
3416 ;; cases have been treated.
3418 (defun org-export-with-backend (backend data
&optional contents info
)
3419 "Call a transcoder from BACKEND on DATA.
3420 BACKEND is an export back-end, as returned by, e.g.,
3421 `org-export-create-backend', or a symbol referring to
3422 a registered back-end. DATA is an Org element, object, secondary
3423 string or string. CONTENTS, when non-nil, is the transcoded
3424 contents of DATA element, as a string. INFO, when non-nil, is
3425 the communication channel used for export, as a plist."
3426 (when (symbolp backend
) (setq backend
(org-export-get-backend backend
)))
3427 (org-export-barf-if-invalid-backend backend
)
3428 (let ((type (org-element-type data
)))
3429 (if (memq type
'(nil org-data
)) (error "No foreign transcoder available")
3430 (let* ((all-transcoders (org-export-get-all-transcoders backend
))
3431 (transcoder (cdr (assq type all-transcoders
))))
3432 (if (not (functionp transcoder
))
3433 (error "No foreign transcoder available")
3435 transcoder data contents
3437 info
(list :back-end backend
3438 :translate-alist all-transcoders
3439 :exported-data
(make-hash-table :test
'eq
:size
401)))))))))
3442 ;;;; For Export Snippets
3444 ;; Every export snippet is transmitted to the back-end. Though, the
3445 ;; latter will only retain one type of export-snippet, ignoring
3446 ;; others, based on the former's target back-end. The function
3447 ;; `org-export-snippet-backend' returns that back-end for a given
3450 (defun org-export-snippet-backend (export-snippet)
3451 "Return EXPORT-SNIPPET targeted back-end as a symbol.
3452 Translation, with `org-export-snippet-translation-alist', is
3454 (let ((back-end (org-element-property :back-end export-snippet
)))
3456 (or (cdr (assoc back-end org-export-snippet-translation-alist
))
3462 ;; `org-export-collect-footnote-definitions' is a tool to list
3463 ;; actually used footnotes definitions in the whole parse tree, or in
3464 ;; a headline, in order to add footnote listings throughout the
3467 ;; `org-export-footnote-first-reference-p' is a predicate used by some
3468 ;; back-ends, when they need to attach the footnote definition only to
3469 ;; the first occurrence of the corresponding label.
3471 ;; `org-export-get-footnote-definition' and
3472 ;; `org-export-get-footnote-number' provide easier access to
3473 ;; additional information relative to a footnote reference.
3475 (defun org-export-collect-footnote-definitions (data info
)
3476 "Return an alist between footnote numbers, labels and definitions.
3478 DATA is the parse tree from which definitions are collected.
3479 INFO is the plist used as a communication channel.
3481 Definitions are sorted by order of references. They either
3482 appear as Org data or as a secondary string for inlined
3483 footnotes. Unreferenced definitions are ignored."
3485 collect-fn
; for byte-compiler.
3489 ;; Collect footnote number, label and definition in DATA.
3490 (org-element-map data
'footnote-reference
3492 (when (org-export-footnote-first-reference-p fn info
)
3493 (let ((def (org-export-get-footnote-definition fn info
)))
3495 (list (org-export-get-footnote-number fn info
)
3496 (org-element-property :label fn
)
3499 ;; Also search in definition for nested footnotes.
3500 (when (eq (org-element-property :type fn
) 'standard
)
3501 (funcall collect-fn def
)))))
3502 ;; Don't enter footnote definitions since it will happen
3503 ;; when their first reference is found.
3504 info nil
'footnote-definition
)))))
3505 (funcall collect-fn
(plist-get info
:parse-tree
))
3506 (reverse num-alist
)))
3508 (defun org-export-footnote-first-reference-p (footnote-reference info
)
3509 "Non-nil when a footnote reference is the first one for its label.
3511 FOOTNOTE-REFERENCE is the footnote reference being considered.
3512 INFO is the plist used as a communication channel."
3513 (let ((label (org-element-property :label footnote-reference
)))
3514 ;; Anonymous footnotes are always a first reference.
3516 ;; Otherwise, return the first footnote with the same LABEL and
3517 ;; test if it is equal to FOOTNOTE-REFERENCE.
3518 (let* (search-refs ; for byte-compiler.
3522 (org-element-map data
'footnote-reference
3525 ((string= (org-element-property :label fn
) label
)
3527 ;; If FN isn't inlined, be sure to traverse its
3528 ;; definition before resuming search. See
3529 ;; comments in `org-export-get-footnote-number'
3530 ;; for more information.
3531 ((eq (org-element-property :type fn
) 'standard
)
3532 (funcall search-refs
3533 (org-export-get-footnote-definition fn info
)))))
3534 ;; Don't enter footnote definitions since it will
3535 ;; happen when their first reference is found.
3536 info
'first-match
'footnote-definition
)))))
3537 (eq (catch 'exit
(funcall search-refs
(plist-get info
:parse-tree
)))
3538 footnote-reference
)))))
3540 (defun org-export-get-footnote-definition (footnote-reference info
)
3541 "Return definition of FOOTNOTE-REFERENCE as parsed data.
3542 INFO is the plist used as a communication channel. If no such
3543 definition can be found, raise an error."
3544 (let ((label (org-element-property :label footnote-reference
)))
3546 (cdr (assoc label
(plist-get info
:footnote-definition-alist
)))
3547 (org-element-contents footnote-reference
))
3548 (error "Definition not found for footnote %s" label
))))
3550 (defun org-export-get-footnote-number (footnote info
)
3551 "Return number associated to a footnote.
3553 FOOTNOTE is either a footnote reference or a footnote definition.
3554 INFO is the plist used as a communication channel."
3555 (let* ((label (org-element-property :label footnote
))
3557 search-ref
; For byte-compiler.
3561 ;; Search footnote references through DATA, filling
3562 ;; SEEN-REFS along the way.
3563 (org-element-map data
'footnote-reference
3565 (let ((fn-lbl (org-element-property :label fn
)))
3567 ;; Anonymous footnote match: return number.
3568 ((and (not fn-lbl
) (eq fn footnote
))
3569 (throw 'exit
(1+ (length seen-refs
))))
3570 ;; Labels match: return number.
3571 ((and label
(string= label fn-lbl
))
3572 (throw 'exit
(1+ (length seen-refs
))))
3573 ;; Anonymous footnote: it's always a new one.
3574 ;; Also, be sure to return nil from the `cond' so
3575 ;; `first-match' doesn't get us out of the loop.
3576 ((not fn-lbl
) (push 'inline seen-refs
) nil
)
3577 ;; Label not seen so far: add it so SEEN-REFS.
3579 ;; Also search for subsequent references in
3580 ;; footnote definition so numbering follows
3581 ;; reading logic. Note that we don't have to care
3582 ;; about inline definitions, since
3583 ;; `org-element-map' already traverses them at the
3586 ;; Once again, return nil to stay in the loop.
3587 ((not (member fn-lbl seen-refs
))
3588 (push fn-lbl seen-refs
)
3590 (org-export-get-footnote-definition fn info
))
3592 ;; Don't enter footnote definitions since it will
3593 ;; happen when their first reference is found.
3594 info
'first-match
'footnote-definition
)))))
3595 (catch 'exit
(funcall search-ref
(plist-get info
:parse-tree
)))))
3600 ;; `org-export-get-relative-level' is a shortcut to get headline
3601 ;; level, relatively to the lower headline level in the parsed tree.
3603 ;; `org-export-get-headline-number' returns the section number of an
3604 ;; headline, while `org-export-number-to-roman' allows to convert it
3605 ;; to roman numbers. With an optional argument,
3606 ;; `org-export-get-headline-number' returns a number to unnumbered
3607 ;; headlines (used for internal id).
3609 ;; `org-export-get-headline-id' returns the unique internal id of a
3612 ;; `org-export-low-level-p', `org-export-first-sibling-p' and
3613 ;; `org-export-last-sibling-p' are three useful predicates when it
3614 ;; comes to fulfill the `:headline-levels' property.
3616 ;; `org-export-get-tags', `org-export-get-category' and
3617 ;; `org-export-get-node-property' extract useful information from an
3618 ;; headline or a parent headline. They all handle inheritance.
3620 ;; `org-export-get-alt-title' tries to retrieve an alternative title,
3621 ;; as a secondary string, suitable for table of contents. It falls
3622 ;; back onto default title.
3624 (defun org-export-get-relative-level (headline info
)
3625 "Return HEADLINE relative level within current parsed tree.
3626 INFO is a plist holding contextual information."
3627 (+ (org-element-property :level headline
)
3628 (or (plist-get info
:headline-offset
) 0)))
3630 (defun org-export-low-level-p (headline info
)
3631 "Non-nil when HEADLINE is considered as low level.
3633 INFO is a plist used as a communication channel.
3635 A low level headlines has a relative level greater than
3636 `:headline-levels' property value.
3638 Return value is the difference between HEADLINE relative level
3639 and the last level being considered as high enough, or nil."
3640 (let ((limit (plist-get info
:headline-levels
)))
3641 (when (wholenump limit
)
3642 (let ((level (org-export-get-relative-level headline info
)))
3643 (and (> level limit
) (- level limit
))))))
3645 (defun org-export-get-headline-id (headline info
)
3646 "Return a unique ID for HEADLINE.
3647 INFO is a plist holding contextual information."
3648 (let ((numbered (org-export-numbered-headline-p headline info
)))
3650 (if numbered
"sec-" "unnumbered-")
3651 (mapconcat #'number-to-string
3653 (org-export-get-headline-number headline info
)
3654 (cdr (assq headline
(plist-get info
:unnumbered-headline-id
)))) "-"))))
3656 (defun org-export-get-headline-number (headline info
)
3657 "Return numbered HEADLINE numbering as a list of numbers.
3658 INFO is a plist holding contextual information."
3659 (and (org-export-numbered-headline-p headline info
)
3660 (cdr (assq headline
(plist-get info
:headline-numbering
)))))
3662 (defun org-export-numbered-headline-p (headline info
)
3663 "Return a non-nil value if HEADLINE element should be numbered.
3664 INFO is a plist used as a communication channel."
3666 (lambda (head) (org-not-nil (org-element-property :UNNUMBERED head
)))
3667 (cons headline
(org-export-get-genealogy headline
)))
3668 (let ((sec-num (plist-get info
:section-numbers
))
3669 (level (org-export-get-relative-level headline info
)))
3670 (if (wholenump sec-num
) (<= level sec-num
) sec-num
))))
3672 (defun org-export-number-to-roman (n)
3673 "Convert integer N into a roman numeral."
3674 (let ((roman '((1000 .
"M") (900 .
"CM") (500 .
"D") (400 .
"CD")
3675 ( 100 .
"C") ( 90 .
"XC") ( 50 .
"L") ( 40 .
"XL")
3676 ( 10 .
"X") ( 9 .
"IX") ( 5 .
"V") ( 4 .
"IV")
3680 (number-to-string n
)
3682 (if (>= n
(caar roman
))
3683 (setq n
(- n
(caar roman
))
3684 res
(concat res
(cdar roman
)))
3688 (defun org-export-get-tags (element info
&optional tags inherited
)
3689 "Return list of tags associated to ELEMENT.
3691 ELEMENT has either an `headline' or an `inlinetask' type. INFO
3692 is a plist used as a communication channel.
3694 Select tags (see `org-export-select-tags') and exclude tags (see
3695 `org-export-exclude-tags') are removed from the list.
3697 When non-nil, optional argument TAGS should be a list of strings.
3698 Any tag belonging to this list will also be removed.
3700 When optional argument INHERITED is non-nil, tags can also be
3701 inherited from parent headlines and FILETAGS keywords."
3703 (lambda (tag) (or (member tag
(plist-get info
:select-tags
))
3704 (member tag
(plist-get info
:exclude-tags
))
3706 (if (not inherited
) (org-element-property :tags element
)
3707 ;; Build complete list of inherited tags.
3708 (let ((current-tag-list (org-element-property :tags element
)))
3713 (when (and (memq (org-element-type parent
) '(headline inlinetask
))
3714 (not (member tag current-tag-list
)))
3715 (push tag current-tag-list
)))
3716 (org-element-property :tags parent
)))
3717 (org-export-get-genealogy element
))
3718 ;; Add FILETAGS keywords and return results.
3719 (org-uniquify (append (plist-get info
:filetags
) current-tag-list
))))))
3721 (defun org-export-get-node-property (property blob
&optional inherited
)
3722 "Return node PROPERTY value for BLOB.
3724 PROPERTY is an upcase symbol (i.e. `:COOKIE_DATA'). BLOB is an
3727 If optional argument INHERITED is non-nil, the value can be
3728 inherited from a parent headline.
3730 Return value is a string or nil."
3731 (let ((headline (if (eq (org-element-type blob
) 'headline
) blob
3732 (org-export-get-parent-headline blob
))))
3733 (if (not inherited
) (org-element-property property blob
)
3734 (let ((parent headline
) value
)
3737 (when (plist-member (nth 1 parent
) property
)
3738 (throw 'found
(org-element-property property parent
)))
3739 (setq parent
(org-element-property :parent parent
))))))))
3741 (defun org-export-get-category (blob info
)
3742 "Return category for element or object BLOB.
3744 INFO is a plist used as a communication channel.
3746 CATEGORY is automatically inherited from a parent headline, from
3747 #+CATEGORY: keyword or created out of original file name. If all
3748 fail, the fall-back value is \"???\"."
3749 (or (org-export-get-node-property :CATEGORY blob t
)
3750 (org-element-map (plist-get info
:parse-tree
) 'keyword
3752 (when (equal (org-element-property :key kwd
) "CATEGORY")
3753 (org-element-property :value kwd
)))
3755 (let ((file (plist-get info
:input-file
)))
3756 (and file
(file-name-sans-extension (file-name-nondirectory file
))))
3759 (defun org-export-get-alt-title (headline info
)
3760 "Return alternative title for HEADLINE, as a secondary string.
3761 INFO is a plist used as a communication channel. If no optional
3762 title is defined, fall-back to the regular title."
3763 (or (org-element-property :alt-title headline
)
3764 (org-element-property :title headline
)))
3766 (defun org-export-first-sibling-p (blob info
)
3767 "Non-nil when BLOB is the first sibling in its parent.
3768 BLOB is an element or an object. If BLOB is a headline, non-nil
3769 means it is the first sibling in the sub-tree. INFO is a plist
3770 used as a communication channel."
3771 (memq (org-element-type (org-export-get-previous-element blob info
))
3774 (defun org-export-last-sibling-p (blob info
)
3775 "Non-nil when BLOB is the last sibling in its parent.
3776 BLOB is an element or an object. INFO is a plist used as
3777 a communication channel."
3778 (not (org-export-get-next-element blob info
)))
3783 ;; `org-export-get-date' returns a date appropriate for the document
3784 ;; to about to be exported. In particular, it takes care of
3785 ;; `org-export-date-timestamp-format'.
3787 (defun org-export-get-date (info &optional fmt
)
3788 "Return date value for the current document.
3790 INFO is a plist used as a communication channel. FMT, when
3791 non-nil, is a time format string that will be applied on the date
3792 if it consists in a single timestamp object. It defaults to
3793 `org-export-date-timestamp-format' when nil.
3795 A proper date can be a secondary string, a string or nil. It is
3796 meant to be translated with `org-export-data' or alike."
3797 (let ((date (plist-get info
:date
))
3798 (fmt (or fmt org-export-date-timestamp-format
)))
3799 (cond ((not date
) nil
)
3802 (eq (org-element-type (car date
)) 'timestamp
))
3803 (org-timestamp-format (car date
) fmt
))
3809 ;; `org-export-solidify-link-text' turns a string into a safer version
3810 ;; for links, replacing most non-standard characters with hyphens.
3812 ;; `org-export-get-coderef-format' returns an appropriate format
3813 ;; string for coderefs.
3815 ;; `org-export-inline-image-p' returns a non-nil value when the link
3816 ;; provided should be considered as an inline image.
3818 ;; `org-export-resolve-fuzzy-link' searches destination of fuzzy links
3819 ;; (i.e. links with "fuzzy" as type) within the parsed tree, and
3820 ;; returns an appropriate unique identifier when found, or nil.
3822 ;; `org-export-resolve-id-link' returns the first headline with
3823 ;; specified id or custom-id in parse tree, the path to the external
3824 ;; file with the id or nil when neither was found.
3826 ;; `org-export-resolve-coderef' associates a reference to a line
3827 ;; number in the element it belongs, or returns the reference itself
3828 ;; when the element isn't numbered.
3830 (defun org-export-solidify-link-text (s)
3831 "Take link text S and make a safe target out of it."
3833 (mapconcat 'identity
(org-split-string s
"[^a-zA-Z0-9_.-:]+") "-")))
3835 (defun org-export-get-coderef-format (path desc
)
3836 "Return format string for code reference link.
3837 PATH is the link path. DESC is its description."
3839 (cond ((not desc
) "%s")
3840 ((string-match (regexp-quote (concat "(" path
")")) desc
)
3841 (replace-match "%s" t t desc
))
3844 (defun org-export-inline-image-p (link &optional rules
)
3845 "Non-nil if LINK object points to an inline image.
3847 Optional argument is a set of RULES defining inline images. It
3848 is an alist where associations have the following shape:
3852 Applying a rule means apply REGEXP against LINK's path when its
3853 type is TYPE. The function will return a non-nil value if any of
3854 the provided rules is non-nil. The default rule is
3855 `org-export-default-inline-image-rule'.
3857 This only applies to links without a description."
3858 (and (not (org-element-contents link
))
3859 (let ((case-fold-search t
)
3860 (rules (or rules org-export-default-inline-image-rule
)))
3864 (and (string= (org-element-property :type link
) (car rule
))
3865 (string-match (cdr rule
)
3866 (org-element-property :path link
))
3869 ;; Return nil if no rule matched.
3872 (defun org-export-resolve-coderef (ref info
)
3873 "Resolve a code reference REF.
3875 INFO is a plist used as a communication channel.
3877 Return associated line number in source code, or REF itself,
3878 depending on src-block or example element's switches."
3879 (org-element-map (plist-get info
:parse-tree
) '(example-block src-block
)
3882 (insert (org-trim (org-element-property :value el
)))
3883 (let* ((label-fmt (regexp-quote
3884 (or (org-element-property :label-fmt el
)
3885 org-coderef-label-format
)))
3887 (format "^.*?\\S-.*?\\([ \t]*\\(%s\\)\\)[ \t]*$"
3888 (replace-regexp-in-string "%s" ref label-fmt nil t
))))
3889 ;; Element containing REF is found. Resolve it to either
3890 ;; a label or a line number, as needed.
3891 (when (re-search-backward ref-re nil t
)
3893 ((org-element-property :use-labels el
) ref
)
3894 ((eq (org-element-property :number-lines el
) 'continued
)
3895 (+ (org-export-get-loc el info
) (line-number-at-pos)))
3896 (t (line-number-at-pos)))))))
3899 (defun org-export-resolve-fuzzy-link (link info
)
3900 "Return LINK destination.
3902 INFO is a plist holding contextual information.
3904 Return value can be an object, an element, or nil:
3906 - If LINK path matches a target object (i.e. <<path>>) return it.
3908 - If LINK path exactly matches the name affiliated keyword
3909 \(i.e. #+NAME: path) of an element, return that element.
3911 - If LINK path exactly matches any headline name, return that
3912 element. If more than one headline share that name, priority
3913 will be given to the one with the closest common ancestor, if
3914 any, or the first one in the parse tree otherwise.
3916 - Otherwise, return nil.
3918 Assume LINK type is \"fuzzy\". White spaces are not
3920 (let* ((raw-path (org-element-property :path link
))
3921 (match-title-p (eq (aref raw-path
0) ?
*))
3922 ;; Split PATH at white spaces so matches are space
3924 (path (org-split-string
3925 (if match-title-p
(substring raw-path
1) raw-path
)))
3926 ;; Cache for destinations that are not position dependent.
3928 (or (plist-get info
:resolve-fuzzy-link-cache
)
3929 (plist-get (setq info
(plist-put info
:resolve-fuzzy-link-cache
3930 (make-hash-table :test
'equal
)))
3931 :resolve-fuzzy-link-cache
)))
3932 (cached (gethash path link-cache
'not-found
)))
3934 ;; Destination is not position dependent: use cached value.
3935 ((and (not match-title-p
) (not (eq cached
'not-found
))) cached
)
3936 ;; First try to find a matching "<<path>>" unless user specified
3937 ;; he was looking for a headline (path starts with a "*"
3939 ((and (not match-title-p
)
3940 (let ((match (org-element-map (plist-get info
:parse-tree
) 'target
3942 (and (equal (org-split-string
3943 (org-element-property :value blob
))
3946 info
'first-match
)))
3947 (and match
(puthash path match link-cache
)))))
3948 ;; Then try to find an element with a matching "#+NAME: path"
3949 ;; affiliated keyword.
3950 ((and (not match-title-p
)
3951 (let ((match (org-element-map (plist-get info
:parse-tree
)
3952 org-element-all-elements
3954 (let ((name (org-element-property :name el
)))
3956 (equal (org-split-string name
) path
))
3958 info
'first-match
)))
3959 (and match
(puthash path match link-cache
)))))
3960 ;; Last case: link either points to a headline or to nothingness.
3961 ;; Try to find the source, with priority given to headlines with
3962 ;; the closest common ancestor. If such candidate is found,
3963 ;; return it, otherwise return nil.
3965 (let ((find-headline
3967 ;; Return first headline whose `:raw-value' property is
3968 ;; NAME in parse tree DATA, or nil. Statistics cookies
3971 (org-element-map data
'headline
3973 (when (equal (org-split-string
3974 (replace-regexp-in-string
3975 "\\[[0-9]+%\\]\\|\\[[0-9]+/[0-9]+\\]" ""
3976 (org-element-property :raw-value headline
)))
3979 info
'first-match
)))))
3980 ;; Search among headlines sharing an ancestor with link, from
3981 ;; closest to farthest.
3985 (let ((foundp (funcall find-headline path parent
)))
3986 (when foundp
(throw 'exit foundp
))))
3987 (let ((parent-hl (org-export-get-parent-headline link
)))
3988 (if (not parent-hl
) (list (plist-get info
:parse-tree
))
3989 (cons parent-hl
(org-export-get-genealogy parent-hl
)))))
3990 ;; No destination found: return nil.
3991 (and (not match-title-p
) (puthash path nil link-cache
))))))))
3993 (defun org-export-resolve-id-link (link info
)
3994 "Return headline referenced as LINK destination.
3996 INFO is a plist used as a communication channel.
3998 Return value can be the headline element matched in current parse
3999 tree, a file name or nil. Assume LINK type is either \"id\" or
4001 (let ((id (org-element-property :path link
)))
4002 ;; First check if id is within the current parse tree.
4003 (or (org-element-map (plist-get info
:parse-tree
) 'headline
4005 (when (or (string= (org-element-property :ID headline
) id
)
4006 (string= (org-element-property :CUSTOM_ID headline
) id
))
4009 ;; Otherwise, look for external files.
4010 (cdr (assoc id
(plist-get info
:id-alist
))))))
4012 (defun org-export-resolve-radio-link (link info
)
4013 "Return radio-target object referenced as LINK destination.
4015 INFO is a plist used as a communication channel.
4017 Return value can be a radio-target object or nil. Assume LINK
4018 has type \"radio\"."
4019 (let ((path (replace-regexp-in-string
4020 "[ \r\t\n]+" " " (org-element-property :path link
))))
4021 (org-element-map (plist-get info
:parse-tree
) 'radio-target
4023 (and (eq (compare-strings
4024 (replace-regexp-in-string
4025 "[ \r\t\n]+" " " (org-element-property :value radio
))
4026 nil nil path nil nil t
)
4029 info
'first-match
)))
4034 ;; `org-export-get-ordinal' associates a sequence number to any object
4037 (defun org-export-get-ordinal (element info
&optional types predicate
)
4038 "Return ordinal number of an element or object.
4040 ELEMENT is the element or object considered. INFO is the plist
4041 used as a communication channel.
4043 Optional argument TYPES, when non-nil, is a list of element or
4044 object types, as symbols, that should also be counted in.
4045 Otherwise, only provided element's type is considered.
4047 Optional argument PREDICATE is a function returning a non-nil
4048 value if the current element or object should be counted in. It
4049 accepts two arguments: the element or object being considered and
4050 the plist used as a communication channel. This allows to count
4051 only a certain type of objects (i.e. inline images).
4053 Return value is a list of numbers if ELEMENT is a headline or an
4054 item. It is nil for keywords. It represents the footnote number
4055 for footnote definitions and footnote references. If ELEMENT is
4056 a target, return the same value as if ELEMENT was the closest
4057 table, item or headline containing the target. In any other
4058 case, return the sequence number of ELEMENT among elements or
4059 objects of the same type."
4060 ;; Ordinal of a target object refer to the ordinal of the closest
4061 ;; table, item, or headline containing the object.
4062 (when (eq (org-element-type element
) 'target
)
4064 (loop for parent in
(org-export-get-genealogy element
)
4067 (org-element-type parent
)
4068 '(footnote-definition footnote-reference headline item
4071 (case (org-element-type element
)
4072 ;; Special case 1: A headline returns its number as a list.
4073 (headline (org-export-get-headline-number element info
))
4074 ;; Special case 2: An item returns its number as a list.
4075 (item (let ((struct (org-element-property :structure element
)))
4076 (org-list-get-item-number
4077 (org-element-property :begin element
)
4079 (org-list-prevs-alist struct
)
4080 (org-list-parents-alist struct
))))
4081 ((footnote-definition footnote-reference
)
4082 (org-export-get-footnote-number element info
))
4085 ;; Increment counter until ELEMENT is found again.
4086 (org-element-map (plist-get info
:parse-tree
)
4087 (or types
(org-element-type element
))
4090 ((eq element el
) (1+ counter
))
4091 ((not predicate
) (incf counter
) nil
)
4092 ((funcall predicate el info
) (incf counter
) nil
)))
4093 info
'first-match
)))))
4098 ;; `org-export-get-loc' counts number of code lines accumulated in
4099 ;; src-block or example-block elements with a "+n" switch until
4100 ;; a given element, excluded. Note: "-n" switches reset that count.
4102 ;; `org-export-unravel-code' extracts source code (along with a code
4103 ;; references alist) from an `element-block' or `src-block' type
4106 ;; `org-export-format-code' applies a formatting function to each line
4107 ;; of code, providing relative line number and code reference when
4108 ;; appropriate. Since it doesn't access the original element from
4109 ;; which the source code is coming, it expects from the code calling
4110 ;; it to know if lines should be numbered and if code references
4113 ;; Eventually, `org-export-format-code-default' is a higher-level
4114 ;; function (it makes use of the two previous functions) which handles
4115 ;; line numbering and code references inclusion, and returns source
4116 ;; code in a format suitable for plain text or verbatim output.
4118 (defun org-export-get-loc (element info
)
4119 "Return accumulated lines of code up to ELEMENT.
4121 INFO is the plist used as a communication channel.
4123 ELEMENT is excluded from count."
4125 (org-element-map (plist-get info
:parse-tree
)
4126 `(src-block example-block
,(org-element-type element
))
4129 ;; ELEMENT is reached: Quit the loop.
4131 ;; Only count lines from src-block and example-block elements
4132 ;; with a "+n" or "-n" switch. A "-n" switch resets counter.
4133 ((not (memq (org-element-type el
) '(src-block example-block
))) nil
)
4134 ((let ((linums (org-element-property :number-lines el
)))
4136 ;; Accumulate locs or reset them.
4137 (let ((lines (org-count-lines
4138 (org-trim (org-element-property :value el
)))))
4139 (setq loc
(if (eq linums
'new
) lines
(+ loc lines
))))))
4140 ;; Return nil to stay in the loop.
4146 (defun org-export-unravel-code (element)
4147 "Clean source code and extract references out of it.
4149 ELEMENT has either a `src-block' an `example-block' type.
4151 Return a cons cell whose CAR is the source code, cleaned from any
4152 reference, protective commas and spurious indentation, and CDR is
4153 an alist between relative line number (integer) and name of code
4154 reference on that line (string)."
4155 (let* ((line 0) refs
4156 (value (org-element-property :value element
))
4157 ;; Get code and clean it. Remove blank lines at its
4158 ;; beginning and end.
4159 (code (replace-regexp-in-string
4160 "\\`\\([ \t]*\n\\)+" ""
4161 (replace-regexp-in-string
4162 "\\([ \t]*\n\\)*[ \t]*\\'" "\n"
4163 (if (or org-src-preserve-indentation
4164 (org-element-property :preserve-indent element
))
4166 (org-element-remove-indentation value
)))))
4167 ;; Get format used for references.
4168 (label-fmt (regexp-quote
4169 (or (org-element-property :label-fmt element
)
4170 org-coderef-label-format
)))
4171 ;; Build a regexp matching a loc with a reference.
4173 (format "^.*?\\S-.*?\\([ \t]*\\(%s\\)[ \t]*\\)$"
4174 (replace-regexp-in-string
4175 "%s" "\\([-a-zA-Z0-9_ ]+\\)" label-fmt nil t
))))
4178 ;; Code with references removed.
4179 (org-element-normalize-string
4183 (if (not (string-match with-ref-re loc
)) loc
4184 ;; Ref line: remove ref, and signal its position in REFS.
4185 (push (cons line
(match-string 3 loc
)) refs
)
4186 (replace-match "" nil nil loc
1)))
4187 (org-split-string code
"\n") "\n"))
4191 (defun org-export-format-code (code fun
&optional num-lines ref-alist
)
4192 "Format CODE by applying FUN line-wise and return it.
4194 CODE is a string representing the code to format. FUN is
4195 a function. It must accept three arguments: a line of
4196 code (string), the current line number (integer) or nil and the
4197 reference associated to the current line (string) or nil.
4199 Optional argument NUM-LINES can be an integer representing the
4200 number of code lines accumulated until the current code. Line
4201 numbers passed to FUN will take it into account. If it is nil,
4202 FUN's second argument will always be nil. This number can be
4203 obtained with `org-export-get-loc' function.
4205 Optional argument REF-ALIST can be an alist between relative line
4206 number (i.e. ignoring NUM-LINES) and the name of the code
4207 reference on it. If it is nil, FUN's third argument will always
4208 be nil. It can be obtained through the use of
4209 `org-export-unravel-code' function."
4210 (let ((--locs (org-split-string code
"\n"))
4212 (org-element-normalize-string
4216 (let ((--ref (cdr (assq --line ref-alist
))))
4217 (funcall fun --loc
(and num-lines
(+ num-lines --line
)) --ref
)))
4220 (defun org-export-format-code-default (element info
)
4221 "Return source code from ELEMENT, formatted in a standard way.
4223 ELEMENT is either a `src-block' or `example-block' element. INFO
4224 is a plist used as a communication channel.
4226 This function takes care of line numbering and code references
4227 inclusion. Line numbers, when applicable, appear at the
4228 beginning of the line, separated from the code by two white
4229 spaces. Code references, on the other hand, appear flushed to
4230 the right, separated by six white spaces from the widest line of
4232 ;; Extract code and references.
4233 (let* ((code-info (org-export-unravel-code element
))
4234 (code (car code-info
))
4235 (code-lines (org-split-string code
"\n")))
4236 (if (null code-lines
) ""
4237 (let* ((refs (and (org-element-property :retain-labels element
)
4239 ;; Handle line numbering.
4240 (num-start (case (org-element-property :number-lines element
)
4241 (continued (org-export-get-loc element info
))
4246 (length (number-to-string
4247 (+ (length code-lines
) num-start
))))))
4248 ;; Prepare references display, if required. Any reference
4249 ;; should start six columns after the widest line of code,
4250 ;; wrapped with parenthesis.
4252 (+ (apply 'max
(mapcar 'length code-lines
))
4253 (if (not num-start
) 0 (length (format num-fmt num-start
))))))
4254 (org-export-format-code
4256 (lambda (loc line-num ref
)
4257 (let ((number-str (and num-fmt
(format num-fmt line-num
))))
4262 (concat (make-string
4264 (+ (length loc
) (length number-str
))) ?
)
4265 (format "(%s)" ref
))))))
4271 ;; `org-export-table-has-special-column-p' and and
4272 ;; `org-export-table-row-is-special-p' are predicates used to look for
4273 ;; meta-information about the table structure.
4275 ;; `org-table-has-header-p' tells when the rows before the first rule
4276 ;; should be considered as table's header.
4278 ;; `org-export-table-cell-width', `org-export-table-cell-alignment'
4279 ;; and `org-export-table-cell-borders' extract information from
4280 ;; a table-cell element.
4282 ;; `org-export-table-dimensions' gives the number on rows and columns
4283 ;; in the table, ignoring horizontal rules and special columns.
4284 ;; `org-export-table-cell-address', given a table-cell object, returns
4285 ;; the absolute address of a cell. On the other hand,
4286 ;; `org-export-get-table-cell-at' does the contrary.
4288 ;; `org-export-table-cell-starts-colgroup-p',
4289 ;; `org-export-table-cell-ends-colgroup-p',
4290 ;; `org-export-table-row-starts-rowgroup-p',
4291 ;; `org-export-table-row-ends-rowgroup-p',
4292 ;; `org-export-table-row-starts-header-p',
4293 ;; `org-export-table-row-ends-header-p' and
4294 ;; `org-export-table-row-in-header-p' indicate position of current row
4295 ;; or cell within the table.
4297 (defun org-export-table-has-special-column-p (table)
4298 "Non-nil when TABLE has a special column.
4299 All special columns will be ignored during export."
4300 ;; The table has a special column when every first cell of every row
4301 ;; has an empty value or contains a symbol among "/", "#", "!", "$",
4302 ;; "*" "_" and "^". Though, do not consider a first row containing
4303 ;; only empty cells as special.
4304 (let ((special-column-p 'empty
))
4308 (when (eq (org-element-property :type row
) 'standard
)
4309 (let ((value (org-element-contents
4310 (car (org-element-contents row
)))))
4311 (cond ((member value
'(("/") ("#") ("!") ("$") ("*") ("_") ("^")))
4312 (setq special-column-p
'special
))
4314 (t (throw 'exit nil
))))))
4315 (org-element-contents table
))
4316 (eq special-column-p
'special
))))
4318 (defun org-export-table-has-header-p (table info
)
4319 "Non-nil when TABLE has a header.
4321 INFO is a plist used as a communication channel.
4323 A table has a header when it contains at least two row groups."
4324 (let ((cache (or (plist-get info
:table-header-cache
)
4325 (plist-get (setq info
4326 (plist-put info
:table-header-cache
4327 (make-hash-table :test
'eq
)))
4328 :table-header-cache
))))
4329 (or (gethash table cache
)
4330 (let ((rowgroup 1) row-flag
)
4333 (org-element-map table
'table-row
4337 ((and row-flag
(eq (org-element-property :type row
) 'rule
))
4338 (incf rowgroup
) (setq row-flag nil
))
4339 ((and (not row-flag
) (eq (org-element-property :type row
)
4341 (setq row-flag t
) nil
)))
4345 (defun org-export-table-row-is-special-p (table-row info
)
4346 "Non-nil if TABLE-ROW is considered special.
4348 INFO is a plist used as the communication channel.
4350 All special rows will be ignored during export."
4351 (when (eq (org-element-property :type table-row
) 'standard
)
4352 (let ((first-cell (org-element-contents
4353 (car (org-element-contents table-row
)))))
4354 ;; A row is special either when...
4356 ;; ... it starts with a field only containing "/",
4357 (equal first-cell
'("/"))
4358 ;; ... the table contains a special column and the row start
4359 ;; with a marking character among, "^", "_", "$" or "!",
4360 (and (org-export-table-has-special-column-p
4361 (org-export-get-parent table-row
))
4362 (member first-cell
'(("^") ("_") ("$") ("!"))))
4363 ;; ... it contains only alignment cookies and empty cells.
4364 (let ((special-row-p 'empty
))
4368 (let ((value (org-element-contents cell
)))
4369 ;; Since VALUE is a secondary string, the following
4370 ;; checks avoid expanding it with `org-export-data'.
4372 ((and (not (cdr value
))
4373 (stringp (car value
))
4374 (string-match "\\`<[lrc]?\\([0-9]+\\)?>\\'"
4376 (setq special-row-p
'cookie
))
4377 (t (throw 'exit nil
)))))
4378 (org-element-contents table-row
))
4379 (eq special-row-p
'cookie
)))))))
4381 (defun org-export-table-row-group (table-row info
)
4382 "Return TABLE-ROW's group number, as an integer.
4384 INFO is a plist used as the communication channel.
4386 Return value is the group number, as an integer, or nil for
4387 special rows and rows separators. First group is also table's
4389 (let ((cache (or (plist-get info
:table-row-group-cache
)
4390 (plist-get (setq info
4391 (plist-put info
:table-row-group-cache
4392 (make-hash-table :test
'eq
)))
4393 :table-row-group-cache
))))
4394 (cond ((gethash table-row cache
))
4395 ((eq (org-element-property :type table-row
) 'rule
) nil
)
4396 (t (let ((group 0) row-flag
)
4397 (org-element-map (org-export-get-parent table-row
) 'table-row
4399 (if (eq (org-element-property :type row
) 'rule
)
4401 (unless row-flag
(incf group
) (setq row-flag t
)))
4402 (when (eq table-row row
) (puthash table-row group cache
)))
4403 info
'first-match
))))))
4405 (defun org-export-table-cell-width (table-cell info
)
4406 "Return TABLE-CELL contents width.
4408 INFO is a plist used as the communication channel.
4410 Return value is the width given by the last width cookie in the
4411 same column as TABLE-CELL, or nil."
4412 (let* ((row (org-export-get-parent table-cell
))
4413 (table (org-export-get-parent row
))
4414 (cells (org-element-contents row
))
4415 (columns (length cells
))
4416 (column (- columns
(length (memq table-cell cells
))))
4417 (cache (or (plist-get info
:table-cell-width-cache
)
4418 (plist-get (setq info
4419 (plist-put info
:table-cell-width-cache
4420 (make-hash-table :test
'eq
)))
4421 :table-cell-width-cache
)))
4422 (width-vector (or (gethash table cache
)
4423 (puthash table
(make-vector columns
'empty
) cache
)))
4424 (value (aref width-vector column
)))
4425 (if (not (eq value
'empty
)) value
4427 (dolist (row (org-element-contents table
)
4428 (aset width-vector column cookie-width
))
4429 (when (org-export-table-row-is-special-p row info
)
4430 ;; In a special row, try to find a width cookie at COLUMN.
4431 (let* ((value (org-element-contents
4432 (elt (org-element-contents row
) column
)))
4433 (cookie (car value
)))
4434 ;; The following checks avoid expanding unnecessarily
4435 ;; the cell with `org-export-data'.
4439 (string-match "\\`<[lrc]?\\([0-9]+\\)?>\\'" cookie
)
4440 (match-string 1 cookie
))
4442 (string-to-number (match-string 1 cookie
)))))))))))
4444 (defun org-export-table-cell-alignment (table-cell info
)
4445 "Return TABLE-CELL contents alignment.
4447 INFO is a plist used as the communication channel.
4449 Return alignment as specified by the last alignment cookie in the
4450 same column as TABLE-CELL. If no such cookie is found, a default
4451 alignment value will be deduced from fraction of numbers in the
4452 column (see `org-table-number-fraction' for more information).
4453 Possible values are `left', `right' and `center'."
4454 ;; Load `org-table-number-fraction' and `org-table-number-regexp'.
4455 (require 'org-table
)
4456 (let* ((row (org-export-get-parent table-cell
))
4457 (table (org-export-get-parent row
))
4458 (cells (org-element-contents row
))
4459 (columns (length cells
))
4460 (column (- columns
(length (memq table-cell cells
))))
4461 (cache (or (plist-get info
:table-cell-alignment-cache
)
4462 (plist-get (setq info
4463 (plist-put info
:table-cell-alignment-cache
4464 (make-hash-table :test
'eq
)))
4465 :table-cell-alignment-cache
)))
4466 (align-vector (or (gethash table cache
)
4467 (puthash table
(make-vector columns nil
) cache
))))
4468 (or (aref align-vector column
)
4469 (let ((number-cells 0)
4472 previous-cell-number-p
)
4473 (dolist (row (org-element-contents (org-export-get-parent row
)))
4475 ;; In a special row, try to find an alignment cookie at
4477 ((org-export-table-row-is-special-p row info
)
4478 (let ((value (org-element-contents
4479 (elt (org-element-contents row
) column
))))
4480 ;; Since VALUE is a secondary string, the following
4481 ;; checks avoid useless expansion through
4482 ;; `org-export-data'.
4485 (stringp (car value
))
4486 (string-match "\\`<\\([lrc]\\)?\\([0-9]+\\)?>\\'"
4488 (match-string 1 (car value
)))
4489 (setq cookie-align
(match-string 1 (car value
))))))
4490 ;; Ignore table rules.
4491 ((eq (org-element-property :type row
) 'rule
))
4492 ;; In a standard row, check if cell's contents are
4493 ;; expressing some kind of number. Increase NUMBER-CELLS
4494 ;; accordingly. Though, don't bother if an alignment
4495 ;; cookie has already defined cell's alignment.
4497 (let ((value (org-export-data
4498 (org-element-contents
4499 (elt (org-element-contents row
) column
))
4502 ;; Treat an empty cell as a number if it follows
4504 (if (not (or (string-match org-table-number-regexp value
)
4505 (and (string= value
"") previous-cell-number-p
)))
4506 (setq previous-cell-number-p nil
)
4507 (setq previous-cell-number-p t
)
4508 (incf number-cells
))))))
4509 ;; Return value. Alignment specified by cookies has
4510 ;; precedence over alignment deduced from cell's contents.
4513 (cond ((equal cookie-align
"l") 'left
)
4514 ((equal cookie-align
"r") 'right
)
4515 ((equal cookie-align
"c") 'center
)
4516 ((>= (/ (float number-cells
) total-cells
)
4517 org-table-number-fraction
)
4521 (defun org-export-table-cell-borders (table-cell info
)
4522 "Return TABLE-CELL borders.
4524 INFO is a plist used as a communication channel.
4526 Return value is a list of symbols, or nil. Possible values are:
4527 `top', `bottom', `above', `below', `left' and `right'. Note:
4528 `top' (resp. `bottom') only happen for a cell in the first
4529 row (resp. last row) of the table, ignoring table rules, if any.
4531 Returned borders ignore special rows."
4532 (let* ((row (org-export-get-parent table-cell
))
4533 (table (org-export-get-parent-table table-cell
))
4535 ;; Top/above border? TABLE-CELL has a border above when a rule
4536 ;; used to demarcate row groups can be found above. Hence,
4537 ;; finding a rule isn't sufficient to push `above' in BORDERS:
4538 ;; another regular row has to be found above that rule.
4542 (cond ((eq (org-element-property :type row
) 'rule
)
4544 ((not (org-export-table-row-is-special-p row info
))
4545 (if rule-flag
(throw 'exit
(push 'above borders
))
4546 (throw 'exit nil
)))))
4547 ;; Look at every row before the current one.
4548 (cdr (memq row
(reverse (org-element-contents table
)))))
4549 ;; No rule above, or rule found starts the table (ignoring any
4550 ;; special row): TABLE-CELL is at the top of the table.
4551 (when rule-flag
(push 'above borders
))
4552 (push 'top borders
)))
4553 ;; Bottom/below border? TABLE-CELL has a border below when next
4554 ;; non-regular row below is a rule.
4558 (cond ((eq (org-element-property :type row
) 'rule
)
4560 ((not (org-export-table-row-is-special-p row info
))
4561 (if rule-flag
(throw 'exit
(push 'below borders
))
4562 (throw 'exit nil
)))))
4563 ;; Look at every row after the current one.
4564 (cdr (memq row
(org-element-contents table
))))
4565 ;; No rule below, or rule found ends the table (modulo some
4566 ;; special row): TABLE-CELL is at the bottom of the table.
4567 (when rule-flag
(push 'below borders
))
4568 (push 'bottom borders
)))
4569 ;; Right/left borders? They can only be specified by column
4570 ;; groups. Column groups are defined in a row starting with "/".
4571 ;; Also a column groups row only contains "<", "<>", ">" or blank
4574 (let ((column (let ((cells (org-element-contents row
)))
4575 (- (length cells
) (length (memq table-cell cells
))))))
4578 (unless (eq (org-element-property :type row
) 'rule
)
4579 (when (equal (org-element-contents
4580 (car (org-element-contents row
)))
4582 (let ((column-groups
4585 (let ((value (org-element-contents cell
)))
4586 (when (member value
'(("<") ("<>") (">") nil
))
4588 (org-element-contents row
))))
4589 ;; There's a left border when previous cell, if
4590 ;; any, ends a group, or current one starts one.
4591 (when (or (and (not (zerop column
))
4592 (member (elt column-groups
(1- column
))
4594 (member (elt column-groups column
) '("<" "<>")))
4595 (push 'left borders
))
4596 ;; There's a right border when next cell, if any,
4597 ;; starts a group, or current one ends one.
4598 (when (or (and (/= (1+ column
) (length column-groups
))
4599 (member (elt column-groups
(1+ column
))
4601 (member (elt column-groups column
) '(">" "<>")))
4602 (push 'right borders
))
4603 (throw 'exit nil
)))))
4604 ;; Table rows are read in reverse order so last column groups
4605 ;; row has precedence over any previous one.
4606 (reverse (org-element-contents table
)))))
4610 (defun org-export-table-cell-starts-colgroup-p (table-cell info
)
4611 "Non-nil when TABLE-CELL is at the beginning of a column group.
4612 INFO is a plist used as a communication channel."
4613 ;; A cell starts a column group either when it is at the beginning
4614 ;; of a row (or after the special column, if any) or when it has
4616 (or (eq (org-element-map (org-export-get-parent table-cell
) 'table-cell
4617 'identity info
'first-match
)
4619 (memq 'left
(org-export-table-cell-borders table-cell info
))))
4621 (defun org-export-table-cell-ends-colgroup-p (table-cell info
)
4622 "Non-nil when TABLE-CELL is at the end of a column group.
4623 INFO is a plist used as a communication channel."
4624 ;; A cell ends a column group either when it is at the end of a row
4625 ;; or when it has a right border.
4626 (or (eq (car (last (org-element-contents
4627 (org-export-get-parent table-cell
))))
4629 (memq 'right
(org-export-table-cell-borders table-cell info
))))
4631 (defun org-export-table-row-starts-rowgroup-p (table-row info
)
4632 "Non-nil when TABLE-ROW is at the beginning of a row group.
4633 INFO is a plist used as a communication channel."
4634 (unless (or (eq (org-element-property :type table-row
) 'rule
)
4635 (org-export-table-row-is-special-p table-row info
))
4636 (let ((borders (org-export-table-cell-borders
4637 (car (org-element-contents table-row
)) info
)))
4638 (or (memq 'top borders
) (memq 'above borders
)))))
4640 (defun org-export-table-row-ends-rowgroup-p (table-row info
)
4641 "Non-nil when TABLE-ROW is at the end of a row group.
4642 INFO is a plist used as a communication channel."
4643 (unless (or (eq (org-element-property :type table-row
) 'rule
)
4644 (org-export-table-row-is-special-p table-row info
))
4645 (let ((borders (org-export-table-cell-borders
4646 (car (org-element-contents table-row
)) info
)))
4647 (or (memq 'bottom borders
) (memq 'below borders
)))))
4649 (defun org-export-table-row-in-header-p (table-row info
)
4650 "Non-nil when TABLE-ROW is located within table's header.
4651 INFO is a plist used as a communication channel. Always return
4652 nil for special rows and rows separators."
4653 (and (org-export-table-has-header-p
4654 (org-export-get-parent-table table-row
) info
)
4655 (eql (org-export-table-row-group table-row info
) 1)))
4657 (defun org-export-table-row-starts-header-p (table-row info
)
4658 "Non-nil when TABLE-ROW is the first table header's row.
4659 INFO is a plist used as a communication channel."
4660 (and (org-export-table-row-in-header-p table-row info
)
4661 (org-export-table-row-starts-rowgroup-p table-row info
)))
4663 (defun org-export-table-row-ends-header-p (table-row info
)
4664 "Non-nil when TABLE-ROW is the last table header's row.
4665 INFO is a plist used as a communication channel."
4666 (and (org-export-table-row-in-header-p table-row info
)
4667 (org-export-table-row-ends-rowgroup-p table-row info
)))
4669 (defun org-export-table-row-number (table-row info
)
4670 "Return TABLE-ROW number.
4671 INFO is a plist used as a communication channel. Return value is
4672 zero-based and ignores separators. The function returns nil for
4673 special columns and separators."
4674 (when (and (eq (org-element-property :type table-row
) 'standard
)
4675 (not (org-export-table-row-is-special-p table-row info
)))
4677 (org-element-map (org-export-get-parent-table table-row
) 'table-row
4679 (cond ((eq row table-row
) number
)
4680 ((eq (org-element-property :type row
) 'standard
)
4681 (incf number
) nil
)))
4682 info
'first-match
))))
4684 (defun org-export-table-dimensions (table info
)
4685 "Return TABLE dimensions.
4687 INFO is a plist used as a communication channel.
4689 Return value is a CONS like (ROWS . COLUMNS) where
4690 ROWS (resp. COLUMNS) is the number of exportable
4691 rows (resp. columns)."
4692 (let (first-row (columns 0) (rows 0))
4693 ;; Set number of rows, and extract first one.
4694 (org-element-map table
'table-row
4696 (when (eq (org-element-property :type row
) 'standard
)
4698 (unless first-row
(setq first-row row
)))) info
)
4699 ;; Set number of columns.
4700 (org-element-map first-row
'table-cell
(lambda (cell) (incf columns
)) info
)
4702 (cons rows columns
)))
4704 (defun org-export-table-cell-address (table-cell info
)
4705 "Return address of a regular TABLE-CELL object.
4707 TABLE-CELL is the cell considered. INFO is a plist used as
4708 a communication channel.
4710 Address is a CONS cell (ROW . COLUMN), where ROW and COLUMN are
4711 zero-based index. Only exportable cells are considered. The
4712 function returns nil for other cells."
4713 (let* ((table-row (org-export-get-parent table-cell
))
4714 (row-number (org-export-table-row-number table-row info
)))
4717 (let ((col-count 0))
4718 (org-element-map table-row
'table-cell
4720 (if (eq cell table-cell
) col-count
(incf col-count
) nil
))
4721 info
'first-match
))))))
4723 (defun org-export-get-table-cell-at (address table info
)
4724 "Return regular table-cell object at ADDRESS in TABLE.
4726 Address is a CONS cell (ROW . COLUMN), where ROW and COLUMN are
4727 zero-based index. TABLE is a table type element. INFO is
4728 a plist used as a communication channel.
4730 If no table-cell, among exportable cells, is found at ADDRESS,
4732 (let ((column-pos (cdr address
)) (column-count 0))
4734 ;; Row at (car address) or nil.
4735 (let ((row-pos (car address
)) (row-count 0))
4736 (org-element-map table
'table-row
4738 (cond ((eq (org-element-property :type row
) 'rule
) nil
)
4739 ((= row-count row-pos
) row
)
4740 (t (incf row-count
) nil
)))
4744 (if (= column-count column-pos
) cell
4745 (incf column-count
) nil
))
4746 info
'first-match
)))
4749 ;;;; For Tables Of Contents
4751 ;; `org-export-collect-headlines' builds a list of all exportable
4752 ;; headline elements, maybe limited to a certain depth. One can then
4753 ;; easily parse it and transcode it.
4755 ;; Building lists of tables, figures or listings is quite similar.
4756 ;; Once the generic function `org-export-collect-elements' is defined,
4757 ;; `org-export-collect-tables', `org-export-collect-figures' and
4758 ;; `org-export-collect-listings' can be derived from it.
4760 (defun org-export-collect-headlines (info &optional n
)
4761 "Collect headlines in order to build a table of contents.
4763 INFO is a plist used as a communication channel.
4765 When optional argument N is an integer, it specifies the depth of
4766 the table of contents. Otherwise, it is set to the value of the
4767 last headline level. See `org-export-headline-levels' for more
4770 Return a list of all exportable headlines as parsed elements.
4771 Footnote sections, if any, will be ignored."
4772 (let ((limit (plist-get info
:headline-levels
)))
4773 (setq n
(if (wholenump n
) (min n limit
) limit
))
4774 (org-element-map (plist-get info
:parse-tree
) 'headline
4775 #'(lambda (headline)
4776 (unless (org-element-property :footnote-section-p headline
)
4777 (let ((level (org-export-get-relative-level headline info
)))
4778 (and (<= level n
) headline
))))
4781 (defun org-export-collect-elements (type info
&optional predicate
)
4782 "Collect referenceable elements of a determined type.
4784 TYPE can be a symbol or a list of symbols specifying element
4785 types to search. Only elements with a caption are collected.
4787 INFO is a plist used as a communication channel.
4789 When non-nil, optional argument PREDICATE is a function accepting
4790 one argument, an element of type TYPE. It returns a non-nil
4791 value when that element should be collected.
4793 Return a list of all elements found, in order of appearance."
4794 (org-element-map (plist-get info
:parse-tree
) type
4796 (and (org-element-property :caption element
)
4797 (or (not predicate
) (funcall predicate element
))
4801 (defun org-export-collect-tables (info)
4802 "Build a list of tables.
4803 INFO is a plist used as a communication channel.
4805 Return a list of table elements with a caption."
4806 (org-export-collect-elements 'table info
))
4808 (defun org-export-collect-figures (info predicate
)
4809 "Build a list of figures.
4811 INFO is a plist used as a communication channel. PREDICATE is
4812 a function which accepts one argument: a paragraph element and
4813 whose return value is non-nil when that element should be
4816 A figure is a paragraph type element, with a caption, verifying
4817 PREDICATE. The latter has to be provided since a \"figure\" is
4818 a vague concept that may depend on back-end.
4820 Return a list of elements recognized as figures."
4821 (org-export-collect-elements 'paragraph info predicate
))
4823 (defun org-export-collect-listings (info)
4824 "Build a list of src blocks.
4826 INFO is a plist used as a communication channel.
4828 Return a list of src-block elements with a caption."
4829 (org-export-collect-elements 'src-block info
))
4834 ;; The main function for the smart quotes sub-system is
4835 ;; `org-export-activate-smart-quotes', which replaces every quote in
4836 ;; a given string from the parse tree with its "smart" counterpart.
4838 ;; Dictionary for smart quotes is stored in
4839 ;; `org-export-smart-quotes-alist'.
4841 ;; Internally, regexps matching potential smart quotes (checks at
4842 ;; string boundaries are also necessary) are defined in
4843 ;; `org-export-smart-quotes-regexps'.
4845 (defconst org-export-smart-quotes-alist
4847 ;; one may use: »...«, "...", ›...‹, or '...'.
4848 ;; http://sproget.dk/raad-og-regler/retskrivningsregler/retskrivningsregler/a7-40-60/a7-58-anforselstegn/
4849 ;; LaTeX quotes require Babel!
4850 (opening-double-quote :utf-8
"»" :html
"»" :latex
">>"
4851 :texinfo
"@guillemetright{}")
4852 (closing-double-quote :utf-8
"«" :html
"«" :latex
"<<"
4853 :texinfo
"@guillemetleft{}")
4854 (opening-single-quote :utf-8
"›" :html
"›" :latex
"\\frq{}"
4855 :texinfo
"@guilsinglright{}")
4856 (closing-single-quote :utf-8
"‹" :html
"‹" :latex
"\\flq{}"
4857 :texinfo
"@guilsingleft{}")
4858 (apostrophe :utf-8
"’" :html
"’"))
4860 (opening-double-quote :utf-8
"„" :html
"„" :latex
"\"`"
4861 :texinfo
"@quotedblbase{}")
4862 (closing-double-quote :utf-8
"“" :html
"“" :latex
"\"'"
4863 :texinfo
"@quotedblleft{}")
4864 (opening-single-quote :utf-8
"‚" :html
"‚" :latex
"\\glq{}"
4865 :texinfo
"@quotesinglbase{}")
4866 (closing-single-quote :utf-8
"‘" :html
"‘" :latex
"\\grq{}"
4867 :texinfo
"@quoteleft{}")
4868 (apostrophe :utf-8
"’" :html
"’"))
4870 (opening-double-quote :utf-8
"“" :html
"“" :latex
"``" :texinfo
"``")
4871 (closing-double-quote :utf-8
"”" :html
"”" :latex
"''" :texinfo
"''")
4872 (opening-single-quote :utf-8
"‘" :html
"‘" :latex
"`" :texinfo
"`")
4873 (closing-single-quote :utf-8
"’" :html
"’" :latex
"'" :texinfo
"'")
4874 (apostrophe :utf-8
"’" :html
"’"))
4876 (opening-double-quote :utf-8
"«" :html
"«" :latex
"\\guillemotleft{}"
4877 :texinfo
"@guillemetleft{}")
4878 (closing-double-quote :utf-8
"»" :html
"»" :latex
"\\guillemotright{}"
4879 :texinfo
"@guillemetright{}")
4880 (opening-single-quote :utf-8
"“" :html
"“" :latex
"``" :texinfo
"``")
4881 (closing-single-quote :utf-8
"”" :html
"”" :latex
"''" :texinfo
"''")
4882 (apostrophe :utf-8
"’" :html
"’"))
4884 (opening-double-quote :utf-8
"« " :html
"« " :latex
"\\og "
4885 :texinfo
"@guillemetleft{}@tie{}")
4886 (closing-double-quote :utf-8
" »" :html
" »" :latex
"\\fg{}"
4887 :texinfo
"@tie{}@guillemetright{}")
4888 (opening-single-quote :utf-8
"« " :html
"« " :latex
"\\og "
4889 :texinfo
"@guillemetleft{}@tie{}")
4890 (closing-single-quote :utf-8
" »" :html
" »" :latex
"\\fg{}"
4891 :texinfo
"@tie{}@guillemetright{}")
4892 (apostrophe :utf-8
"’" :html
"’"))
4894 ;; https://nn.wikipedia.org/wiki/Sitatteikn
4895 (opening-double-quote :utf-8
"«" :html
"«" :latex
"\\guillemotleft{}"
4896 :texinfo
"@guillemetleft{}")
4897 (closing-double-quote :utf-8
"»" :html
"»" :latex
"\\guillemotright{}"
4898 :texinfo
"@guillemetright{}")
4899 (opening-single-quote :utf-8
"‘" :html
"‘" :latex
"`" :texinfo
"`")
4900 (closing-single-quote :utf-8
"’" :html
"’" :latex
"'" :texinfo
"'")
4901 (apostrophe :utf-8
"’" :html
"’"))
4903 ;; https://nn.wikipedia.org/wiki/Sitatteikn
4904 (opening-double-quote :utf-8
"«" :html
"«" :latex
"\\guillemotleft{}"
4905 :texinfo
"@guillemetleft{}")
4906 (closing-double-quote :utf-8
"»" :html
"»" :latex
"\\guillemotright{}"
4907 :texinfo
"@guillemetright{}")
4908 (opening-single-quote :utf-8
"‘" :html
"‘" :latex
"`" :texinfo
"`")
4909 (closing-single-quote :utf-8
"’" :html
"’" :latex
"'" :texinfo
"'")
4910 (apostrophe :utf-8
"’" :html
"’"))
4912 ;; https://nn.wikipedia.org/wiki/Sitatteikn
4913 (opening-double-quote :utf-8
"«" :html
"«" :latex
"\\guillemotleft{}"
4914 :texinfo
"@guillemetleft{}")
4915 (closing-double-quote :utf-8
"»" :html
"»" :latex
"\\guillemotright{}"
4916 :texinfo
"@guillemetright{}")
4917 (opening-single-quote :utf-8
"‘" :html
"‘" :latex
"`" :texinfo
"`")
4918 (closing-single-quote :utf-8
"’" :html
"’" :latex
"'" :texinfo
"'")
4919 (apostrophe :utf-8
"’" :html
"’"))
4921 ;; http://ru.wikipedia.org/wiki/%D0%9A%D0%B0%D0%B2%D1%8B%D1%87%D0%BA%D0%B8#.D0.9A.D0.B0.D0.B2.D1.8B.D1.87.D0.BA.D0.B8.2C_.D0.B8.D1.81.D0.BF.D0.BE.D0.BB.D1.8C.D0.B7.D1.83.D0.B5.D0.BC.D1.8B.D0.B5_.D0.B2_.D1.80.D1.83.D1.81.D1.81.D0.BA.D0.BE.D0.BC_.D1.8F.D0.B7.D1.8B.D0.BA.D0.B5
4922 ;; http://www.artlebedev.ru/kovodstvo/sections/104/
4923 (opening-double-quote :utf-8
"«" :html
"«" :latex
"{}<<"
4924 :texinfo
"@guillemetleft{}")
4925 (closing-double-quote :utf-8
"»" :html
"»" :latex
">>{}"
4926 :texinfo
"@guillemetright{}")
4927 (opening-single-quote :utf-8
"„" :html
"„" :latex
"\\glqq{}"
4928 :texinfo
"@quotedblbase{}")
4929 (closing-single-quote :utf-8
"“" :html
"“" :latex
"\\grqq{}"
4930 :texinfo
"@quotedblleft{}")
4931 (apostrophe :utf-8
"’" :html
: "'"))
4933 ;; based on https://sv.wikipedia.org/wiki/Citattecken
4934 (opening-double-quote :utf-8
"”" :html
"”" :latex
"’’" :texinfo
"’’")
4935 (closing-double-quote :utf-8
"”" :html
"”" :latex
"’’" :texinfo
"’’")
4936 (opening-single-quote :utf-8
"’" :html
"’" :latex
"’" :texinfo
"`")
4937 (closing-single-quote :utf-8
"’" :html
"’" :latex
"’" :texinfo
"'")
4938 (apostrophe :utf-8
"’" :html
"’"))
4940 "Smart quotes translations.
4942 Alist whose CAR is a language string and CDR is an alist with
4943 quote type as key and a plist associating various encodings to
4944 their translation as value.
4946 A quote type can be any symbol among `opening-double-quote',
4947 `closing-double-quote', `opening-single-quote',
4948 `closing-single-quote' and `apostrophe'.
4950 Valid encodings include `:utf-8', `:html', `:latex' and
4953 If no translation is found, the quote character is left as-is.")
4955 (defconst org-export-smart-quotes-regexps
4957 ;; Possible opening quote at beginning of string.
4958 "\\`\\([\"']\\)\\(\\w\\|\\s.\\|\\s_\\|\\s(\\)"
4959 ;; Possible closing quote at beginning of string.
4960 "\\`\\([\"']\\)\\(\\s-\\|\\s)\\|\\s.\\)"
4961 ;; Possible apostrophe at beginning of string.
4963 ;; Opening single and double quotes.
4964 "\\(?:\\s-\\|\\s(\\)\\([\"']\\)\\(?:\\w\\|\\s.\\|\\s_\\)"
4965 ;; Closing single and double quotes.
4966 "\\(?:\\w\\|\\s.\\|\\s_\\)\\([\"']\\)\\(?:\\s-\\|\\s)\\|\\s.\\)"
4969 ;; Possible opening quote at end of string.
4970 "\\(?:\\s-\\|\\s(\\)\\([\"']\\)\\'"
4971 ;; Possible closing quote at end of string.
4972 "\\(?:\\w\\|\\s.\\|\\s_\\)\\([\"']\\)\\'"
4973 ;; Possible apostrophe at end of string.
4975 "List of regexps matching a quote or an apostrophe.
4976 In every regexp, quote or apostrophe matched is put in group 1.")
4978 (defun org-export-activate-smart-quotes (s encoding info
&optional original
)
4979 "Replace regular quotes with \"smart\" quotes in string S.
4981 ENCODING is a symbol among `:html', `:latex', `:texinfo' and
4982 `:utf-8'. INFO is a plist used as a communication channel.
4984 The function has to retrieve information about string
4985 surroundings in parse tree. It can only happen with an
4986 unmodified string. Thus, if S has already been through another
4987 process, a non-nil ORIGINAL optional argument will provide that
4990 Return the new string."
4992 (let* ((prev (org-export-get-previous-element (or original s
) info
))
4993 ;; Try to be flexible when computing number of blanks
4994 ;; before object. The previous object may be a string
4995 ;; introduced by the back-end and not completely parsed.
4996 (pre-blank (and prev
4997 (or (org-element-property :post-blank prev
)
4998 ;; A string with missing `:post-blank'
5001 (string-match " *\\'" prev
)
5002 (length (match-string 0 prev
)))
5005 (next (org-export-get-next-element (or original s
) info
))
5008 ;; Return smart quote associated to a give quote Q, as
5009 ;; a string. TYPE is a symbol among `open', `close' and
5011 (let ((key (case type
5012 (apostrophe 'apostrophe
)
5013 (open (if (equal "'" q
) 'opening-single-quote
5014 'opening-double-quote
))
5015 (otherwise (if (equal "'" q
) 'closing-single-quote
5016 'closing-double-quote
)))))
5019 (cdr (assoc (plist-get info
:language
)
5020 org-export-smart-quotes-alist
))))
5023 (if (or (equal "\"" s
) (equal "'" s
))
5024 ;; Only a quote: no regexp can match. We have to check both
5025 ;; sides and decide what to do.
5026 (cond ((and (not prev
) (not next
)) s
)
5027 ((not prev
) (funcall get-smart-quote s
'open
))
5028 ((and (not next
) (zerop pre-blank
))
5029 (funcall get-smart-quote s
'close
))
5031 ((zerop pre-blank
) (funcall get-smart-quote s
'apostrophe
))
5032 (t (funcall get-smart-quote
'open
)))
5033 ;; 1. Replace quote character at the beginning of S.
5036 ((and prev
(zerop pre-blank
)
5037 (string-match (nth 2 org-export-smart-quotes-regexps
) s
))
5038 (setq s
(replace-match
5039 (funcall get-smart-quote
(match-string 1 s
) 'apostrophe
)
5042 ((and prev
(zerop pre-blank
)
5043 (string-match (nth 1 org-export-smart-quotes-regexps
) s
))
5044 (setq s
(replace-match
5045 (funcall get-smart-quote
(match-string 1 s
) 'close
)
5048 ((and (or (not prev
) (> pre-blank
0))
5049 (string-match (nth 0 org-export-smart-quotes-regexps
) s
))
5050 (setq s
(replace-match
5051 (funcall get-smart-quote
(match-string 1 s
) 'open
)
5053 ;; 2. Replace quotes in the middle of the string.
5054 (setq s
(replace-regexp-in-string
5056 (nth 3 org-export-smart-quotes-regexps
)
5058 (funcall get-smart-quote
(match-string 1 text
) 'open
))
5060 (setq s
(replace-regexp-in-string
5062 (nth 4 org-export-smart-quotes-regexps
)
5064 (funcall get-smart-quote
(match-string 1 text
) 'close
))
5066 (setq s
(replace-regexp-in-string
5068 (nth 5 org-export-smart-quotes-regexps
)
5070 (funcall get-smart-quote
(match-string 1 text
) 'apostrophe
))
5072 ;; 3. Replace quote character at the end of S.
5075 ((and next
(string-match (nth 8 org-export-smart-quotes-regexps
) s
))
5076 (setq s
(replace-match
5077 (funcall get-smart-quote
(match-string 1 s
) 'apostrophe
)
5081 (string-match (nth 7 org-export-smart-quotes-regexps
) s
))
5082 (setq s
(replace-match
5083 (funcall get-smart-quote
(match-string 1 s
) 'close
)
5086 ((and next
(string-match (nth 6 org-export-smart-quotes-regexps
) s
))
5087 (setq s
(replace-match
5088 (funcall get-smart-quote
(match-string 1 s
) 'open
)
5090 ;; Return string with smart quotes.
5095 ;; Here are various functions to retrieve information about the
5096 ;; neighborhood of a given element or object. Neighbors of interest
5097 ;; are direct parent (`org-export-get-parent'), parent headline
5098 ;; (`org-export-get-parent-headline'), first element containing an
5099 ;; object, (`org-export-get-parent-element'), parent table
5100 ;; (`org-export-get-parent-table'), previous element or object
5101 ;; (`org-export-get-previous-element') and next element or object
5102 ;; (`org-export-get-next-element').
5104 ;; `org-export-get-genealogy' returns the full genealogy of a given
5105 ;; element or object, from closest parent to full parse tree.
5107 ;; defsubst org-export-get-parent must be defined before first use
5109 (defun org-export-get-genealogy (blob)
5110 "Return full genealogy relative to a given element or object.
5112 BLOB is the element or object being considered.
5114 Ancestors are returned from closest to farthest, the last one
5115 being the full parse tree."
5116 (let (genealogy (parent blob
))
5117 (while (setq parent
(org-element-property :parent parent
))
5118 (push parent genealogy
))
5119 (nreverse genealogy
)))
5121 (defun org-export-get-parent-headline (blob)
5122 "Return BLOB parent headline or nil.
5123 BLOB is the element or object being considered."
5124 (let ((parent blob
))
5125 (while (and (setq parent
(org-element-property :parent parent
))
5126 (not (eq (org-element-type parent
) 'headline
))))
5129 (defun org-export-get-parent-element (object)
5130 "Return first element containing OBJECT or nil.
5131 OBJECT is the object to consider."
5132 (let ((parent object
))
5133 (while (and (setq parent
(org-element-property :parent parent
))
5134 (memq (org-element-type parent
) org-element-all-objects
)))
5137 (defun org-export-get-parent-table (object)
5138 "Return OBJECT parent table or nil.
5139 OBJECT is either a `table-cell' or `table-element' type object."
5140 (let ((parent object
))
5141 (while (and (setq parent
(org-element-property :parent parent
))
5142 (not (eq (org-element-type parent
) 'table
))))
5145 (defun org-export-get-previous-element (blob info
&optional n
)
5146 "Return previous element or object.
5148 BLOB is an element or object. INFO is a plist used as
5149 a communication channel. Return previous exportable element or
5150 object, a string, or nil.
5152 When optional argument N is a positive integer, return a list
5153 containing up to N siblings before BLOB, from farthest to
5154 closest. With any other non-nil value, return a list containing
5156 (let* ((secondary (org-element-secondary-p blob
))
5157 (parent (org-export-get-parent blob
))
5159 (if secondary
(org-element-property secondary parent
)
5160 (org-element-contents parent
)))
5163 (dolist (obj (cdr (memq blob
(reverse siblings
))) prev
)
5164 (cond ((memq obj
(plist-get info
:ignore-list
)))
5165 ((null n
) (throw 'exit obj
))
5166 ((not (wholenump n
)) (push obj prev
))
5167 ((zerop n
) (throw 'exit prev
))
5168 (t (decf n
) (push obj prev
)))))))
5170 (defun org-export-get-next-element (blob info
&optional n
)
5171 "Return next element or object.
5173 BLOB is an element or object. INFO is a plist used as
5174 a communication channel. Return next exportable element or
5175 object, a string, or nil.
5177 When optional argument N is a positive integer, return a list
5178 containing up to N siblings after BLOB, from closest to farthest.
5179 With any other non-nil value, return a list containing all of
5181 (let* ((secondary (org-element-secondary-p blob
))
5182 (parent (org-export-get-parent blob
))
5185 (if secondary
(org-element-property secondary parent
)
5186 (org-element-contents parent
)))))
5189 (dolist (obj siblings
(nreverse next
))
5190 (cond ((memq obj
(plist-get info
:ignore-list
)))
5191 ((null n
) (throw 'exit obj
))
5192 ((not (wholenump n
)) (push obj next
))
5193 ((zerop n
) (throw 'exit
(nreverse next
)))
5194 (t (decf n
) (push obj next
)))))))
5199 ;; `org-export-translate' translates a string according to the language
5200 ;; specified by the LANGUAGE keyword. `org-export-dictionary' contains
5201 ;; the dictionary used for the translation.
5203 (defconst org-export-dictionary
5205 ("fr" :default
"%e %n : %c" :html
"%e %n : %c"))
5207 ("ca" :default
"Autor")
5208 ("cs" :default
"Autor")
5209 ("da" :default
"Forfatter")
5210 ("de" :default
"Autor")
5211 ("eo" :html
"Aŭtoro")
5212 ("es" :default
"Autor")
5213 ("et" :default
"Autor")
5214 ("fi" :html
"Tekijä")
5215 ("fr" :default
"Auteur")
5216 ("hu" :default
"Szerzõ")
5217 ("is" :html
"Höfundur")
5218 ("it" :default
"Autore")
5219 ("ja" :default
"著者" :html
"著者")
5220 ("nl" :default
"Auteur")
5221 ("no" :default
"Forfatter")
5222 ("nb" :default
"Forfatter")
5223 ("nn" :default
"Forfattar")
5224 ("pl" :default
"Autor")
5225 ("ru" :html
"Автор" :utf-8
"Автор")
5226 ("sv" :html
"Författare")
5227 ("uk" :html
"Автор" :utf-8
"Автор")
5228 ("zh-CN" :html
"作者" :utf-8
"作者")
5229 ("zh-TW" :html
"作者" :utf-8
"作者"))
5230 ("Continued from previous page"
5231 ("de" :default
"Fortsetzung von vorheriger Seite")
5232 ("es" :default
"Continúa de la página anterior")
5233 ("fr" :default
"Suite de la page précédente")
5234 ("it" :default
"Continua da pagina precedente")
5235 ("ja" :default
"前ページからの続き")
5236 ("nl" :default
"Vervolg van vorige pagina")
5237 ("pt" :default
"Continuação da página anterior")
5238 ("ru" :html
"(Продолжение)"
5239 :utf-8
"(Продолжение)"))
5240 ("Continued on next page"
5241 ("de" :default
"Fortsetzung nächste Seite")
5242 ("es" :default
"Continúa en la siguiente página")
5243 ("fr" :default
"Suite page suivante")
5244 ("it" :default
"Continua alla pagina successiva")
5245 ("ja" :default
"次ページに続く")
5246 ("nl" :default
"Vervolg op volgende pagina")
5247 ("pt" :default
"Continua na página seguinte")
5248 ("ru" :html
"(Продолжение следует)"
5249 :utf-8
"(Продолжение следует)"))
5251 ("ca" :default
"Data")
5252 ("cs" :default
"Datum")
5253 ("da" :default
"Dato")
5254 ("de" :default
"Datum")
5255 ("eo" :default
"Dato")
5256 ("es" :default
"Fecha")
5257 ("et" :html
"Kuupäev" :utf-8
"Kuupäev")
5258 ("fi" :html
"Päivämäärä")
5259 ("hu" :html
"Dátum")
5260 ("is" :default
"Dagsetning")
5261 ("it" :default
"Data")
5262 ("ja" :default
"日付" :html
"日付")
5263 ("nl" :default
"Datum")
5264 ("no" :default
"Dato")
5265 ("nb" :default
"Dato")
5266 ("nn" :default
"Dato")
5267 ("pl" :default
"Data")
5268 ("ru" :html
"Дата" :utf-8
"Дата")
5269 ("sv" :default
"Datum")
5270 ("uk" :html
"Дата" :utf-8
"Дата")
5271 ("zh-CN" :html
"日期" :utf-8
"日期")
5272 ("zh-TW" :html
"日期" :utf-8
"日期"))
5274 ("da" :default
"Ligning")
5275 ("de" :default
"Gleichung")
5276 ("es" :html
"Ecuación" :default
"Ecuación")
5277 ("et" :html
"Võrrand" :utf-8
"Võrrand")
5278 ("fr" :ascii
"Equation" :default
"Équation")
5279 ("ja" :default
"方程式")
5280 ("no" :default
"Ligning")
5281 ("nb" :default
"Ligning")
5282 ("nn" :default
"Likning")
5283 ("ru" :html
"Уравнение"
5285 ("sv" :default
"Ekvation")
5286 ("zh-CN" :html
"方程" :utf-8
"方程"))
5288 ("da" :default
"Figur")
5289 ("de" :default
"Abbildung")
5290 ("es" :default
"Figura")
5291 ("et" :default
"Joonis")
5292 ("ja" :default
"図" :html
"図")
5293 ("no" :default
"Illustrasjon")
5294 ("nb" :default
"Illustrasjon")
5295 ("nn" :default
"Illustrasjon")
5296 ("ru" :html
"Рисунок" :utf-8
"Рисунок")
5297 ("sv" :default
"Illustration")
5298 ("zh-CN" :html
"图" :utf-8
"图"))
5300 ("da" :default
"Figur %d")
5301 ("de" :default
"Abbildung %d:")
5302 ("es" :default
"Figura %d:")
5303 ("et" :default
"Joonis %d:")
5304 ("fr" :default
"Figure %d :" :html
"Figure %d :")
5305 ("ja" :default
"図%d: " :html
"図%d: ")
5306 ("no" :default
"Illustrasjon %d")
5307 ("nb" :default
"Illustrasjon %d")
5308 ("nn" :default
"Illustrasjon %d")
5309 ("ru" :html
"Рис. %d.:" :utf-8
"Рис. %d.:")
5310 ("sv" :default
"Illustration %d")
5311 ("zh-CN" :html
"图%d " :utf-8
"图%d "))
5313 ("ca" :html
"Peus de pàgina")
5314 ("cs" :default
"Pozn\xe1mky pod carou")
5315 ("da" :default
"Fodnoter")
5316 ("de" :html
"Fußnoten" :default
"Fußnoten")
5317 ("eo" :default
"Piednotoj")
5318 ("es" :html
"Nota al pie de página" :default
"Nota al pie de página")
5319 ("et" :html
"Allmärkused" :utf-8
"Allmärkused")
5320 ("fi" :default
"Alaviitteet")
5321 ("fr" :default
"Notes de bas de page")
5322 ("hu" :html
"Lábjegyzet")
5323 ("is" :html
"Aftanmálsgreinar")
5324 ("it" :html
"Note a piè di pagina")
5325 ("ja" :default
"脚注" :html
"脚注")
5326 ("nl" :default
"Voetnoten")
5327 ("no" :default
"Fotnoter")
5328 ("nb" :default
"Fotnoter")
5329 ("nn" :default
"Fotnotar")
5330 ("pl" :default
"Przypis")
5331 ("ru" :html
"Сноски" :utf-8
"Сноски")
5332 ("sv" :default
"Fotnoter")
5333 ("uk" :html
"Примітки"
5335 ("zh-CN" :html
"脚注" :utf-8
"脚注")
5336 ("zh-TW" :html
"腳註" :utf-8
"腳註"))
5338 ("da" :default
"Programmer")
5339 ("de" :default
"Programmauflistungsverzeichnis")
5340 ("es" :default
"Indice de Listados de programas")
5341 ("et" :default
"Loendite nimekiri")
5342 ("fr" :default
"Liste des programmes")
5343 ("ja" :default
"ソースコード目次")
5344 ("no" :default
"Dataprogrammer")
5345 ("nb" :default
"Dataprogrammer")
5346 ("ru" :html
"Список распечаток"
5347 :utf-8
"Список распечаток")
5348 ("zh-CN" :html
"代码目录" :utf-8
"代码目录"))
5350 ("da" :default
"Tabeller")
5351 ("de" :default
"Tabellenverzeichnis")
5352 ("es" :default
"Indice de tablas")
5353 ("et" :default
"Tabelite nimekiri")
5354 ("fr" :default
"Liste des tableaux")
5355 ("ja" :default
"表目次")
5356 ("no" :default
"Tabeller")
5357 ("nb" :default
"Tabeller")
5358 ("nn" :default
"Tabeller")
5359 ("ru" :html
"Список таблиц"
5360 :utf-8
"Список таблиц")
5361 ("sv" :default
"Tabeller")
5362 ("zh-CN" :html
"表格目录" :utf-8
"表格目录"))
5364 ("da" :default
"Program %d")
5365 ("de" :default
"Programmlisting %d")
5366 ("es" :default
"Listado de programa %d")
5367 ("et" :default
"Loend %d")
5368 ("fr" :default
"Programme %d :" :html
"Programme %d :")
5369 ("ja" :default
"ソースコード%d:")
5370 ("no" :default
"Dataprogram %d")
5371 ("nb" :default
"Dataprogram %d")
5372 ("ru" :html
"Распечатка %d.:"
5373 :utf-8
"Распечатка %d.:")
5374 ("zh-CN" :html
"代码%d " :utf-8
"代码%d "))
5376 ("fr" :ascii
"References" :default
"Références")
5377 ("de" :default
"Quellen"))
5379 ("da" :default
"jævnfør afsnit %s")
5380 ("de" :default
"siehe Abschnitt %s")
5381 ("es" :default
"vea seccion %s")
5382 ("et" :html
"Vaata peatükki %s" :utf-8
"Vaata peatükki %s")
5383 ("fr" :default
"cf. section %s")
5384 ("ja" :default
"セクション %s を参照")
5385 ("ru" :html
"См. раздел %s"
5386 :utf-8
"См. раздел %s")
5387 ("zh-CN" :html
"参见第%s节" :utf-8
"参见第%s节"))
5389 ("de" :default
"Tabelle")
5390 ("es" :default
"Tabla")
5391 ("et" :default
"Tabel")
5392 ("fr" :default
"Tableau")
5393 ("ja" :default
"表" :html
"表")
5394 ("ru" :html
"Таблица" :utf-8
"Таблица")
5395 ("zh-CN" :html
"表" :utf-8
"表"))
5397 ("da" :default
"Tabel %d")
5398 ("de" :default
"Tabelle %d")
5399 ("es" :default
"Tabla %d")
5400 ("et" :default
"Tabel %d")
5401 ("fr" :default
"Tableau %d :")
5402 ("ja" :default
"表%d:" :html
"表%d:")
5403 ("no" :default
"Tabell %d")
5404 ("nb" :default
"Tabell %d")
5405 ("nn" :default
"Tabell %d")
5406 ("ru" :html
"Таблица %d.:"
5407 :utf-8
"Таблица %d.:")
5408 ("sv" :default
"Tabell %d")
5409 ("zh-CN" :html
"表%d " :utf-8
"表%d "))
5410 ("Table of Contents"
5411 ("ca" :html
"Índex")
5412 ("cs" :default
"Obsah")
5413 ("da" :default
"Indhold")
5414 ("de" :default
"Inhaltsverzeichnis")
5415 ("eo" :default
"Enhavo")
5416 ("es" :html
"Índice")
5417 ("et" :default
"Sisukord")
5418 ("fi" :html
"Sisällysluettelo")
5419 ("fr" :ascii
"Sommaire" :default
"Table des matières")
5420 ("hu" :html
"Tartalomjegyzék")
5421 ("is" :default
"Efnisyfirlit")
5422 ("it" :default
"Indice")
5423 ("ja" :default
"目次" :html
"目次")
5424 ("nl" :default
"Inhoudsopgave")
5425 ("no" :default
"Innhold")
5426 ("nb" :default
"Innhold")
5427 ("nn" :default
"Innhald")
5428 ("pl" :html
"Spis treści")
5429 ("ru" :html
"Содержание"
5430 :utf-8
"Содержание")
5431 ("sv" :html
"Innehåll")
5432 ("uk" :html
"Зміст" :utf-8
"Зміст")
5433 ("zh-CN" :html
"目录" :utf-8
"目录")
5434 ("zh-TW" :html
"目錄" :utf-8
"目錄"))
5435 ("Unknown reference"
5436 ("da" :default
"ukendt reference")
5437 ("de" :default
"Unbekannter Verweis")
5438 ("es" :default
"referencia desconocida")
5439 ("et" :default
"Tundmatu viide")
5440 ("fr" :ascii
"Destination inconnue" :default
"Référence inconnue")
5441 ("ja" :default
"不明な参照先")
5442 ("ru" :html
"Неизвестная ссылка"
5443 :utf-8
"Неизвестная ссылка")
5444 ("zh-CN" :html
"未知引用" :utf-8
"未知引用")))
5445 "Dictionary for export engine.
5447 Alist whose CAR is the string to translate and CDR is an alist
5448 whose CAR is the language string and CDR is a plist whose
5449 properties are possible charsets and values translated terms.
5451 It is used as a database for `org-export-translate'. Since this
5452 function returns the string as-is if no translation was found,
5453 the variable only needs to record values different from the
5456 (defun org-export-translate (s encoding info
)
5457 "Translate string S according to language specification.
5459 ENCODING is a symbol among `:ascii', `:html', `:latex', `:latin1'
5460 and `:utf-8'. INFO is a plist used as a communication channel.
5462 Translation depends on `:language' property. Return the
5463 translated string. If no translation is found, try to fall back
5464 to `:default' encoding. If it fails, return S."
5465 (let* ((lang (plist-get info
:language
))
5466 (translations (cdr (assoc lang
5467 (cdr (assoc s org-export-dictionary
))))))
5468 (or (plist-get translations encoding
)
5469 (plist-get translations
:default
)
5474 ;;; Asynchronous Export
5476 ;; `org-export-async-start' is the entry point for asynchronous
5477 ;; export. It recreates current buffer (including visibility,
5478 ;; narrowing and visited file) in an external Emacs process, and
5479 ;; evaluates a command there. It then applies a function on the
5480 ;; returned results in the current process.
5482 ;; At a higher level, `org-export-to-buffer' and `org-export-to-file'
5483 ;; allow to export to a buffer or a file, asynchronously or not.
5485 ;; `org-export-output-file-name' is an auxiliary function meant to be
5486 ;; used with `org-export-to-file'. With a given extension, it tries
5487 ;; to provide a canonical file name to write export output to.
5489 ;; Asynchronously generated results are never displayed directly.
5490 ;; Instead, they are stored in `org-export-stack-contents'. They can
5491 ;; then be retrieved by calling `org-export-stack'.
5493 ;; Export Stack is viewed through a dedicated major mode
5494 ;;`org-export-stack-mode' and tools: `org-export-stack-refresh',
5495 ;;`org-export-stack-delete', `org-export-stack-view' and
5496 ;;`org-export-stack-clear'.
5498 ;; For back-ends, `org-export-add-to-stack' add a new source to stack.
5499 ;; It should be used whenever `org-export-async-start' is called.
5501 (defmacro org-export-async-start
(fun &rest body
)
5502 "Call function FUN on the results returned by BODY evaluation.
5504 FUN is an anonymous function of one argument. BODY evaluation
5505 happens in an asynchronous process, from a buffer which is an
5506 exact copy of the current one.
5508 Use `org-export-add-to-stack' in FUN in order to register results
5511 This is a low level function. See also `org-export-to-buffer'
5512 and `org-export-to-file' for more specialized functions."
5513 (declare (indent 1) (debug t
))
5514 (org-with-gensyms (process temp-file copy-fun proc-buffer coding
)
5515 ;; Write the full sexp evaluating BODY in a copy of the current
5516 ;; buffer to a temporary file, as it may be too long for program
5517 ;; args in `start-process'.
5518 `(with-temp-message "Initializing asynchronous export process"
5519 (let ((,copy-fun
(org-export--generate-copy-script (current-buffer)))
5520 (,temp-file
(make-temp-file "org-export-process"))
5521 (,coding buffer-file-coding-system
))
5522 (with-temp-file ,temp-file
5524 ;; Null characters (from variable values) are inserted
5525 ;; within the file. As a consequence, coding system for
5526 ;; buffer contents will not be recognized properly. So,
5527 ;; we make sure it is the same as the one used to display
5528 ;; the original buffer.
5529 (format ";; -*- coding: %s; -*-\n%S"
5532 (when org-export-async-debug
'(setq debug-on-error t
))
5533 ;; Ignore `kill-emacs-hook' and code evaluation
5534 ;; queries from Babel as we need a truly
5535 ;; non-interactive process.
5536 (setq kill-emacs-hook nil
5537 org-babel-confirm-evaluate-answer-no t
)
5538 ;; Initialize export framework.
5540 ;; Re-create current buffer there.
5541 (funcall ,,copy-fun
)
5542 (restore-buffer-modified-p nil
)
5543 ;; Sexp to evaluate in the buffer.
5544 (print (progn ,,@body
))))))
5545 ;; Start external process.
5546 (let* ((process-connection-type nil
)
5547 (,proc-buffer
(generate-new-buffer-name "*Org Export Process*"))
5552 (list "org-export-process"
5554 (expand-file-name invocation-name invocation-directory
)
5556 (if org-export-async-init-file
5557 (list "-Q" "-l" org-export-async-init-file
)
5558 (list "-l" user-init-file
))
5559 (list "-l" ,temp-file
)))))
5560 ;; Register running process in stack.
5561 (org-export-add-to-stack (get-buffer ,proc-buffer
) nil
,process
)
5562 ;; Set-up sentinel in order to catch results.
5563 (let ((handler ,fun
))
5564 (set-process-sentinel
5567 (let ((proc-buffer (process-buffer p
)))
5568 (when (eq (process-status p
) 'exit
)
5570 (if (zerop (process-exit-status p
))
5573 (with-current-buffer proc-buffer
5574 (goto-char (point-max))
5576 (read (current-buffer)))))
5577 (funcall ,handler results
))
5578 (unless org-export-async-debug
5579 (and (get-buffer proc-buffer
)
5580 (kill-buffer proc-buffer
))))
5581 (org-export-add-to-stack proc-buffer nil p
)
5583 (message "Process '%s' exited abnormally" p
))
5584 (unless org-export-async-debug
5585 (delete-file ,,temp-file
)))))))))))))
5588 (defun org-export-to-buffer
5590 &optional async subtreep visible-only body-only ext-plist
5592 "Call `org-export-as' with output to a specified buffer.
5594 BACKEND is either an export back-end, as returned by, e.g.,
5595 `org-export-create-backend', or a symbol referring to
5596 a registered back-end.
5598 BUFFER is the name of the output buffer. If it already exists,
5599 it will be erased first, otherwise, it will be created.
5601 A non-nil optional argument ASYNC means the process should happen
5602 asynchronously. The resulting buffer should then be accessible
5603 through the `org-export-stack' interface. When ASYNC is nil, the
5604 buffer is displayed if `org-export-show-temporary-export-buffer'
5607 Optional arguments SUBTREEP, VISIBLE-ONLY, BODY-ONLY and
5608 EXT-PLIST are similar to those used in `org-export-as', which
5611 Optional argument POST-PROCESS is a function which should accept
5612 no argument. It is always called within the current process,
5613 from BUFFER, with point at its beginning. Export back-ends can
5614 use it to set a major mode there, e.g,
5616 \(defun org-latex-export-as-latex
5617 \(&optional async subtreep visible-only body-only ext-plist)
5619 \(org-export-to-buffer 'latex \"*Org LATEX Export*\"
5620 async subtreep visible-only body-only ext-plist (lambda () (LaTeX-mode))))
5622 This function returns BUFFER."
5623 (declare (indent 2))
5625 (org-export-async-start
5627 (with-current-buffer (get-buffer-create ,buffer
)
5629 (setq buffer-file-coding-system
',buffer-file-coding-system
)
5631 (goto-char (point-min))
5632 (org-export-add-to-stack (current-buffer) ',backend
)
5633 (ignore-errors (funcall ,post-process
))))
5635 ',backend
,subtreep
,visible-only
,body-only
',ext-plist
))
5637 (org-export-as backend subtreep visible-only body-only ext-plist
))
5638 (buffer (get-buffer-create buffer
))
5639 (encoding buffer-file-coding-system
))
5640 (when (and (org-string-nw-p output
) (org-export--copy-to-kill-ring-p))
5641 (org-kill-new output
))
5642 (with-current-buffer buffer
5644 (setq buffer-file-coding-system encoding
)
5646 (goto-char (point-min))
5647 (and (functionp post-process
) (funcall post-process
)))
5648 (when org-export-show-temporary-export-buffer
5649 (switch-to-buffer-other-window buffer
))
5653 (defun org-export-to-file
5654 (backend file
&optional async subtreep visible-only body-only ext-plist
5656 "Call `org-export-as' with output to a specified file.
5658 BACKEND is either an export back-end, as returned by, e.g.,
5659 `org-export-create-backend', or a symbol referring to
5660 a registered back-end. FILE is the name of the output file, as
5663 A non-nil optional argument ASYNC means the process should happen
5664 asynchronously. The resulting buffer will then be accessible
5665 through the `org-export-stack' interface.
5667 Optional arguments SUBTREEP, VISIBLE-ONLY, BODY-ONLY and
5668 EXT-PLIST are similar to those used in `org-export-as', which
5671 Optional argument POST-PROCESS is called with FILE as its
5672 argument and happens asynchronously when ASYNC is non-nil. It
5673 has to return a file name, or nil. Export back-ends can use this
5674 to send the output file through additional processing, e.g,
5676 \(defun org-latex-export-to-latex
5677 \(&optional async subtreep visible-only body-only ext-plist)
5679 \(let ((outfile (org-export-output-file-name \".tex\" subtreep)))
5680 \(org-export-to-file 'latex outfile
5681 async subtreep visible-only body-only ext-plist
5682 \(lambda (file) (org-latex-compile file)))
5684 The function returns either a file name returned by POST-PROCESS,
5686 (declare (indent 2))
5687 (if (not (file-writable-p file
)) (error "Output file not writable")
5688 (let ((ext-plist (org-combine-plists `(:output-file
,file
) ext-plist
))
5689 (encoding (or org-export-coding-system buffer-file-coding-system
)))
5691 (org-export-async-start
5693 (org-export-add-to-stack (expand-file-name file
) ',backend
))
5696 ',backend
,subtreep
,visible-only
,body-only
5700 (let ((coding-system-for-write ',encoding
))
5701 (write-file ,file
)))
5702 (or (ignore-errors (funcall ',post-process
,file
)) ,file
)))
5703 (let ((output (org-export-as
5704 backend subtreep visible-only body-only ext-plist
)))
5707 (let ((coding-system-for-write encoding
))
5709 (when (and (org-export--copy-to-kill-ring-p) (org-string-nw-p output
))
5710 (org-kill-new output
))
5711 ;; Get proper return value.
5712 (or (and (functionp post-process
) (funcall post-process file
))
5715 (defun org-export-output-file-name (extension &optional subtreep pub-dir
)
5716 "Return output file's name according to buffer specifications.
5718 EXTENSION is a string representing the output file extension,
5719 with the leading dot.
5721 With a non-nil optional argument SUBTREEP, try to determine
5722 output file's name by looking for \"EXPORT_FILE_NAME\" property
5723 of subtree at point.
5725 When optional argument PUB-DIR is set, use it as the publishing
5728 When optional argument VISIBLE-ONLY is non-nil, don't export
5729 contents of hidden elements.
5731 Return file name as a string."
5732 (let* ((visited-file (buffer-file-name (buffer-base-buffer)))
5734 ;; File name may come from EXPORT_FILE_NAME subtree
5735 ;; property, assuming point is at beginning of said
5737 (file-name-sans-extension
5741 (ignore-errors (org-back-to-heading) (point)))
5742 "EXPORT_FILE_NAME" t
))
5743 ;; File name may be extracted from buffer's associated
5745 (and visited-file
(file-name-nondirectory visited-file
))
5746 ;; Can't determine file name on our own: Ask user.
5747 (let ((read-file-name-function
5748 (and org-completion-use-ido
'ido-read-file-name
)))
5750 "Output file: " pub-dir nil nil nil
5752 (string= (file-name-extension name t
) extension
)))))))
5754 ;; Build file name. Enforce EXTENSION over whatever user
5755 ;; may have come up with. PUB-DIR, if defined, always has
5756 ;; precedence over any provided path.
5759 (concat (file-name-as-directory pub-dir
)
5760 (file-name-nondirectory base-name
)
5762 ((file-name-absolute-p base-name
) (concat base-name extension
))
5763 (t (concat (file-name-as-directory ".") base-name extension
)))))
5764 ;; If writing to OUTPUT-FILE would overwrite original file, append
5765 ;; EXTENSION another time to final name.
5766 (if (and visited-file
(org-file-equal-p visited-file output-file
))
5767 (concat output-file extension
)
5770 (defun org-export-add-to-stack (source backend
&optional process
)
5771 "Add a new result to export stack if not present already.
5773 SOURCE is a buffer or a file name containing export results.
5774 BACKEND is a symbol representing export back-end used to generate
5777 Entries already pointing to SOURCE and unavailable entries are
5778 removed beforehand. Return the new stack."
5779 (setq org-export-stack-contents
5780 (cons (list source backend
(or process
(current-time)))
5781 (org-export-stack-remove source
))))
5783 (defun org-export-stack ()
5784 "Menu for asynchronous export results and running processes."
5786 (let ((buffer (get-buffer-create "*Org Export Stack*")))
5788 (when (zerop (buffer-size)) (org-export-stack-mode))
5789 (org-export-stack-refresh)
5790 (pop-to-buffer buffer
))
5791 (message "Type \"q\" to quit, \"?\" for help"))
5793 (defun org-export--stack-source-at-point ()
5794 "Return source from export results at point in stack."
5795 (let ((source (car (nth (1- (org-current-line)) org-export-stack-contents
))))
5796 (if (not source
) (error "Source unavailable, please refresh buffer")
5797 (let ((source-name (if (stringp source
) source
(buffer-name source
))))
5800 (looking-at (concat ".* +" (regexp-quote source-name
) "$")))
5802 ;; SOURCE is not consistent with current line. The stack
5803 ;; view is outdated.
5804 (error "Source unavailable; type `g' to update buffer"))))))
5806 (defun org-export-stack-clear ()
5807 "Remove all entries from export stack."
5809 (setq org-export-stack-contents nil
))
5811 (defun org-export-stack-refresh (&rest dummy
)
5812 "Refresh the asynchronous export stack.
5813 DUMMY is ignored. Unavailable sources are removed from the list.
5814 Return the new stack."
5815 (let ((inhibit-read-only t
))
5822 (let ((proc-p (processp (nth 2 entry
))))
5825 (format " %-12s " (or (nth 1 entry
) ""))
5827 (let ((data (nth 2 entry
)))
5828 (if proc-p
(format " %6s " (process-status data
))
5829 ;; Compute age of the results.
5832 (float-time (time-since data
)))))
5835 (let ((source (car entry
)))
5836 (if (stringp source
) source
5837 (buffer-name source
)))))))
5838 ;; Clear stack from exited processes, dead buffers or
5839 ;; non-existent files.
5840 (setq org-export-stack-contents
5843 (if (processp (nth 2 el
))
5844 (buffer-live-p (process-buffer (nth 2 el
)))
5845 (let ((source (car el
)))
5846 (if (bufferp source
) (buffer-live-p source
)
5847 (file-exists-p source
)))))
5848 org-export-stack-contents
)) "\n")))))))
5850 (defun org-export-stack-remove (&optional source
)
5851 "Remove export results at point from stack.
5852 If optional argument SOURCE is non-nil, remove it instead."
5854 (let ((source (or source
(org-export--stack-source-at-point))))
5855 (setq org-export-stack-contents
5856 (org-remove-if (lambda (el) (equal (car el
) source
))
5857 org-export-stack-contents
))))
5859 (defun org-export-stack-view (&optional in-emacs
)
5860 "View export results at point in stack.
5861 With an optional prefix argument IN-EMACS, force viewing files
5864 (let ((source (org-export--stack-source-at-point)))
5865 (cond ((processp source
)
5866 (org-switch-to-buffer-other-window (process-buffer source
)))
5867 ((bufferp source
) (org-switch-to-buffer-other-window source
))
5868 (t (org-open-file source in-emacs
)))))
5870 (defvar org-export-stack-mode-map
5871 (let ((km (make-sparse-keymap)))
5872 (define-key km
" " 'next-line
)
5873 (define-key km
"n" 'next-line
)
5874 (define-key km
"\C-n" 'next-line
)
5875 (define-key km
[down] 'next-line)
5876 (define-key km "p" 'previous-line)
5877 (define-key km "\C-p" 'previous-line)
5878 (define-key km "\C-?" 'previous-line)
5879 (define-key km [up] 'previous-line)
5880 (define-key km "C" 'org-export-stack-clear)
5881 (define-key km "v" 'org-export-stack-view)
5882 (define-key km (kbd "RET") 'org-export-stack-view)
5883 (define-key km "d" 'org-export-stack-remove)
5885 "Keymap for Org Export Stack.")
5887 (define-derived-mode org-export-stack-mode special-mode "Org-Stack"
5888 "Mode for displaying asynchronous export stack.
5890 Type \\[org-export-stack] to visualize the asynchronous export
5893 In an Org Export Stack buffer, use \\<org-export-stack-mode-map>\\[org-export-stack-view] to view export output
5894 on current line, \\[org-export-stack-remove] to remove it from the stack and \\[org-export-stack-clear] to clear
5897 Removing entries in an Org Export Stack buffer doesn't affect
5898 files or buffers, only the display.
5900 \\{org-export-stack-mode-map}"
5903 (setq buffer-read-only t
5908 (format " %-12s | %6s | %s" "Back-End" "Age" "Source")))
5909 (org-add-hook 'post-command-hook 'org-export-stack-refresh nil t)
5910 (set (make-local-variable 'revert-buffer-function)
5911 'org-export-stack-refresh))
5917 ;; `org-export-dispatch' is the standard interactive way to start an
5918 ;; export process. It uses `org-export--dispatch-ui' as a subroutine
5919 ;; for its interface, which, in turn, delegates response to key
5920 ;; pressed to `org-export--dispatch-action'.
5923 (defun org-export-dispatch (&optional arg)
5924 "Export dispatcher for Org mode.
5926 It provides an access to common export related tasks in a buffer.
5927 Its interface comes in two flavors: standard and expert.
5929 While both share the same set of bindings, only the former
5930 displays the valid keys associations in a dedicated buffer.
5931 Scrolling (resp. line-wise motion) in this buffer is done with
5932 SPC and DEL (resp. C-n and C-p) keys.
5934 Set variable `org-export-dispatch-use-expert-ui' to switch to one
5935 flavor or the other.
5937 When ARG is \\[universal-argument], repeat the last export action, with the same set
5938 of options used back then, on the current buffer.
5940 When ARG is \\[universal-argument] \\[universal-argument], display the asynchronous export stack."
5943 (cond ((equal arg '(16)) '(stack))
5944 ((and arg org-export-dispatch-last-action))
5945 (t (save-window-excursion
5948 ;; Remember where we are
5949 (move-marker org-export-dispatch-last-position
5951 (org-base-buffer (current-buffer)))
5952 ;; Get and store an export command
5953 (setq org-export-dispatch-last-action
5954 (org-export--dispatch-ui
5955 (list org-export-initial-scope
5956 (and org-export-in-background 'async))
5958 org-export-dispatch-use-expert-ui)))
5959 (and (get-buffer "*Org Export Dispatcher*")
5960 (kill-buffer "*Org Export Dispatcher*")))))))
5961 (action (car input))
5962 (optns (cdr input)))
5963 (unless (memq 'subtree optns)
5964 (move-marker org-export-dispatch-last-position nil))
5966 ;; First handle special hard-coded actions.
5967 (template (org-export-insert-default-template nil optns))
5968 (stack (org-export-stack))
5969 (publish-current-file
5970 (org-publish-current-file (memq 'force optns) (memq 'async optns)))
5971 (publish-current-project
5972 (org-publish-current-project (memq 'force optns) (memq 'async optns)))
5973 (publish-choose-project
5974 (org-publish (assoc (org-icompleting-read
5976 org-publish-project-alist nil t)
5977 org-publish-project-alist)
5979 (memq 'async optns)))
5980 (publish-all (org-publish-all (memq 'force optns) (memq 'async optns)))
5984 ;; Repeating command, maybe move cursor to restore subtree
5986 (if (eq (marker-buffer org-export-dispatch-last-position)
5987 (org-base-buffer (current-buffer)))
5988 (goto-char org-export-dispatch-last-position)
5989 ;; We are in a different buffer, forget position.
5990 (move-marker org-export-dispatch-last-position nil)))
5992 ;; Return a symbol instead of a list to ease
5993 ;; asynchronous export macro use.
5994 (and (memq 'async optns) t)
5995 (and (memq 'subtree optns) t)
5996 (and (memq 'visible optns) t)
5997 (and (memq 'body optns) t)))))))
5999 (defun org-export--dispatch-ui (options first-key expertp)
6000 "Handle interface for `org-export-dispatch'.
6002 OPTIONS is a list containing current interactive options set for
6003 export. It can contain any of the following symbols:
6004 `body' toggles a body-only export
6005 `subtree' restricts export to current subtree
6006 `visible' restricts export to visible part of buffer.
6007 `force' force publishing files.
6008 `async' use asynchronous export process
6010 FIRST-KEY is the key pressed to select the first level menu. It
6011 is nil when this menu hasn't been selected yet.
6013 EXPERTP, when non-nil, triggers expert UI. In that case, no help
6014 buffer is provided, but indications about currently active
6015 options are given in the prompt. Moreover, \[?] allows to switch
6016 back to standard interface."
6018 (lambda (key &optional access-key)
6019 ;; Fontify KEY string. Optional argument ACCESS-KEY, when
6020 ;; non-nil is the required first-level key to activate
6021 ;; KEY. When its value is t, activate KEY independently
6022 ;; on the first key, if any. A nil value means KEY will
6023 ;; only be activated at first level.
6024 (if (or (eq access-key t) (eq access-key first-key))
6025 (org-propertize key 'face 'org-warning)
6029 ;; Fontify VALUE string.
6030 (org-propertize value 'face 'font-lock-variable-name-face)))
6031 ;; Prepare menu entries by extracting them from registered
6032 ;; back-ends and sorting them by access key and by ordinal,
6035 (sort (sort (delq nil
6036 (mapcar 'org-export-backend-menu
6037 org-export--registered-backends))
6039 (let ((key-a (nth 1 a))
6041 (cond ((and (numberp key-a) (numberp key-b))
6043 ((numberp key-b) t)))))
6044 'car-less-than-car))
6045 ;; Compute a list of allowed keys based on the first key
6046 ;; pressed, if any. Some keys
6047 ;; (?^B, ?^V, ?^S, ?^F, ?^A, ?&, ?# and ?q) are always
6050 (nconc (list 2 22 19 6 1)
6051 (if (not first-key) (org-uniquify (mapcar 'car entries))
6053 (dolist (entry entries (sort (mapcar 'car sub-menu) '<))
6054 (when (eq (car entry) first-key)
6055 (setq sub-menu (append (nth 2 entry) sub-menu))))))
6056 (cond ((eq first-key ?P) (list ?f ?p ?x ?a))
6057 ((not first-key) (list ?P)))
6059 (when expertp (list ??))
6061 ;; Build the help menu for standard UI.
6065 ;; Options are hard-coded.
6066 (format "[%s] Body only: %s [%s] Visible only: %s
6067 \[%s] Export scope: %s [%s] Force publishing: %s
6068 \[%s] Async export: %s\n\n"
6069 (funcall fontify-key "C-b" t)
6070 (funcall fontify-value
6071 (if (memq 'body options) "On " "Off"))
6072 (funcall fontify-key "C-v" t)
6073 (funcall fontify-value
6074 (if (memq 'visible options) "On " "Off"))
6075 (funcall fontify-key "C-s" t)
6076 (funcall fontify-value
6077 (if (memq 'subtree options) "Subtree" "Buffer "))
6078 (funcall fontify-key "C-f" t)
6079 (funcall fontify-value
6080 (if (memq 'force options) "On " "Off"))
6081 (funcall fontify-key "C-a" t)
6082 (funcall fontify-value
6083 (if (memq 'async options) "On " "Off")))
6084 ;; Display registered back-end entries. When a key
6085 ;; appears for the second time, do not create another
6086 ;; entry, but append its sub-menu to existing menu.
6090 (let ((top-key (car entry)))
6092 (unless (eq top-key last-key)
6093 (setq last-key top-key)
6094 (format "\n[%s] %s\n"
6095 (funcall fontify-key (char-to-string top-key))
6097 (let ((sub-menu (nth 2 entry)))
6098 (unless (functionp sub-menu)
6099 ;; Split sub-menu into two columns.
6106 (if (zerop (mod index 2)) " [%s] %-26s"
6108 (funcall fontify-key
6109 (char-to-string (car sub-entry))
6113 (when (zerop (mod index 2)) "\n"))))))))
6115 ;; Publishing menu is hard-coded.
6116 (format "\n[%s] Publish
6117 [%s] Current file [%s] Current project
6118 [%s] Choose project [%s] All projects\n\n\n"
6119 (funcall fontify-key "P")
6120 (funcall fontify-key "f" ?P)
6121 (funcall fontify-key "p" ?P)
6122 (funcall fontify-key "x" ?P)
6123 (funcall fontify-key "a" ?P))
6124 (format "[%s] Export stack [%s] Insert template\n"
6125 (funcall fontify-key "&" t)
6126 (funcall fontify-key "#" t))
6128 (funcall fontify-key "q" t)
6129 (if first-key "Main menu" "Exit")))))
6130 ;; Build prompts for both standard and expert UI.
6131 (standard-prompt (unless expertp "Export command: "))
6135 "Export command (C-%s%s%s%s%s) [%s]: "
6136 (if (memq 'body options) (funcall fontify-key "b" t) "b")
6137 (if (memq 'visible options) (funcall fontify-key "v" t) "v")
6138 (if (memq 'subtree options) (funcall fontify-key "s" t) "s")
6139 (if (memq 'force options) (funcall fontify-key "f" t) "f")
6140 (if (memq 'async options) (funcall fontify-key "a" t) "a")
6141 (mapconcat (lambda (k)
6142 ;; Strip control characters.
6143 (unless (< k 27) (char-to-string k)))
6144 allowed-keys "")))))
6145 ;; With expert UI, just read key with a fancy prompt. In standard
6146 ;; UI, display an intrusive help buffer.
6148 (org-export--dispatch-action
6149 expert-prompt allowed-keys entries options first-key expertp)
6150 ;; At first call, create frame layout in order to display menu.
6151 (unless (get-buffer "*Org Export Dispatcher*")
6152 (delete-other-windows)
6153 (org-switch-to-buffer-other-window
6154 (get-buffer-create "*Org Export Dispatcher*"))
6155 (setq cursor-type nil
6156 header-line-format "Use SPC, DEL, C-n or C-p to navigate.")
6157 ;; Make sure that invisible cursor will not highlight square
6159 (set-syntax-table (copy-syntax-table))
6160 (modify-syntax-entry ?\[ "w"))
6161 ;; At this point, the buffer containing the menu exists and is
6162 ;; visible in the current window. So, refresh it.
6163 (with-current-buffer "*Org Export Dispatcher*"
6164 ;; Refresh help. Maintain display continuity by re-visiting
6165 ;; previous window position.
6166 (let ((pos (window-start)))
6169 (set-window-start nil pos)))
6170 (org-fit-window-to-buffer)
6171 (org-export--dispatch-action
6172 standard-prompt allowed-keys entries options first-key expertp))))
6174 (defun org-export--dispatch-action
6175 (prompt allowed-keys entries options first-key expertp)
6176 "Read a character from command input and act accordingly.
6178 PROMPT is the displayed prompt, as a string. ALLOWED-KEYS is
6179 a list of characters available at a given step in the process.
6180 ENTRIES is a list of menu entries. OPTIONS, FIRST-KEY and
6181 EXPERTP are the same as defined in `org-export--dispatch-ui',
6184 Toggle export options when required. Otherwise, return value is
6185 a list with action as CAR and a list of interactive export
6188 ;; Scrolling: when in non-expert mode, act on motion keys (C-n,
6190 (while (and (setq key (read-char-exclusive prompt))
6192 (memq key '(14 16 ?\s ?\d)))
6194 (14 (if (not (pos-visible-in-window-p (point-max)))
6195 (ignore-errors (scroll-up 1))
6196 (message "End of buffer")
6198 (16 (if (not (pos-visible-in-window-p (point-min)))
6199 (ignore-errors (scroll-down 1))
6200 (message "Beginning of buffer")
6202 (?\s (if (not (pos-visible-in-window-p (point-max)))
6204 (message "End of buffer")
6206 (?\d (if (not (pos-visible-in-window-p (point-min)))
6208 (message "Beginning of buffer")
6211 ;; Ignore undefined associations.
6212 ((not (memq key allowed-keys))
6214 (unless expertp (message "Invalid key") (sit-for 1))
6215 (org-export--dispatch-ui options first-key expertp))
6216 ;; q key at first level aborts export. At second level, cancel
6217 ;; first key instead.
6218 ((eq key ?q) (if (not first-key) (error "Export aborted")
6219 (org-export--dispatch-ui options nil expertp)))
6220 ;; Help key: Switch back to standard interface if expert UI was
6222 ((eq key ??) (org-export--dispatch-ui options first-key nil))
6223 ;; Send request for template insertion along with export scope.
6224 ((eq key ?#) (cons 'template (memq 'subtree options)))
6225 ;; Switch to asynchronous export stack.
6226 ((eq key ?&) '(stack))
6227 ;; Toggle options: C-b (2) C-v (22) C-s (19) C-f (6) C-a (1).
6228 ((memq key '(2 22 19 6 1))
6229 (org-export--dispatch-ui
6230 (let ((option (case key (2 'body) (22 'visible) (19 'subtree)
6231 (6 'force) (1 'async))))
6232 (if (memq option options) (remq option options)
6233 (cons option options)))
6235 ;; Action selected: Send key and options back to
6236 ;; `org-export-dispatch'.
6237 ((or first-key (functionp (nth 2 (assq key entries))))
6239 ((not first-key) (nth 2 (assq key entries)))
6240 ;; Publishing actions are hard-coded. Send a special
6241 ;; signal to `org-export-dispatch'.
6244 (?f 'publish-current-file)
6245 (?p 'publish-current-project)
6246 (?x 'publish-choose-project)
6248 ;; Return first action associated to FIRST-KEY + KEY
6249 ;; path. Indeed, derived backends can share the same
6252 (mapc (lambda (entry)
6253 (let ((match (assq key (nth 2 entry))))
6254 (when match (throw 'found (nth 2 match)))))
6255 (member (assq first-key entries) entries)))))
6257 ;; Otherwise, enter sub-menu.
6258 (t (org-export--dispatch-ui options key expertp)))))
6265 ;; generated-autoload-file: "org-loaddefs.el"