1 ;;; test-ox.el --- Tests for ox.el
3 ;; Copyright (C) 2012-2015 Nicolas Goaziou
5 ;; Author: Nicolas Goaziou <n.goaziou at gmail dot com>
7 ;; This file is not part of GNU Emacs.
9 ;; This program is free software; you can redistribute it and/or modify
10 ;; it under the terms of the GNU General Public License as published by
11 ;; the Free Software Foundation, either version 3 of the License, or
12 ;; (at your option) any later version.
14 ;; This program is distributed in the hope that it will be useful,
15 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
16 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 ;; GNU General Public License for more details.
19 ;; You should have received a copy of the GNU General Public License
20 ;; along with this program. If not, see <http://www.gnu.org/licenses/>.
24 (unless (featurep 'ox
)
25 (signal 'missing-test-dependency
"org-export"))
27 (defun org-test-default-backend ()
28 "Return a default export back-end.
29 This back-end simply returns parsed data as Org syntax."
30 (org-export-create-backend
31 :transcoders
(let (transcode-table)
32 (dolist (type (append org-element-all-elements
33 org-element-all-objects
)
37 (lambda (obj contents info
)
39 (intern (format "org-element-%s-interpreter"
44 (defmacro org-test-with-parsed-data
(data &rest body
)
45 "Execute body with parsed data available.
46 DATA is a string containing the data to be parsed. BODY is the
47 body to execute. Parse tree is available under the `tree'
48 variable, and communication channel under `info'."
49 (declare (debug (form body
)) (indent 1))
50 `(org-test-with-temp-text ,data
51 (org-export--delete-comments)
52 (let* ((tree (org-element-parse-buffer))
53 (info (org-export-get-environment)))
54 (org-export--prune-tree tree info
)
55 (org-export--remove-uninterpreted-data tree info
)
56 (let ((info (org-combine-plists
57 info
(org-export-collect-tree-properties tree info
))))
64 (ert-deftest test-org-export
/bind-keyword
()
65 "Test reading #+BIND: keywords."
66 ;; Test with `org-export-allow-bind-keywords' set to t.
68 (org-test-with-temp-text "#+BIND: test-ox-var value"
69 (let ((org-export-allow-bind-keywords t
))
70 (org-export-get-environment)
71 (eq test-ox-var
'value
))))
72 ;; Test with `org-export-allow-bind-keywords' set to nil.
74 (org-test-with-temp-text "#+BIND: test-ox-var value"
75 (let ((org-export-allow-bind-keywords nil
))
76 (org-export-get-environment)
77 (boundp 'test-ox-var
))))
78 ;; BIND keywords are case-insensitive.
80 (org-test-with-temp-text "#+bind: test-ox-var value"
81 (let ((org-export-allow-bind-keywords t
))
82 (org-export-get-environment)
83 (eq test-ox-var
'value
))))
84 ;; Preserve order of BIND keywords.
86 (org-test-with-temp-text "#+BIND: test-ox-var 1\n#+BIND: test-ox-var 2"
87 (let ((org-export-allow-bind-keywords t
))
88 (org-export-get-environment)
90 ;; Read BIND keywords in setup files.
92 (org-test-with-temp-text
93 (format "#+SETUPFILE: \"%s/examples/setupfile.org\"" org-test-dir
)
94 (let ((org-export-allow-bind-keywords t
))
95 (org-export-get-environment)
96 (eq variable
'value
))))
97 ;; Verify that bound variables are seen during export.
100 (org-test-with-temp-text "#+BIND: test-ox-var value"
101 (let ((org-export-allow-bind-keywords t
))
103 (org-export-create-backend
105 '((section .
(lambda (s c i
)
106 (if (eq test-ox-var
'value
) "Yes" "No")))))))))))
108 (ert-deftest test-org-export
/parse-option-keyword
()
109 "Test reading all standard #+OPTIONS: items."
112 (org-export--parse-option-keyword
113 "H:1 num:t \\n:t timestamp:t arch:t author:t creator:t d:t email:t \
114 *:t e:t ::t f:t pri:t -:t ^:t toc:t |:t tags:t tasks:t <:t todo:t inline:nil \
116 (and (eq (plist-get options
:headline-levels
) 1)
117 (eq (plist-get options
:section-numbers
) t
)
118 (eq (plist-get options
:preserve-breaks
) t
)
119 (eq (plist-get options
:time-stamp-file
) t
)
120 (eq (plist-get options
:with-archived-trees
) t
)
121 (eq (plist-get options
:with-author
) t
)
122 (eq (plist-get options
:with-drawers
) t
)
123 (eq (plist-get options
:with-email
) t
)
124 (eq (plist-get options
:with-emphasize
) t
)
125 (eq (plist-get options
:with-entities
) t
)
126 (eq (plist-get options
:with-fixed-width
) t
)
127 (eq (plist-get options
:with-footnotes
) t
)
128 (eq (plist-get options
:with-priority
) t
)
129 (eq (plist-get options
:with-special-strings
) t
)
130 (eq (plist-get options
:with-sub-superscript
) t
)
131 (eq (plist-get options
:with-toc
) t
)
132 (eq (plist-get options
:with-tables
) t
)
133 (eq (plist-get options
:with-tags
) t
)
134 (eq (plist-get options
:with-tasks
) t
)
135 (eq (plist-get options
:with-timestamps
) t
)
136 (eq (plist-get options
:with-todo-keywords
) t
)
137 (eq (plist-get options
:with-inlinetasks
) nil
)
138 (eq (plist-get options
:with-statistics-cookies
) t
)
139 (eq (plist-get options
:with-title
) t
))))
140 ;; Test some special values.
143 (org-export--parse-option-keyword
144 "arch:headline d:(\"TEST\") ^:{} toc:1 tags:not-in-toc tasks:todo \
146 (and (eq (plist-get options
:with-archived-trees
) 'headline
)
147 (eq (plist-get options
:with-sub-superscript
) '{})
148 (eq (plist-get options
:with-toc
) 1)
149 (eq (plist-get options
:with-tags
) 'not-in-toc
)
150 (eq (plist-get options
:with-tasks
) 'todo
)
151 (eq (plist-get options
:section-numbers
) 2)
152 (eq (plist-get options
:with-timestamps
) 'active
)
153 (equal (plist-get options
:with-drawers
) '("TEST")))))
154 ;; Test back-end specific values.
157 (org-export--parse-option-keyword
158 "opt:t" (org-export-create-backend :options
'((:option nil
"opt"))))
160 ;; More than one property can refer to the same option item.
162 (equal '(:opt1 t
:opt2 t
)
163 (org-export--parse-option-keyword
165 (org-export-create-backend
166 :options
'((:opt1 nil
"opt") (:opt2 nil
"opt")))))))
168 (ert-deftest test-org-export
/get-inbuffer-options
()
169 "Test reading all standard export keywords."
170 ;; Properties should follow buffer order.
173 (org-test-with-temp-text "#+LANGUAGE: fr\n#+CREATOR: Me\n#+EMAIL: email"
174 (org-export--get-inbuffer-options))
175 '(:language
"fr" :creator
"Me" :email
"email")))
176 ;; Test `space' behaviour.
179 (let ((back-end (org-export-create-backend
180 :options
'((:keyword
"KEYWORD" nil nil space
)))))
181 (org-test-with-temp-text "#+KEYWORD: With\n#+KEYWORD: spaces"
182 (org-export--get-inbuffer-options back-end
)))
183 '(:keyword
"With spaces")))
184 ;; Test `newline' behaviour.
187 (let ((back-end (org-export-create-backend
188 :options
'((:keyword
"KEYWORD" nil nil newline
)))))
189 (org-test-with-temp-text "#+KEYWORD: With\n#+KEYWORD: two lines"
190 (org-export--get-inbuffer-options back-end
)))
191 '(:keyword
"With\ntwo lines")))
192 ;; Test `split' behaviour.
195 (org-test-with-temp-text "#+SELECT_TAGS: a\n#+SELECT_TAGS: b"
196 (org-export--get-inbuffer-options))
197 '(:select-tags
("a" "b"))))
198 ;; Test `parse' behaviour. `parse' implies `space' but preserve
199 ;; line breaks. Multi-line objects are allowed.
202 (org-test-with-temp-text "#+TITLE: *bold*"
203 (plist-get (org-export--get-inbuffer-options) :title
))
204 'bold
#'identity nil t
))
207 (org-test-with-temp-text "#+TITLE: Some title\n#+TITLE: with spaces"
208 (plist-get (org-export--get-inbuffer-options) :title
))
209 '("Some title with spaces")))
212 (org-test-with-temp-text "#+TITLE: Some title\\\\\n#+TITLE: with spaces"
213 (plist-get (org-export--get-inbuffer-options) :title
))
214 'line-break
#'identity nil t
))
217 (org-test-with-temp-text "#+TITLE: *bold\n#+TITLE: sentence*"
218 (plist-get (org-export--get-inbuffer-options) :title
))
219 'bold
#'identity nil t
))
220 ;; Options set through SETUPFILE.
223 (org-test-with-temp-text
224 (format "#+DESCRIPTION: l1
228 #+SETUPFILE: \"%s/examples/setupfile.org\"
233 (org-export--get-inbuffer-options))
234 '(:language
"fr" :select-tags
("a" "b" "c") :title
("a b c"))))
235 ;; More than one property can refer to the same buffer keyword.
237 (equal '(:k2
"value" :k1
"value")
238 (let ((backend (org-export-create-backend
239 :options
'((:k1
"KEYWORD")
241 (org-test-with-temp-text "#+KEYWORD: value"
242 (org-export--get-inbuffer-options backend
)))))
243 ;; Keywords in commented subtrees are ignored.
246 (org-test-with-parsed-data "* COMMENT H1\n#+AUTHOR: Me"
247 (plist-get info
:author
))))
250 (org-test-with-parsed-data "* COMMENT H1\n** H2\n#+EMAIL: Mine"
251 (plist-get info
:email
)))))
253 (ert-deftest test-org-export
/get-subtree-options
()
254 "Test setting options from headline's properties."
257 (equal '("Subtree Title")
258 (org-test-with-temp-text "#+TITLE: Title
261 :EXPORT_TITLE: Subtree Title
264 (plist-get (org-export-get-environment nil t
) :title
))))
268 (org-test-with-temp-text "#+OPTIONS: H:1
274 (plist-get (org-export-get-environment nil t
) :headline-levels
))))
277 (equal '("29-03-2012")
278 (org-test-with-temp-text "#+DATE: today
281 :EXPORT_DATE: 29-03-2012
284 (plist-get (org-export-get-environment nil t
) :date
))))
285 ;; Properties with `split' behaviour are stored as a list of
289 (org-test-with-temp-text "#+EXCLUDE_TAGS: noexport
292 :EXPORT_EXCLUDE_TAGS: a b
295 (plist-get (org-export-get-environment nil t
) :exclude-tags
))))
296 ;; Handle :PROPERTY+: syntax.
299 (org-test-with-temp-text "#+EXCLUDE_TAGS: noexport
302 :EXPORT_EXCLUDE_TAGS: a
303 :EXPORT_EXCLUDE_TAGS+: b
306 (plist-get (org-export-get-environment nil t
) :exclude-tags
))))
307 ;; Export properties are case-insensitive.
309 (equal '("29-03-2012")
310 (org-test-with-temp-text "* Headline
312 :EXPORT_Date: 29-03-2012
315 (plist-get (org-export-get-environment nil t
) :date
))))
316 ;; Still grab correct options when section above is empty.
319 (org-test-with-temp-text "* H1\n** H11\n** H12<point>"
320 (plist-get (org-export-get-environment nil t
) :title
))))
321 ;; More than one property can refer to the same node property.
324 (org-test-with-temp-text
325 "* H\n:PROPERTIES:\n:EXPORT_A: 1\n:END:\n<point>"
326 (let* ((backend (org-export-create-backend
329 (options (org-export-get-environment backend t
)))
330 (list (plist-get options
:k1
) (plist-get options
:k2
)))))))
332 (ert-deftest test-org-export
/set-title
()
333 "Test title setting."
334 ;; Without TITLE keyword.
338 (let (org-export-filter-body-functions
339 org-export-filter-final-output-functions
)
340 (org-test-with-temp-text "Test"
342 (org-export-create-backend
344 '((template .
(lambda (text info
)
345 (org-element-interpret-data
346 (plist-get info
:title
)))))))))))
347 ;; With a blank TITLE keyword.
351 (let (org-export-filter-body-functions
352 org-export-filter-final-output-functions
)
353 (org-test-with-temp-text "#+TITLE:\nTest"
355 (org-export-create-backend
357 '((template .
(lambda (text info
)
358 (org-element-interpret-data
359 (plist-get info
:title
)))))))))))
360 ;; With a non-empty TITLE keyword.
364 (org-test-with-temp-text "#+TITLE: Title\nTest"
366 (org-export-create-backend
368 '((template .
(lambda (text info
)
369 (org-element-interpret-data
370 (plist-get info
:title
))))))))))
371 ;; When exporting a subtree, its heading becomes the headline of the
376 (org-test-with-temp-text "* Headline\nBody"
378 (org-export-create-backend
380 '((template .
(lambda (text info
)
381 (org-element-interpret-data
382 (plist-get info
:title
))))))
384 ;; ... unless there is an EXPORT_TITLE property at the root of the
389 (org-test-with-temp-text
390 "* A\n :PROPERTIES:\n :EXPORT_TITLE: B\n :END:\nBody"
392 (org-export-create-backend
394 '((template .
(lambda (text info
)
395 (org-element-interpret-data
396 (plist-get info
:title
))))))
399 (ert-deftest test-org-export
/handle-options
()
400 "Test if export options have an impact on output."
401 ;; Test exclude tags for headlines and inlinetasks.
404 (let (org-export-filter-body-functions
405 org-export-filter-final-output-functions
)
406 (org-test-with-temp-text "* Head1 :noexp:"
407 (org-export-as (org-test-default-backend)
408 nil nil nil
'(:exclude-tags
("noexp")))))))
409 ;; Test include tags for headlines and inlinetasks.
411 (equal "* H2\n** Sub :exp:\n*** Sub Sub\n"
412 (org-test-with-temp-text "* H1\n* H2\n** Sub :exp:\n*** Sub Sub\n* H3"
413 (let ((org-tags-column 0))
414 (org-export-as (org-test-default-backend)
415 nil nil nil
'(:select-tags
("exp")))))))
416 ;; If there is an include tag, ignore the section before the first
419 (equal "* H1 :exp:\nBody\n"
420 (org-test-with-temp-text "First section\n* H1 :exp:\nBody"
421 (let ((org-tags-column 0))
422 (org-export-as (org-test-default-backend)
423 nil nil nil
'(:select-tags
("exp")))))))
425 (equal "* H1 :exp:\n"
426 (org-test-with-temp-text "* H1 :exp:\nBody"
427 (let ((org-tags-column 0))
428 (org-export-as (org-test-default-backend)
429 nil nil nil
'(:select-tags
("exp")))))))
430 ;; Test mixing include tags and exclude tags.
433 "\\* Head1[ \t]+:export:\n\\*\\* Sub-Head2\n"
434 (org-test-with-temp-text "
436 ** Sub-Head1 :noexport:
439 ** Sub-Head1 :export:"
440 (org-export-as (org-test-default-backend) nil nil nil
441 '(:select-tags
("export") :exclude-tags
("noexport"))))))
445 (let ((org-todo-keywords '((sequence "TODO" "DONE")))
446 org-export-filter-body-functions
447 org-export-filter-final-output-functions
)
448 (org-test-with-temp-text "* TODO Head1"
449 (org-export-as (org-test-default-backend)
450 nil nil nil
'(:with-tasks nil
))))))
452 (equal "* TODO Head1\n"
453 (let ((org-todo-keywords '((sequence "TODO" "DONE"))))
454 (org-test-with-temp-text "* TODO Head1"
455 (org-export-as (org-test-default-backend)
456 nil nil nil
'(:with-tasks t
))))))
460 (let (org-export-filter-body-functions
461 org-export-filter-final-output-functions
)
462 (org-test-with-temp-text "* Head1 :archive:"
463 (let ((org-archive-tag "archive"))
464 (org-export-as (org-test-default-backend)
465 nil nil nil
'(:with-archived-trees nil
)))))))
468 "\\* Head1[ \t]+:archive:"
469 (org-test-with-temp-text "* Head1 :archive:\nbody\n** Sub-head 2"
470 (let ((org-archive-tag "archive"))
471 (org-export-as (org-test-default-backend) nil nil nil
472 '(:with-archived-trees headline
))))))
475 "\\`\\* Head1[ \t]+:archive:\n\\'"
476 (org-test-with-temp-text "* Head1 :archive:"
477 (let ((org-archive-tag "archive"))
478 (org-export-as (org-test-default-backend)
479 nil nil nil
'(:with-archived-trees t
))))))
482 (string-match "CLOCK: \\[2012-04-29 .* 10:45\\]"
483 (org-test-with-temp-text "CLOCK: [2012-04-29 sun. 10:45]"
484 (org-export-as (org-test-default-backend)
485 nil nil nil
'(:with-clocks t
)))))
488 (let (org-export-filter-body-functions
489 org-export-filter-final-output-functions
)
490 (org-test-with-temp-text "CLOCK: [2012-04-29 sun. 10:45]"
491 (org-export-as (org-test-default-backend)
492 nil nil nil
'(:with-clocks nil
))))))
496 (let (org-export-filter-body-functions
497 org-export-filter-final-output-functions
)
498 (org-test-with-temp-text ":TEST:\ncontents\n:END:"
499 (org-export-as (org-test-default-backend)
500 nil nil nil
'(:with-drawers nil
))))))
502 (equal ":TEST:\ncontents\n:END:\n"
503 (org-test-with-temp-text ":TEST:\ncontents\n:END:"
504 (org-export-as (org-test-default-backend)
505 nil nil nil
'(:with-drawers t
)))))
507 (equal ":FOO:\nkeep\n:END:\n"
508 (org-test-with-temp-text ":FOO:\nkeep\n:END:\n:BAR:\nremove\n:END:"
509 (org-export-as (org-test-default-backend)
510 nil nil nil
'(:with-drawers
("FOO"))))))
512 (equal ":FOO:\nkeep\n:END:\n"
513 (org-test-with-temp-text ":FOO:\nkeep\n:END:\n:BAR:\nremove\n:END:"
514 (org-export-as (org-test-default-backend)
515 nil nil nil
'(:with-drawers
(not "BAR"))))))
519 (org-test-with-temp-text ": A"
520 (org-export-as (org-test-default-backend) nil nil nil
521 '(:with-fixed-width t
)))))
524 (let (org-export-filter-body-functions
525 org-export-filter-final-output-functions
)
526 (org-test-with-temp-text ": A"
527 (org-export-as (org-test-default-backend) nil nil nil
528 '(:with-fixed-width nil
))))))
532 (let ((org-footnote-section nil
))
533 (org-test-with-temp-text "Footnote?[fn:1]\n\n[fn:1] Def"
534 (org-trim (org-export-as (org-test-default-backend)
535 nil nil nil
'(:with-footnotes nil
)))))))
537 (equal "Footnote?[fn:1]\n\n[fn:1] Def"
538 (let ((org-footnote-section nil
))
539 (org-test-with-temp-text "Footnote?[fn:1]\n\n[fn:1] Def"
540 (org-trim (org-export-as (org-test-default-backend)
541 nil nil nil
'(:with-footnotes t
)))))))
543 (when (featurep 'org-inlinetask
)
547 (let ((org-inlinetask-min-level 15)
548 org-export-filter-body-functions
549 org-export-filter-final-output-functions
)
550 (org-test-with-temp-text "*************** Task"
551 (org-export-as (org-test-default-backend)
552 nil nil nil
'(:with-inlinetasks nil
))))))
556 (let ((org-inlinetask-min-level 15)
557 org-export-filter-body-functions
558 org-export-filter-final-output-functions
)
559 (org-test-with-temp-text
560 "*************** Task\nContents\n*************** END"
561 (org-export-as (org-test-default-backend)
562 nil nil nil
'(:with-inlinetasks nil
)))))))
566 "* H\nCLOSED: \\[2012-04-29 .* 10:45\\]"
567 (let ((org-closed-string "CLOSED:"))
568 (org-test-with-temp-text "* H\nCLOSED: [2012-04-29 sun. 10:45]"
569 (org-export-as (org-test-default-backend)
570 nil nil nil
'(:with-planning t
))))))
573 (let ((org-closed-string "CLOSED:"))
574 (org-test-with-temp-text "* H\nCLOSED: [2012-04-29 sun. 10:45]"
575 (org-export-as (org-test-default-backend)
576 nil nil nil
'(:with-planning nil
))))))
580 (org-test-with-temp-text
581 "* H1\n :PROPERTIES:\n :PROP: value\n :END:"
582 (org-export-as (org-test-default-backend)
583 nil nil nil
'(:with-properties nil
)))))
585 (equal "* H1\n:PROPERTIES:\n:PROP: value\n:END:\n"
586 (org-test-with-temp-text
587 "* H1\n :PROPERTIES:\n :PROP: value\n :END:"
588 (org-export-as (org-test-default-backend)
589 nil nil nil
'(:with-properties t
)))))
591 (equal "* H1\n:PROPERTIES:\n:B: 2\n:END:\n"
592 (org-test-with-temp-text
593 "* H1\n :PROPERTIES:\n :A: 1\n :B: 2\n:END:"
594 (org-export-as (org-test-default-backend)
595 nil nil nil
'(:with-properties
("B"))))))
596 ;; Statistics cookies.
599 (let (org-export-filter-body-functions
600 org-export-filter-final-output-functions
)
602 (org-test-with-temp-text "* Stats [0/0]"
603 (org-export-as (org-test-default-backend)
604 nil nil nil
'(:with-statistics-cookies nil
)))))))
608 (org-test-with-temp-text "| A |"
609 (org-export-as (org-test-default-backend) nil nil nil
610 '(:with-tables t
)))))
613 (let (org-export-filter-body-functions
614 org-export-filter-final-output-functions
)
615 (org-test-with-temp-text "| A |"
616 (org-export-as (org-test-default-backend) nil nil nil
617 '(:with-tables nil
)))))))
619 (ert-deftest test-org-export
/with-timestamps
()
620 "Test `org-export-with-timestamps' specifications."
624 "\\[2012-04-29 .*? 10:45\\]<2012-04-29 .*? 10:45>"
625 (org-test-with-temp-text "[2012-04-29 sun. 10:45]<2012-04-29 sun. 10:45>"
626 (org-export-as (org-test-default-backend)
627 nil nil nil
'(:with-timestamps t
)))))
632 (let (org-export-filter-body-functions
633 org-export-filter-final-output-functions
)
635 (org-test-with-temp-text "[2012-04-29 sun. 10:45]<2012-04-29 sun. 10:45>"
636 (org-export-as (org-test-default-backend)
637 nil nil nil
'(:with-timestamps nil
)))))))
641 "<2012-03-29 .*?>\n\nParagraph <2012-03-29 .*?>\\[2012-03-29 .*?\\]"
642 (org-test-with-temp-text
643 "<2012-03-29 Thu>[2012-03-29 Thu]
645 Paragraph <2012-03-29 Thu>[2012-03-29 Thu]"
646 (org-export-as (org-test-default-backend)
647 nil nil nil
'(:with-timestamps active
)))))
651 "\\[2012-03-29 .*?\\]\n\nParagraph <2012-03-29 .*?>\\[2012-03-29 .*?\\]"
652 (org-test-with-temp-text
653 "<2012-03-29 Thu>[2012-03-29 Thu]
655 Paragraph <2012-03-29 Thu>[2012-03-29 Thu]"
656 (org-export-as (org-test-default-backend)
657 nil nil nil
'(:with-timestamps inactive
))))))
659 (ert-deftest test-org-export
/comment-tree
()
660 "Test if export process ignores commented trees."
663 (let (org-export-filter-body-functions
664 org-export-filter-final-output-functions
)
665 (org-test-with-temp-text "* COMMENT Head1"
666 (org-export-as (org-test-default-backend)))))))
668 (ert-deftest test-org-export
/uninterpreted
()
669 "Test handling of uninterpreted elements."
673 (org-test-with-temp-text "\\alpha"
675 (org-export-create-backend
676 :transcoders
'((entity .
(lambda (e c i
) "dummy"))
677 (paragraph .
(lambda (p c i
) c
))
678 (section .
(lambda (s c i
) c
))))
679 nil nil nil
'(:with-entities t
)))))
682 (org-test-with-temp-text "\\alpha"
684 (org-export-create-backend
685 :transcoders
'((entity .
(lambda (e c i
) "dummy"))
686 (paragraph .
(lambda (p c i
) c
))
687 (section .
(lambda (s c i
) c
))))
688 nil nil nil
'(:with-entities nil
)))))
692 (org-test-with-temp-text "*bold*"
694 (org-export-create-backend
695 :transcoders
'((bold .
(lambda (b c i
) "dummy"))
696 (paragraph .
(lambda (p c i
) c
))
697 (section .
(lambda (s c i
) c
))))
698 nil nil nil
'(:with-emphasize t
)))))
701 (org-test-with-temp-text "*bold*"
703 (org-export-create-backend
704 :transcoders
'((bold .
(lambda (b c i
) "dummy"))
705 (paragraph .
(lambda (p c i
) c
))
706 (section .
(lambda (s c i
) c
))))
707 nil nil nil
'(:with-emphasize nil
)))))
708 ;; LaTeX environment.
711 (org-test-with-temp-text "\\begin{equation}\n1+1=2\n\\end{equation}"
713 (org-export-create-backend
714 :transcoders
'((latex-environment .
(lambda (l c i
) "dummy"))
715 (section .
(lambda (s c i
) c
))))
716 nil nil nil
'(:with-latex t
)))))
718 (equal "\\begin{equation}\n1+1=2\n\\end{equation}\n"
719 (org-test-with-temp-text "\\begin{equation}\n1+1=2\n\\end{equation}"
721 (org-export-create-backend
722 :transcoders
'((latex-environment .
(lambda (l c i
) "dummy"))
723 (section .
(lambda (s c i
) c
))))
724 nil nil nil
'(:with-latex verbatim
)))))
728 (org-test-with-temp-text "$1$"
730 (org-export-create-backend
731 :transcoders
'((latex-fragment .
(lambda (l c i
) "dummy"))
732 (paragraph .
(lambda (p c i
) c
))
733 (section .
(lambda (s c i
) c
))))
734 nil nil nil
'(:with-latex t
)))))
737 (org-test-with-temp-text "$1$"
739 (org-export-create-backend
740 :transcoders
'((latex-fragment .
(lambda (l c i
) "dummy"))
741 (paragraph .
(lambda (p c i
) c
))
742 (section .
(lambda (s c i
) c
))))
743 nil nil nil
'(:with-latex verbatim
)))))
747 (org-test-with-temp-text "a_b"
749 (org-export-create-backend
750 :transcoders
'((subscript .
(lambda (s c i
) "dummy"))
751 (paragraph .
(lambda (p c i
) c
))
752 (section .
(lambda (s c i
) c
))))
753 nil nil nil
'(:with-sub-superscript t
)))))
756 (org-test-with-temp-text "a_b"
758 (org-export-create-backend
759 :transcoders
'((subscript .
(lambda (s c i
) "dummy"))
760 (paragraph .
(lambda (p c i
) c
))
761 (section .
(lambda (s c i
) c
))))
762 nil nil nil
'(:with-sub-superscript nil
)))))
765 (org-test-with-temp-text "a_b"
767 (org-export-create-backend
768 :transcoders
'((subscript .
(lambda (s c i
) "dummy"))
769 (paragraph .
(lambda (p c i
) c
))
770 (section .
(lambda (s c i
) c
))))
771 nil nil nil
'(:with-sub-superscript
{})))))
774 (org-test-with-temp-text "a_{b}"
776 (org-export-create-backend
777 :transcoders
'((subscript .
(lambda (s c i
) "dummy"))
778 (paragraph .
(lambda (p c i
) c
))
779 (section .
(lambda (s c i
) c
))))
780 nil nil nil
'(:with-sub-superscript
{})))))
781 ;; Also handle uninterpreted objects in title.
784 (org-test-with-temp-text "#+TITLE: a_b"
786 (org-export-create-backend
788 '((subscript .
(lambda (s c i
) "dummy"))
789 (template .
(lambda (c i
) (org-export-data
790 (plist-get i
:title
) i
)))
791 (section .
(lambda (s c i
) c
))))
792 nil nil nil
'(:with-sub-superscript nil
)))))
793 ;; Handle uninterpreted objects in captions.
796 (org-test-with-temp-text "#+CAPTION: a_b\nParagraph"
798 (org-export-create-backend
800 '((subscript .
(lambda (s c i
) "dummy"))
801 (paragraph .
(lambda (p c i
)
802 (org-export-data (org-export-get-caption p
) i
)))
803 (section .
(lambda (s c i
) c
))))
804 nil nil nil
'(:with-sub-superscript t
)))))
807 (org-test-with-temp-text "#+CAPTION: a_b\nParagraph"
809 (org-export-create-backend
811 '((subscript .
(lambda (s c i
) "dummy"))
812 (paragraph .
(lambda (p c i
)
813 (org-export-data (org-export-get-caption p
) i
)))
814 (section .
(lambda (s c i
) c
))))
815 nil nil nil
'(:with-sub-superscript nil
)))))
816 ;; Special case: multiples uninterpreted objects in a row.
819 (org-test-with-temp-text "a_b_c_d"
821 (org-export-create-backend
822 :transcoders
'((subscript .
(lambda (s c i
) "dummy"))
823 (paragraph .
(lambda (p c i
) c
))
824 (section .
(lambda (s c i
) c
))))
825 nil nil nil
'(:with-sub-superscript
{}))))))
827 (ert-deftest test-org-export
/export-scope
()
828 "Test all export scopes."
829 (org-test-with-temp-text "
836 (should (equal (org-export-as (org-test-default-backend) 'subtree
)
837 "text\n*** Head3\n"))
839 (goto-char (point-min))
842 (should (equal (org-export-as (org-test-default-backend) nil
'visible
)
845 (goto-char (point-min))
847 (transient-mark-mode 1)
848 (push-mark (point) t t
)
849 (goto-char (point-at-eol))
850 (should (equal (org-export-as (org-test-default-backend)) "text\n")))
851 ;; Subtree with a code block calling another block outside.
852 (let ((org-export-babel-evaluate t
))
855 (org-test-with-temp-text "
857 #+BEGIN_SRC emacs-lisp :noweb yes :exports results
862 #+BEGIN_SRC emacs-lisp
866 (org-export-as (org-test-default-backend) 'subtree
)))))
868 (let ((backend (org-test-default-backend)))
869 (setf (org-export-backend-transcoders backend
)
870 (cons '(template .
(lambda (body i
)
871 (format "BEGIN\n%sEND" body
)))
872 (org-export-backend-transcoders backend
)))
873 (org-test-with-temp-text "Text"
874 (should (equal (org-export-as backend nil nil
'body-only
)
876 (should (equal (org-export-as backend
) "BEGIN\nText\nEND")))))
878 (ert-deftest test-org-export
/output-file-name
()
879 "Test `org-export-output-file-name' specifications."
880 ;; Export from a file: name is built from original file name.
882 (org-test-with-temp-text-in-file "Test"
883 (equal (concat (file-name-as-directory ".")
884 (file-name-nondirectory
885 (file-name-sans-extension (buffer-file-name))))
886 (file-name-sans-extension (org-export-output-file-name ".ext")))))
887 ;; When exporting to subtree, check EXPORT_FILE_NAME property first.
889 (org-test-with-temp-text-in-file
890 "* Test\n :PROPERTIES:\n :EXPORT_FILE_NAME: test\n :END:"
891 (equal (org-export-output-file-name ".ext" t
) "./test.ext")))
892 ;; From a buffer not associated to a file, too.
894 (org-test-with-temp-text
895 "* Test\n :PROPERTIES:\n :EXPORT_FILE_NAME: test\n :END:"
896 (equal (org-export-output-file-name ".ext" t
) "./test.ext")))
897 ;; When provided name is absolute, preserve it.
899 (org-test-with-temp-text
900 (format "* Test\n :PROPERTIES:\n :EXPORT_FILE_NAME: %s\n :END:"
901 (expand-file-name "test"))
902 (file-name-absolute-p (org-export-output-file-name ".ext" t
))))
903 ;; When PUB-DIR argument is provided, use it.
905 (org-test-with-temp-text-in-file "Test"
906 (equal (file-name-directory
907 (org-export-output-file-name ".ext" nil
"dir/"))
909 ;; When returned name would overwrite original file, add EXTENSION
912 (org-test-at-id "75282ba2-f77a-4309-a970-e87c149fe125"
913 (equal (org-export-output-file-name ".org") "./normal.org.org"))))
915 (ert-deftest test-org-export
/expand-include
()
916 "Test file inclusion in an Org buffer."
917 ;; Error when file isn't specified.
919 (org-test-with-temp-text "#+INCLUDE: dummy.org"
920 (org-export-expand-include-keyword)))
921 ;; Full insertion with recursive inclusion.
926 (expand-file-name "examples/include.org" org-test-dir
))
927 (replace-regexp-in-string
928 (regexp-quote "#+INCLUDE: \"include2.org\"")
929 "Success!" (buffer-string)))
930 (org-test-with-temp-text
931 (format "#+INCLUDE: \"%s/examples/include.org\"" org-test-dir
)
932 (org-export-expand-include-keyword)
934 ;; Localized insertion.
935 (org-test-with-temp-text
936 (format "#+INCLUDE: \"%s/examples/include.org\" :lines \"1-2\""
938 (org-export-expand-include-keyword)
939 (should (equal (buffer-string)
940 "Small Org file with an include keyword.\n")))
941 ;; Insertion with constraints on headlines level.
944 "* Top heading\n** Heading\nbody\n"
945 (org-test-with-temp-text
947 "* Top heading\n#+INCLUDE: \"%s/examples/include.org\" :lines \"9-11\""
949 (org-export-expand-include-keyword)
953 "* Top heading\n* Heading\nbody\n"
954 (org-test-with-temp-text
956 "* Top heading\n#+INCLUDE: \"%s/examples/include.org\" :lines \"9-11\" :minlevel 1"
958 (org-export-expand-include-keyword)
960 ;; Inclusion within an example block.
963 "#+BEGIN_EXAMPLE\nSmall Org file with an include keyword.\n#+END_EXAMPLE\n"
964 (org-test-with-temp-text
965 (format "#+INCLUDE: \"%s/examples/include.org\" :lines \"1-2\" EXAMPLE"
967 (org-export-expand-include-keyword)
969 ;; Inclusion within a src-block.
972 "#+BEGIN_SRC emacs-lisp\n(+ 2 1)\n#+END_SRC\n"
973 (org-test-with-temp-text
975 "#+INCLUDE: \"%s/examples/include.org\" :lines \"4-5\" SRC emacs-lisp"
977 (org-export-expand-include-keyword)
979 ;; Inclusion within an html export-block.
982 "#+BEGIN_HTML\n<p>HTML!</p>\n#+END_HTML\n"
983 (org-test-with-temp-text
985 "#+INCLUDE: \"%s/examples/include.html\" HTML"
987 (org-export-expand-include-keyword)
989 ;; Inclusion within an center paragraph
992 "#+BEGIN_CENTER\nSuccess!\n#+END_CENTER\n"
993 (org-test-with-temp-text
995 "#+INCLUDE: \"%s/examples/include2.org\" CENTER"
997 (org-export-expand-include-keyword)
999 ;; Footnotes labels are local to each included file.
1005 Footnotes[fn:1], [fn:test], [fn:test] and [fn:inline:anonymous footnote].
1007 \[fn:test] Footnote \"test\""))
1008 (org-test-with-temp-text-in-file contents
1009 (let ((file1 (buffer-file-name)))
1010 (org-test-with-temp-text-in-file contents
1011 (let ((file2 (buffer-file-name)))
1012 (org-test-with-temp-text
1013 (format "#+INCLUDE: \"%s\"\n#+INCLUDE: \"%s\""
1015 (org-export-expand-include-keyword)
1016 (org-element-map (org-element-parse-buffer)
1018 (lambda (r) (org-element-property :label r
)))))))))))))
1019 ;; Footnotes labels are not local to each include keyword.
1025 Footnotes[fn:1], [fn:test], [2] and [fn:inline:anonymous footnote].
1028 \[fn:test] Footnote \"test\""))
1029 (org-test-with-temp-text-in-file contents
1030 (let ((file (buffer-file-name)))
1031 (org-test-with-temp-text
1032 (format "#+INCLUDE: \"%s\"\n#+INCLUDE: \"%s\"" file file
)
1033 (org-export-expand-include-keyword)
1034 (org-element-map (org-element-parse-buffer)
1036 (lambda (ref) (org-element-property :label ref
)))))))))))
1037 ;; Footnotes are supported by :lines-like elements and unnecessary
1038 ;; footnotes are dropped.
1047 Footnotes[fn:2], foot[fn:test], digit only[3], and [fn:inline:anonymous footnote]
1052 \[fn:test] Footnote \"test\"
1055 (org-test-with-temp-text-in-file contents
1056 (let ((file (buffer-file-name)))
1057 (org-test-with-temp-text
1058 (format "#+INCLUDE: \"%s::*bar\"
1060 (org-export-expand-include-keyword)
1061 (org-element-map (org-element-parse-buffer)
1062 'footnote-definition
1063 (lambda (ref) (org-element-property :label ref
)))))))))))
1064 ;; If only-contents is non-nil only include contents of element.
1068 (org-test-with-temp-text
1070 (format "#+INCLUDE: \"%s/examples/include.org::*Heading\" " org-test-dir
)
1072 (org-export-expand-include-keyword)
1074 ;; Headings can be included via CUSTOM_ID.
1076 (org-test-with-temp-text
1077 (format "#+INCLUDE: \"%s/examples/include.org::#ah\"" org-test-dir
)
1078 (org-export-expand-include-keyword)
1079 (goto-char (point-min))
1080 (looking-at "* Another heading")))
1081 ;; Named objects can be included.
1085 (org-test-with-temp-text
1086 (format "#+INCLUDE: \"%s/examples/include.org::tbl\" :only-contents t" org-test-dir
)
1087 (org-export-expand-include-keyword)
1089 ;; Including non-existing elements should result in an error.
1091 (org-test-with-temp-text
1092 (format "#+INCLUDE: \"%s/examples/include.org::*non-existing heading\"" org-test-dir
)
1093 (org-export-expand-include-keyword)))
1094 ;; Lines work relatively to an included element.
1098 (org-test-with-temp-text
1099 (format "#+INCLUDE: \"%s/examples/include.org::#ah\" :only-contents t :lines \"2-3\"" org-test-dir
)
1100 (org-export-expand-include-keyword)
1102 ;; Properties should be dropped from headlines.
1105 (org-test-with-temp-text
1106 (format "#+INCLUDE: \"%s/examples/include.org::#ht\" :only-contents t" org-test-dir
)
1107 (org-export-expand-include-keyword)
1109 (org-test-with-temp-text
1110 (format "#+INCLUDE: \"%s/examples/include.org::tbl\"" org-test-dir
)
1111 (org-export-expand-include-keyword)
1113 ;; Properties should be dropped, drawers should not be.
1116 ":LOGBOOK:\ndrawer\n:END:\ncontent\n"
1117 (org-test-with-temp-text
1118 (format "#+INCLUDE: \"%s/examples/include.org::#dh\" :only-contents t" org-test-dir
)
1119 (org-export-expand-include-keyword)
1121 ;; Adjacent INCLUDE-keywords should have the same :minlevel if unspecified.
1123 (org-every (lambda (level) (zerop (1- level
)))
1124 (org-test-with-temp-text
1126 (format "#+INCLUDE: \"%s/examples/include.org::#ah\"\n" org-test-dir
)
1127 (format "#+INCLUDE: \"%s/examples/include.org::*Heading\"" org-test-dir
))
1128 (org-export-expand-include-keyword)
1129 (org-element-map (org-element-parse-buffer) 'headline
1130 (lambda (head) (org-element-property :level head
))))))
1131 ;; INCLUDE does not insert induced :minlevel for src-blocks.
1134 (org-test-with-temp-text
1135 (format "#+INCLUDE: \"%s/examples/include2.org\" src emacs-lisp" org-test-dir
)
1136 (org-export-expand-include-keyword)
1138 (org-test-with-temp-text
1139 (format "#+INCLUDE: \"%s/examples/include2.org\" src emacs-lisp :minlevel 1" org-test-dir
)
1140 (org-export-expand-include-keyword)
1142 ;; INCLUDE assigns the relative :minlevel conditional on narrowing.
1144 (org-test-with-temp-text-in-file
1145 (format "* h1\n<point>#+INCLUDE: \"%s/examples/include.org::#ah\"" org-test-dir
)
1146 (narrow-to-region (point) (point-max))
1147 (org-export-expand-include-keyword)
1148 (eq 1 (org-current-level))))
1149 ;; If :minlevel is present do not alter it.
1151 (org-test-with-temp-text
1152 (format "* h1\n<point>#+INCLUDE: \"%s/examples/include.org::#ah\" :minlevel 3" org-test-dir
)
1153 (narrow-to-region (point) (point-max))
1154 (org-export-expand-include-keyword)
1155 (eq 3 (org-current-level)))))
1157 (ert-deftest test-org-export
/expand-macro
()
1158 "Test macro expansion in an Org buffer."
1159 ;; Standard macro expansion.
1161 (equal "#+MACRO: macro1 value\nvalue\n"
1162 (org-test-with-temp-text "#+MACRO: macro1 value\n{{{macro1}}}"
1163 (org-export-as (org-test-default-backend)))))
1164 ;; Allow macro in parsed keywords and associated properties.
1165 ;; Standard macro expansion.
1169 (let ((backend (org-export-create-backend
1171 :options
'((:k
"K" nil nil parse
)))))
1172 (org-test-with-temp-text "#+MACRO: macro value\n#+K: {{{macro}}}"
1173 (org-export-as backend
)))))
1177 (let ((backend (org-export-create-backend
1179 :options
'((:k
"K" nil nil parse
)))))
1180 (org-test-with-temp-text
1181 "#+MACRO: m v\n* H\n:PROPERTIES:\n:EXPORT_K: {{{m}}}\n:END:"
1182 (org-export-as backend nil nil nil
'(:with-properties t
))))))
1183 ;; Expand specific macros.
1185 (equal "me 2012-03-29 me@here Title\n"
1186 (org-test-with-temp-text
1192 {{{author}}} {{{date}}} {{{email}}} {{{title}}}"
1193 (let ((output (org-export-as (org-test-default-backend))))
1194 (substring output
(string-match ".*\n\\'" output
))))))
1195 ;; Expand specific macros when property contained a regular macro
1199 (org-test-with-temp-text "
1200 #+MACRO: macro1 value
1201 #+TITLE: {{{macro1}}}
1203 (let ((output (org-export-as (org-test-default-backend))))
1204 (substring output
(string-match ".*\n\\'" output
))))))
1205 ;; Expand macros with templates in included files.
1208 (org-test-with-temp-text
1209 (format "#+INCLUDE: \"%s/examples/macro-templates.org\"
1210 {{{included-macro}}}" org-test-dir
)
1211 (let ((output (org-export-as (org-test-default-backend))))
1212 (substring output
(string-match ".*\n\\'" output
))))))
1213 ;; Date macro takes a optional formatting argument
1216 (org-test-with-temp-text "{{{date(%d-%m-%y)}}}\n* d :noexport:\n#+DATE: <2015-02-09>"
1217 (org-export-as (org-test-default-backend)))))
1218 ;; Only single timestamps are formatted
1220 (equal "<2015-02x-09>\n"
1221 (org-test-with-temp-text "{{{date(%d-%m-%y)}}}\n* d :noexport:\n#+DATE: <2015-02x-09>"
1222 (org-export-as (org-test-default-backend)))))
1223 ;; Throw an error when a macro definition is missing.
1225 (org-test-with-temp-text "{{{missing}}}"
1226 (org-export-as (org-test-default-backend))))
1227 ;; Macros defined in commented subtrees are ignored.
1229 (org-test-with-temp-text
1230 "* COMMENT H\n#+MACRO: macro1\n* H2\nvalue\n{{{macro1}}}"
1231 (org-export-as (org-test-default-backend))))
1233 (org-test-with-temp-text
1234 "* COMMENT H\n** H2\n#+MACRO: macro1\n* H3\nvalue\n{{{macro1}}}"
1235 (org-export-as (org-test-default-backend)))))
1237 (ert-deftest test-org-export
/before-processing-hook
()
1238 "Test `org-export-before-processing-hook'."
1241 "#+MACRO: mac val\nTest\n"
1242 (org-test-with-temp-text "#+MACRO: mac val\n{{{mac}}} Test"
1243 (let ((org-export-before-processing-hook
1245 (while (re-search-forward "{{{" nil t
)
1246 (let ((object (org-element-context)))
1247 (when (eq (org-element-type object
) 'macro
)
1249 (org-element-property :begin object
)
1250 (org-element-property :end object
)))))))))
1251 (org-export-as (org-test-default-backend)))))))
1253 (ert-deftest test-org-export
/before-parsing-hook
()
1254 "Test `org-export-before-parsing-hook'."
1256 (equal "Body 1\nBody 2\n"
1257 (org-test-with-temp-text "* Headline 1\nBody 1\n* Headline 2\nBody 2"
1258 (let ((org-export-before-parsing-hook
1260 (goto-char (point-min))
1261 (while (re-search-forward org-outline-regexp-bol nil t
)
1263 (point-at-bol) (progn (forward-line) (point))))))))
1264 (org-export-as (org-test-default-backend)))))))
1268 ;;; Affiliated Keywords
1270 (ert-deftest test-org-export
/read-attribute
()
1271 "Test `org-export-read-attribute' specifications."
1275 (org-export-read-attribute
1277 (org-test-with-temp-text "#+ATTR_HTML: :a 1 :b 2\nParagraph"
1278 (org-element-at-point)))
1280 ;; Return nil on empty attribute.
1282 (org-export-read-attribute
1284 (org-test-with-temp-text "Paragraph" (org-element-at-point))))
1285 ;; Return nil on "nil" string.
1287 (equal '(:a nil
:b nil
)
1288 (org-export-read-attribute
1290 (org-test-with-temp-text "#+ATTR_HTML: :a nil :b nil\nParagraph"
1291 (org-element-at-point)))))
1292 ;; Return nil on empty string.
1294 (equal '(:a nil
:b nil
)
1295 (org-export-read-attribute
1297 (org-test-with-temp-text "#+ATTR_HTML: :a :b\nParagraph"
1298 (org-element-at-point)))))
1299 ;; Return empty string when value is "".
1302 (org-export-read-attribute
1304 (org-test-with-temp-text "#+ATTR_HTML: :a \"\"\nParagraph"
1305 (org-element-at-point)))))
1306 ;; Return \"\" when value is """".
1309 (org-export-read-attribute
1311 (org-test-with-temp-text "#+ATTR_HTML: :a \"\"\"\"\nParagraph"
1312 (org-element-at-point)))))
1313 ;; Ignore text before first property.
1316 (org-export-read-attribute
1318 (org-test-with-temp-text "#+ATTR_HTML: ignore :a 1\nParagraph"
1319 (org-element-at-point))))))
1321 (ert-deftest test-org-export
/get-caption
()
1322 "Test `org-export-get-caption' specifications."
1323 ;; Without optional argument, return long caption
1327 (org-test-with-temp-text "#+CAPTION[s]: l\nPara"
1328 (org-export-get-caption (org-element-at-point)))))
1329 ;; With optional argument, return short caption.
1333 (org-test-with-temp-text "#+CAPTION[s]: l\nPara"
1334 (org-export-get-caption (org-element-at-point) t
))))
1335 ;; Multiple lines are separated by white spaces.
1339 (org-test-with-temp-text "#+CAPTION: a\n#+CAPTION: b\nPara"
1340 (org-export-get-caption (org-element-at-point))))))
1346 (ert-deftest test-org-export
/define-backend
()
1347 "Test back-end definition and accessors."
1350 (equal '((headline . my-headline-test
))
1351 (let (org-export-registered-backends)
1352 (org-export-define-backend 'test
'((headline . my-headline-test
)))
1353 (org-export-get-all-transcoders 'test
))))
1356 (equal '((:filter-headline . my-filter
))
1357 (let (org-export-registered-backends)
1358 (org-export-define-backend 'test
1359 '((headline . my-headline-test
))
1360 :filters-alist
'((:filter-headline . my-filter
)))
1361 (org-export-backend-filters (org-export-get-backend 'test
)))))
1364 (equal '((:prop value
))
1365 (let (org-export-registered-backends)
1366 (org-export-define-backend 'test
1367 '((headline . my-headline-test
))
1368 :options-alist
'((:prop value
)))
1369 (org-export-backend-options (org-export-get-backend 'test
)))))
1372 (equal '(?k
"Test Export" test
)
1373 (let (org-export-registered-backends)
1374 (org-export-define-backend 'test
1375 '((headline . my-headline-test
))
1376 :menu-entry
'(?k
"Test Export" test
))
1377 (org-export-backend-menu (org-export-get-backend 'test
)))))
1380 (equal '(("TEST" . org-element-export-block-parser
))
1381 (let (org-export-registered-backends org-element-block-name-alist
)
1382 (org-export-define-backend 'test
1383 '((headline . my-headline-test
))
1384 :export-block
'("test"))
1385 org-element-block-name-alist
))))
1387 (ert-deftest test-org-export
/define-derived-backend
()
1388 "Test `org-export-define-derived-backend' specifications."
1389 ;; Error when parent back-end is not defined.
1391 (let (org-export-registered-backends)
1392 (org-export-define-derived-backend 'test
'parent
)))
1393 ;; Append translation table to parent's.
1395 (equal '((:headline . test
) (:headline . parent
))
1396 (let (org-export-registered-backends)
1397 (org-export-define-backend 'parent
'((:headline . parent
)))
1398 (org-export-define-derived-backend 'test
'parent
1399 :translate-alist
'((:headline . test
)))
1400 (org-export-get-all-transcoders 'test
))))
1401 ;; Options defined in the new back have priority over those defined
1405 (let (org-export-registered-backends)
1406 (org-export-define-backend 'parent
1407 '((:headline . parent
))
1408 :options-alist
'((:a nil nil
'parent
)))
1409 (org-export-define-derived-backend 'test
'parent
1410 :options-alist
'((:a nil nil
'test
)))
1411 (plist-get (org-export--get-global-options
1412 (org-export-get-backend 'test
))
1415 (ert-deftest test-org-export
/derived-backend-p
()
1416 "Test `org-export-derived-backend-p' specifications."
1417 ;; Non-nil with direct match.
1419 (let (org-export-registered-backends)
1420 (org-export-define-backend 'test
'((headline . test
)))
1421 (org-export-derived-backend-p 'test
'test
)))
1423 (let (org-export-registered-backends)
1424 (org-export-define-backend 'test
'((headline . test
)))
1425 (org-export-define-derived-backend 'test2
'test
)
1426 (org-export-derived-backend-p 'test2
'test2
)))
1427 ;; Non-nil with a direct parent.
1429 (let (org-export-registered-backends)
1430 (org-export-define-backend 'test
'((headline . test
)))
1431 (org-export-define-derived-backend 'test2
'test
)
1432 (org-export-derived-backend-p 'test2
'test
)))
1433 ;; Non-nil with an indirect parent.
1435 (let (org-export-registered-backends)
1436 (org-export-define-backend 'test
'((headline . test
)))
1437 (org-export-define-derived-backend 'test2
'test
)
1438 (org-export-define-derived-backend 'test3
'test2
)
1439 (org-export-derived-backend-p 'test3
'test
)))
1442 (let (org-export-registered-backends)
1443 (org-export-define-backend 'test
'((headline . test
)))
1444 (org-export-define-backend 'test2
'((headline . test2
)))
1445 (org-export-derived-backend-p 'test2
'test
)))
1447 (let (org-export-registered-backends)
1448 (org-export-define-backend 'test
'((headline . test
)))
1449 (org-export-define-backend 'test2
'((headline . test2
)))
1450 (org-export-define-derived-backend 'test3
'test2
)
1451 (org-export-derived-backend-p 'test3
'test
))))
1453 (ert-deftest test-org-export
/get-all-transcoders
()
1454 "Test `org-export-get-all-transcoders' specifications."
1455 ;; Return nil when back-end cannot be found.
1456 (should-not (org-export-get-all-transcoders nil
))
1457 ;; Same as `org-export-transcoders' if no parent.
1459 (equal '((headline . ignore
))
1460 (org-export-get-all-transcoders
1461 (org-export-create-backend
1462 :transcoders
'((headline . ignore
))))))
1463 ;; But inherit from all ancestors whenever possible.
1465 (equal '((section . ignore
) (headline . ignore
))
1466 (let (org-export-registered-backends)
1467 (org-export-define-backend 'b1
'((headline . ignore
)))
1468 (org-export-get-all-transcoders
1469 (org-export-create-backend
1470 :parent
'b1
:transcoders
'((section . ignore
)))))))
1472 (equal '((paragraph . ignore
) (section . ignore
) (headline . ignore
))
1473 (let (org-export-registered-backends)
1474 (org-export-define-backend 'b1
'((headline . ignore
)))
1475 (org-export-define-derived-backend 'b2
'b1
1476 :translate-alist
'((section . ignore
)))
1477 (org-export-get-all-transcoders
1478 (org-export-create-backend
1479 :parent
'b2
:transcoders
'((paragraph . ignore
)))))))
1480 ;; Back-end transcoders overrule inherited ones.
1483 (let (org-export-registered-backends)
1484 (org-export-define-backend 'b1
'((headline . a
)))
1485 (cdr (assq 'headline
1486 (org-export-get-all-transcoders
1487 (org-export-create-backend
1488 :parent
'b1
:transcoders
'((headline . b
))))))))))
1490 (ert-deftest test-org-export
/get-all-options
()
1491 "Test `org-export-get-all-options' specifications."
1492 ;; Return nil when back-end cannot be found.
1493 (should-not (org-export-get-all-options nil
))
1494 ;; Same as `org-export-options' if no parent.
1496 (equal '((headline . ignore
))
1497 (org-export-get-all-options
1498 (org-export-create-backend
1499 :options
'((headline . ignore
))))))
1500 ;; But inherit from all ancestors whenever possible.
1502 (equal '((:key2 value2
) (:key1 value1
))
1503 (let (org-export-registered-backends)
1504 (org-export-define-backend 'b1 nil
:options-alist
'((:key1 value1
)))
1505 (org-export-get-all-options
1506 (org-export-create-backend
1507 :parent
'b1
:options
'((:key2 value2
)))))))
1509 (equal '((:key3 value3
) (:key2 value2
) (:key1 value1
))
1510 (let (org-export-registered-backends)
1511 (org-export-define-backend 'b1 nil
:options-alist
'((:key1 value1
)))
1512 (org-export-define-derived-backend 'b2
'b1
1513 :options-alist
'((:key2 value2
)))
1514 (org-export-get-all-options
1515 (org-export-create-backend
1516 :parent
'b2
:options
'((:key3 value3
)))))))
1517 ;; Back-end options overrule inherited ones.
1520 (let (org-export-registered-backends)
1521 (org-export-define-backend 'b1 nil
:options-alist
'((:key1 . a
)))
1523 (org-export-get-all-options
1524 (org-export-create-backend
1525 :parent
'b1
:options
'((:key1 . b
))))))))))
1527 (ert-deftest test-org-export
/get-all-filters
()
1528 "Test `org-export-get-all-filters' specifications."
1529 ;; Return nil when back-end cannot be found.
1530 (should-not (org-export-get-all-filters nil
))
1531 ;; Same as `org-export-filters' if no parent.
1533 (equal '((:filter-headline . ignore
))
1534 (org-export-get-all-filters
1535 (org-export-create-backend
1536 :filters
'((:filter-headline . ignore
))))))
1537 ;; But inherit from all ancestors whenever possible.
1539 (equal '((:filter-section . ignore
) (:filter-headline . ignore
))
1540 (let (org-export-registered-backends)
1541 (org-export-define-backend 'b1
1542 nil
:filters-alist
'((:filter-headline . ignore
)))
1543 (org-export-get-all-filters
1544 (org-export-create-backend
1545 :parent
'b1
:filters
'((:filter-section . ignore
)))))))
1547 (equal '((:filter-paragraph . ignore
)
1548 (:filter-section . ignore
)
1549 (:filter-headline . ignore
))
1550 (let (org-export-registered-backends)
1551 (org-export-define-backend 'b1
1552 nil
:filters-alist
'((:filter-headline . ignore
)))
1553 (org-export-define-derived-backend 'b2
'b1
1554 :filters-alist
'((:filter-section . ignore
)))
1555 (org-export-get-all-filters
1556 (org-export-create-backend
1557 :parent
'b2
:filters
'((:filter-paragraph . ignore
)))))))
1558 ;; Back-end filters overrule inherited ones.
1561 (let (org-export-registered-backends)
1562 (org-export-define-backend 'b1
'((:filter-headline . a
)))
1563 (cdr (assq :filter-headline
1564 (org-export-get-all-filters
1565 (org-export-create-backend
1566 :parent
'b1
:filters
'((:filter-headline . b
))))))))))
1568 (ert-deftest test-org-export
/with-backend
()
1569 "Test `org-export-with-backend' definition."
1570 ;; Error when calling an undefined back-end
1571 (should-error (org-export-with-backend nil
"Test"))
1572 ;; Error when called back-end doesn't have an appropriate
1575 (org-export-with-backend
1576 (org-export-create-backend :transcoders
'((headline . ignore
)))
1578 ;; Otherwise, export using correct transcoder
1581 (let (org-export-registered-backends)
1582 (org-export-define-backend 'test
1583 '((plain-text .
(lambda (text contents info
) "Failure"))))
1584 (org-export-define-backend 'test2
1585 '((plain-text .
(lambda (text contents info
) "Success"))))
1586 (org-export-with-backend 'test2
"Test"))))
1587 ;; Provide correct back-end if transcoder needs to use recursive
1591 (let ((test-back-end
1592 (org-export-create-backend
1594 '((headline .
(lambda (headline contents info
)
1596 (org-element-property :title headline
)
1598 (plain-text .
(lambda (text info
) "Success"))))))
1599 (org-export-string-as
1601 (org-export-create-backend
1603 '((headline .
(lambda (headline contents info
)
1604 (org-export-with-backend
1605 test-back-end headline contents info
))))))))))
1607 (ert-deftest test-org-export
/data-with-backend
()
1608 "Test `org-export-data-with-backend' specifications."
1609 ;; Error when calling an undefined back-end.
1610 (should-error (org-export-data-with-backend nil
"nil" nil
))
1611 ;; Otherwise, export data recursively, using correct back-end.
1615 (org-export-data-with-backend
1617 (org-export-create-backend
1619 '((plain-text .
(lambda (text info
) "Success"))
1620 (bold .
(lambda (bold contents info
) (concat contents
"!")))))
1621 '(:with-emphasize t
)))))
1627 (ert-deftest test-org-export
/export-snippet
()
1628 "Test export snippets transcoding."
1630 (org-test-with-temp-text "@@test:A@@@@t:B@@"
1631 (let ((backend (org-test-default-backend)))
1632 (setf (org-export-backend-name backend
) 'test
)
1633 (setf (org-export-backend-transcoders backend
)
1634 (cons (cons 'export-snippet
1635 (lambda (snippet contents info
)
1636 (when (eq (org-export-snippet-backend snippet
) 'test
)
1637 (org-element-property :value snippet
))))
1638 (org-export-backend-transcoders backend
)))
1639 (let ((org-export-snippet-translation-alist nil
))
1640 (should (equal (org-export-as backend
) "A\n")))
1641 (let ((org-export-snippet-translation-alist '(("t" .
"test"))))
1642 (should (equal (org-export-as backend
) "AB\n")))))
1643 ;; Ignored export snippets do not remove any blank.
1645 (equal "begin end\n"
1646 (org-test-with-parsed-data "begin @@test:A@@ end"
1647 (org-export-data-with-backend
1649 (org-export-create-backend
1651 '((paragraph .
(lambda (paragraph contents info
) contents
))
1652 (section .
(lambda (section contents info
) contents
))))
1659 (ert-deftest test-org-export
/footnote-first-reference-p
()
1660 "Test `org-export-footnote-first-reference-p' specifications."
1664 (org-test-with-temp-text "Text[fn:1][fn:1]\n\n[fn:1] Definition"
1667 (org-export-create-backend
1669 `(,(cons 'footnote-reference
1671 (push (org-export-footnote-first-reference-p f info
)
1674 (section .
(lambda (s c i
) c
))
1675 (paragraph .
(lambda (p c i
) c
))))
1676 nil nil nil
'(:with-footnotes t
))
1677 (nreverse result
)))))
1678 ;; Limit check to DATA, when non-nil.
1682 (org-test-with-parsed-data "Text[fn:1]\n* H\nText[fn:1]\n\n[fn:1] D1"
1684 (org-element-map tree
'footnote-reference
1687 (org-export-footnote-first-reference-p
1688 ref info
(org-element-map tree
'headline
#'identity info t
))
1691 (nreverse result
)))))
1695 (org-test-with-parsed-data "Text[fn:1]\n* H\nText[fn:1]\n\n[fn:1] D1"
1697 (org-element-map tree
'footnote-reference
1699 (push (org-export-footnote-first-reference-p ref info
) result
))
1701 (nreverse result
)))))
1702 ;; If optional argument BODY-FIRST is non-nil, first find footnote
1703 ;; in the main body of the document. Otherwise, enter footnote
1704 ;; definitions when they are encountered.
1708 (org-test-with-temp-text
1709 ":BODY:\nText[fn:1][fn:2]\n:END:\n\n[fn:1] Definition[fn:2]\n\n[fn:2] Inner"
1712 (org-export-create-backend
1714 `(,(cons 'footnote-reference
1716 (when (org-element-lineage f
'(drawer))
1717 (push (org-export-footnote-first-reference-p f info nil
)
1720 (drawer .
(lambda (d c i
) c
))
1721 (footnote-definition .
(lambda (d c i
) c
))
1722 (section .
(lambda (s c i
) c
))
1723 (paragraph .
(lambda (p c i
) c
))))
1724 nil nil nil
'(:with-footnotes t
))
1725 (nreverse result
)))))
1729 (org-test-with-temp-text
1730 ":BODY:\nText[fn:1][fn:2]\n:END:\n\n[fn:1] Definition[fn:2]\n\n[fn:2] Inner"
1733 (org-export-create-backend
1735 `(,(cons 'footnote-reference
1737 (when (org-element-lineage f
'(drawer))
1738 (push (org-export-footnote-first-reference-p f info nil t
)
1741 (drawer .
(lambda (d c i
) c
))
1742 (footnote-definition .
(lambda (d c i
) c
))
1743 (section .
(lambda (s c i
) c
))
1744 (paragraph .
(lambda (p c i
) c
))))
1745 nil nil nil
'(:with-footnotes t
))
1746 (nreverse result
))))))
1748 (ert-deftest test-org-export
/get-footnote-number
()
1749 "Test `org-export-get-footnote-number' specifications."
1752 (org-test-with-parsed-data
1753 "Text[fn:1][fn:2][fn:1]\n\n[fn:1] Def\n[fn:2] Def"
1754 (org-element-map tree
'footnote-reference
1755 (lambda (ref) (org-export-get-footnote-number ref info
))
1757 ;; Anonymous footnotes all get a new number.
1760 (org-test-with-parsed-data
1761 "Text[fn::anon1][fn::anon2]"
1762 (org-element-map tree
'footnote-reference
1763 (lambda (ref) (org-export-get-footnote-number ref info
))
1765 ;; Test nested footnotes order.
1768 '((1 .
"fn:1") (2 .
"fn:2") (3 .
"fn:3") (3 .
"fn:3") (4))
1769 (org-test-with-parsed-data
1770 "Text[fn:1:A[fn:2]] [fn:3].\n\n[fn:2] B [fn:3] [fn::D].\n\n[fn:3] C."
1771 (org-element-map tree
'footnote-reference
1773 (cons (org-export-get-footnote-number ref info
)
1774 (org-element-property :label ref
)))
1776 ;; Limit number to provided DATA, when non-nil.
1780 (org-test-with-parsed-data
1781 "Text[fn:1]\n* H\nText[fn:2]\n\n[fn:1] D1\n[fn:2] D2"
1782 (org-element-map tree
'footnote-reference
1784 (org-export-get-footnote-number
1785 ref info
(org-element-map tree
'headline
#'identity info t
)))
1790 (org-test-with-parsed-data
1791 "Text[fn:1]\n* H\nText[fn:2]\n\n[fn:1] D1\n[fn:2]"
1792 (org-element-map tree
'footnote-reference
1793 (lambda (ref) (org-export-get-footnote-number ref info
))
1795 ;; With a non-nil BODY-FIRST optional argument, first check body,
1796 ;; then footnote definitions.
1799 '(("fn:1" .
1) ("fn:2" .
2) ("fn:3" .
3) ("fn:3" .
3))
1800 (org-test-with-parsed-data
1801 "Text[fn:1][fn:2][fn:3]\n\n[fn:1] Def[fn:3]\n[fn:2] Def\n[fn:3] Def"
1802 (org-element-map tree
'footnote-reference
1804 (cons (org-element-property :label ref
)
1805 (org-export-get-footnote-number ref info nil t
)))
1809 '(("fn:1" .
1) ("fn:2" .
3) ("fn:3" .
2) ("fn:3" .
2))
1810 (org-test-with-parsed-data
1811 "Text[fn:1][fn:2][fn:3]\n\n[fn:1] Def[fn:3]\n[fn:2] Def\n[fn:3] Def"
1812 (org-element-map tree
'footnote-reference
1814 (cons (org-element-property :label ref
)
1815 (org-export-get-footnote-number ref info nil
)))
1818 (ert-deftest test-org-export
/collect-footnote-definitions
()
1819 "Test `org-export-collect-footnote-definitions' specifications."
1822 (org-test-with-parsed-data "Text[fn:1:A[fn:2]] [fn:3].
1824 \[fn:2] B [fn:3] [fn::D].
1827 (length (org-export-collect-footnote-definitions info
)))))
1828 ;; Limit number to provided DATA, when non-nil.
1832 (org-test-with-parsed-data
1833 "Text[fn:1]\n* H\nText[fn:2]\n\n[fn:1] D1\n[fn:2] D2"
1835 (org-export-collect-footnote-definitions
1836 info
(org-element-map tree
'headline
#'identity info t
))))))
1839 '((1 "fn:1") (2 "fn:2"))
1840 (org-test-with-parsed-data
1841 "Text[fn:1]\n* H\nText[fn:2]\n\n[fn:1] D1\n[fn:2] D2"
1842 (mapcar #'butlast
(org-export-collect-footnote-definitions info
)))))
1843 ;; With optional argument BODY-FIRST, first check body, then
1844 ;; footnote definitions.
1846 (equal '("fn:1" "fn:3" "fn:2" nil
)
1847 (org-test-with-parsed-data "Text[fn:1:A[fn:2]] [fn:3].
1849 \[fn:2] B [fn:3] [fn::D].
1852 (mapcar (lambda (e) (nth 1 e
))
1853 (org-export-collect-footnote-definitions info nil t
)))))
1855 (equal '("fn:1" "fn:3" "fn:2" nil
)
1856 (org-test-with-parsed-data "Text[fn:1:A[fn:2]] [fn:3].
1858 \[fn:2] B [fn:3] [fn::D].
1861 (mapcar (lambda (e) (nth 1 e
))
1862 (org-export-collect-footnote-definitions info
))))))
1864 (ert-deftest test-org-export
/footnotes
()
1865 "Miscellaneous tests on footnotes."
1866 (let ((org-footnote-section nil
)
1867 (org-export-with-footnotes t
))
1868 ;; Read every type of footnote.
1871 '((1 .
"A\n") (2 .
"B") (3 .
"C") (4 .
"D"))
1872 (org-test-with-parsed-data
1873 "Text[fn:1] [1] [fn:label:C] [fn::D]\n\n[fn:1] A\n\n[1] B"
1874 (org-element-map tree
'footnote-reference
1876 (let ((def (org-export-get-footnote-definition ref info
)))
1877 (cons (org-export-get-footnote-number ref info
)
1878 (if (eq (org-element-property :type ref
) 'inline
) (car def
)
1879 (car (org-element-contents
1880 (car (org-element-contents def
))))))))
1882 ;; Test nested footnote in invisible definitions.
1885 (org-test-with-temp-text "Text[1]\n\n[1] B [2]\n\n[2] C."
1886 (narrow-to-region (point) (line-end-position))
1889 (org-export-create-backend
1894 (throw 'exit
(length
1895 (org-export-collect-footnote-definitions
1897 ;; Test export of footnotes defined outside parsing scope.
1900 "ParagraphOut of scope\n"
1901 (org-test-with-temp-text "[fn:1] Out of scope
1903 <point>Paragraph[fn:1]"
1904 (let ((backend (org-test-default-backend)))
1905 (setf (org-export-backend-transcoders backend
)
1907 (list (cons 'footnote-reference
1908 (lambda (fn contents info
)
1909 (org-element-interpret-data
1910 (org-export-get-footnote-definition fn info
))))
1911 (cons 'footnote-definition
#'ignore
)
1912 (cons 'headline
#'ignore
))
1913 (org-export-backend-transcoders backend
)))
1914 (org-export-as backend
'subtree
)))))
1915 ;; Footnotes without a definition should throw an error.
1917 (org-test-with-parsed-data "Text[fn:1]"
1918 (org-export-get-footnote-definition
1919 (org-element-map tree
'footnote-reference
#'identity info t
) info
)))
1920 ;; Footnote section should be ignored in TOC and in headlines
1923 (= 1 (let ((org-footnote-section "Footnotes"))
1924 (length (org-test-with-parsed-data "* H1\n* Footnotes\n"
1925 (org-export-collect-headlines info
))))))
1928 (let ((org-footnote-section "Footnotes"))
1929 (org-test-with-parsed-data "* H1\n* Footnotes\n* H2"
1930 (org-element-map tree
'headline
1932 (when (equal (org-element-property :raw-value hl
) "H2")
1933 (org-export-get-headline-number hl info
)))
1938 ;;; Headlines and Inlinetasks
1940 (ert-deftest test-org-export
/get-relative-level
()
1941 "Test `org-export-get-relative-level' specifications."
1945 (let ((org-odd-levels-only nil
))
1946 (org-test-with-parsed-data "* Headline 1\n** Headline 2"
1947 (org-element-map tree
'headline
1948 (lambda (h) (org-export-get-relative-level h info
))
1953 (let ((org-odd-levels-only nil
))
1954 (org-test-with-parsed-data "** Headline 1\n**** Headline 2"
1955 (org-element-map tree
'headline
1956 (lambda (h) (org-export-get-relative-level h info
))
1959 (ert-deftest test-org-export
/low-level-p
()
1960 "Test `org-export-low-level-p' specifications."
1964 (let ((org-odd-levels-only nil
))
1965 (org-test-with-parsed-data "* Headline 1\n** Headline 2"
1966 (org-element-map tree
'headline
1967 (lambda (h) (if (org-export-low-level-p h info
) 'yes
'no
))
1968 (plist-put info
:headline-levels
1)))))))
1970 (ert-deftest test-org-export
/get-headline-number
()
1971 "Test `org-export-get-headline-number' specifications."
1976 (let ((org-odd-levels-only nil
))
1977 (org-test-with-parsed-data "* Headline 1\n** Headline 2"
1978 (org-element-map tree
'headline
1979 (lambda (h) (org-export-get-headline-number h info
))
1981 ;; Missing levels are replaced with 0.
1985 (let ((org-odd-levels-only nil
))
1986 (org-test-with-parsed-data "* Headline 1\n*** Headline 2"
1987 (org-element-map tree
'headline
1988 (lambda (h) (org-export-get-headline-number h info
))
1991 (ert-deftest test-org-export
/numbered-headline-p
()
1992 "Test `org-export-numbered-headline-p' specifications."
1993 ;; If `:section-numbers' is nil, never number headlines.
1995 (org-test-with-parsed-data "* Headline"
1996 (org-element-map tree
'headline
1997 (lambda (h) (org-export-numbered-headline-p h info
))
1998 (plist-put info
:section-numbers nil
))))
1999 ;; If `:section-numbers' is a number, only number headlines with
2000 ;; a level greater that it.
2004 (org-test-with-parsed-data "* Headline 1\n** Headline 2"
2005 (org-element-map tree
'headline
2006 (lambda (h) (if (org-export-numbered-headline-p h info
) 'yes
'no
))
2007 (plist-put info
:section-numbers
1)))))
2008 ;; Otherwise, headlines are always numbered.
2010 (org-test-with-parsed-data "* Headline"
2011 (org-element-map tree
'headline
2012 (lambda (h) (org-export-numbered-headline-p h info
))
2013 (plist-put info
:section-numbers t
))))
2014 ;; With #+OPTIONS: num:nil all headlines are unnumbered.
2016 (org-test-with-parsed-data "* H\n#+OPTIONS: num:nil"
2017 (org-export-numbered-headline-p
2018 (org-element-map tree
'headline
'identity info t
)
2020 ;; Headlines with a non-nil UNNUMBERED property are not numbered.
2022 (org-test-with-parsed-data "* H\n:PROPERTIES:\n:UNNUMBERED: t\n:END:"
2023 (org-export-numbered-headline-p
2024 (org-element-map tree
'headline
#'identity info t
)
2026 ;; UNNUMBERED ignores inheritance. Any non-nil value among
2027 ;; ancestors disables numbering.
2029 (org-test-with-parsed-data
2040 (lambda (h) (not (org-export-numbered-headline-p h info
)))
2041 (org-element-map tree
'headline
#'identity info
)))))
2043 (ert-deftest test-org-export
/number-to-roman
()
2044 "Test `org-export-number-to-roman' specifications."
2045 ;; If number is negative, return it as a string.
2046 (should (equal (org-export-number-to-roman -
1) "-1"))
2047 ;; Otherwise, return it as a roman number.
2048 (should (equal (org-export-number-to-roman 1449) "MCDXLIX")))
2050 (ert-deftest test-org-export
/get-optional-title
()
2051 "Test `org-export-get-alt-title' specifications."
2052 ;; If ALT_TITLE property is defined, use it.
2055 (org-test-with-parsed-data
2056 "* Headline\n:PROPERTIES:\n:ALT_TITLE: opt\n:END:"
2057 (org-export-get-alt-title
2058 (org-element-map tree
'headline
'identity info t
)
2060 ;; Otherwise, fall-back to regular title.
2062 (equal '("Headline")
2063 (org-test-with-parsed-data "* Headline"
2064 (org-export-get-alt-title
2065 (org-element-map tree
'headline
'identity info t
)
2068 (ert-deftest test-org-export
/get-tags
()
2069 "Test `org-export-get-tags' specifications."
2070 (let ((org-export-exclude-tags '("noexport"))
2071 (org-export-select-tags '("export")))
2072 ;; Standard test: tags which are not a select tag, an exclude tag,
2073 ;; or specified as optional argument shouldn't be ignored.
2075 (org-test-with-parsed-data "* Headline :tag:"
2076 (org-export-get-tags (org-element-map tree
'headline
'identity info t
)
2078 ;; Exclude tags are removed.
2080 (org-test-with-parsed-data "* Headline :noexport:"
2081 (org-export-get-tags (org-element-map tree
'headline
'identity info t
)
2083 ;; Select tags are removed.
2085 (org-test-with-parsed-data "* Headline :export:"
2086 (org-export-get-tags (org-element-map tree
'headline
'identity info t
)
2091 (org-test-with-parsed-data "* Headline :tag:export:"
2092 (org-export-get-tags (org-element-map tree
'headline
'identity info t
)
2094 ;; Tags provided in the optional argument are also ignored.
2096 (org-test-with-parsed-data "* Headline :ignore:"
2097 (org-export-get-tags (org-element-map tree
'headline
'identity info t
)
2099 ;; Allow tag inheritance.
2103 (org-test-with-parsed-data "* Headline :tag:\n** Sub-heading"
2104 (org-element-map tree
'headline
2105 (lambda (hl) (org-export-get-tags hl info nil t
)) info
))))
2106 ;; Tag inheritance checks FILETAGS keywords.
2110 (org-test-with-parsed-data "#+FILETAGS: :a:b:\n* Headline :tag:"
2111 (org-element-map tree
'headline
2112 (lambda (hl) (org-export-get-tags hl info nil t
)) info
))))))
2114 (ert-deftest test-org-export
/get-node-property
()
2115 "Test`org-export-get-node-property' specifications."
2119 (org-test-with-parsed-data "* Headline
2123 (org-export-get-node-property
2124 :PROP
(org-element-map tree
'headline
'identity nil t
)))))
2125 ;; Test inheritance.
2128 (org-test-with-parsed-data "* Parent
2134 (org-export-get-node-property
2135 :PROP
(org-element-map tree
'paragraph
'identity nil t
) t
))))
2136 ;; Cannot return a value before the first headline.
2138 (org-test-with-parsed-data "Paragraph
2143 (org-export-get-node-property
2144 :PROP
(org-element-map tree
'paragraph
'identity nil t
)))))
2146 (ert-deftest test-org-export
/get-category
()
2147 "Test `org-export-get-category' specifications."
2151 (org-test-with-parsed-data "* Headline
2155 (org-export-get-category
2156 (org-element-map tree
'headline
'identity nil t
) info
))))
2157 ;; Test inheritance from a parent headline.
2159 (equal '("value" "value")
2160 (org-test-with-parsed-data "* Headline1
2165 (org-element-map tree
'headline
2166 (lambda (hl) (org-export-get-category hl info
)) info
))))
2167 ;; Test inheritance from #+CATEGORY keyword
2170 (org-test-with-parsed-data "#+CATEGORY: value
2172 (org-export-get-category
2173 (org-element-map tree
'headline
'identity nil t
) info
))))
2174 ;; Test inheritance from file name.
2177 (org-test-with-parsed-data "* Headline"
2178 (let ((info (plist-put info
:input-file
"~/test.org")))
2179 (org-export-get-category
2180 (org-element-map tree
'headline
'identity nil t
) info
)))))
2184 (org-test-with-parsed-data "* Headline"
2185 (org-export-get-category
2186 (org-element-map tree
'headline
'identity nil t
) info
)))))
2188 (ert-deftest test-org-export
/first-sibling-p
()
2189 "Test `org-export-first-sibling-p' specifications."
2194 (org-test-with-parsed-data "* H\n** H 2\n** H 3"
2195 (org-element-map tree
'headline
2196 (lambda (h) (if (org-export-first-sibling-p h info
) 'yes
'no
))
2200 (org-test-with-parsed-data "- item\n\n para"
2201 (org-element-map tree
'paragraph
2202 (lambda (h) (if (org-export-first-sibling-p h info
) 'yes
'no
))
2204 ;; Ignore sections for headlines.
2207 (org-test-with-parsed-data "* H\nSection\n** H 2"
2208 (org-element-map tree
'headline
2209 (lambda (h) (if (org-export-first-sibling-p h info
) 'yes
'no
))
2211 ;; Ignore headlines not exported.
2215 (let ((org-export-exclude-tags '("ignore")))
2216 (org-test-with-parsed-data "* Headline :ignore:\n* Headline 2"
2217 (org-element-map tree
'headline
2218 (lambda (h) (if (org-export-first-sibling-p h info
) 'yes
'no
))
2221 (ert-deftest test-org-export
/last-sibling-p
()
2222 "Test `org-export-last-sibling-p' specifications."
2227 (org-test-with-parsed-data "* Headline\n** Headline 2\n** Headline 3"
2228 (org-element-map tree
'headline
2229 (lambda (h) (if (org-export-last-sibling-p h info
) 'yes
'no
))
2233 (org-test-with-parsed-data "- item\n\n para"
2234 (org-element-map tree
'paragraph
2235 (lambda (h) (if (org-export-last-sibling-p h info
) 'yes
'no
))
2237 ;; Ignore headlines not exported.
2241 (let ((org-export-exclude-tags '("ignore")))
2242 (org-test-with-parsed-data "* Headline\n* Headline 2 :ignore:"
2243 (org-element-map tree
'headline
2244 (lambda (h) (if (org-export-last-sibling-p h info
) 'yes
'no
))
2247 (ert-deftest test-org-export
/handle-inlinetasks
()
2248 "Test inlinetask export."
2249 ;; Inlinetask with an exclude tag.
2250 (when (featurep 'org-inlinetask
)
2254 (let ((org-inlinetask-min-level 3)
2255 org-export-filter-body-functions
2256 org-export-filter-final-output-functions
)
2257 (org-test-with-temp-text "*** Inlinetask :noexp:\nContents\n*** end"
2258 (org-export-as (org-test-default-backend)
2259 nil nil nil
'(:exclude-tags
("noexp")))))))
2260 ;; Inlinetask with an include tag.
2263 "* H2\n*** Inline :exp:\n"
2264 (let ((org-inlinetask-min-level 3)
2265 (org-tags-column 0))
2266 (org-test-with-temp-text "* H1\n* H2\n*** Inline :exp:"
2267 (org-export-as (org-test-default-backend)
2268 nil nil nil
'(:select-tags
("exp")))))))
2269 ;; Ignore inlinetask with a TODO keyword and tasks excluded.
2272 (let ((org-todo-keywords '((sequence "TODO" "DONE")))
2273 (org-inlinetask-min-level 3)
2274 org-export-filter-body-functions
2275 org-export-filter-final-output-functions
)
2276 (org-test-with-temp-text "*** TODO Inline"
2277 (org-export-as (org-test-default-backend)
2278 nil nil nil
'(:with-tasks nil
))))))))
2284 (ert-deftest test-org-export
/get-date
()
2285 "Test `org-export-get-date' specifications."
2286 ;; Return a properly formatted string when
2287 ;; `org-export-date-timestamp-format' is non-nil and DATE keyword
2288 ;; consists in a single timestamp.
2291 (let ((org-export-date-timestamp-format "%d %m %Y"))
2292 (org-test-with-parsed-data "#+DATE: <2012-03-29 Thu>"
2293 (org-export-get-date info
)))))
2294 ;; Return a secondary string otherwise.
2297 (let ((org-export-date-timestamp-format nil
))
2298 (org-test-with-parsed-data "#+DATE: <2012-03-29 Thu>"
2299 (org-export-get-date info
)))))
2302 (org-test-with-parsed-data "#+DATE: Date"
2303 (org-export-get-date info
))))
2304 ;; Optional argument has precedence over
2305 ;; `org-export-date-timestamp-format'.
2308 (let ((org-export-date-timestamp-format "%d %m %Y"))
2309 (org-test-with-parsed-data "#+DATE: <2012-03-29 Thu>"
2310 (org-export-get-date info
"%d %m"))))))
2316 (ert-deftest test-org-export
/custom-protocol-maybe
()
2317 "Test `org-export-custom-protocol-maybe' specifications."
2321 (let ((org-link-types (copy-sequence org-link-types
)))
2322 (org-add-link-type "foo" nil
(lambda (p d f
) "success"))
2323 (org-export-string-as
2325 (org-export-create-backend
2328 '((section .
(lambda (s c i
) c
))
2329 (paragraph .
(lambda (p c i
) c
))
2330 (link .
(lambda (l c i
)
2331 (or (org-export-custom-protocol-maybe l c
'test
)
2336 (let ((org-link-types (copy-sequence org-link-types
)))
2338 "foo" nil
(lambda (p d f
) (and (eq f
'test
) "success")))
2339 (org-export-string-as
2341 (org-export-create-backend
2344 '((section .
(lambda (s c i
) c
))
2345 (paragraph .
(lambda (p c i
) c
))
2346 (link .
(lambda (l c i
)
2347 (or (org-export-custom-protocol-maybe l c
'no-test
)
2349 ;; Ignore anonymous back-ends.
2353 (let ((org-link-types (copy-sequence org-link-types
)))
2355 "foo" nil
(lambda (p d f
) (and (eq f
'test
) "success")))
2356 (org-export-string-as
2358 (org-export-create-backend
2360 '((section .
(lambda (s c i
) c
))
2361 (paragraph .
(lambda (p c i
) c
))
2362 (link .
(lambda (l c i
)
2363 (or (org-export-custom-protocol-maybe l c nil
)
2366 (ert-deftest test-org-export
/get-coderef-format
()
2367 "Test `org-export-get-coderef-format' specifications."
2368 ;; A link without description returns "%s"
2369 (should (equal (org-export-get-coderef-format "(ref:line)" nil
)
2371 ;; Return "%s" when path is matched within description.
2372 (should (equal (org-export-get-coderef-format "path" "desc (path)")
2374 ;; Otherwise return description.
2375 (should (equal (org-export-get-coderef-format "path" "desc")
2378 (ert-deftest test-org-export
/inline-image-p
()
2379 "Test `org-export-inline-image-p' specifications."
2381 (org-export-inline-image-p
2382 (org-test-with-temp-text "[[#id]]"
2383 (org-element-map (org-element-parse-buffer) 'link
'identity nil t
))
2384 '(("custom-id" .
"id")))))
2386 (ert-deftest test-org-export
/fuzzy-link
()
2387 "Test fuzzy links specifications."
2388 ;; Link to an headline should return headline's number.
2389 (org-test-with-parsed-data
2390 "Paragraph.\n* Head1\n* Head2\n* Head3\n[[Head2]]"
2392 ;; Note: Headline's number is in fact a list of numbers.
2394 (org-element-map tree
'link
2396 (org-export-get-ordinal
2397 (org-export-resolve-fuzzy-link link info
) info
)) info t
))))
2398 ;; Link to a target in an item should return item's number.
2399 (org-test-with-parsed-data
2400 "- Item1\n - Item11\n - <<test>>Item12\n- Item2\n\n\n[[test]]"
2402 ;; Note: Item's number is in fact a list of numbers.
2404 (org-element-map tree
'link
2406 (org-export-get-ordinal
2407 (org-export-resolve-fuzzy-link link info
) info
)) info t
))))
2408 ;; Link to a target in a footnote should return footnote's number.
2409 (org-test-with-parsed-data "
2410 Paragraph[1][2][fn:lbl3:C<<target>>][[test]][[target]]\n[1] A\n\n[2] <<test>>B"
2413 (org-element-map tree
'link
2415 (org-export-get-ordinal
2416 (org-export-resolve-fuzzy-link link info
) info
)) info
))))
2417 ;; Link to a named element should return sequence number of that
2419 (org-test-with-parsed-data
2420 "#+NAME: tbl1\n|1|2|\n#+NAME: tbl2\n|3|4|\n#+NAME: tbl3\n|5|6|\n[[tbl2]]"
2423 (org-element-map tree
'link
2425 (org-export-get-ordinal
2426 (org-export-resolve-fuzzy-link link info
) info
)) info t
))))
2427 ;; Link to a target not within an item, a table, a footnote
2428 ;; reference or definition should return section number.
2429 (org-test-with-parsed-data
2430 "* Head1\n* Head2\nParagraph<<target>>\n* Head3\n[[target]]"
2433 (org-element-map tree
'link
2435 (org-export-get-ordinal
2436 (org-export-resolve-fuzzy-link link info
) info
)) info t
))))
2437 ;; Space are not significant when matching a fuzzy link.
2439 (org-test-with-parsed-data "* Head 1\n[[Head\n 1]]"
2440 (org-element-map tree
'link
2441 (lambda (link) (org-export-resolve-fuzzy-link link info
))
2443 ;; Statistics cookies are ignored for headline match.
2445 (org-test-with-parsed-data "* Head [0/0]\n[[Head]]"
2446 (org-element-map tree
'link
2447 (lambda (link) (org-export-resolve-fuzzy-link link info
))
2450 (org-test-with-parsed-data "* Head [100%]\n[[Head]]"
2451 (org-element-map tree
'link
2452 (lambda (link) (org-export-resolve-fuzzy-link link info
))
2455 (ert-deftest test-org-export
/resolve-coderef
()
2456 "Test `org-export-resolve-coderef' specifications."
2457 (let ((org-coderef-label-format "(ref:%s)"))
2458 ;; A link to a "-n -k -r" block returns line number.
2461 (org-test-with-parsed-data
2462 "#+BEGIN_EXAMPLE -n -k -r\nText (ref:coderef)\n#+END_EXAMPLE"
2463 (org-export-resolve-coderef "coderef" info
))))
2466 (org-test-with-parsed-data
2467 "#+BEGIN_SRC emacs-lisp -n -k -r\n(+ 1 1) (ref:coderef)\n#+END_SRC"
2468 (org-export-resolve-coderef "coderef" info
))))
2469 ;; A link to a "-n -r" block returns line number.
2472 (org-test-with-parsed-data
2473 "#+BEGIN_EXAMPLE -n -r\nText (ref:coderef)\n#+END_EXAMPLE"
2474 (org-export-resolve-coderef "coderef" info
))))
2477 (org-test-with-parsed-data
2478 "#+BEGIN_SRC emacs-lisp -n -r\n(+ 1 1) (ref:coderef)\n#+END_SRC"
2479 (org-export-resolve-coderef "coderef" info
))))
2480 ;; A link to a "-n" block returns coderef.
2483 (org-test-with-parsed-data
2484 "#+BEGIN_SRC emacs-lisp -n\n(+ 1 1) (ref:coderef)\n#+END_SRC"
2485 (org-export-resolve-coderef "coderef" info
))))
2488 (org-test-with-parsed-data
2489 "#+BEGIN_EXAMPLE -n\nText (ref:coderef)\n#+END_EXAMPLE"
2490 (org-export-resolve-coderef "coderef" info
))))
2491 ;; A link to a "-r" block returns line number.
2494 (org-test-with-parsed-data
2495 "#+BEGIN_SRC emacs-lisp -r\n(+ 1 1) (ref:coderef)\n#+END_SRC"
2496 (org-export-resolve-coderef "coderef" info
))))
2499 (org-test-with-parsed-data
2500 "#+BEGIN_EXAMPLE -r\nText (ref:coderef)\n#+END_EXAMPLE"
2501 (org-export-resolve-coderef "coderef" info
))))
2502 ;; A link to a block without a switch returns coderef.
2505 (org-test-with-parsed-data
2506 "#+BEGIN_SRC emacs-lisp\n(+ 1 1) (ref:coderef)\n#+END_SRC"
2507 (org-export-resolve-coderef "coderef" info
))))
2508 (org-test-with-parsed-data
2509 "#+BEGIN_EXAMPLE\nText (ref:coderef)\n#+END_EXAMPLE"
2510 (should (equal (org-export-resolve-coderef "coderef" info
) "coderef")))
2511 ;; Correctly handle continued line numbers. A "+n" switch should
2512 ;; resume numbering from previous block with numbered lines,
2513 ;; ignoring blocks not numbering lines in the process. A "-n"
2514 ;; switch resets count.
2517 (org-test-with-parsed-data "
2522 #+BEGIN_SRC emacs-lisp
2526 #+BEGIN_SRC emacs-lisp +n -r
2527 \(+ 1 1) (ref:addition)
2530 #+BEGIN_EXAMPLE -n -r
2531 Another text. (ref:text)
2533 (list (org-export-resolve-coderef "addition" info
)
2534 (org-export-resolve-coderef "text" info
)))))
2535 ;; Recognize coderef with user-specified syntax.
2538 (org-test-with-parsed-data
2539 "#+BEGIN_EXAMPLE -l \"[ref:%s]\"\nText. [ref:text]\n#+END_EXAMPLE"
2540 (org-export-resolve-coderef "text" info
))))
2541 ;; Unresolved coderefs throw an error.
2543 (org-test-with-parsed-data "#+BEGIN_SRC emacs-lisp\n(+ 1 1)\n#+END_SRC"
2544 (org-export-resolve-coderef "unknown" info
)))))
2546 (ert-deftest test-org-export
/resolve-fuzzy-link
()
2547 "Test `org-export-resolve-fuzzy-link' specifications."
2548 ;; Match target objects.
2550 (org-test-with-parsed-data "<<target>> [[target]]"
2551 (org-export-resolve-fuzzy-link
2552 (org-element-map tree
'link
'identity info t
) info
)))
2553 ;; Match named elements.
2555 (org-test-with-parsed-data "#+NAME: target\nParagraph\n\n[[target]]"
2556 (org-export-resolve-fuzzy-link
2557 (org-element-map tree
'link
'identity info t
) info
)))
2558 ;; Match exact headline's name.
2560 (org-test-with-parsed-data "* My headline\n[[My headline]]"
2561 (org-export-resolve-fuzzy-link
2562 (org-element-map tree
'link
'identity info t
) info
)))
2563 ;; Targets objects have priority over named elements and headline
2567 (org-test-with-parsed-data
2568 "* target\n#+NAME: target\n<<target>>\n\n[[target]]"
2570 (org-export-resolve-fuzzy-link
2571 (org-element-map tree
'link
'identity info t
) info
)))))
2572 ;; Named elements have priority over headline titles.
2575 (org-test-with-parsed-data
2576 "* target\n#+NAME: target\nParagraph\n\n[[target]]"
2578 (org-export-resolve-fuzzy-link
2579 (org-element-map tree
'link
'identity info t
) info
)))))
2580 ;; If link's path starts with a "*", only match headline titles,
2584 (org-test-with-parsed-data
2585 "* target\n#+NAME: target\n<<target>>\n\n[[*target]]"
2587 (org-export-resolve-fuzzy-link
2588 (org-element-map tree
'link
'identity info t
) info
)))))
2589 ;; Error if no match.
2591 (org-test-with-parsed-data "[[target]]"
2592 (org-export-resolve-fuzzy-link
2593 (org-element-map tree
'link
'identity info t
) info
)))
2594 ;; Match fuzzy link even when before first headline.
2597 (org-test-with-parsed-data "[[hl]]\n* hl"
2599 (org-export-resolve-fuzzy-link
2600 (org-element-map tree
'link
'identity info t
) info
)))))
2601 ;; Handle url-encoded fuzzy links.
2603 (org-test-with-parsed-data "* A B\n[[A%20B]]"
2604 (org-export-resolve-fuzzy-link
2605 (org-element-map tree
'link
#'identity info t
) info
))))
2607 (ert-deftest test-org-export
/resolve-id-link
()
2608 "Test `org-export-resolve-id-link' specifications."
2609 ;; Regular test for custom-id link.
2611 (equal '("Headline1")
2612 (org-test-with-parsed-data "* Headline1
2618 (org-element-property
2620 (org-export-resolve-id-link
2621 (org-element-map tree
'link
'identity info t
) info
)))))
2622 ;; Throw an error on failing searches.
2624 (org-test-with-parsed-data "* Headline1
2630 (org-export-resolve-id-link
2631 (org-element-map tree
'link
'identity info t
) info
)))
2632 ;; Test for internal id target.
2634 (equal '("Headline1")
2635 (org-test-with-parsed-data "* Headline1
2641 (org-element-property
2643 (org-export-resolve-id-link
2644 (org-element-map tree
'link
'identity info t
) info
)))))
2645 ;; Test for external id target.
2649 (org-test-with-parsed-data "[[id:aaaa]]"
2650 (org-export-resolve-id-link
2651 (org-element-map tree
'link
'identity info t
)
2652 (org-combine-plists info
'(:id-alist
(("aaaa" .
"external-file")))))))))
2654 (ert-deftest test-org-export
/resolve-radio-link
()
2655 "Test `org-export-resolve-radio-link' specifications."
2658 (org-test-with-temp-text "<<<radio>>> radio"
2659 (org-update-radio-target-regexp)
2660 (let* ((tree (org-element-parse-buffer))
2661 (info `(:parse-tree
,tree
)))
2662 (org-export-resolve-radio-link
2663 (org-element-map tree
'link
'identity info t
)
2665 ;; Radio targets are case-insensitive.
2667 (org-test-with-temp-text "<<<RADIO>>> radio"
2668 (org-update-radio-target-regexp)
2669 (let* ((tree (org-element-parse-buffer))
2670 (info `(:parse-tree
,tree
)))
2671 (org-export-resolve-radio-link
2672 (org-element-map tree
'link
'identity info t
)
2674 ;; Radio target with objects.
2676 (org-test-with-temp-text "<<<radio \\alpha>>> radio \\alpha"
2677 (org-update-radio-target-regexp)
2678 (let* ((tree (org-element-parse-buffer))
2679 (info `(:parse-tree
,tree
)))
2680 (org-export-resolve-radio-link
2681 (org-element-map tree
'link
'identity info t
)
2683 ;; Radio target with objects at its beginning.
2685 (org-test-with-temp-text "<<<\\alpha radio>>> \\alpha radio"
2686 (org-update-radio-target-regexp)
2687 (let* ((tree (org-element-parse-buffer))
2688 (info `(:parse-tree
,tree
)))
2689 (org-export-resolve-radio-link
2690 (org-element-map tree
'link
'identity info t
)
2692 ;; Radio link next to an apostrophe.
2694 (org-test-with-temp-text "<<<radio>>> radio's"
2695 (org-update-radio-target-regexp)
2696 (let* ((tree (org-element-parse-buffer))
2697 (info `(:parse-tree
,tree
)))
2698 (org-export-resolve-radio-link
2699 (org-element-map tree
'link
'identity info t
)
2701 ;; Multiple radio targets.
2703 (equal '("radio1" "radio2")
2704 (org-test-with-temp-text "<<<radio1>>> <<<radio2>>> radio1 radio2"
2705 (org-update-radio-target-regexp)
2706 (let* ((tree (org-element-parse-buffer))
2707 (info `(:parse-tree
,tree
)))
2708 (org-element-map tree
'link
2710 (org-element-property
2711 :value
(org-export-resolve-radio-link link info
)))
2713 ;; Radio target is whitespace insensitive.
2715 (org-test-with-temp-text "<<<a radio>>> a\n radio"
2716 (org-update-radio-target-regexp)
2717 (let* ((tree (org-element-parse-buffer))
2718 (info `(:parse-tree
,tree
)))
2719 (org-element-map tree
'link
2720 (lambda (link) (org-export-resolve-radio-link link info
)) info t
)))))
2722 (ert-deftest test-org-export
/file-uri
()
2723 "Test `org-export-file-uri' specifications."
2724 ;; Preserve relative filenames.
2725 (should (equal "relative.org" (org-export-file-uri "relative.org")))
2726 ;; Local files start with "file:///"
2727 (should (equal "file:///local.org" (org-export-file-uri "/local.org")))
2728 ;; Remote files start with "file://"
2729 (should (equal "file://myself@some.where:papers/last.pdf"
2730 (org-export-file-uri "/myself@some.where:papers/last.pdf")))
2731 (should (equal "file://localhost/etc/fstab"
2732 (org-export-file-uri "//localhost/etc/fstab")))
2733 ;; Expand filename starting with "~".
2734 (should (equal (org-export-file-uri "~/file.org")
2735 (concat "file://" (expand-file-name "~/file.org")))))
2739 ;;; Src-block and example-block
2741 (ert-deftest test-org-export
/unravel-code
()
2742 "Test `org-export-unravel-code' function."
2743 ;; Code without reference.
2745 (equal '("(+ 1 1)\n")
2746 (org-test-with-temp-text "#+BEGIN_EXAMPLE\n(+ 1 1)\n#+END_EXAMPLE"
2747 (org-export-unravel-code (org-element-at-point)))))
2748 ;; Code with reference.
2750 (equal '("(+ 1 1)\n" (1 .
"test"))
2751 (org-test-with-temp-text
2752 "#+BEGIN_EXAMPLE\n(+ 1 1) (ref:test)\n#+END_EXAMPLE"
2753 (let ((org-coderef-label-format "(ref:%s)"))
2754 (org-export-unravel-code (org-element-at-point))))))
2755 ;; Code with user-defined reference.
2758 '("(+ 1 1)\n" (1 .
"test"))
2759 (org-test-with-temp-text
2760 "#+BEGIN_EXAMPLE -l \"[ref:%s]\"\n(+ 1 1) [ref:test]\n#+END_EXAMPLE"
2761 (let ((org-coderef-label-format "(ref:%s)"))
2762 (org-export-unravel-code (org-element-at-point))))))
2763 ;; Code references keys are relative to the current block.
2765 (equal '("(+ 2 2)\n(+ 3 3)\n" (2 .
"one"))
2766 (org-test-with-temp-text "
2775 (let ((org-coderef-label-format "(ref:%s)"))
2776 (org-export-unravel-code (org-element-at-point)))))))
2778 (ert-deftest test-org-export
/format-code-default
()
2779 "Test `org-export-format-code-default' specifications."
2780 ;; Return the empty string when code is empty.
2783 (org-test-with-parsed-data "#+BEGIN_SRC emacs-lisp\n\n\n#+END_SRC"
2784 (org-export-format-code-default
2785 (org-element-map tree
'src-block
'identity info t
) info
))))
2786 ;; Number lines, two whitespace characters before the actual loc.
2789 (org-test-with-parsed-data
2790 "#+BEGIN_SRC emacs-lisp +n\na\nb\n#+END_SRC"
2791 (org-export-format-code-default
2792 (org-element-map tree
'src-block
'identity info t
) info
))))
2793 ;; Put references 6 whitespace characters after the widest line,
2794 ;; wrapped within parenthesis.
2796 (equal "123 (a)\n1 (b)\n"
2797 (let ((org-coderef-label-format "(ref:%s)"))
2798 (org-test-with-parsed-data
2799 "#+BEGIN_SRC emacs-lisp\n123 (ref:a)\n1 (ref:b)\n#+END_SRC"
2800 (org-export-format-code-default
2801 (org-element-map tree
'src-block
'identity info t
) info
))))))
2807 (ert-deftest test-org-export
/activate-smart-quotes
()
2808 "Test `org-export-activate-smart-quotes' specifications."
2809 ;; Double quotes: standard test.
2812 '("some “quoted” text")
2813 (let ((org-export-default-language "en"))
2814 (org-test-with-parsed-data "some \"quoted\" text"
2815 (org-element-map tree
'plain-text
2816 (lambda (s) (org-export-activate-smart-quotes s
:html info
))
2818 ;; Opening quotes: at the beginning of a paragraph.
2822 (let ((org-export-default-language "en"))
2823 (org-test-with-parsed-data "\"begin"
2824 (org-element-map tree
'plain-text
2825 (lambda (s) (org-export-activate-smart-quotes s
:html info
))
2827 ;; Opening quotes: after an object.
2830 '("“quoted” text")
2831 (let ((org-export-default-language "en"))
2832 (org-test-with-parsed-data "=verb= \"quoted\" text"
2833 (org-element-map tree
'plain-text
2834 (lambda (s) (org-export-activate-smart-quotes s
:html info
))
2836 ;; Closing quotes: at the end of a paragraph.
2839 '("Quoted “text”")
2840 (let ((org-export-default-language "en"))
2841 (org-test-with-parsed-data "Quoted \"text\""
2842 (org-element-map tree
'plain-text
2843 (lambda (s) (org-export-activate-smart-quotes s
:html info
))
2845 ;; Inner quotes: standard test.
2847 (equal '("« outer « inner » outer »")
2848 (let ((org-export-default-language "fr"))
2849 (org-test-with-parsed-data "\"outer 'inner' outer\""
2850 (org-element-map tree
'plain-text
2851 (lambda (s) (org-export-activate-smart-quotes s
:utf-8 info
))
2853 ;; Inner quotes: close to special symbols.
2855 (equal '("« outer (« inner ») outer »")
2856 (let ((org-export-default-language "fr"))
2857 (org-test-with-parsed-data "\"outer ('inner') outer\""
2858 (org-element-map tree
'plain-text
2859 (lambda (s) (org-export-activate-smart-quotes s
:utf-8 info
))
2862 (equal '("« « inner » »")
2863 (let ((org-export-default-language "fr"))
2864 (org-test-with-parsed-data "\"'inner'\""
2865 (org-element-map tree
'plain-text
2866 (lambda (s) (org-export-activate-smart-quotes s
:utf-8 info
))
2868 ;; Apostrophe: standard test.
2870 (equal '("It « shouldn’t » fail")
2871 (let ((org-export-default-language "fr"))
2872 (org-test-with-parsed-data "It \"shouldn't\" fail"
2873 (org-element-map tree
'plain-text
2874 (lambda (s) (org-export-activate-smart-quotes s
:utf-8 info
))
2877 (equal '("It shouldn’t fail")
2878 (let ((org-export-default-language "fr"))
2879 (org-test-with-parsed-data "It shouldn't fail"
2880 (org-element-map tree
'plain-text
2881 (lambda (s) (org-export-activate-smart-quotes s
:utf-8 info
))
2883 ;; Apostrophe: before an object.
2886 '("« a’" " »")
2887 (let ((org-export-default-language "fr"))
2888 (org-test-with-parsed-data "\"a'=b=\""
2889 (org-element-map tree
'plain-text
2890 (lambda (s) (org-export-activate-smart-quotes s
:utf-8 info
))
2892 ;; Apostrophe: after an object.
2894 (equal '("« " "’s »")
2895 (let ((org-export-default-language "fr"))
2896 (org-test-with-parsed-data "\"=code='s\""
2897 (org-element-map tree
'plain-text
2898 (lambda (s) (org-export-activate-smart-quotes s
:utf-8 info
))
2900 ;; Special case: isolated quotes.
2902 (equal '("“" "”")
2903 (let ((org-export-default-language "en"))
2904 (org-test-with-parsed-data "\"$x$\""
2905 (org-element-map tree
'plain-text
2906 (lambda (s) (org-export-activate-smart-quotes s
:html info
))
2908 ;; Smart quotes in secondary strings.
2910 (equal '("“" "”")
2911 (let ((org-export-default-language "en"))
2912 (org-test-with-parsed-data "* \"$x$\""
2913 (org-element-map tree
'plain-text
2914 (lambda (s) (org-export-activate-smart-quotes s
:html info
))
2916 ;; Smart quotes in document keywords.
2918 (equal '("“" "”")
2919 (let ((org-export-default-language "en"))
2920 (org-test-with-parsed-data "#+TITLE: \"$x$\""
2921 (org-element-map (plist-get info
:title
) 'plain-text
2922 (lambda (s) (org-export-activate-smart-quotes s
:html info
))
2924 ;; Smart quotes in parsed affiliated keywords.
2926 (equal '("“" "”" "Paragraph")
2927 (let ((org-export-default-language "en"))
2928 (org-test-with-parsed-data "#+CAPTION: \"$x$\"\nParagraph"
2929 (org-element-map tree
'plain-text
2930 (lambda (s) (org-export-activate-smart-quotes s
:html info
))
2931 info nil nil t
))))))
2937 (ert-deftest test-org-export
/special-column
()
2938 "Test if the table's special column is properly recognized."
2939 ;; 1. First column is special if it contains only a special marking
2940 ;; characters or empty cells.
2941 (org-test-with-temp-text "
2945 (org-export-table-has-special-column-p
2947 (org-element-parse-buffer) 'table
'identity nil
'first-match
))))
2948 ;; 2. If the column contains anything else, it isn't special.
2949 (org-test-with-temp-text "
2953 (org-export-table-has-special-column-p
2955 (org-element-parse-buffer) 'table
'identity nil
'first-match
))))
2956 ;; 3. Special marking characters are "#", "^", "*", "_", "/", "$"
2958 (org-test-with-temp-text "
2967 (org-export-table-has-special-column-p
2969 (org-element-parse-buffer) 'table
'identity nil
'first-match
))))
2970 ;; 4. A first column with only empty cells isn't considered as
2972 (org-test-with-temp-text "
2976 (org-export-table-has-special-column-p
2978 (org-element-parse-buffer) 'table
'identity nil
'first-match
)))))
2980 (ert-deftest test-org-export
/table-row-is-special-p
()
2981 "Test `org-export-table-row-is-special-p' specifications."
2982 ;; 1. A row is special if it has a special marking character in the
2984 (org-test-with-parsed-data "| ! | 1 |"
2986 (org-export-table-row-is-special-p
2987 (org-element-map tree
'table-row
'identity nil
'first-match
) info
)))
2988 ;; 2. A row is special when its first field is "/"
2989 (org-test-with-parsed-data "
2993 (org-export-table-row-is-special-p
2994 (org-element-map tree
'table-row
'identity nil
'first-match
) info
)))
2995 ;; 3. A row only containing alignment cookies is also considered as
2997 (org-test-with-parsed-data "| <5> | | <l> | <l22> |"
2999 (org-export-table-row-is-special-p
3000 (org-element-map tree
'table-row
'identity nil
'first-match
) info
)))
3001 ;; 4. Everything else isn't considered as special.
3002 (org-test-with-parsed-data "| \alpha | | c |"
3004 (org-export-table-row-is-special-p
3005 (org-element-map tree
'table-row
'identity nil
'first-match
) info
)))
3006 ;; 5. Table's rules are never considered as special rows.
3007 (org-test-with-parsed-data "|---+---|"
3009 (org-export-table-row-is-special-p
3010 (org-element-map tree
'table-row
'identity nil
'first-match
) info
))))
3012 (ert-deftest test-org-export
/has-header-p
()
3013 "Test `org-export-table-has-header-p' specifications."
3014 ;; 1. With an header.
3015 (org-test-with-parsed-data "
3020 (org-export-table-has-header-p
3021 (org-element-map tree
'table
'identity info
'first-match
)
3023 ;; 2. Without an header.
3024 (org-test-with-parsed-data "
3028 (org-export-table-has-header-p
3029 (org-element-map tree
'table
'identity info
'first-match
)
3031 ;; 3. Don't get fooled with starting and ending rules.
3032 (org-test-with-parsed-data "
3038 (org-export-table-has-header-p
3039 (org-element-map tree
'table
'identity info
'first-match
)
3042 (ert-deftest test-org-export
/table-row-group
()
3043 "Test `org-export-table-row-group' specifications."
3044 ;; 1. A rule creates a new group.
3047 (org-test-with-parsed-data "
3051 (org-element-map tree
'table-row
3053 (if (eq (org-element-property :type row
) 'rule
) 'rule
3054 (org-export-table-row-group row info
)))))))
3055 ;; 2. Special rows are ignored in count.
3059 (org-test-with-parsed-data "
3063 (org-element-map tree
'table-row
3065 (if (eq (org-element-property :type row
) 'rule
) 'rule
3066 (org-export-table-row-group row info
)))
3068 ;; 3. Double rules also are ignored in count.
3070 (equal '(1 rule rule
2)
3071 (org-test-with-parsed-data "
3076 (org-element-map tree
'table-row
3078 (if (eq (org-element-property :type row
) 'rule
) 'rule
3079 (org-export-table-row-group row info
))))))))
3081 (ert-deftest test-org-export
/table-row-number
()
3082 "Test `org-export-table-row-number' specifications."
3083 ;; Standard test. Number is 0-indexed.
3086 (org-test-with-parsed-data "| a | b | c |\n| d | e | f |"
3087 (org-element-map tree
'table-row
3088 (lambda (row) (org-export-table-row-number row info
)) info
))))
3089 ;; Number ignores separators.
3092 (org-test-with-parsed-data "
3096 (org-element-map tree
'table-row
3097 (lambda (row) (org-export-table-row-number row info
)) info
))))
3098 ;; Number ignores special rows.
3101 (org-test-with-parsed-data "
3107 (org-element-map tree
'table-row
3108 (lambda (row) (org-export-table-row-number row info
)) info
)))))
3110 (ert-deftest test-org-export
/table-cell-width
()
3111 "Test `org-export-table-cell-width' specifications."
3112 ;; 1. Width is primarily determined by width cookies. If no cookie
3113 ;; is found, cell's width is nil.
3114 (org-test-with-parsed-data "
3115 | / | <l> | <6> | <l7> |
3120 (mapcar (lambda (cell) (org-export-table-cell-width cell info
))
3121 (org-element-map tree
'table-cell
'identity info
)))))
3122 ;; 2. The last width cookie has precedence.
3123 (org-test-with-parsed-data "
3130 (mapcar (lambda (cell) (org-export-table-cell-width cell info
))
3131 (org-element-map tree
'table-cell
'identity info
)))))
3132 ;; 3. Valid width cookies must have a specific row.
3133 (org-test-with-parsed-data "| <6> | cell |"
3137 (mapcar (lambda (cell) (org-export-table-cell-width cell info
))
3138 (org-element-map tree
'table-cell
'identity
))))))
3140 (ert-deftest test-org-export
/table-cell-alignment
()
3141 "Test `org-export-table-cell-alignment' specifications."
3142 ;; 1. Alignment is primarily determined by alignment cookies.
3144 (equal '(left center right
)
3145 (let ((org-table-number-fraction 0.5)
3146 (org-table-number-regexp "^[0-9]+$"))
3147 (org-test-with-parsed-data "| <l> | <c> | <r> |"
3148 (mapcar (lambda (cell)
3149 (org-export-table-cell-alignment cell info
))
3150 (org-element-map tree
'table-cell
'identity
))))))
3151 ;; 2. The last alignment cookie has precedence.
3153 (equal '(right right right
)
3154 (org-test-with-parsed-data "
3158 (mapcar (lambda (cell) (org-export-table-cell-alignment cell info
))
3159 (org-element-map tree
'table-cell
'identity
)))))
3160 ;; 3. If there's no cookie, cell's contents determine alignment.
3161 ;; A column mostly made of cells containing numbers will align
3162 ;; its cells to the right.
3164 (equal '(right right right
)
3165 (let ((org-table-number-fraction 0.5)
3166 (org-table-number-regexp "^[0-9]+$"))
3167 (org-test-with-parsed-data "
3171 (mapcar (lambda (cell)
3172 (org-export-table-cell-alignment cell info
))
3173 (org-element-map tree
'table-cell
'identity
))))))
3174 ;; 4. Otherwise, they will be aligned to the left.
3176 (equal '(left left left
)
3177 (org-test-with-parsed-data "
3181 (mapcar (lambda (cell)
3182 (org-export-table-cell-alignment cell info
))
3183 (org-element-map tree
'table-cell
'identity info
))))))
3185 (ert-deftest test-org-export
/table-cell-borders
()
3186 "Test `org-export-table-cell-borders' specifications."
3187 ;; 1. Recognize various column groups indicators.
3188 (org-test-with-parsed-data "| / | < | > | <> |"
3191 '((right bottom top
) (left bottom top
) (right bottom top
)
3192 (right left bottom top
))
3193 (mapcar (lambda (cell)
3194 (org-export-table-cell-borders cell info
))
3195 (org-element-map tree
'table-cell
'identity
)))))
3196 ;; 2. Accept shortcuts to define column groups.
3197 (org-test-with-parsed-data "| / | < | < |"
3200 '((right bottom top
) (right left bottom top
) (left bottom top
))
3201 (mapcar (lambda (cell)
3202 (org-export-table-cell-borders cell info
))
3203 (org-element-map tree
'table-cell
'identity
)))))
3204 ;; 3. A valid column groups row must start with a "/".
3205 (org-test-with-parsed-data "
3209 (equal '((top) (top) (bottom) (bottom))
3210 (mapcar (lambda (cell)
3211 (org-export-table-cell-borders cell info
))
3212 (org-element-map tree
'table-cell
'identity
)))))
3213 ;; 4. Take table rules into consideration.
3214 (org-test-with-parsed-data "
3219 (equal '((below top
) (bottom above
))
3220 (mapcar (lambda (cell)
3221 (org-export-table-cell-borders cell info
))
3222 (org-element-map tree
'table-cell
'identity
)))))
3223 ;; 5. Top and (resp. bottom) rules induce both `top' and `above'
3224 ;; (resp. `bottom' and `below') borders. Any special row is
3226 (org-test-with-parsed-data "
3232 (equal '((bottom below top above
))
3234 (mapcar (lambda (cell)
3235 (org-export-table-cell-borders cell info
))
3236 (org-element-map tree
'table-cell
'identity
)))))))
3238 (ert-deftest test-org-export
/table-dimensions
()
3239 "Test `org-export-table-dimensions' specifications."
3240 ;; 1. Standard test.
3241 (org-test-with-parsed-data "
3246 (org-export-table-dimensions
3247 (org-element-map tree
'table
'identity info
'first-match
) info
))))
3248 ;; 2. Ignore horizontal rules and special columns.
3249 (org-test-with-parsed-data "
3256 (org-export-table-dimensions
3257 (org-element-map tree
'table
'identity info
'first-match
) info
)))))
3259 (ert-deftest test-org-export
/table-cell-address
()
3260 "Test `org-export-table-cell-address' specifications."
3261 ;; 1. Standard test: index is 0-based.
3262 (org-test-with-parsed-data "| a | b |"
3264 (equal '((0 .
0) (0 .
1))
3265 (org-element-map tree
'table-cell
3266 (lambda (cell) (org-export-table-cell-address cell info
))
3268 ;; 2. Special column isn't counted, nor are special rows.
3269 (org-test-with-parsed-data "
3274 (org-export-table-cell-address
3275 (car (last (org-element-map tree
'table-cell
'identity info
)))
3277 ;; 3. Tables rules do not count either.
3278 (org-test-with-parsed-data "
3286 (org-export-table-cell-address
3287 (car (last (org-element-map tree
'table-cell
'identity info
)))
3289 ;; 4. Return nil for special cells.
3290 (org-test-with-parsed-data "| / | a |"
3292 (org-export-table-cell-address
3293 (org-element-map tree
'table-cell
'identity nil
'first-match
)
3296 (ert-deftest test-org-export
/get-table-cell-at
()
3297 "Test `org-export-get-table-cell-at' specifications."
3298 ;; 1. Address ignores special columns, special rows and rules.
3299 (org-test-with-parsed-data "
3306 (org-element-contents
3307 (org-export-get-table-cell-at
3309 (org-element-map tree
'table
'identity info
'first-match
)
3311 ;; 2. Return value for a non-existent address is nil.
3312 (org-test-with-parsed-data "| a |"
3314 (org-export-get-table-cell-at
3316 (org-element-map tree
'table
'identity info
'first-match
)
3318 (org-test-with-parsed-data "| / |"
3320 (org-export-get-table-cell-at
3322 (org-element-map tree
'table
'identity info
'first-match
)
3325 (ert-deftest test-org-export
/table-cell-starts-colgroup-p
()
3326 "Test `org-export-table-cell-starts-colgroup-p' specifications."
3327 ;; 1. A cell at a beginning of a row always starts a column group.
3328 (org-test-with-parsed-data "| a |"
3330 (org-export-table-cell-starts-colgroup-p
3331 (org-element-map tree
'table-cell
'identity info
'first-match
)
3333 ;; 2. Special column should be ignored when determining the
3334 ;; beginning of the row.
3335 (org-test-with-parsed-data "
3339 (org-export-table-cell-starts-colgroup-p
3340 (org-element-map tree
'table-cell
'identity info
'first-match
)
3342 ;; 2. Explicit column groups.
3343 (org-test-with-parsed-data "
3349 (org-element-map tree
'table-cell
3351 (if (org-export-table-cell-starts-colgroup-p cell info
) 'yes
'no
))
3354 (ert-deftest test-org-export
/table-cell-ends-colgroup-p
()
3355 "Test `org-export-table-cell-ends-colgroup-p' specifications."
3356 ;; 1. A cell at the end of a row always ends a column group.
3357 (org-test-with-parsed-data "| a |"
3359 (org-export-table-cell-ends-colgroup-p
3360 (org-element-map tree
'table-cell
'identity info
'first-match
)
3362 ;; 2. Special column should be ignored when determining the
3363 ;; beginning of the row.
3364 (org-test-with-parsed-data "
3368 (org-export-table-cell-ends-colgroup-p
3369 (org-element-map tree
'table-cell
'identity info
'first-match
)
3371 ;; 3. Explicit column groups.
3372 (org-test-with-parsed-data "
3378 (org-element-map tree
'table-cell
3380 (if (org-export-table-cell-ends-colgroup-p cell info
) 'yes
'no
))
3383 (ert-deftest test-org-export
/table-row-starts-rowgroup-p
()
3384 "Test `org-export-table-row-starts-rowgroup-p' specifications."
3385 ;; 1. A row at the beginning of a table always starts a row group.
3386 ;; So does a row following a table rule.
3387 (org-test-with-parsed-data "
3394 (org-element-map tree
'table-row
3396 (if (org-export-table-row-starts-rowgroup-p row info
) 'yes
'no
))
3398 ;; 2. Special rows should be ignored when determining the beginning
3400 (org-test-with-parsed-data "
3409 (org-element-map tree
'table-row
3411 (if (org-export-table-row-starts-rowgroup-p row info
) 'yes
'no
))
3414 (ert-deftest test-org-export
/table-row-ends-rowgroup-p
()
3415 "Test `org-export-table-row-ends-rowgroup-p' specifications."
3416 ;; 1. A row at the end of a table always ends a row group. So does
3417 ;; a row preceding a table rule.
3418 (org-test-with-parsed-data "
3425 (org-element-map tree
'table-row
3427 (if (org-export-table-row-ends-rowgroup-p row info
) 'yes
'no
))
3429 ;; 2. Special rows should be ignored when determining the beginning
3431 (org-test-with-parsed-data "
3440 (org-element-map tree
'table-row
3442 (if (org-export-table-row-ends-rowgroup-p row info
) 'yes
'no
))
3445 (ert-deftest test-org-export
/table-row-in-header-p
()
3446 "Test `org-export-table-row-in-header-p' specifications."
3447 ;; Standard test. Separators are always nil.
3451 (org-test-with-parsed-data "| a |\n|---|\n| b |"
3452 (org-element-map tree
'table-row
3454 (if (org-export-table-row-in-header-p row info
) 'yes
'no
)) info
))))
3455 ;; Nil when there is no header.
3459 (org-test-with-parsed-data "| a |\n| b |"
3460 (org-element-map tree
'table-row
3462 (if (org-export-table-row-in-header-p row info
) 'yes
'no
)) info
)))))
3464 (ert-deftest test-org-export
/table-row-starts-header-p
()
3465 "Test `org-export-table-row-starts-header-p' specifications."
3466 ;; 1. Only the row starting the first row group starts the table
3468 (org-test-with-parsed-data "
3476 (org-element-map tree
'table-row
3478 (if (org-export-table-row-starts-header-p row info
) 'yes
'no
))
3480 ;; 2. A row cannot start an header if there's no header in the
3482 (org-test-with-parsed-data "
3486 (org-export-table-row-starts-header-p
3487 (org-element-map tree
'table-row
'identity info
'first-match
)
3490 (ert-deftest test-org-export
/table-row-ends-header-p
()
3491 "Test `org-export-table-row-ends-header-p' specifications."
3492 ;; 1. Only the row starting the first row group starts the table
3494 (org-test-with-parsed-data "
3502 (org-element-map tree
'table-row
3504 (if (org-export-table-row-ends-header-p row info
) 'yes
'no
))
3506 ;; 2. A row cannot start an header if there's no header in the
3508 (org-test-with-parsed-data "
3512 (org-export-table-row-ends-header-p
3513 (org-element-map tree
'table-row
'identity info
'first-match
)
3518 ;;; Tables of Contents
3520 (ert-deftest test-org-export
/collect-headlines
()
3521 "Test `org-export-collect-headlines' specifications."
3526 (org-test-with-parsed-data "* H1\n** H2"
3527 (org-export-collect-headlines info
)))))
3528 ;; Do not collect headlines below optional argument.
3532 (org-test-with-parsed-data "* H1\n** H2"
3533 (org-export-collect-headlines info
1)))))
3534 ;; Never collect headlines below maximum headline level.
3538 (org-test-with-parsed-data "#+OPTIONS: H:1\n* H1\n** H2"
3539 (org-export-collect-headlines info
)))))
3543 (org-test-with-parsed-data "#+OPTIONS: H:1\n* H1\n** H2"
3544 (org-export-collect-headlines info
2)))))
3545 ;; Collect headlines locally.
3548 (org-test-with-parsed-data "* H1\n** H2\n** H3"
3549 (let ((scope (org-element-map tree
'headline
#'identity info t
)))
3550 (length (org-export-collect-headlines info nil scope
))))))
3551 ;; When collecting locally, optional level is relative.
3554 (org-test-with-parsed-data "* H1\n** H2\n*** H3"
3555 (let ((scope (org-element-map tree
'headline
#'identity info t
)))
3556 (length (org-export-collect-headlines info
1 scope
)))))))
3562 (ert-deftest test-org-export
/inner-template
()
3563 "Test `inner-template' translator specifications."
3566 (org-test-with-temp-text "* Headline"
3568 (org-export-create-backend
3570 '((inner-template .
(lambda (contents info
) "Success!"))
3571 (headline .
(lambda (h c i
) "Headline"))))))))
3572 ;; Inner template is applied even in a "body-only" export.
3575 (org-test-with-temp-text "* Headline"
3577 (org-export-create-backend
3578 :transcoders
'((inner-template .
(lambda (c i
) "Success!"))
3579 (headline .
(lambda (h c i
) "Headline"))))
3580 nil nil
'body-only
)))))
3582 (ert-deftest test-org-export
/template
()
3583 "Test `template' translator specifications."
3586 (org-test-with-temp-text "* Headline"
3588 (org-export-create-backend
3589 :transcoders
'((template .
(lambda (contents info
) "Success!"))
3590 (headline .
(lambda (h c i
) "Headline"))))))))
3591 ;; Template is not applied in a "body-only" export.
3594 (org-test-with-temp-text "* Headline"
3596 (org-export-create-backend
3597 :transcoders
'((template .
(lambda (contents info
) "Success!"))
3598 (headline .
(lambda (h c i
) "Headline"))))
3599 nil nil
'body-only
)))))
3605 (ert-deftest test-org-export
/get-next-element
()
3606 "Test `org-export-get-next-element' specifications."
3610 (org-test-with-parsed-data "* Headline\n*a* b"
3611 (org-export-get-next-element
3612 (org-element-map tree
'bold
'identity info t
) info
))))
3613 ;; Return nil when no previous element.
3615 (org-test-with-parsed-data "* Headline\na *b*"
3616 (org-export-get-next-element
3617 (org-element-map tree
'bold
'identity info t
) info
)))
3618 ;; Non-exportable elements are ignored.
3620 (let ((org-export-with-timestamps nil
))
3621 (org-test-with-parsed-data "\alpha <2012-03-29 Thu>"
3622 (org-export-get-next-element
3623 (org-element-map tree
'entity
'identity info t
) info
))))
3624 ;; Find next element in secondary strings.
3627 (org-test-with-parsed-data "* a =verb="
3629 (org-export-get-next-element
3630 (org-element-map tree
'plain-text
'identity info t
) info
)))))
3633 (org-test-with-parsed-data "* /italic/ =verb="
3635 (org-export-get-next-element
3636 (org-element-map tree
'italic
'identity info t
) info
)))))
3637 ;; Find next element in document keywords.
3640 (org-test-with-parsed-data "#+TITLE: a =verb="
3642 (org-export-get-next-element
3644 (plist-get info
:title
) 'plain-text
'identity info t
) info
)))))
3645 ;; Find next element in parsed affiliated keywords.
3648 (org-test-with-parsed-data "#+CAPTION: a =verb=\nParagraph"
3650 (org-export-get-next-element
3651 (org-element-map tree
'plain-text
'identity info t nil t
) info
)))))
3652 ;; With optional argument N, return a list containing all the
3653 ;; following elements.
3656 '(bold code underline
)
3657 (org-test-with-parsed-data "_a_ /b/ *c* ~d~ _e_"
3659 (org-export-get-next-element
3660 (org-element-map tree
'italic
'identity info t
) info t
)))))
3661 ;; When N is a positive integer, return a list containing up to
3662 ;; N following elements.
3666 (org-test-with-parsed-data "_a_ /b/ *c* ~d~ _e_"
3668 (org-export-get-next-element
3669 (org-element-map tree
'italic
'identity info t
) info
2))))))
3671 (ert-deftest test-org-export
/get-previous-element
()
3672 "Test `org-export-get-previous-element' specifications."
3676 (org-test-with-parsed-data "* Headline\na *b*"
3677 (org-export-get-previous-element
3678 (org-element-map tree
'bold
'identity info t
) info
))))
3679 ;; Return nil when no previous element.
3681 (org-test-with-parsed-data "* Headline\n*a* b"
3682 (org-export-get-previous-element
3683 (org-element-map tree
'bold
'identity info t
) info
)))
3684 ;; Non-exportable elements are ignored.
3686 (let ((org-export-with-timestamps nil
))
3687 (org-test-with-parsed-data "<2012-03-29 Thu> \alpha"
3688 (org-export-get-previous-element
3689 (org-element-map tree
'entity
'identity info t
) info
))))
3690 ;; Find previous element in secondary strings.
3693 (org-test-with-parsed-data "* =verb= a"
3695 (org-export-get-previous-element
3696 (org-element-map tree
'plain-text
'identity info t
) info
)))))
3699 (org-test-with-parsed-data "* =verb= /italic/"
3701 (org-export-get-previous-element
3702 (org-element-map tree
'italic
'identity info t
) info
)))))
3703 ;; Find previous element in document keywords.
3706 (org-test-with-parsed-data "#+TITLE: =verb= a"
3708 (org-export-get-previous-element
3710 (plist-get info
:title
) 'plain-text
'identity info t
) info
)))))
3711 ;; Find previous element in parsed affiliated keywords.
3714 (org-test-with-parsed-data "#+CAPTION: =verb= a\nParagraph"
3716 (org-export-get-previous-element
3717 (org-element-map tree
'plain-text
'identity info t nil t
) info
)))))
3718 ;; With optional argument N, return a list containing up to
3719 ;; N previous elements.
3721 (equal '(underline italic bold
)
3722 (org-test-with-parsed-data "_a_ /b/ *c* ~d~"
3724 (org-export-get-previous-element
3725 (org-element-map tree
'code
'identity info t
) info t
)))))
3726 ;; When N is a positive integer, return a list containing up to
3727 ;; N previous elements.
3729 (equal '(italic bold
)
3730 (org-test-with-parsed-data "_a_ /b/ *c* ~d~"
3732 (org-export-get-previous-element
3733 (org-element-map tree
'code
'identity info t
) info
2))))))
3737 ;;; test-org-export.el end here