1 ;;; test-ox.el --- Tests for ox.el
3 ;; Copyright (C) 2012, 2013, 2014 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 (let* ((tree (org-element-parse-buffer))
52 (info (org-export-get-environment)))
53 (org-export-prune-tree tree info
)
54 (org-export-remove-uninterpreted-data tree info
)
55 (let ((info (org-combine-plists
56 info
(org-export-collect-tree-properties tree info
))))
63 (ert-deftest test-org-export
/bind-keyword
()
64 "Test reading #+BIND: keywords."
65 ;; Test with `org-export-allow-bind-keywords' set to t.
67 (org-test-with-temp-text "#+BIND: test-ox-var value"
68 (let ((org-export-allow-bind-keywords t
))
69 (org-export-get-environment)
70 (eq test-ox-var
'value
))))
71 ;; Test with `org-export-allow-bind-keywords' set to nil.
73 (org-test-with-temp-text "#+BIND: test-ox-var value"
74 (let ((org-export-allow-bind-keywords nil
))
75 (org-export-get-environment)
76 (boundp 'test-ox-var
))))
77 ;; BIND keywords are case-insensitive.
79 (org-test-with-temp-text "#+bind: test-ox-var value"
80 (let ((org-export-allow-bind-keywords t
))
81 (org-export-get-environment)
82 (eq test-ox-var
'value
))))
83 ;; Preserve order of BIND keywords.
85 (org-test-with-temp-text "#+BIND: test-ox-var 1\n#+BIND: test-ox-var 2"
86 (let ((org-export-allow-bind-keywords t
))
87 (org-export-get-environment)
89 ;; Read BIND keywords in setup files.
91 (org-test-with-temp-text
92 (format "#+SETUPFILE: \"%s/examples/setupfile.org\"" org-test-dir
)
93 (let ((org-export-allow-bind-keywords t
))
94 (org-export-get-environment)
95 (eq variable
'value
))))
96 ;; Verify that bound variables are seen during export.
99 (org-test-with-temp-text "#+BIND: test-ox-var value"
100 (let ((org-export-allow-bind-keywords t
))
102 (org-export-create-backend
104 '((section .
(lambda (s c i
)
105 (if (eq test-ox-var
'value
) "Yes" "No")))))))))))
107 (ert-deftest test-org-export
/parse-option-keyword
()
108 "Test reading all standard #+OPTIONS: items."
111 (org-export--parse-option-keyword
112 "H:1 num:t \\n:t timestamp:t arch:t author:t creator:t d:t email:t
113 *:t e:t ::t f:t pri:t -:t ^:t toc:t |:t tags:t tasks:t <:t todo:t inline:nil
116 1 :preserve-breaks t
:section-numbers t
:time-stamp-file t
117 :with-archived-trees t
:with-author t
:with-creator t
:with-drawers t
118 :with-email t
:with-emphasize t
:with-entities t
:with-fixed-width t
119 :with-footnotes t
:with-inlinetasks nil
:with-priority t
120 :with-special-strings t
:with-statistics-cookies t
:with-sub-superscript t
121 :with-toc t
:with-tables t
:with-tags t
:with-tasks t
:with-timestamps t
122 :with-title t
:with-todo-keywords t
)))
123 ;; Test some special values.
126 (org-export--parse-option-keyword
127 "arch:headline creator:comment d:(\"TEST\")
128 ^:{} toc:1 tags:not-in-toc tasks:todo num:2 <:active")
131 :with-archived-trees headline
:with-creator comment
132 :with-drawers
("TEST") :with-sub-superscript
{} :with-toc
1
133 :with-tags not-in-toc
:with-tasks todo
:with-timestamps active
))))
135 (ert-deftest test-org-export
/get-inbuffer-options
()
136 "Test reading all standard export keywords."
137 ;; Properties should follow buffer order.
140 (org-test-with-temp-text "#+LANGUAGE: fr\n#+CREATOR: Me\n#+EMAIL: email"
141 (org-export--get-inbuffer-options))
142 '(:language
"fr" :creator
"Me" :email
"email")))
143 ;; Parse document keywords.
146 (org-test-with-temp-text "#+AUTHOR: Me"
147 (org-export--get-inbuffer-options))
149 ;; Test `space' behaviour.
152 (org-test-with-temp-text "#+TITLE: Some title\n#+TITLE: with spaces"
153 (org-export--get-inbuffer-options))
154 '(:title
("Some title with spaces"))))
155 ;; Test `newline' behaviour.
158 (org-test-with-temp-text "#+DESCRIPTION: With\n#+DESCRIPTION: two lines"
159 (org-export--get-inbuffer-options))
160 '(:description
"With\ntwo lines")))
161 ;; Test `split' behaviour.
164 (org-test-with-temp-text "#+SELECT_TAGS: a\n#+SELECT_TAGS: b"
165 (org-export--get-inbuffer-options))
166 '(:select-tags
("a" "b"))))
167 ;; Options set through SETUPFILE.
170 (org-test-with-temp-text
171 (format "#+DESCRIPTION: l1
175 #+SETUPFILE: \"%s/examples/setupfile.org\"
181 (org-export--get-inbuffer-options))
182 '(:description
"l1\nl2\nl3":language
"fr" :select-tags
("a" "b" "c")
184 ;; More than one property can refer to the same buffer keyword.
186 (equal '(:k2
"value" :k1
"value")
187 (let ((backend (org-export-create-backend
188 :options
'((:k1
"KEYWORD")
190 (org-test-with-temp-text "#+KEYWORD: value"
191 (org-export--get-inbuffer-options backend
))))))
193 (ert-deftest test-org-export
/get-subtree-options
()
194 "Test setting options from headline's properties."
196 (org-test-with-temp-text "#+TITLE: Title
199 :EXPORT_TITLE: Subtree Title
203 (should (equal (plist-get (org-export-get-environment nil t
) :title
)
204 '("Subtree Title"))))
208 (org-test-with-temp-text "#+OPTIONS: H:1
216 (= 2 (plist-get (org-export-get-environment nil t
) :headline-levels
))))
218 (org-test-with-temp-text "#+DATE: today
221 :EXPORT_DATE: 29-03-2012
225 (should (equal (plist-get (org-export-get-environment nil t
) :date
)
227 ;; Properties with `split' behaviour are stored as a list of
231 (org-test-with-temp-text "#+EXCLUDE_TAGS: noexport
234 :EXPORT_EXCLUDE_TAGS: a b
239 (plist-get (org-export-get-environment nil t
) :exclude-tags
)))))
240 ;; Handle :PROPERTY+: syntax.
243 (org-test-with-temp-text "#+EXCLUDE_TAGS: noexport
246 :EXPORT_EXCLUDE_TAGS: a
247 :EXPORT_EXCLUDE_TAGS+: b
252 (plist-get (org-export-get-environment nil t
) :exclude-tags
)))))
253 ;; Export properties are case-insensitive.
254 (org-test-with-temp-text "* Headline
256 :EXPORT_Date: 29-03-2012
259 (should (equal (plist-get (org-export-get-environment nil t
) :date
)
261 ;; Still grab correct options when section above is empty.
264 (org-test-with-temp-text "* H1\n** H11\n** H12"
265 (progn (forward-line 2)
266 (plist-get (org-export-get-environment nil t
) :title
))))))
268 (ert-deftest test-org-export
/set-title
()
269 "Test title setting."
270 ;; Without TITLE keyword.
274 (let (org-export-filter-body-functions
275 org-export-filter-final-output-functions
)
276 (org-test-with-temp-text "Test"
278 (org-export-create-backend
280 '((template .
(lambda (text info
)
281 (org-element-interpret-data
282 (plist-get info
:title
)))))))))))
283 ;; With a blank TITLE keyword.
287 (let (org-export-filter-body-functions
288 org-export-filter-final-output-functions
)
289 (org-test-with-temp-text "#+TITLE:\nTest"
291 (org-export-create-backend
293 '((template .
(lambda (text info
)
294 (org-element-interpret-data
295 (plist-get info
:title
)))))))))))
296 ;; With a non-empty TITLE keyword.
300 (org-test-with-temp-text "#+TITLE: Title\nTest"
302 (org-export-create-backend
304 '((template .
(lambda (text info
)
305 (org-element-interpret-data
306 (plist-get info
:title
))))))))))
307 ;; When exporting a subtree, its heading becomes the headline of the
312 (org-test-with-temp-text "* Headline\nBody"
314 (org-export-create-backend
316 '((template .
(lambda (text info
)
317 (org-element-interpret-data
318 (plist-get info
:title
))))))
320 ;; ... unless there is an EXPORT_TITLE property at the root of the
325 (org-test-with-temp-text
326 "* A\n :PROPERTIES:\n :EXPORT_TITLE: B\n :END:\nBody"
328 (org-export-create-backend
330 '((template .
(lambda (text info
)
331 (org-element-interpret-data
332 (plist-get info
:title
))))))
335 (ert-deftest test-org-export
/handle-options
()
336 "Test if export options have an impact on output."
337 ;; Test exclude tags for headlines and inlinetasks.
340 (let (org-export-filter-body-functions
341 org-export-filter-final-output-functions
)
342 (org-test-with-temp-text "* Head1 :noexp:"
343 (org-export-as (org-test-default-backend)
344 nil nil nil
'(:exclude-tags
("noexp")))))))
345 ;; Test include tags for headlines and inlinetasks.
347 (equal "* H2\n** Sub :exp:\n*** Sub Sub\n"
348 (org-test-with-temp-text "* H1\n* H2\n** Sub :exp:\n*** Sub Sub\n* H3"
349 (let ((org-tags-column 0))
350 (org-export-as (org-test-default-backend)
351 nil nil nil
'(:select-tags
("exp")))))))
352 ;; If there is an include tag, ignore the section before the first
355 (equal "* H1 :exp:\nBody\n"
356 (org-test-with-temp-text "First section\n* H1 :exp:\nBody"
357 (let ((org-tags-column 0))
358 (org-export-as (org-test-default-backend)
359 nil nil nil
'(:select-tags
("exp")))))))
361 (equal "* H1 :exp:\n"
362 (org-test-with-temp-text "* H1 :exp:\nBody"
363 (let ((org-tags-column 0))
364 (org-export-as (org-test-default-backend)
365 nil nil nil
'(:select-tags
("exp")))))))
366 ;; Test mixing include tags and exclude tags.
369 "\\* Head1[ \t]+:export:\n\\*\\* Sub-Head2\n"
370 (org-test-with-temp-text "
372 ** Sub-Head1 :noexport:
375 ** Sub-Head1 :export:"
376 (org-export-as (org-test-default-backend) nil nil nil
377 '(:select-tags
("export") :exclude-tags
("noexport"))))))
381 (let ((org-todo-keywords '((sequence "TODO" "DONE")))
382 org-export-filter-body-functions
383 org-export-filter-final-output-functions
)
384 (org-test-with-temp-text "* TODO Head1"
385 (org-export-as (org-test-default-backend)
386 nil nil nil
'(:with-tasks nil
))))))
388 (equal "* TODO Head1\n"
389 (let ((org-todo-keywords '((sequence "TODO" "DONE"))))
390 (org-test-with-temp-text "* TODO Head1"
391 (org-export-as (org-test-default-backend)
392 nil nil nil
'(:with-tasks t
))))))
396 (let (org-export-filter-body-functions
397 org-export-filter-final-output-functions
)
398 (org-test-with-temp-text "* Head1 :archive:"
399 (let ((org-archive-tag "archive"))
400 (org-export-as (org-test-default-backend)
401 nil nil nil
'(:with-archived-trees nil
)))))))
404 "\\* Head1[ \t]+:archive:"
405 (org-test-with-temp-text "* Head1 :archive:\nbody\n** Sub-head 2"
406 (let ((org-archive-tag "archive"))
407 (org-export-as (org-test-default-backend) nil nil nil
408 '(:with-archived-trees headline
))))))
411 "\\`\\* Head1[ \t]+:archive:\n\\'"
412 (org-test-with-temp-text "* Head1 :archive:"
413 (let ((org-archive-tag "archive"))
414 (org-export-as (org-test-default-backend)
415 nil nil nil
'(:with-archived-trees t
))))))
418 (string-match "CLOCK: \\[2012-04-29 .* 10:45\\]"
419 (org-test-with-temp-text "CLOCK: [2012-04-29 sun. 10:45]"
420 (org-export-as (org-test-default-backend)
421 nil nil nil
'(:with-clocks t
)))))
424 (let (org-export-filter-body-functions
425 org-export-filter-final-output-functions
)
426 (org-test-with-temp-text "CLOCK: [2012-04-29 sun. 10:45]"
427 (org-export-as (org-test-default-backend)
428 nil nil nil
'(:with-clocks nil
))))))
432 (let (org-export-filter-body-functions
433 org-export-filter-final-output-functions
)
434 (org-test-with-temp-text ":TEST:\ncontents\n:END:"
435 (org-export-as (org-test-default-backend)
436 nil nil nil
'(:with-drawers nil
))))))
438 (equal ":TEST:\ncontents\n:END:\n"
439 (org-test-with-temp-text ":TEST:\ncontents\n:END:"
440 (org-export-as (org-test-default-backend)
441 nil nil nil
'(:with-drawers t
)))))
443 (equal ":FOO:\nkeep\n:END:\n"
444 (org-test-with-temp-text ":FOO:\nkeep\n:END:\n:BAR:\nremove\n:END:"
445 (org-export-as (org-test-default-backend)
446 nil nil nil
'(:with-drawers
("FOO"))))))
448 (equal ":FOO:\nkeep\n:END:\n"
449 (org-test-with-temp-text ":FOO:\nkeep\n:END:\n:BAR:\nremove\n:END:"
450 (org-export-as (org-test-default-backend)
451 nil nil nil
'(:with-drawers
(not "BAR"))))))
455 (org-test-with-temp-text ": A"
456 (org-export-as (org-test-default-backend) nil nil nil
457 '(:with-fixed-width t
)))))
460 (let (org-export-filter-body-functions
461 org-export-filter-final-output-functions
)
462 (org-test-with-temp-text ": A"
463 (org-export-as (org-test-default-backend) nil nil nil
464 '(:with-fixed-width nil
))))))
468 (let ((org-footnote-section nil
))
469 (org-test-with-temp-text "Footnote?[fn:1]\n\n[fn:1] Def"
470 (org-trim (org-export-as (org-test-default-backend)
471 nil nil nil
'(:with-footnotes nil
)))))))
473 (equal "Footnote?[fn:1]\n\n[fn:1] Def"
474 (let ((org-footnote-section nil
))
475 (org-test-with-temp-text "Footnote?[fn:1]\n\n[fn:1] Def"
476 (org-trim (org-export-as (org-test-default-backend)
477 nil nil nil
'(:with-footnotes t
)))))))
479 (when (featurep 'org-inlinetask
)
483 (let ((org-inlinetask-min-level 15)
484 org-export-filter-body-functions
485 org-export-filter-final-output-functions
)
486 (org-test-with-temp-text "*************** Task"
487 (org-export-as (org-test-default-backend)
488 nil nil nil
'(:with-inlinetasks nil
))))))
492 (let ((org-inlinetask-min-level 15)
493 org-export-filter-body-functions
494 org-export-filter-final-output-functions
)
495 (org-test-with-temp-text
496 "*************** Task\nContents\n*************** END"
497 (org-export-as (org-test-default-backend)
498 nil nil nil
'(:with-inlinetasks nil
)))))))
502 "* H\nCLOSED: \\[2012-04-29 .* 10:45\\]"
503 (let ((org-closed-string "CLOSED:"))
504 (org-test-with-temp-text "* H\nCLOSED: [2012-04-29 sun. 10:45]"
505 (org-export-as (org-test-default-backend)
506 nil nil nil
'(:with-planning t
))))))
509 (let ((org-closed-string "CLOSED:"))
510 (org-test-with-temp-text "* H\nCLOSED: [2012-04-29 sun. 10:45]"
511 (org-export-as (org-test-default-backend)
512 nil nil nil
'(:with-planning nil
))))))
516 (org-test-with-temp-text
517 "* H1\n :PROPERTIES:\n :PROP: value\n :END:"
518 (org-export-as (org-test-default-backend)
519 nil nil nil
'(:with-properties nil
)))))
521 (equal "* H1\n:PROPERTIES:\n:PROP: value\n:END:\n"
522 (org-test-with-temp-text
523 "* H1\n :PROPERTIES:\n :PROP: value\n :END:"
524 (org-export-as (org-test-default-backend)
525 nil nil nil
'(:with-properties t
)))))
527 (equal "* H1\n:PROPERTIES:\n:B: 2\n:END:\n"
528 (org-test-with-temp-text
529 "* H1\n :PROPERTIES:\n :A: 1\n :B: 2\n:END:"
530 (org-export-as (org-test-default-backend)
531 nil nil nil
'(:with-properties
("B"))))))
532 ;; Statistics cookies.
535 (let (org-export-filter-body-functions
536 org-export-filter-final-output-functions
)
538 (org-test-with-temp-text "[0/0]"
539 (org-export-as (org-test-default-backend)
540 nil nil nil
'(:with-statistics-cookies nil
)))))))
544 (org-test-with-temp-text "| A |"
545 (org-export-as (org-test-default-backend) nil nil nil
546 '(:with-tables t
)))))
549 (let (org-export-filter-body-functions
550 org-export-filter-final-output-functions
)
551 (org-test-with-temp-text "| A |"
552 (org-export-as (org-test-default-backend) nil nil nil
553 '(:with-tables nil
)))))))
555 (ert-deftest test-org-export
/with-timestamps
()
556 "Test `org-export-with-timestamps' specifications."
560 "\\[2012-04-29 .*? 10:45\\]<2012-04-29 .*? 10:45>"
561 (org-test-with-temp-text "[2012-04-29 sun. 10:45]<2012-04-29 sun. 10:45>"
562 (org-export-as (org-test-default-backend)
563 nil nil nil
'(:with-timestamps t
)))))
568 (let (org-export-filter-body-functions
569 org-export-filter-final-output-functions
)
571 (org-test-with-temp-text "[2012-04-29 sun. 10:45]<2012-04-29 sun. 10:45>"
572 (org-export-as (org-test-default-backend)
573 nil nil nil
'(:with-timestamps nil
)))))))
577 "<2012-03-29 .*?>\n\nParagraph <2012-03-29 .*?>\\[2012-03-29 .*?\\]"
578 (org-test-with-temp-text
579 "<2012-03-29 Thu>[2012-03-29 Thu]
581 Paragraph <2012-03-29 Thu>[2012-03-29 Thu]"
582 (org-export-as (org-test-default-backend)
583 nil nil nil
'(:with-timestamps active
)))))
587 "\\[2012-03-29 .*?\\]\n\nParagraph <2012-03-29 .*?>\\[2012-03-29 .*?\\]"
588 (org-test-with-temp-text
589 "<2012-03-29 Thu>[2012-03-29 Thu]
591 Paragraph <2012-03-29 Thu>[2012-03-29 Thu]"
592 (org-export-as (org-test-default-backend)
593 nil nil nil
'(:with-timestamps inactive
))))))
595 (ert-deftest test-org-export
/comment-tree
()
596 "Test if export process ignores commented trees."
599 (let (org-export-filter-body-functions
600 org-export-filter-final-output-functions
)
601 (org-test-with-temp-text "* COMMENT Head1"
602 (org-export-as (org-test-default-backend)))))))
604 (ert-deftest test-org-export
/uninterpreted
()
605 "Test handling of uninterpreted elements."
609 (org-test-with-temp-text "\\alpha"
611 (org-export-create-backend
612 :transcoders
'((entity .
(lambda (e c i
) "dummy"))
613 (paragraph .
(lambda (p c i
) c
))
614 (section .
(lambda (s c i
) c
))))
615 nil nil nil
'(:with-entities t
)))))
618 (org-test-with-temp-text "\\alpha"
620 (org-export-create-backend
621 :transcoders
'((entity .
(lambda (e c i
) "dummy"))
622 (paragraph .
(lambda (p c i
) c
))
623 (section .
(lambda (s c i
) c
))))
624 nil nil nil
'(:with-entities nil
)))))
628 (org-test-with-temp-text "*bold*"
630 (org-export-create-backend
631 :transcoders
'((bold .
(lambda (b c i
) "dummy"))
632 (paragraph .
(lambda (p c i
) c
))
633 (section .
(lambda (s c i
) c
))))
634 nil nil nil
'(:with-emphasize t
)))))
637 (org-test-with-temp-text "*bold*"
639 (org-export-create-backend
640 :transcoders
'((bold .
(lambda (b c i
) "dummy"))
641 (paragraph .
(lambda (p c i
) c
))
642 (section .
(lambda (s c i
) c
))))
643 nil nil nil
'(:with-emphasize nil
)))))
644 ;; LaTeX environment.
647 (org-test-with-temp-text "\\begin{equation}\n1+1=2\n\\end{equation}"
649 (org-export-create-backend
650 :transcoders
'((latex-environment .
(lambda (l c i
) "dummy"))
651 (section .
(lambda (s c i
) c
))))
652 nil nil nil
'(:with-latex t
)))))
654 (equal "\\begin{equation}\n1+1=2\n\\end{equation}\n"
655 (org-test-with-temp-text "\\begin{equation}\n1+1=2\n\\end{equation}"
657 (org-export-create-backend
658 :transcoders
'((latex-environment .
(lambda (l c i
) "dummy"))
659 (section .
(lambda (s c i
) c
))))
660 nil nil nil
'(:with-latex verbatim
)))))
664 (org-test-with-temp-text "$1$"
666 (org-export-create-backend
667 :transcoders
'((latex-fragment .
(lambda (l c i
) "dummy"))
668 (paragraph .
(lambda (p c i
) c
))
669 (section .
(lambda (s c i
) c
))))
670 nil nil nil
'(:with-latex t
)))))
673 (org-test-with-temp-text "$1$"
675 (org-export-create-backend
676 :transcoders
'((latex-fragment .
(lambda (l c i
) "dummy"))
677 (paragraph .
(lambda (p c i
) c
))
678 (section .
(lambda (s c i
) c
))))
679 nil nil nil
'(:with-latex verbatim
)))))
683 (org-test-with-temp-text "a_b"
685 (org-export-create-backend
686 :transcoders
'((subscript .
(lambda (s c i
) "dummy"))
687 (paragraph .
(lambda (p c i
) c
))
688 (section .
(lambda (s c i
) c
))))
689 nil nil nil
'(:with-sub-superscript t
)))))
692 (org-test-with-temp-text "a_b"
694 (org-export-create-backend
695 :transcoders
'((subscript .
(lambda (s c i
) "dummy"))
696 (paragraph .
(lambda (p c i
) c
))
697 (section .
(lambda (s c i
) c
))))
698 nil nil nil
'(:with-sub-superscript nil
)))))
701 (org-test-with-temp-text "a_b"
703 (org-export-create-backend
704 :transcoders
'((subscript .
(lambda (s c i
) "dummy"))
705 (paragraph .
(lambda (p c i
) c
))
706 (section .
(lambda (s c i
) c
))))
707 nil nil nil
'(:with-sub-superscript
{})))))
710 (org-test-with-temp-text "a_{b}"
712 (org-export-create-backend
713 :transcoders
'((subscript .
(lambda (s c i
) "dummy"))
714 (paragraph .
(lambda (p c i
) c
))
715 (section .
(lambda (s c i
) c
))))
716 nil nil nil
'(:with-sub-superscript
{})))))
717 ;; Also handle uninterpreted objects in title.
720 (org-test-with-temp-text "#+TITLE: a_b"
722 (org-export-create-backend
724 '((subscript .
(lambda (s c i
) "dummy"))
725 (template .
(lambda (c i
) (org-export-data
726 (plist-get i
:title
) i
)))
727 (section .
(lambda (s c i
) c
))))
728 nil nil nil
'(:with-sub-superscript nil
)))))
729 ;; Special case: multiples uninterpreted objects in a row.
732 (org-test-with-temp-text "a_b_c_d"
734 (org-export-create-backend
735 :transcoders
'((subscript .
(lambda (s c i
) "dummy"))
736 (paragraph .
(lambda (p c i
) c
))
737 (section .
(lambda (s c i
) c
))))
738 nil nil nil
'(:with-sub-superscript
{}))))))
740 (ert-deftest test-org-export
/export-scope
()
741 "Test all export scopes."
742 (org-test-with-temp-text "
749 (should (equal (org-export-as (org-test-default-backend) 'subtree
)
750 "text\n*** Head3\n"))
752 (goto-char (point-min))
755 (should (equal (org-export-as (org-test-default-backend) nil
'visible
)
758 (goto-char (point-min))
760 (transient-mark-mode 1)
761 (push-mark (point) t t
)
762 (goto-char (point-at-eol))
763 (should (equal (org-export-as (org-test-default-backend)) "text\n")))
764 ;; Subtree with a code block calling another block outside.
765 (let ((org-export-babel-evaluate t
))
768 (org-test-with-temp-text "
770 #+BEGIN_SRC emacs-lisp :noweb yes :exports results
775 #+BEGIN_SRC emacs-lisp
779 (org-export-as (org-test-default-backend) 'subtree
)))))
781 (let ((backend (org-test-default-backend)))
782 (setf (org-export-backend-transcoders backend
)
783 (cons '(template .
(lambda (body i
)
784 (format "BEGIN\n%sEND" body
)))
785 (org-export-backend-transcoders backend
)))
786 (org-test-with-temp-text "Text"
787 (should (equal (org-export-as backend nil nil
'body-only
)
789 (should (equal (org-export-as backend
) "BEGIN\nText\nEND")))))
791 (ert-deftest test-org-export
/output-file-name
()
792 "Test `org-export-output-file-name' specifications."
793 ;; Export from a file: name is built from original file name.
795 (org-test-with-temp-text-in-file "Test"
796 (equal (concat (file-name-as-directory ".")
797 (file-name-nondirectory
798 (file-name-sans-extension (buffer-file-name))))
799 (file-name-sans-extension (org-export-output-file-name ".ext")))))
800 ;; When exporting to subtree, check EXPORT_FILE_NAME property first.
802 (org-test-with-temp-text-in-file
803 "* Test\n :PROPERTIES:\n :EXPORT_FILE_NAME: test\n :END:"
804 (equal (org-export-output-file-name ".ext" t
) "./test.ext")))
805 ;; From a buffer not associated to a file, too.
807 (org-test-with-temp-text
808 "* Test\n :PROPERTIES:\n :EXPORT_FILE_NAME: test\n :END:"
809 (equal (org-export-output-file-name ".ext" t
) "./test.ext")))
810 ;; When provided name is absolute, preserve it.
812 (org-test-with-temp-text
813 (format "* Test\n :PROPERTIES:\n :EXPORT_FILE_NAME: %s\n :END:"
814 (expand-file-name "test"))
815 (file-name-absolute-p (org-export-output-file-name ".ext" t
))))
816 ;; When PUB-DIR argument is provided, use it.
818 (org-test-with-temp-text-in-file "Test"
819 (equal (file-name-directory
820 (org-export-output-file-name ".ext" nil
"dir/"))
822 ;; When returned name would overwrite original file, add EXTENSION
825 (org-test-at-id "75282ba2-f77a-4309-a970-e87c149fe125"
826 (equal (org-export-output-file-name ".org") "./normal.org.org"))))
828 (ert-deftest test-org-export
/expand-include
()
829 "Test file inclusion in an Org buffer."
830 ;; Error when file isn't specified.
832 (org-test-with-temp-text "#+INCLUDE: dummy.org"
833 (org-export-expand-include-keyword)))
834 ;; Full insertion with recursive inclusion.
839 (expand-file-name "examples/include.org" org-test-dir
))
840 (replace-regexp-in-string
841 (regexp-quote "#+INCLUDE: \"include2.org\"")
842 "Success!" (buffer-string)))
843 (org-test-with-temp-text
844 (format "#+INCLUDE: \"%s/examples/include.org\"" org-test-dir
)
845 (org-export-expand-include-keyword)
847 ;; Localized insertion.
848 (org-test-with-temp-text
849 (format "#+INCLUDE: \"%s/examples/include.org\" :lines \"1-2\""
851 (org-export-expand-include-keyword)
852 (should (equal (buffer-string)
853 "Small Org file with an include keyword.\n")))
854 ;; Insertion with constraints on headlines level.
857 "* Top heading\n** Heading\nbody\n"
858 (org-test-with-temp-text
860 "* Top heading\n#+INCLUDE: \"%s/examples/include.org\" :lines \"9-11\""
862 (org-export-expand-include-keyword)
866 "* Top heading\n* Heading\nbody\n"
867 (org-test-with-temp-text
869 "* Top heading\n#+INCLUDE: \"%s/examples/include.org\" :lines \"9-11\" :minlevel 1"
871 (org-export-expand-include-keyword)
873 ;; Inclusion within an example block.
876 "#+BEGIN_EXAMPLE\nSmall Org file with an include keyword.\n#+END_EXAMPLE\n"
877 (org-test-with-temp-text
878 (format "#+INCLUDE: \"%s/examples/include.org\" :lines \"1-2\" EXAMPLE"
880 (org-export-expand-include-keyword)
882 ;; Inclusion within a src-block.
885 "#+BEGIN_SRC emacs-lisp\n(+ 2 1)\n#+END_SRC\n"
886 (org-test-with-temp-text
888 "#+INCLUDE: \"%s/examples/include.org\" :lines \"4-5\" SRC emacs-lisp"
890 (org-export-expand-include-keyword)
892 ;; Inclusion within an html export-block.
895 "#+BEGIN_HTML\n<p>HTML!</p>\n#+END_HTML\n"
896 (org-test-with-temp-text
898 "#+INCLUDE: \"%s/examples/include.html\" HTML"
900 (org-export-expand-include-keyword)
902 ;; Inclusion within an center paragraph
905 "#+BEGIN_CENTER\nSuccess!\n#+END_CENTER\n"
906 (org-test-with-temp-text
908 "#+INCLUDE: \"%s/examples/include2.org\" CENTER"
910 (org-export-expand-include-keyword)
912 ;; Footnotes labels are local to each included file.
918 Footnotes[fn:1], [fn:test] and [fn:inline:anonymous footnote].
920 \[fn:test] Footnote \"test\""))
921 (org-test-with-temp-text-in-file contents
922 (let ((file1 (buffer-file-name)))
923 (org-test-with-temp-text-in-file contents
924 (let ((file2 (buffer-file-name)))
925 (org-test-with-temp-text
926 (format "#+INCLUDE: \"%s\"\n#+INCLUDE: \"%s\""
928 (org-export-expand-include-keyword)
929 (org-element-map (org-element-parse-buffer)
932 (org-element-property :label ref
)))))))))))))
933 ;; Footnotes labels are not local to each include keyword.
939 Footnotes[fn:1], [fn:test], [2] and [fn:inline:anonymous footnote].
942 \[fn:test] Footnote \"test\""))
943 (org-test-with-temp-text-in-file contents
944 (let ((file (buffer-file-name)))
945 (org-test-with-temp-text
946 (format "#+INCLUDE: \"%s\"\n#+INCLUDE: \"%s\"" file file
)
947 (org-export-expand-include-keyword)
948 (org-element-map (org-element-parse-buffer)
950 (lambda (ref) (org-element-property :label ref
)))))))))))
951 ;; Footnotes are supported by :lines-like elements and unnecessary
952 ;; footnotes are dropped.
961 Footnotes[fn:2], foot[fn:test], digit only[3], and [fn:inline:anonymous footnote]
966 \[fn:test] Footnote \"test\"
969 (org-test-with-temp-text-in-file contents
970 (let ((file (buffer-file-name)))
971 (org-test-with-temp-text
972 (format "#+INCLUDE: \"%s::*bar\"
974 (org-export-expand-include-keyword)
975 (org-element-map (org-element-parse-buffer)
977 (lambda (ref) (org-element-property :label ref
)))))))))))
978 ;; If only-contents is non-nil only include contents of element.
982 (org-test-with-temp-text
984 (format "#+INCLUDE: \"%s/examples/include.org::*Heading\" " org-test-dir
)
986 (org-export-expand-include-keyword)
988 ;; Headings can be included via CUSTOM_ID.
990 (org-test-with-temp-text
991 (format "#+INCLUDE: \"%s/examples/include.org::#ah\"" org-test-dir
)
992 (org-export-expand-include-keyword)
993 (goto-char (point-min))
994 (looking-at "* Another heading")))
995 ;; Named objects can be included.
999 (org-test-with-temp-text
1000 (format "#+INCLUDE: \"%s/examples/include.org::tbl\" :only-contents t" org-test-dir
)
1001 (org-export-expand-include-keyword)
1003 ;; Including non-existing elements should result in an error.
1005 (org-test-with-temp-text
1006 (format "#+INCLUDE: \"%s/examples/include.org::*non-existing heading\"" org-test-dir
)
1007 (org-export-expand-include-keyword)))
1008 ;; Lines work relatively to an included element.
1012 (org-test-with-temp-text
1013 (format "#+INCLUDE: \"%s/examples/include.org::#ah\" :only-contents t :lines \"2-3\"" org-test-dir
)
1014 (org-export-expand-include-keyword)
1016 ;; Properties should be dropped from headlines.
1019 (org-test-with-temp-text
1020 (format "#+INCLUDE: \"%s/examples/include.org::#ht\" :only-contents t" org-test-dir
)
1021 (org-export-expand-include-keyword)
1023 (org-test-with-temp-text
1024 (format "#+INCLUDE: \"%s/examples/include.org::tbl\"" org-test-dir
)
1025 (org-export-expand-include-keyword)
1027 ;; Properties should be dropped, drawers should not be.
1030 ":LOGBOOK:\ndrawer\n:END:\ncontent\n"
1031 (org-test-with-temp-text
1032 (format "#+INCLUDE: \"%s/examples/include.org::#dh\" :only-contents t" org-test-dir
)
1033 (org-export-expand-include-keyword)
1035 ;; Adjacent INCLUDE-keywords should have the same :minlevel if unspecified.
1037 (org-every (lambda (level) (zerop (1- level
)))
1038 (org-test-with-temp-text
1040 (format "#+INCLUDE: \"%s/examples/include.org::#ah\"\n" org-test-dir
)
1041 (format "#+INCLUDE: \"%s/examples/include.org::*Heading\"" org-test-dir
))
1042 (org-export-expand-include-keyword)
1043 (org-element-map (org-element-parse-buffer) 'headline
1044 (lambda (head) (org-element-property :level head
))))))
1045 ;; INCLUDE does not insert induced :minlevel for src-blocks.
1048 (org-test-with-temp-text
1049 (format "#+INCLUDE: \"%s/examples/include2.org\" src emacs-lisp" org-test-dir
)
1050 (org-export-expand-include-keyword)
1052 (org-test-with-temp-text
1053 (format "#+INCLUDE: \"%s/examples/include2.org\" src emacs-lisp :minlevel 1" org-test-dir
)
1054 (org-export-expand-include-keyword)
1056 ;; INCLUDE assigns the relative :minlevel conditional on narrowing.
1058 (org-test-with-temp-text-in-file
1059 (format "* h1\n<point>#+INCLUDE: \"%s/examples/include.org::#ah\"" org-test-dir
)
1060 (narrow-to-region (point) (point-max))
1061 (org-export-expand-include-keyword)
1062 (eq 1 (org-current-level))))
1063 ;; If :minlevel is present do not alter it.
1065 (org-test-with-temp-text
1066 (format "* h1\n<point>#+INCLUDE: \"%s/examples/include.org::#ah\" :minlevel 3" org-test-dir
)
1067 (narrow-to-region (point) (point-max))
1068 (org-export-expand-include-keyword)
1069 (eq 3 (org-current-level)))))
1071 (ert-deftest test-org-export
/expand-macro
()
1072 "Test macro expansion in an Org buffer."
1073 ;; Standard macro expansion.
1075 (equal "#+MACRO: macro1 value\nvalue\n"
1076 (org-test-with-temp-text "#+MACRO: macro1 value\n{{{macro1}}}"
1077 (org-export-as (org-test-default-backend)))))
1078 ;; Expand specific macros.
1080 (equal "me 2012-03-29 me@here Title\n"
1081 (org-test-with-temp-text
1087 {{{author}}} {{{date}}} {{{email}}} {{{title}}}"
1088 (let ((output (org-export-as (org-test-default-backend))))
1089 (substring output
(string-match ".*\n\\'" output
))))))
1090 ;; Expand specific macros when property contained a regular macro
1094 (org-test-with-temp-text "
1095 #+MACRO: macro1 value
1096 #+TITLE: {{{macro1}}}
1098 (let ((output (org-export-as (org-test-default-backend))))
1099 (substring output
(string-match ".*\n\\'" output
))))))
1100 ;; Expand macros with templates in included files.
1103 (org-test-with-temp-text
1104 (format "#+INCLUDE: \"%s/examples/macro-templates.org\"
1105 {{{included-macro}}}" org-test-dir
)
1106 (let ((output (org-export-as (org-test-default-backend))))
1107 (substring output
(string-match ".*\n\\'" output
))))))
1108 ;; Date macro takes a optional formatting argument
1111 (org-test-with-temp-text "{{{date(%d-%m-%y)}}}\n* d :noexport:\n#+DATE: <2015-02-09>"
1112 (org-export-as (org-test-default-backend)))))
1113 ;; Only single timestamps are formatted
1115 (equal "<2015-02x-09>\n"
1116 (org-test-with-temp-text "{{{date(%d-%m-%y)}}}\n* d :noexport:\n#+DATE: <2015-02x-09>"
1117 (org-export-as (org-test-default-backend))))))
1119 (ert-deftest test-org-export
/before-processing-hook
()
1120 "Test `org-export-before-processing-hook'."
1123 "#+MACRO: mac val\nTest\n"
1124 (org-test-with-temp-text "#+MACRO: mac val\n{{{mac}}} Test"
1125 (let ((org-export-before-processing-hook
1127 (while (re-search-forward "{{{" nil t
)
1128 (let ((object (org-element-context)))
1129 (when (eq (org-element-type object
) 'macro
)
1131 (org-element-property :begin object
)
1132 (org-element-property :end object
)))))))))
1133 (org-export-as (org-test-default-backend)))))))
1135 (ert-deftest test-org-export
/before-parsing-hook
()
1136 "Test `org-export-before-parsing-hook'."
1138 (equal "Body 1\nBody 2\n"
1139 (org-test-with-temp-text "* Headline 1\nBody 1\n* Headline 2\nBody 2"
1140 (let ((org-export-before-parsing-hook
1142 (goto-char (point-min))
1143 (while (re-search-forward org-outline-regexp-bol nil t
)
1145 (point-at-bol) (progn (forward-line) (point))))))))
1146 (org-export-as (org-test-default-backend)))))))
1150 ;;; Affiliated Keywords
1152 (ert-deftest test-org-export
/read-attribute
()
1153 "Test `org-export-read-attribute' specifications."
1157 (org-export-read-attribute
1159 (org-test-with-temp-text "#+ATTR_HTML: :a 1 :b 2\nParagraph"
1160 (org-element-at-point)))
1162 ;; Return nil on empty attribute.
1164 (org-export-read-attribute
1166 (org-test-with-temp-text "Paragraph" (org-element-at-point))))
1167 ;; Return nil on "nil" string.
1169 (equal '(:a nil
:b nil
)
1170 (org-export-read-attribute
1172 (org-test-with-temp-text "#+ATTR_HTML: :a nil :b nil\nParagraph"
1173 (org-element-at-point)))))
1174 ;; Return nil on empty string.
1176 (equal '(:a nil
:b nil
)
1177 (org-export-read-attribute
1179 (org-test-with-temp-text "#+ATTR_HTML: :a :b\nParagraph"
1180 (org-element-at-point)))))
1181 ;; Return empty string when value is "".
1184 (org-export-read-attribute
1186 (org-test-with-temp-text "#+ATTR_HTML: :a \"\"\nParagraph"
1187 (org-element-at-point)))))
1188 ;; Return \"\" when value is """".
1191 (org-export-read-attribute
1193 (org-test-with-temp-text "#+ATTR_HTML: :a \"\"\"\"\nParagraph"
1194 (org-element-at-point)))))
1195 ;; Ignore text before first property.
1198 (org-export-read-attribute
1200 (org-test-with-temp-text "#+ATTR_HTML: ignore :a 1\nParagraph"
1201 (org-element-at-point))))))
1203 (ert-deftest test-org-export
/get-caption
()
1204 "Test `org-export-get-caption' specifications."
1205 ;; Without optional argument, return long caption
1209 (org-test-with-temp-text "#+CAPTION[s]: l\nPara"
1210 (org-export-get-caption (org-element-at-point)))))
1211 ;; With optional argument, return short caption.
1215 (org-test-with-temp-text "#+CAPTION[s]: l\nPara"
1216 (org-export-get-caption (org-element-at-point) t
))))
1217 ;; Multiple lines are separated by white spaces.
1221 (org-test-with-temp-text "#+CAPTION: a\n#+CAPTION: b\nPara"
1222 (org-export-get-caption (org-element-at-point))))))
1228 (ert-deftest test-org-export
/define-backend
()
1229 "Test back-end definition and accessors."
1232 (equal '((headline . my-headline-test
))
1233 (let (org-export--registered-backends)
1234 (org-export-define-backend 'test
'((headline . my-headline-test
)))
1235 (org-export-get-all-transcoders 'test
))))
1238 (equal '((:filter-headline . my-filter
))
1239 (let (org-export--registered-backends)
1240 (org-export-define-backend 'test
1241 '((headline . my-headline-test
))
1242 :filters-alist
'((:filter-headline . my-filter
)))
1243 (org-export-backend-filters (org-export-get-backend 'test
)))))
1246 (equal '((:prop value
))
1247 (let (org-export--registered-backends)
1248 (org-export-define-backend 'test
1249 '((headline . my-headline-test
))
1250 :options-alist
'((:prop value
)))
1251 (org-export-backend-options (org-export-get-backend 'test
)))))
1254 (equal '(?k
"Test Export" test
)
1255 (let (org-export--registered-backends)
1256 (org-export-define-backend 'test
1257 '((headline . my-headline-test
))
1258 :menu-entry
'(?k
"Test Export" test
))
1259 (org-export-backend-menu (org-export-get-backend 'test
)))))
1262 (equal '(("TEST" . org-element-export-block-parser
))
1263 (let (org-export--registered-backends org-element-block-name-alist
)
1264 (org-export-define-backend 'test
1265 '((headline . my-headline-test
))
1266 :export-block
'("test"))
1267 org-element-block-name-alist
))))
1269 (ert-deftest test-org-export
/define-derived-backend
()
1270 "Test `org-export-define-derived-backend' specifications."
1271 ;; Error when parent back-end is not defined.
1273 (let (org-export--registered-backends)
1274 (org-export-define-derived-backend 'test
'parent
)))
1275 ;; Append translation table to parent's.
1277 (equal '((:headline . test
) (:headline . parent
))
1278 (let (org-export--registered-backends)
1279 (org-export-define-backend 'parent
'((:headline . parent
)))
1280 (org-export-define-derived-backend 'test
'parent
1281 :translate-alist
'((:headline . test
)))
1282 (org-export-get-all-transcoders 'test
))))
1283 ;; Options defined in the new back have priority over those defined
1287 (let (org-export--registered-backends)
1288 (org-export-define-backend 'parent
1289 '((:headline . parent
))
1290 :options-alist
'((:a nil nil
'parent
)))
1291 (org-export-define-derived-backend 'test
'parent
1292 :options-alist
'((:a nil nil
'test
)))
1293 (plist-get (org-export--get-global-options
1294 (org-export-get-backend 'test
))
1297 (ert-deftest test-org-export
/derived-backend-p
()
1298 "Test `org-export-derived-backend-p' specifications."
1299 ;; Non-nil with direct match.
1301 (let (org-export--registered-backends)
1302 (org-export-define-backend 'test
'((headline . test
)))
1303 (org-export-derived-backend-p 'test
'test
)))
1305 (let (org-export--registered-backends)
1306 (org-export-define-backend 'test
'((headline . test
)))
1307 (org-export-define-derived-backend 'test2
'test
)
1308 (org-export-derived-backend-p 'test2
'test2
)))
1309 ;; Non-nil with a direct parent.
1311 (let (org-export--registered-backends)
1312 (org-export-define-backend 'test
'((headline . test
)))
1313 (org-export-define-derived-backend 'test2
'test
)
1314 (org-export-derived-backend-p 'test2
'test
)))
1315 ;; Non-nil with an indirect parent.
1317 (let (org-export--registered-backends)
1318 (org-export-define-backend 'test
'((headline . test
)))
1319 (org-export-define-derived-backend 'test2
'test
)
1320 (org-export-define-derived-backend 'test3
'test2
)
1321 (org-export-derived-backend-p 'test3
'test
)))
1324 (let (org-export--registered-backends)
1325 (org-export-define-backend 'test
'((headline . test
)))
1326 (org-export-define-backend 'test2
'((headline . test2
)))
1327 (org-export-derived-backend-p 'test2
'test
)))
1329 (let (org-export--registered-backends)
1330 (org-export-define-backend 'test
'((headline . test
)))
1331 (org-export-define-backend 'test2
'((headline . test2
)))
1332 (org-export-define-derived-backend 'test3
'test2
)
1333 (org-export-derived-backend-p 'test3
'test
))))
1335 (ert-deftest test-org-export
/get-all-transcoders
()
1336 "Test `org-export-get-all-transcoders' specifications."
1337 ;; Return nil when back-end cannot be found.
1338 (should-not (org-export-get-all-transcoders nil
))
1339 ;; Same as `org-export-transcoders' if no parent.
1341 (equal '((headline . ignore
))
1342 (org-export-get-all-transcoders
1343 (org-export-create-backend
1344 :transcoders
'((headline . ignore
))))))
1345 ;; But inherit from all ancestors whenever possible.
1347 (equal '((section . ignore
) (headline . ignore
))
1348 (let (org-export--registered-backends)
1349 (org-export-define-backend 'b1
'((headline . ignore
)))
1350 (org-export-get-all-transcoders
1351 (org-export-create-backend
1352 :parent
'b1
:transcoders
'((section . ignore
)))))))
1354 (equal '((paragraph . ignore
) (section . ignore
) (headline . ignore
))
1355 (let (org-export--registered-backends)
1356 (org-export-define-backend 'b1
'((headline . ignore
)))
1357 (org-export-define-derived-backend 'b2
'b1
1358 :translate-alist
'((section . ignore
)))
1359 (org-export-get-all-transcoders
1360 (org-export-create-backend
1361 :parent
'b2
:transcoders
'((paragraph . ignore
)))))))
1362 ;; Back-end transcoders overrule inherited ones.
1365 (let (org-export--registered-backends)
1366 (org-export-define-backend 'b1
'((headline . a
)))
1367 (cdr (assq 'headline
1368 (org-export-get-all-transcoders
1369 (org-export-create-backend
1370 :parent
'b1
:transcoders
'((headline . b
))))))))))
1372 (ert-deftest test-org-export
/get-all-options
()
1373 "Test `org-export-get-all-options' specifications."
1374 ;; Return nil when back-end cannot be found.
1375 (should-not (org-export-get-all-options nil
))
1376 ;; Same as `org-export-options' if no parent.
1378 (equal '((headline . ignore
))
1379 (org-export-get-all-options
1380 (org-export-create-backend
1381 :options
'((headline . ignore
))))))
1382 ;; But inherit from all ancestors whenever possible.
1384 (equal '((:key2 value2
) (:key1 value1
))
1385 (let (org-export--registered-backends)
1386 (org-export-define-backend 'b1 nil
:options-alist
'((:key1 value1
)))
1387 (org-export-get-all-options
1388 (org-export-create-backend
1389 :parent
'b1
:options
'((:key2 value2
)))))))
1391 (equal '((:key3 value3
) (:key2 value2
) (:key1 value1
))
1392 (let (org-export--registered-backends)
1393 (org-export-define-backend 'b1 nil
:options-alist
'((:key1 value1
)))
1394 (org-export-define-derived-backend 'b2
'b1
1395 :options-alist
'((:key2 value2
)))
1396 (org-export-get-all-options
1397 (org-export-create-backend
1398 :parent
'b2
:options
'((:key3 value3
)))))))
1399 ;; Back-end options overrule inherited ones.
1402 (let (org-export--registered-backends)
1403 (org-export-define-backend 'b1 nil
:options-alist
'((:key1 . a
)))
1405 (org-export-get-all-options
1406 (org-export-create-backend
1407 :parent
'b1
:options
'((:key1 . b
))))))))))
1409 (ert-deftest test-org-export
/get-all-filters
()
1410 "Test `org-export-get-all-filters' specifications."
1411 ;; Return nil when back-end cannot be found.
1412 (should-not (org-export-get-all-filters nil
))
1413 ;; Same as `org-export-filters' if no parent.
1415 (equal '((:filter-headline . ignore
))
1416 (org-export-get-all-filters
1417 (org-export-create-backend
1418 :filters
'((:filter-headline . ignore
))))))
1419 ;; But inherit from all ancestors whenever possible.
1421 (equal '((:filter-section . ignore
) (:filter-headline . ignore
))
1422 (let (org-export--registered-backends)
1423 (org-export-define-backend 'b1
1424 nil
:filters-alist
'((:filter-headline . ignore
)))
1425 (org-export-get-all-filters
1426 (org-export-create-backend
1427 :parent
'b1
:filters
'((:filter-section . ignore
)))))))
1429 (equal '((:filter-paragraph . ignore
)
1430 (:filter-section . ignore
)
1431 (:filter-headline . ignore
))
1432 (let (org-export--registered-backends)
1433 (org-export-define-backend 'b1
1434 nil
:filters-alist
'((:filter-headline . ignore
)))
1435 (org-export-define-derived-backend 'b2
'b1
1436 :filters-alist
'((:filter-section . ignore
)))
1437 (org-export-get-all-filters
1438 (org-export-create-backend
1439 :parent
'b2
:filters
'((:filter-paragraph . ignore
)))))))
1440 ;; Back-end filters overrule inherited ones.
1443 (let (org-export--registered-backends)
1444 (org-export-define-backend 'b1
'((:filter-headline . a
)))
1445 (cdr (assq :filter-headline
1446 (org-export-get-all-filters
1447 (org-export-create-backend
1448 :parent
'b1
:filters
'((:filter-headline . b
))))))))))
1450 (ert-deftest test-org-export
/with-backend
()
1451 "Test `org-export-with-backend' definition."
1452 ;; Error when calling an undefined back-end
1453 (should-error (org-export-with-backend nil
"Test"))
1454 ;; Error when called back-end doesn't have an appropriate
1457 (org-export-with-backend
1458 (org-export-create-backend :transcoders
'((headline . ignore
)))
1460 ;; Otherwise, export using correct transcoder
1463 (let (org-export--registered-backends)
1464 (org-export-define-backend 'test
1465 '((plain-text .
(lambda (text contents info
) "Failure"))))
1466 (org-export-define-backend 'test2
1467 '((plain-text .
(lambda (text contents info
) "Success"))))
1468 (org-export-with-backend 'test2
"Test"))))
1469 ;; Provide correct back-end if transcoder needs to use recursive
1473 (let ((test-back-end
1474 (org-export-create-backend
1476 '((headline .
(lambda (headline contents info
)
1478 (org-element-property :title headline
)
1480 (plain-text .
(lambda (text info
) "Success"))))))
1481 (org-export-string-as
1483 (org-export-create-backend
1485 '((headline .
(lambda (headline contents info
)
1486 (org-export-with-backend
1487 test-back-end headline contents info
))))))))))
1489 (ert-deftest test-org-export
/data-with-backend
()
1490 "Test `org-export-data-with-backend' specifications."
1491 ;; Error when calling an undefined back-end.
1492 (should-error (org-export-data-with-backend nil
"nil" nil
))
1493 ;; Otherwise, export data recursively, using correct back-end.
1497 (org-export-data-with-backend
1499 (org-export-create-backend
1501 '((plain-text .
(lambda (text info
) "Success"))
1502 (bold .
(lambda (bold contents info
) (concat contents
"!")))))
1503 '(:with-emphasize t
)))))
1509 (ert-deftest test-org-export
/export-snippet
()
1510 "Test export snippets transcoding."
1512 (org-test-with-temp-text "@@test:A@@@@t:B@@"
1513 (let ((backend (org-test-default-backend)))
1514 (setf (org-export-backend-name backend
) 'test
)
1515 (setf (org-export-backend-transcoders backend
)
1516 (cons (cons 'export-snippet
1517 (lambda (snippet contents info
)
1518 (when (eq (org-export-snippet-backend snippet
) 'test
)
1519 (org-element-property :value snippet
))))
1520 (org-export-backend-transcoders backend
)))
1521 (let ((org-export-snippet-translation-alist nil
))
1522 (should (equal (org-export-as backend
) "A\n")))
1523 (let ((org-export-snippet-translation-alist '(("t" .
"test"))))
1524 (should (equal (org-export-as backend
) "AB\n")))))
1525 ;; Ignored export snippets do not remove any blank.
1527 (equal "begin end\n"
1528 (org-test-with-parsed-data "begin @@test:A@@ end"
1529 (org-export-data-with-backend
1531 (org-export-create-backend
1533 '((paragraph .
(lambda (paragraph contents info
) contents
))
1534 (section .
(lambda (section contents info
) contents
))))
1541 (ert-deftest test-org-export
/footnotes
()
1542 "Test footnotes specifications."
1543 (let ((org-footnote-section nil
)
1544 (org-export-with-footnotes t
))
1545 ;; 1. Read every type of footnote.
1548 '((1 .
"A\n") (2 .
"B") (3 .
"C") (4 .
"D"))
1549 (org-test-with-parsed-data
1550 "Text[fn:1] [1] [fn:label:C] [fn::D]\n\n[fn:1] A\n\n[1] B"
1551 (org-element-map tree
'footnote-reference
1553 (let ((def (org-export-get-footnote-definition ref info
)))
1554 (cons (org-export-get-footnote-number ref info
)
1555 (if (eq (org-element-property :type ref
) 'inline
) (car def
)
1556 (car (org-element-contents
1557 (car (org-element-contents def
))))))))
1559 ;; 2. Test nested footnotes order.
1562 '((1 .
"fn:1") (2 .
"fn:2") (3 .
"fn:3") (4))
1563 (org-test-with-parsed-data
1564 "Text[fn:1:A[fn:2]] [fn:3].\n\n[fn:2] B [fn:3] [fn::D].\n\n[fn:3] C."
1565 (org-element-map tree
'footnote-reference
1567 (when (org-export-footnote-first-reference-p ref info
)
1568 (cons (org-export-get-footnote-number ref info
)
1569 (org-element-property :label ref
))))
1571 ;; 3. Test nested footnote in invisible definitions.
1572 (org-test-with-temp-text "Text[1]\n\n[1] B [2]\n\n[2] C."
1573 ;; Hide definitions.
1574 (narrow-to-region (point) (point-at-eol))
1575 (let* ((tree (org-element-parse-buffer))
1576 (info (org-combine-plists
1577 `(:parse-tree
,tree
)
1578 (org-export-collect-tree-properties
1579 tree
(org-export-get-environment)))))
1580 ;; Both footnotes should be seen.
1582 (= (length (org-export-collect-footnote-definitions tree info
)) 2))))
1583 ;; 4. Test footnotes definitions collection.
1586 (org-test-with-parsed-data "Text[fn:1:A[fn:2]] [fn:3].
1588 \[fn:2] B [fn:3] [fn::D].
1591 (length (org-export-collect-footnote-definitions tree info
)))))
1592 ;; 5. Test export of footnotes defined outside parsing scope.
1595 "ParagraphOut of scope\n"
1596 (org-test-with-temp-text "[fn:1] Out of scope
1599 (let ((backend (org-test-default-backend)))
1600 (setf (org-export-backend-transcoders backend
)
1601 (cons (cons 'footnote-reference
1602 (lambda (fn contents info
)
1603 (org-element-interpret-data
1604 (org-export-get-footnote-definition fn info
))))
1605 (org-export-backend-transcoders backend
)))
1607 (org-export-as backend
'subtree
)))))
1608 ;; 6. Footnotes without a definition should throw an error.
1610 (org-test-with-parsed-data "Text[fn:1]"
1611 (org-export-get-footnote-definition
1612 (org-element-map tree
'footnote-reference
'identity info t
) info
)))
1613 ;; 7. Footnote section should be ignored in TOC and in headlines
1616 (= 1 (let ((org-footnote-section "Footnotes"))
1617 (length (org-test-with-parsed-data "* H1\n* Footnotes\n"
1618 (org-export-collect-headlines info
))))))
1621 (let ((org-footnote-section "Footnotes"))
1622 (org-test-with-parsed-data "* H1\n* Footnotes\n* H2"
1623 (org-element-map tree
'headline
1625 (when (equal (org-element-property :raw-value hl
) "H2")
1626 (org-export-get-headline-number hl info
)))
1631 ;;; Headlines and Inlinetasks
1633 (ert-deftest test-org-export
/get-relative-level
()
1634 "Test `org-export-get-relative-level' specifications."
1638 (let ((org-odd-levels-only nil
))
1639 (org-test-with-parsed-data "* Headline 1\n** Headline 2"
1640 (org-element-map tree
'headline
1641 (lambda (h) (org-export-get-relative-level h info
))
1646 (let ((org-odd-levels-only nil
))
1647 (org-test-with-parsed-data "** Headline 1\n**** Headline 2"
1648 (org-element-map tree
'headline
1649 (lambda (h) (org-export-get-relative-level h info
))
1652 (ert-deftest test-org-export
/low-level-p
()
1653 "Test `org-export-low-level-p' specifications."
1657 (let ((org-odd-levels-only nil
))
1658 (org-test-with-parsed-data "* Headline 1\n** Headline 2"
1659 (org-element-map tree
'headline
1660 (lambda (h) (if (org-export-low-level-p h info
) 'yes
'no
))
1661 (plist-put info
:headline-levels
1)))))))
1663 (ert-deftest test-org-export
/get-headline-number
()
1664 "Test `org-export-get-headline-number' specifications."
1669 (let ((org-odd-levels-only nil
))
1670 (org-test-with-parsed-data "* Headline 1\n** Headline 2"
1671 (org-element-map tree
'headline
1672 (lambda (h) (org-export-get-headline-number h info
))
1674 ;; Missing levels are replaced with 0.
1678 (let ((org-odd-levels-only nil
))
1679 (org-test-with-parsed-data "* Headline 1\n*** Headline 2"
1680 (org-element-map tree
'headline
1681 (lambda (h) (org-export-get-headline-number h info
))
1684 (ert-deftest test-org-export
/numbered-headline-p
()
1685 "Test `org-export-numbered-headline-p' specifications."
1686 ;; If `:section-numbers' is nil, never number headlines.
1688 (org-test-with-parsed-data "* Headline"
1689 (org-element-map tree
'headline
1690 (lambda (h) (org-export-numbered-headline-p h info
))
1691 (plist-put info
:section-numbers nil
))))
1692 ;; If `:section-numbers' is a number, only number headlines with
1693 ;; a level greater that it.
1697 (org-test-with-parsed-data "* Headline 1\n** Headline 2"
1698 (org-element-map tree
'headline
1699 (lambda (h) (if (org-export-numbered-headline-p h info
) 'yes
'no
))
1700 (plist-put info
:section-numbers
1)))))
1701 ;; Otherwise, headlines are always numbered.
1703 (org-test-with-parsed-data "* Headline"
1704 (org-element-map tree
'headline
1705 (lambda (h) (org-export-numbered-headline-p h info
))
1706 (plist-put info
:section-numbers t
)))))
1708 (ert-deftest test-org-export
/org-export-get-headline-id
()
1709 "Test `org-export-get-headline-id' specifications."
1710 ;; Numbered headlines have IDs akin to "sec-N".
1713 (org-test-with-parsed-data "* H"
1714 (org-export-get-headline-id
1715 (org-element-map tree
'headline
#'identity info t
)
1717 ;; The ID of numbered headlines reflect the hierarchy.
1720 (org-test-with-parsed-data "* H1\n** H2"
1721 (org-export-get-headline-id
1722 (org-element-map tree
'headline
1724 (and (equal "H2" (org-element-property :raw-value h
)) h
))
1727 ;; Unnumbered headlines have IDs akin to "unnumbered-N".
1729 (equal "unnumbered-1"
1730 (org-test-with-parsed-data
1731 "* H\n:PROPERTIES:\n:UNNUMBERED: t\n:END:"
1732 (org-export-get-headline-id
1733 (org-element-map tree
'headline
#'identity info t
)
1735 ;; The ID of Unnumbered headlines do not reflect the hierarchy.
1737 (equal "unnumbered-2"
1738 (org-test-with-parsed-data
1739 "* H1\n:PROPERTIES:\n:UNNUMBERED: t\n:END:\n** H2"
1740 (org-export-get-headline-id
1741 (org-element-map tree
'headline
1743 (and (equal "H2" (org-element-property :raw-value h
)) h
))
1746 ;; When #+OPTIONS: num:nil all headlines are unnumbered.
1748 (equal "unnumbered-1"
1749 (org-test-with-parsed-data "* H\n#+OPTIONS: num:nil"
1750 (org-export-get-headline-id
1751 (org-element-map tree
'headline
'identity info t
)
1753 ;; UNNUMBERED ignores inheritance. Any non-nil value among
1754 ;; ancestors disables numbering.
1756 (org-test-with-parsed-data
1767 (lambda (h) (not (org-export-numbered-headline-p h info
)))
1768 (org-element-map tree
'headline
#'identity info
)))))
1770 (ert-deftest test-org-export
/number-to-roman
()
1771 "Test `org-export-number-to-roman' specifications."
1772 ;; If number is negative, return it as a string.
1773 (should (equal (org-export-number-to-roman -
1) "-1"))
1774 ;; Otherwise, return it as a roman number.
1775 (should (equal (org-export-number-to-roman 1449) "MCDXLIX")))
1777 (ert-deftest test-org-export
/get-optional-title
()
1778 "Test `org-export-get-alt-title' specifications."
1779 ;; If ALT_TITLE property is defined, use it.
1782 (org-test-with-parsed-data
1783 "* Headline\n:PROPERTIES:\n:ALT_TITLE: opt\n:END:"
1784 (org-export-get-alt-title
1785 (org-element-map tree
'headline
'identity info t
)
1787 ;; Otherwise, fall-back to regular title.
1789 (equal '("Headline")
1790 (org-test-with-parsed-data "* Headline"
1791 (org-export-get-alt-title
1792 (org-element-map tree
'headline
'identity info t
)
1795 (ert-deftest test-org-export
/get-tags
()
1796 "Test `org-export-get-tags' specifications."
1797 (let ((org-export-exclude-tags '("noexport"))
1798 (org-export-select-tags '("export")))
1799 ;; Standard test: tags which are not a select tag, an exclude tag,
1800 ;; or specified as optional argument shouldn't be ignored.
1802 (org-test-with-parsed-data "* Headline :tag:"
1803 (org-export-get-tags (org-element-map tree
'headline
'identity info t
)
1805 ;; Exclude tags are removed.
1807 (org-test-with-parsed-data "* Headline :noexport:"
1808 (org-export-get-tags (org-element-map tree
'headline
'identity info t
)
1810 ;; Select tags are removed.
1812 (org-test-with-parsed-data "* Headline :export:"
1813 (org-export-get-tags (org-element-map tree
'headline
'identity info t
)
1818 (org-test-with-parsed-data "* Headline :tag:export:"
1819 (org-export-get-tags (org-element-map tree
'headline
'identity info t
)
1821 ;; Tags provided in the optional argument are also ignored.
1823 (org-test-with-parsed-data "* Headline :ignore:"
1824 (org-export-get-tags (org-element-map tree
'headline
'identity info t
)
1826 ;; Allow tag inheritance.
1830 (org-test-with-parsed-data "* Headline :tag:\n** Sub-heading"
1831 (org-element-map tree
'headline
1832 (lambda (hl) (org-export-get-tags hl info nil t
)) info
))))
1833 ;; Tag inheritance checks FILETAGS keywords.
1837 (org-test-with-parsed-data "#+FILETAGS: :a:b:\n* Headline :tag:"
1838 (org-element-map tree
'headline
1839 (lambda (hl) (org-export-get-tags hl info nil t
)) info
))))))
1841 (ert-deftest test-org-export
/get-node-property
()
1842 "Test`org-export-get-node-property' specifications."
1846 (org-test-with-parsed-data "* Headline
1850 (org-export-get-node-property
1851 :PROP
(org-element-map tree
'headline
'identity nil t
)))))
1852 ;; Test inheritance.
1855 (org-test-with-parsed-data "* Parent
1861 (org-export-get-node-property
1862 :PROP
(org-element-map tree
'paragraph
'identity nil t
) t
))))
1863 ;; Cannot return a value before the first headline.
1865 (org-test-with-parsed-data "Paragraph
1870 (org-export-get-node-property
1871 :PROP
(org-element-map tree
'paragraph
'identity nil t
)))))
1873 (ert-deftest test-org-export
/get-category
()
1874 "Test `org-export-get-category' specifications."
1878 (org-test-with-parsed-data "* Headline
1882 (org-export-get-category
1883 (org-element-map tree
'headline
'identity nil t
) info
))))
1884 ;; Test inheritance from a parent headline.
1886 (equal '("value" "value")
1887 (org-test-with-parsed-data "* Headline1
1892 (org-element-map tree
'headline
1893 (lambda (hl) (org-export-get-category hl info
)) info
))))
1894 ;; Test inheritance from #+CATEGORY keyword
1897 (org-test-with-parsed-data "#+CATEGORY: value
1899 (org-export-get-category
1900 (org-element-map tree
'headline
'identity nil t
) info
))))
1901 ;; Test inheritance from file name.
1904 (org-test-with-parsed-data "* Headline"
1905 (let ((info (plist-put info
:input-file
"~/test.org")))
1906 (org-export-get-category
1907 (org-element-map tree
'headline
'identity nil t
) info
)))))
1911 (org-test-with-parsed-data "* Headline"
1912 (org-export-get-category
1913 (org-element-map tree
'headline
'identity nil t
) info
)))))
1915 (ert-deftest test-org-export
/first-sibling-p
()
1916 "Test `org-export-first-sibling-p' specifications."
1921 (org-test-with-parsed-data "* H\n** H 2\n** H 3"
1922 (org-element-map tree
'headline
1923 (lambda (h) (if (org-export-first-sibling-p h info
) 'yes
'no
))
1927 (org-test-with-parsed-data "- item\n\n para"
1928 (org-element-map tree
'paragraph
1929 (lambda (h) (if (org-export-first-sibling-p h info
) 'yes
'no
))
1931 ;; Ignore sections for headlines.
1934 (org-test-with-parsed-data "* H\nSection\n** H 2"
1935 (org-element-map tree
'headline
1936 (lambda (h) (if (org-export-first-sibling-p h info
) 'yes
'no
))
1938 ;; Ignore headlines not exported.
1942 (let ((org-export-exclude-tags '("ignore")))
1943 (org-test-with-parsed-data "* Headline :ignore:\n* Headline 2"
1944 (org-element-map tree
'headline
1945 (lambda (h) (if (org-export-first-sibling-p h info
) 'yes
'no
))
1948 (ert-deftest test-org-export
/last-sibling-p
()
1949 "Test `org-export-last-sibling-p' specifications."
1954 (org-test-with-parsed-data "* Headline\n** Headline 2\n** Headline 3"
1955 (org-element-map tree
'headline
1956 (lambda (h) (if (org-export-last-sibling-p h info
) 'yes
'no
))
1960 (org-test-with-parsed-data "- item\n\n para"
1961 (org-element-map tree
'paragraph
1962 (lambda (h) (if (org-export-last-sibling-p h info
) 'yes
'no
))
1964 ;; Ignore headlines not exported.
1968 (let ((org-export-exclude-tags '("ignore")))
1969 (org-test-with-parsed-data "* Headline\n* Headline 2 :ignore:"
1970 (org-element-map tree
'headline
1971 (lambda (h) (if (org-export-last-sibling-p h info
) 'yes
'no
))
1974 (ert-deftest test-org-export
/handle-inlinetasks
()
1975 "Test inlinetask export."
1976 ;; Inlinetask with an exclude tag.
1977 (when (featurep 'org-inlinetask
)
1981 (let ((org-inlinetask-min-level 3)
1982 org-export-filter-body-functions
1983 org-export-filter-final-output-functions
)
1984 (org-test-with-temp-text "*** Inlinetask :noexp:\nContents\n*** end"
1985 (org-export-as (org-test-default-backend)
1986 nil nil nil
'(:exclude-tags
("noexp")))))))
1987 ;; Inlinetask with an include tag.
1990 "* H2\n*** Inline :exp:\n"
1991 (let ((org-inlinetask-min-level 3)
1992 (org-tags-column 0))
1993 (org-test-with-temp-text "* H1\n* H2\n*** Inline :exp:"
1994 (org-export-as (org-test-default-backend)
1995 nil nil nil
'(:select-tags
("exp")))))))
1996 ;; Ignore inlinetask with a TODO keyword and tasks excluded.
1999 (let ((org-todo-keywords '((sequence "TODO" "DONE")))
2000 (org-inlinetask-min-level 3)
2001 org-export-filter-body-functions
2002 org-export-filter-final-output-functions
)
2003 (org-test-with-temp-text "*** TODO Inline"
2004 (org-export-as (org-test-default-backend)
2005 nil nil nil
'(:with-tasks nil
))))))))
2011 (ert-deftest test-org-export
/get-date
()
2012 "Test `org-export-get-date' specifications."
2013 ;; Return a properly formatted string when
2014 ;; `org-export-date-timestamp-format' is non-nil and DATE keyword
2015 ;; consists in a single timestamp.
2018 (let ((org-export-date-timestamp-format "%d %m %Y"))
2019 (org-test-with-parsed-data "#+DATE: <2012-03-29 Thu>"
2020 (org-export-get-date info
)))))
2021 ;; Return a secondary string otherwise.
2024 (let ((org-export-date-timestamp-format nil
))
2025 (org-test-with-parsed-data "#+DATE: <2012-03-29 Thu>"
2026 (org-export-get-date info
)))))
2029 (org-test-with-parsed-data "#+DATE: Date"
2030 (org-export-get-date info
))))
2031 ;; Optional argument has precedence over
2032 ;; `org-export-date-timestamp-format'.
2035 (let ((org-export-date-timestamp-format "%d %m %Y"))
2036 (org-test-with-parsed-data "#+DATE: <2012-03-29 Thu>"
2037 (org-export-get-date info
"%d %m"))))))
2043 (ert-deftest test-org-export
/custom-protocol-maybe
()
2044 "Test `org-export-custom-protocol-maybe' specifications."
2048 (let ((org-link-types (copy-sequence org-link-types
)))
2049 (org-add-link-type "foo" nil
(lambda (p d f
) "success"))
2050 (org-export-string-as
2052 (org-export-create-backend
2054 :transcoders
'((section .
(lambda (s c i
) c
))
2055 (paragraph .
(lambda (p c i
) c
))
2056 (link .
(lambda (l c i
)
2057 (or (org-export-custom-protocol-maybe l c i
)
2062 (let ((org-link-types (copy-sequence org-link-types
)))
2064 "foo" nil
(lambda (p d f
) (and (eq f
'test
) "success")))
2065 (org-export-string-as
2067 (org-export-create-backend
2069 :transcoders
'((section .
(lambda (s c i
) c
))
2070 (paragraph .
(lambda (p c i
) c
))
2071 (link .
(lambda (l c i
)
2072 (or (org-export-custom-protocol-maybe l c i
)
2074 ;; Ignore anonymous back-ends.
2078 (let ((org-link-types (copy-sequence org-link-types
)))
2080 "foo" nil
(lambda (p d f
) (and (eq f
'test
) "success")))
2081 (org-export-string-as
2083 (org-export-create-backend
2084 :transcoders
'((section .
(lambda (s c i
) c
))
2085 (paragraph .
(lambda (p c i
) c
))
2086 (link .
(lambda (l c i
)
2087 (or (org-export-custom-protocol-maybe l c i
)
2090 (ert-deftest test-org-export
/get-coderef-format
()
2091 "Test `org-export-get-coderef-format' specifications."
2092 ;; A link without description returns "%s"
2093 (should (equal (org-export-get-coderef-format "(ref:line)" nil
)
2095 ;; Return "%s" when path is matched within description.
2096 (should (equal (org-export-get-coderef-format "path" "desc (path)")
2098 ;; Otherwise return description.
2099 (should (equal (org-export-get-coderef-format "path" "desc")
2102 (ert-deftest test-org-export
/inline-image-p
()
2103 "Test `org-export-inline-image-p' specifications."
2105 (org-export-inline-image-p
2106 (org-test-with-temp-text "[[#id]]"
2107 (org-element-map (org-element-parse-buffer) 'link
'identity nil t
))
2108 '(("custom-id" .
"id")))))
2110 (ert-deftest test-org-export
/fuzzy-link
()
2111 "Test fuzzy links specifications."
2112 ;; Link to an headline should return headline's number.
2113 (org-test-with-parsed-data
2114 "Paragraph.\n* Head1\n* Head2\n* Head3\n[[Head2]]"
2116 ;; Note: Headline's number is in fact a list of numbers.
2118 (org-element-map tree
'link
2120 (org-export-get-ordinal
2121 (org-export-resolve-fuzzy-link link info
) info
)) info t
))))
2122 ;; Link to a target in an item should return item's number.
2123 (org-test-with-parsed-data
2124 "- Item1\n - Item11\n - <<test>>Item12\n- Item2\n\n\n[[test]]"
2126 ;; Note: Item's number is in fact a list of numbers.
2128 (org-element-map tree
'link
2130 (org-export-get-ordinal
2131 (org-export-resolve-fuzzy-link link info
) info
)) info t
))))
2132 ;; Link to a target in a footnote should return footnote's number.
2133 (org-test-with-parsed-data "
2134 Paragraph[1][2][fn:lbl3:C<<target>>][[test]][[target]]\n[1] A\n\n[2] <<test>>B"
2137 (org-element-map tree
'link
2139 (org-export-get-ordinal
2140 (org-export-resolve-fuzzy-link link info
) info
)) info
))))
2141 ;; Link to a named element should return sequence number of that
2143 (org-test-with-parsed-data
2144 "#+NAME: tbl1\n|1|2|\n#+NAME: tbl2\n|3|4|\n#+NAME: tbl3\n|5|6|\n[[tbl2]]"
2147 (org-element-map tree
'link
2149 (org-export-get-ordinal
2150 (org-export-resolve-fuzzy-link link info
) info
)) info t
))))
2151 ;; Link to a target not within an item, a table, a footnote
2152 ;; reference or definition should return section number.
2153 (org-test-with-parsed-data
2154 "* Head1\n* Head2\nParagraph<<target>>\n* Head3\n[[target]]"
2157 (org-element-map tree
'link
2159 (org-export-get-ordinal
2160 (org-export-resolve-fuzzy-link link info
) info
)) info t
))))
2161 ;; Space are not significant when matching a fuzzy link.
2163 (org-test-with-parsed-data "* Head 1\n[[Head\n 1]]"
2164 (org-element-map tree
'link
2165 (lambda (link) (org-export-resolve-fuzzy-link link info
))
2167 ;; Statistics cookies are ignored for headline match.
2169 (org-test-with-parsed-data "* Head [0/0]\n[[Head]]"
2170 (org-element-map tree
'link
2171 (lambda (link) (org-export-resolve-fuzzy-link link info
))
2174 (org-test-with-parsed-data "* Head [100%]\n[[Head]]"
2175 (org-element-map tree
'link
2176 (lambda (link) (org-export-resolve-fuzzy-link link info
))
2178 ;; Headline match is position dependent.
2182 (org-test-with-parsed-data "* H1\n[[*H1]]\n* H1\n[[*H1]]"
2183 (org-element-map tree
'link
2184 (lambda (link) (org-export-resolve-fuzzy-link link info
)) info
)))))
2186 (ert-deftest test-org-export
/resolve-coderef
()
2187 "Test `org-export-resolve-coderef' specifications."
2188 (let ((org-coderef-label-format "(ref:%s)"))
2189 ;; 1. A link to a "-n -k -r" block returns line number.
2190 (org-test-with-parsed-data
2191 "#+BEGIN_EXAMPLE -n -k -r\nText (ref:coderef)\n#+END_EXAMPLE"
2192 (should (= (org-export-resolve-coderef "coderef" info
) 1)))
2193 (org-test-with-parsed-data
2194 "#+BEGIN_SRC emacs-lisp -n -k -r\n(+ 1 1) (ref:coderef)\n#+END_SRC"
2195 (should (= (org-export-resolve-coderef "coderef" info
) 1)))
2196 ;; 2. A link to a "-n -r" block returns line number.
2197 (org-test-with-parsed-data
2198 "#+BEGIN_EXAMPLE -n -r\nText (ref:coderef)\n#+END_EXAMPLE"
2199 (should (= (org-export-resolve-coderef "coderef" info
) 1)))
2200 (org-test-with-parsed-data
2201 "#+BEGIN_SRC emacs-lisp -n -r\n(+ 1 1) (ref:coderef)\n#+END_SRC"
2202 (should (= (org-export-resolve-coderef "coderef" info
) 1)))
2203 ;; 3. A link to a "-n" block returns coderef.
2204 (org-test-with-parsed-data
2205 "#+BEGIN_SRC emacs-lisp -n\n(+ 1 1) (ref:coderef)\n#+END_SRC"
2206 (should (equal (org-export-resolve-coderef "coderef" info
) "coderef")))
2207 (org-test-with-parsed-data
2208 "#+BEGIN_EXAMPLE -n\nText (ref:coderef)\n#+END_EXAMPLE"
2209 (should (equal (org-export-resolve-coderef "coderef" info
) "coderef")))
2210 ;; 4. A link to a "-r" block returns line number.
2211 (org-test-with-parsed-data
2212 "#+BEGIN_SRC emacs-lisp -r\n(+ 1 1) (ref:coderef)\n#+END_SRC"
2213 (should (= (org-export-resolve-coderef "coderef" info
) 1)))
2214 (org-test-with-parsed-data
2215 "#+BEGIN_EXAMPLE -r\nText (ref:coderef)\n#+END_EXAMPLE"
2216 (should (= (org-export-resolve-coderef "coderef" info
) 1)))
2217 ;; 5. A link to a block without a switch returns coderef.
2218 (org-test-with-parsed-data
2219 "#+BEGIN_SRC emacs-lisp\n(+ 1 1) (ref:coderef)\n#+END_SRC"
2220 (should (equal (org-export-resolve-coderef "coderef" info
) "coderef")))
2221 (org-test-with-parsed-data
2222 "#+BEGIN_EXAMPLE\nText (ref:coderef)\n#+END_EXAMPLE"
2223 (should (equal (org-export-resolve-coderef "coderef" info
) "coderef")))
2224 ;; 6. Correctly handle continued line numbers. A "+n" switch
2225 ;; should resume numbering from previous block with numbered
2226 ;; lines, ignoring blocks not numbering lines in the process.
2227 ;; A "-n" switch resets count.
2228 (org-test-with-parsed-data "
2233 #+BEGIN_SRC emacs-lisp
2237 #+BEGIN_SRC emacs-lisp +n -r
2238 \(+ 1 1) (ref:addition)
2241 #+BEGIN_EXAMPLE -n -r
2242 Another text. (ref:text)
2244 (should (= (org-export-resolve-coderef "addition" info
) 2))
2245 (should (= (org-export-resolve-coderef "text" info
) 1)))
2246 ;; 7. Recognize coderef with user-specified syntax.
2247 (org-test-with-parsed-data
2248 "#+BEGIN_EXAMPLE -l \"[ref:%s]\"\nText. [ref:text]\n#+END_EXAMPLE"
2249 (should (equal (org-export-resolve-coderef "text" info
) "text")))))
2251 (ert-deftest test-org-export
/resolve-fuzzy-link
()
2252 "Test `org-export-resolve-fuzzy-link' specifications."
2253 ;; Match target objects.
2255 (org-test-with-parsed-data "<<target>> [[target]]"
2256 (org-export-resolve-fuzzy-link
2257 (org-element-map tree
'link
'identity info t
) info
)))
2258 ;; Match named elements.
2260 (org-test-with-parsed-data "#+NAME: target\nParagraph\n\n[[target]]"
2261 (org-export-resolve-fuzzy-link
2262 (org-element-map tree
'link
'identity info t
) info
)))
2263 ;; Match exact headline's name.
2265 (org-test-with-parsed-data "* My headline\n[[My headline]]"
2266 (org-export-resolve-fuzzy-link
2267 (org-element-map tree
'link
'identity info t
) info
)))
2268 ;; Targets objects have priority over named elements and headline
2272 (org-test-with-parsed-data
2273 "* target\n#+NAME: target\n<<target>>\n\n[[target]]"
2275 (org-export-resolve-fuzzy-link
2276 (org-element-map tree
'link
'identity info t
) info
)))))
2277 ;; Named elements have priority over headline titles.
2280 (org-test-with-parsed-data
2281 "* target\n#+NAME: target\nParagraph\n\n[[target]]"
2283 (org-export-resolve-fuzzy-link
2284 (org-element-map tree
'link
'identity info t
) info
)))))
2285 ;; If link's path starts with a "*", only match headline titles,
2289 (org-test-with-parsed-data
2290 "* target\n#+NAME: target\n<<target>>\n\n[[*target]]"
2292 (org-export-resolve-fuzzy-link
2293 (org-element-map tree
'link
'identity info t
) info
)))))
2294 ;; Return nil if no match.
2296 (org-test-with-parsed-data "[[target]]"
2297 (org-export-resolve-fuzzy-link
2298 (org-element-map tree
'link
'identity info t
) info
)))
2299 ;; Match fuzzy link even when before first headline.
2302 (org-test-with-parsed-data "[[hl]]\n* hl"
2304 (org-export-resolve-fuzzy-link
2305 (org-element-map tree
'link
'identity info t
) info
))))))
2307 (ert-deftest test-org-export
/resolve-id-link
()
2308 "Test `org-export-resolve-id-link' specifications."
2309 ;; 1. Regular test for custom-id link.
2310 (org-test-with-parsed-data "* Headline1
2317 (org-export-resolve-id-link
2318 (org-element-map tree
'link
'identity info t
) info
)))
2319 ;; 2. Failing test for custom-id link.
2320 (org-test-with-parsed-data "* Headline1
2327 (org-export-resolve-id-link
2328 (org-element-map tree
'link
'identity info t
) info
)))
2329 ;; 3. Test for internal id target.
2330 (org-test-with-parsed-data "* Headline1
2337 (org-export-resolve-id-link
2338 (org-element-map tree
'link
'identity info t
) info
)))
2339 ;; 4. Test for external id target.
2340 (org-test-with-parsed-data "[[id:aaaa]]"
2342 (org-export-resolve-id-link
2343 (org-element-map tree
'link
'identity info t
)
2344 (org-combine-plists info
'(:id-alist
(("aaaa" .
"external-file"))))))))
2346 (ert-deftest test-org-export
/resolve-radio-link
()
2347 "Test `org-export-resolve-radio-link' specifications."
2350 (org-test-with-temp-text "<<<radio>>> radio"
2351 (org-update-radio-target-regexp)
2352 (let* ((tree (org-element-parse-buffer))
2353 (info `(:parse-tree
,tree
)))
2354 (org-export-resolve-radio-link
2355 (org-element-map tree
'link
'identity info t
)
2357 ;; Radio targets are case-insensitive.
2359 (org-test-with-temp-text "<<<RADIO>>> radio"
2360 (org-update-radio-target-regexp)
2361 (let* ((tree (org-element-parse-buffer))
2362 (info `(:parse-tree
,tree
)))
2363 (org-export-resolve-radio-link
2364 (org-element-map tree
'link
'identity info t
)
2366 ;; Radio target with objects.
2368 (org-test-with-temp-text "<<<radio \\alpha>>> radio \\alpha"
2369 (org-update-radio-target-regexp)
2370 (let* ((tree (org-element-parse-buffer))
2371 (info `(:parse-tree
,tree
)))
2372 (org-export-resolve-radio-link
2373 (org-element-map tree
'link
'identity info t
)
2375 ;; Radio target with objects at its beginning.
2377 (org-test-with-temp-text "<<<\\alpha radio>>> \\alpha radio"
2378 (org-update-radio-target-regexp)
2379 (let* ((tree (org-element-parse-buffer))
2380 (info `(:parse-tree
,tree
)))
2381 (org-export-resolve-radio-link
2382 (org-element-map tree
'link
'identity info t
)
2384 ;; Radio link next to an apostrophe.
2386 (org-test-with-temp-text "<<<radio>>> radio's"
2387 (org-update-radio-target-regexp)
2388 (let* ((tree (org-element-parse-buffer))
2389 (info `(:parse-tree
,tree
)))
2390 (org-export-resolve-radio-link
2391 (org-element-map tree
'link
'identity info t
)
2393 ;; Multiple radio targets.
2395 (equal '("radio1" "radio2")
2396 (org-test-with-temp-text "<<<radio1>>> <<<radio2>>> radio1 radio2"
2397 (org-update-radio-target-regexp)
2398 (let* ((tree (org-element-parse-buffer))
2399 (info `(:parse-tree
,tree
)))
2400 (org-element-map tree
'link
2402 (org-element-property
2403 :value
(org-export-resolve-radio-link link info
)))
2405 ;; Radio target is whitespace insensitive.
2407 (org-test-with-temp-text "<<<a radio>>> a\n radio"
2408 (org-update-radio-target-regexp)
2409 (let* ((tree (org-element-parse-buffer))
2410 (info `(:parse-tree
,tree
)))
2411 (org-element-map tree
'link
2412 (lambda (link) (org-export-resolve-radio-link link info
)) info t
)))))
2416 ;;; Src-block and example-block
2418 (ert-deftest test-org-export
/unravel-code
()
2419 "Test `org-export-unravel-code' function."
2420 ;; Code without reference.
2422 (equal '("(+ 1 1)\n")
2423 (org-test-with-temp-text "#+BEGIN_EXAMPLE\n(+ 1 1)\n#+END_EXAMPLE"
2424 (org-export-unravel-code (org-element-at-point)))))
2425 ;; Code with reference.
2427 (equal '("(+ 1 1)\n" (1 .
"test"))
2428 (org-test-with-temp-text
2429 "#+BEGIN_EXAMPLE\n(+ 1 1) (ref:test)\n#+END_EXAMPLE"
2430 (let ((org-coderef-label-format "(ref:%s)"))
2431 (org-export-unravel-code (org-element-at-point))))))
2432 ;; Code with user-defined reference.
2435 '("(+ 1 1)\n" (1 .
"test"))
2436 (org-test-with-temp-text
2437 "#+BEGIN_EXAMPLE -l \"[ref:%s]\"\n(+ 1 1) [ref:test]\n#+END_EXAMPLE"
2438 (let ((org-coderef-label-format "(ref:%s)"))
2439 (org-export-unravel-code (org-element-at-point))))))
2440 ;; Code references keys are relative to the current block.
2442 (equal '("(+ 2 2)\n(+ 3 3)\n" (2 .
"one"))
2443 (org-test-with-temp-text "
2452 (let ((org-coderef-label-format "(ref:%s)"))
2453 (org-export-unravel-code (org-element-at-point)))))))
2455 (ert-deftest test-org-export
/format-code-default
()
2456 "Test `org-export-format-code-default' specifications."
2457 ;; Return the empty string when code is empty.
2460 (org-test-with-parsed-data "#+BEGIN_SRC emacs-lisp\n\n\n#+END_SRC"
2461 (org-export-format-code-default
2462 (org-element-map tree
'src-block
'identity info t
) info
))))
2463 ;; Number lines, two whitespace characters before the actual loc.
2466 (org-test-with-parsed-data
2467 "#+BEGIN_SRC emacs-lisp +n\na\nb\n#+END_SRC"
2468 (org-export-format-code-default
2469 (org-element-map tree
'src-block
'identity info t
) info
))))
2470 ;; Put references 6 whitespace characters after the widest line,
2471 ;; wrapped within parenthesis.
2473 (equal "123 (a)\n1 (b)\n"
2474 (let ((org-coderef-label-format "(ref:%s)"))
2475 (org-test-with-parsed-data
2476 "#+BEGIN_SRC emacs-lisp\n123 (ref:a)\n1 (ref:b)\n#+END_SRC"
2477 (org-export-format-code-default
2478 (org-element-map tree
'src-block
'identity info t
) info
))))))
2484 (ert-deftest test-org-export
/activate-smart-quotes
()
2485 "Test `org-export-activate-smart-quotes' specifications."
2486 ;; Opening double quotes: standard test.
2489 '("some “paragraph")
2490 (let ((org-export-default-language "en"))
2491 (org-test-with-parsed-data "some \"paragraph"
2492 (org-element-map tree
'plain-text
2493 (lambda (s) (org-export-activate-smart-quotes s
:html info
))
2495 ;; Opening quotes: at the beginning of a paragraph.
2499 (let ((org-export-default-language "en"))
2500 (org-test-with-parsed-data "\"begin"
2501 (org-element-map tree
'plain-text
2502 (lambda (s) (org-export-activate-smart-quotes s
:html info
))
2504 ;; Opening quotes: after an object.
2508 (let ((org-export-default-language "en"))
2509 (org-test-with-parsed-data "=verb= \"begin"
2510 (org-element-map tree
'plain-text
2511 (lambda (s) (org-export-activate-smart-quotes s
:html info
))
2513 ;; Closing quotes: standard test.
2516 '("some” paragraph")
2517 (let ((org-export-default-language "en"))
2518 (org-test-with-parsed-data "some\" paragraph"
2519 (org-element-map tree
'plain-text
2520 (lambda (s) (org-export-activate-smart-quotes s
:html info
))
2522 ;; Closing quotes: at the end of a paragraph.
2526 (let ((org-export-default-language "en"))
2527 (org-test-with-parsed-data "end\""
2528 (org-element-map tree
'plain-text
2529 (lambda (s) (org-export-activate-smart-quotes s
:html info
))
2531 ;; Apostrophe: standard test.
2534 '("It shouldn’t fail")
2535 (let ((org-export-default-language "en"))
2536 (org-test-with-parsed-data "It shouldn't fail"
2537 (org-element-map tree
'plain-text
2538 (lambda (s) (org-export-activate-smart-quotes s
:html info
))
2540 ;; Apostrophe: before an object.
2544 (let ((org-export-default-language "en"))
2545 (org-test-with-parsed-data "a'=b="
2546 (org-element-map tree
'plain-text
2547 (lambda (s) (org-export-activate-smart-quotes s
:html info
))
2549 ;; Apostrophe: after an object.
2553 (let ((org-export-default-language "en"))
2554 (org-test-with-parsed-data "=code='s"
2555 (org-element-map tree
'plain-text
2556 (lambda (s) (org-export-activate-smart-quotes s
:html info
))
2558 ;; Special case: isolated quotes.
2560 (equal '("“" "”")
2561 (let ((org-export-default-language "en"))
2562 (org-test-with-parsed-data "\"$x$\""
2563 (org-element-map tree
'plain-text
2564 (lambda (s) (org-export-activate-smart-quotes s
:html info
))
2566 ;; Smart quotes in secondary strings.
2568 (equal '("“" "”")
2569 (let ((org-export-default-language "en"))
2570 (org-test-with-parsed-data "* \"$x$\""
2571 (org-element-map tree
'plain-text
2572 (lambda (s) (org-export-activate-smart-quotes s
:html info
))
2574 ;; Smart quotes in document keywords.
2576 (equal '("“" "”")
2577 (let ((org-export-default-language "en"))
2578 (org-test-with-parsed-data "#+TITLE: \"$x$\""
2579 (org-element-map (plist-get info
:title
) 'plain-text
2580 (lambda (s) (org-export-activate-smart-quotes s
:html info
))
2582 ;; Smart quotes in parsed affiliated keywords.
2584 (equal '("“" "”" "Paragraph")
2585 (let ((org-export-default-language "en"))
2586 (org-test-with-parsed-data "#+CAPTION: \"$x$\"\nParagraph"
2587 (org-element-map tree
'plain-text
2588 (lambda (s) (org-export-activate-smart-quotes s
:html info
))
2589 info nil nil t
))))))
2595 (ert-deftest test-org-export
/special-column
()
2596 "Test if the table's special column is properly recognized."
2597 ;; 1. First column is special if it contains only a special marking
2598 ;; characters or empty cells.
2599 (org-test-with-temp-text "
2603 (org-export-table-has-special-column-p
2605 (org-element-parse-buffer) 'table
'identity nil
'first-match
))))
2606 ;; 2. If the column contains anything else, it isn't special.
2607 (org-test-with-temp-text "
2611 (org-export-table-has-special-column-p
2613 (org-element-parse-buffer) 'table
'identity nil
'first-match
))))
2614 ;; 3. Special marking characters are "#", "^", "*", "_", "/", "$"
2616 (org-test-with-temp-text "
2625 (org-export-table-has-special-column-p
2627 (org-element-parse-buffer) 'table
'identity nil
'first-match
))))
2628 ;; 4. A first column with only empty cells isn't considered as
2630 (org-test-with-temp-text "
2634 (org-export-table-has-special-column-p
2636 (org-element-parse-buffer) 'table
'identity nil
'first-match
)))))
2638 (ert-deftest test-org-export
/table-row-is-special-p
()
2639 "Test `org-export-table-row-is-special-p' specifications."
2640 ;; 1. A row is special if it has a special marking character in the
2642 (org-test-with-parsed-data "| ! | 1 |"
2644 (org-export-table-row-is-special-p
2645 (org-element-map tree
'table-row
'identity nil
'first-match
) info
)))
2646 ;; 2. A row is special when its first field is "/"
2647 (org-test-with-parsed-data "
2651 (org-export-table-row-is-special-p
2652 (org-element-map tree
'table-row
'identity nil
'first-match
) info
)))
2653 ;; 3. A row only containing alignment cookies is also considered as
2655 (org-test-with-parsed-data "| <5> | | <l> | <l22> |"
2657 (org-export-table-row-is-special-p
2658 (org-element-map tree
'table-row
'identity nil
'first-match
) info
)))
2659 ;; 4. Everything else isn't considered as special.
2660 (org-test-with-parsed-data "| \alpha | | c |"
2662 (org-export-table-row-is-special-p
2663 (org-element-map tree
'table-row
'identity nil
'first-match
) info
)))
2664 ;; 5. Table's rules are never considered as special rows.
2665 (org-test-with-parsed-data "|---+---|"
2667 (org-export-table-row-is-special-p
2668 (org-element-map tree
'table-row
'identity nil
'first-match
) info
))))
2670 (ert-deftest test-org-export
/has-header-p
()
2671 "Test `org-export-table-has-header-p' specifications."
2672 ;; 1. With an header.
2673 (org-test-with-parsed-data "
2678 (org-export-table-has-header-p
2679 (org-element-map tree
'table
'identity info
'first-match
)
2681 ;; 2. Without an header.
2682 (org-test-with-parsed-data "
2686 (org-export-table-has-header-p
2687 (org-element-map tree
'table
'identity info
'first-match
)
2689 ;; 3. Don't get fooled with starting and ending rules.
2690 (org-test-with-parsed-data "
2696 (org-export-table-has-header-p
2697 (org-element-map tree
'table
'identity info
'first-match
)
2700 (ert-deftest test-org-export
/table-row-group
()
2701 "Test `org-export-table-row-group' specifications."
2702 ;; 1. A rule creates a new group.
2705 (org-test-with-parsed-data "
2709 (org-element-map tree
'table-row
2711 (if (eq (org-element-property :type row
) 'rule
) 'rule
2712 (org-export-table-row-group row info
)))))))
2713 ;; 2. Special rows are ignored in count.
2717 (org-test-with-parsed-data "
2721 (org-element-map tree
'table-row
2723 (if (eq (org-element-property :type row
) 'rule
) 'rule
2724 (org-export-table-row-group row info
)))
2726 ;; 3. Double rules also are ignored in count.
2728 (equal '(1 rule rule
2)
2729 (org-test-with-parsed-data "
2734 (org-element-map tree
'table-row
2736 (if (eq (org-element-property :type row
) 'rule
) 'rule
2737 (org-export-table-row-group row info
))))))))
2739 (ert-deftest test-org-export
/table-row-number
()
2740 "Test `org-export-table-row-number' specifications."
2741 ;; Standard test. Number is 0-indexed.
2744 (org-test-with-parsed-data "| a | b | c |\n| d | e | f |"
2745 (org-element-map tree
'table-row
2746 (lambda (row) (org-export-table-row-number row info
)) info
))))
2747 ;; Number ignores separators.
2750 (org-test-with-parsed-data "
2754 (org-element-map tree
'table-row
2755 (lambda (row) (org-export-table-row-number row info
)) info
))))
2756 ;; Number ignores special rows.
2759 (org-test-with-parsed-data "
2765 (org-element-map tree
'table-row
2766 (lambda (row) (org-export-table-row-number row info
)) info
)))))
2768 (ert-deftest test-org-export
/table-cell-width
()
2769 "Test `org-export-table-cell-width' specifications."
2770 ;; 1. Width is primarily determined by width cookies. If no cookie
2771 ;; is found, cell's width is nil.
2772 (org-test-with-parsed-data "
2773 | / | <l> | <6> | <l7> |
2778 (mapcar (lambda (cell) (org-export-table-cell-width cell info
))
2779 (org-element-map tree
'table-cell
'identity info
)))))
2780 ;; 2. The last width cookie has precedence.
2781 (org-test-with-parsed-data "
2788 (mapcar (lambda (cell) (org-export-table-cell-width cell info
))
2789 (org-element-map tree
'table-cell
'identity info
)))))
2790 ;; 3. Valid width cookies must have a specific row.
2791 (org-test-with-parsed-data "| <6> | cell |"
2795 (mapcar (lambda (cell) (org-export-table-cell-width cell info
))
2796 (org-element-map tree
'table-cell
'identity
))))))
2798 (ert-deftest test-org-export
/table-cell-alignment
()
2799 "Test `org-export-table-cell-alignment' specifications."
2800 ;; 1. Alignment is primarily determined by alignment cookies.
2802 (equal '(left center right
)
2803 (let ((org-table-number-fraction 0.5)
2804 (org-table-number-regexp "^[0-9]+$"))
2805 (org-test-with-parsed-data "| <l> | <c> | <r> |"
2806 (mapcar (lambda (cell)
2807 (org-export-table-cell-alignment cell info
))
2808 (org-element-map tree
'table-cell
'identity
))))))
2809 ;; 2. The last alignment cookie has precedence.
2811 (equal '(right right right
)
2812 (org-test-with-parsed-data "
2816 (mapcar (lambda (cell) (org-export-table-cell-alignment cell info
))
2817 (org-element-map tree
'table-cell
'identity
)))))
2818 ;; 3. If there's no cookie, cell's contents determine alignment.
2819 ;; A column mostly made of cells containing numbers will align
2820 ;; its cells to the right.
2822 (equal '(right right right
)
2823 (let ((org-table-number-fraction 0.5)
2824 (org-table-number-regexp "^[0-9]+$"))
2825 (org-test-with-parsed-data "
2829 (mapcar (lambda (cell)
2830 (org-export-table-cell-alignment cell info
))
2831 (org-element-map tree
'table-cell
'identity
))))))
2832 ;; 4. Otherwise, they will be aligned to the left.
2834 (equal '(left left left
)
2835 (org-test-with-parsed-data "
2839 (mapcar (lambda (cell)
2840 (org-export-table-cell-alignment cell info
))
2841 (org-element-map tree
'table-cell
'identity info
))))))
2843 (ert-deftest test-org-export
/table-cell-borders
()
2844 "Test `org-export-table-cell-borders' specifications."
2845 ;; 1. Recognize various column groups indicators.
2846 (org-test-with-parsed-data "| / | < | > | <> |"
2849 '((right bottom top
) (left bottom top
) (right bottom top
)
2850 (right left bottom top
))
2851 (mapcar (lambda (cell)
2852 (org-export-table-cell-borders cell info
))
2853 (org-element-map tree
'table-cell
'identity
)))))
2854 ;; 2. Accept shortcuts to define column groups.
2855 (org-test-with-parsed-data "| / | < | < |"
2858 '((right bottom top
) (right left bottom top
) (left bottom top
))
2859 (mapcar (lambda (cell)
2860 (org-export-table-cell-borders cell info
))
2861 (org-element-map tree
'table-cell
'identity
)))))
2862 ;; 3. A valid column groups row must start with a "/".
2863 (org-test-with-parsed-data "
2867 (equal '((top) (top) (bottom) (bottom))
2868 (mapcar (lambda (cell)
2869 (org-export-table-cell-borders cell info
))
2870 (org-element-map tree
'table-cell
'identity
)))))
2871 ;; 4. Take table rules into consideration.
2872 (org-test-with-parsed-data "
2877 (equal '((below top
) (bottom above
))
2878 (mapcar (lambda (cell)
2879 (org-export-table-cell-borders cell info
))
2880 (org-element-map tree
'table-cell
'identity
)))))
2881 ;; 5. Top and (resp. bottom) rules induce both `top' and `above'
2882 ;; (resp. `bottom' and `below') borders. Any special row is
2884 (org-test-with-parsed-data "
2890 (equal '((bottom below top above
))
2892 (mapcar (lambda (cell)
2893 (org-export-table-cell-borders cell info
))
2894 (org-element-map tree
'table-cell
'identity
)))))))
2896 (ert-deftest test-org-export
/table-dimensions
()
2897 "Test `org-export-table-dimensions' specifications."
2898 ;; 1. Standard test.
2899 (org-test-with-parsed-data "
2904 (org-export-table-dimensions
2905 (org-element-map tree
'table
'identity info
'first-match
) info
))))
2906 ;; 2. Ignore horizontal rules and special columns.
2907 (org-test-with-parsed-data "
2914 (org-export-table-dimensions
2915 (org-element-map tree
'table
'identity info
'first-match
) info
)))))
2917 (ert-deftest test-org-export
/table-cell-address
()
2918 "Test `org-export-table-cell-address' specifications."
2919 ;; 1. Standard test: index is 0-based.
2920 (org-test-with-parsed-data "| a | b |"
2922 (equal '((0 .
0) (0 .
1))
2923 (org-element-map tree
'table-cell
2924 (lambda (cell) (org-export-table-cell-address cell info
))
2926 ;; 2. Special column isn't counted, nor are special rows.
2927 (org-test-with-parsed-data "
2932 (org-export-table-cell-address
2933 (car (last (org-element-map tree
'table-cell
'identity info
)))
2935 ;; 3. Tables rules do not count either.
2936 (org-test-with-parsed-data "
2944 (org-export-table-cell-address
2945 (car (last (org-element-map tree
'table-cell
'identity info
)))
2947 ;; 4. Return nil for special cells.
2948 (org-test-with-parsed-data "| / | a |"
2950 (org-export-table-cell-address
2951 (org-element-map tree
'table-cell
'identity nil
'first-match
)
2954 (ert-deftest test-org-export
/get-table-cell-at
()
2955 "Test `org-export-get-table-cell-at' specifications."
2956 ;; 1. Address ignores special columns, special rows and rules.
2957 (org-test-with-parsed-data "
2964 (org-element-contents
2965 (org-export-get-table-cell-at
2967 (org-element-map tree
'table
'identity info
'first-match
)
2969 ;; 2. Return value for a non-existent address is nil.
2970 (org-test-with-parsed-data "| a |"
2972 (org-export-get-table-cell-at
2974 (org-element-map tree
'table
'identity info
'first-match
)
2976 (org-test-with-parsed-data "| / |"
2978 (org-export-get-table-cell-at
2980 (org-element-map tree
'table
'identity info
'first-match
)
2983 (ert-deftest test-org-export
/table-cell-starts-colgroup-p
()
2984 "Test `org-export-table-cell-starts-colgroup-p' specifications."
2985 ;; 1. A cell at a beginning of a row always starts a column group.
2986 (org-test-with-parsed-data "| a |"
2988 (org-export-table-cell-starts-colgroup-p
2989 (org-element-map tree
'table-cell
'identity info
'first-match
)
2991 ;; 2. Special column should be ignored when determining the
2992 ;; beginning of the row.
2993 (org-test-with-parsed-data "
2997 (org-export-table-cell-starts-colgroup-p
2998 (org-element-map tree
'table-cell
'identity info
'first-match
)
3000 ;; 2. Explicit column groups.
3001 (org-test-with-parsed-data "
3007 (org-element-map tree
'table-cell
3009 (if (org-export-table-cell-starts-colgroup-p cell info
) 'yes
'no
))
3012 (ert-deftest test-org-export
/table-cell-ends-colgroup-p
()
3013 "Test `org-export-table-cell-ends-colgroup-p' specifications."
3014 ;; 1. A cell at the end of a row always ends a column group.
3015 (org-test-with-parsed-data "| a |"
3017 (org-export-table-cell-ends-colgroup-p
3018 (org-element-map tree
'table-cell
'identity info
'first-match
)
3020 ;; 2. Special column should be ignored when determining the
3021 ;; beginning of the row.
3022 (org-test-with-parsed-data "
3026 (org-export-table-cell-ends-colgroup-p
3027 (org-element-map tree
'table-cell
'identity info
'first-match
)
3029 ;; 3. Explicit column groups.
3030 (org-test-with-parsed-data "
3036 (org-element-map tree
'table-cell
3038 (if (org-export-table-cell-ends-colgroup-p cell info
) 'yes
'no
))
3041 (ert-deftest test-org-export
/table-row-starts-rowgroup-p
()
3042 "Test `org-export-table-row-starts-rowgroup-p' specifications."
3043 ;; 1. A row at the beginning of a table always starts a row group.
3044 ;; So does a row following a table rule.
3045 (org-test-with-parsed-data "
3052 (org-element-map tree
'table-row
3054 (if (org-export-table-row-starts-rowgroup-p row info
) 'yes
'no
))
3056 ;; 2. Special rows should be ignored when determining the beginning
3058 (org-test-with-parsed-data "
3067 (org-element-map tree
'table-row
3069 (if (org-export-table-row-starts-rowgroup-p row info
) 'yes
'no
))
3072 (ert-deftest test-org-export
/table-row-ends-rowgroup-p
()
3073 "Test `org-export-table-row-ends-rowgroup-p' specifications."
3074 ;; 1. A row at the end of a table always ends a row group. So does
3075 ;; a row preceding a table rule.
3076 (org-test-with-parsed-data "
3083 (org-element-map tree
'table-row
3085 (if (org-export-table-row-ends-rowgroup-p row info
) 'yes
'no
))
3087 ;; 2. Special rows should be ignored when determining the beginning
3089 (org-test-with-parsed-data "
3098 (org-element-map tree
'table-row
3100 (if (org-export-table-row-ends-rowgroup-p row info
) 'yes
'no
))
3103 (ert-deftest test-org-export
/table-row-in-header-p
()
3104 "Test `org-export-table-row-in-header-p' specifications."
3105 ;; Standard test. Separators are always nil.
3109 (org-test-with-parsed-data "| a |\n|---|\n| b |"
3110 (org-element-map tree
'table-row
3112 (if (org-export-table-row-in-header-p row info
) 'yes
'no
)) info
))))
3113 ;; Nil when there is no header.
3117 (org-test-with-parsed-data "| a |\n| b |"
3118 (org-element-map tree
'table-row
3120 (if (org-export-table-row-in-header-p row info
) 'yes
'no
)) info
)))))
3122 (ert-deftest test-org-export
/table-row-starts-header-p
()
3123 "Test `org-export-table-row-starts-header-p' specifications."
3124 ;; 1. Only the row starting the first row group starts the table
3126 (org-test-with-parsed-data "
3134 (org-element-map tree
'table-row
3136 (if (org-export-table-row-starts-header-p row info
) 'yes
'no
))
3138 ;; 2. A row cannot start an header if there's no header in the
3140 (org-test-with-parsed-data "
3144 (org-export-table-row-starts-header-p
3145 (org-element-map tree
'table-row
'identity info
'first-match
)
3148 (ert-deftest test-org-export
/table-row-ends-header-p
()
3149 "Test `org-export-table-row-ends-header-p' specifications."
3150 ;; 1. Only the row starting the first row group starts the table
3152 (org-test-with-parsed-data "
3160 (org-element-map tree
'table-row
3162 (if (org-export-table-row-ends-header-p row info
) 'yes
'no
))
3164 ;; 2. A row cannot start an header if there's no header in the
3166 (org-test-with-parsed-data "
3170 (org-export-table-row-ends-header-p
3171 (org-element-map tree
'table-row
'identity info
'first-match
)
3176 ;;; Tables of Contents
3178 (ert-deftest test-org-export
/collect-headlines
()
3179 "Test `org-export-collect-headlines' specifications."
3184 (org-test-with-parsed-data "* H1\n** H2"
3185 (org-export-collect-headlines info
)))))
3186 ;; Do not collect headlines below optional argument.
3190 (org-test-with-parsed-data "* H1\n** H2"
3191 (org-export-collect-headlines info
1)))))
3192 ;; Never collect headlines below maximum headline level.
3196 (org-test-with-parsed-data "#+OPTIONS: H:1\n* H1\n** H2"
3197 (org-export-collect-headlines info
)))))
3201 (org-test-with-parsed-data "#+OPTIONS: H:1\n* H1\n** H2"
3202 (org-export-collect-headlines info
2)))))
3203 ;; Collect headlines locally.
3206 (org-test-with-parsed-data "* H1\n** H2\n** H3"
3207 (let ((scope (org-element-map tree
'headline
#'identity info t
)))
3208 (length (org-export-collect-headlines info nil scope
))))))
3209 ;; When collecting locally, optional level is relative.
3212 (org-test-with-parsed-data "* H1\n** H2\n*** H3"
3213 (let ((scope (org-element-map tree
'headline
#'identity info t
)))
3214 (length (org-export-collect-headlines info
1 scope
)))))))
3220 (ert-deftest test-org-export
/inner-template
()
3221 "Test `inner-template' translator specifications."
3224 (org-test-with-temp-text "* Headline"
3226 (org-export-create-backend
3228 '((inner-template .
(lambda (contents info
) "Success!"))
3229 (headline .
(lambda (h c i
) "Headline"))))))))
3230 ;; Inner template is applied even in a "body-only" export.
3233 (org-test-with-temp-text "* Headline"
3235 (org-export-create-backend
3236 :transcoders
'((inner-template .
(lambda (c i
) "Success!"))
3237 (headline .
(lambda (h c i
) "Headline"))))
3238 nil nil
'body-only
)))))
3240 (ert-deftest test-org-export
/template
()
3241 "Test `template' translator specifications."
3244 (org-test-with-temp-text "* Headline"
3246 (org-export-create-backend
3247 :transcoders
'((template .
(lambda (contents info
) "Success!"))
3248 (headline .
(lambda (h c i
) "Headline"))))))))
3249 ;; Template is not applied in a "body-only" export.
3252 (org-test-with-temp-text "* Headline"
3254 (org-export-create-backend
3255 :transcoders
'((template .
(lambda (contents info
) "Success!"))
3256 (headline .
(lambda (h c i
) "Headline"))))
3257 nil nil
'body-only
)))))
3263 (ert-deftest test-org-export
/get-next-element
()
3264 "Test `org-export-get-next-element' specifications."
3268 (org-test-with-parsed-data "* Headline\n*a* b"
3269 (org-export-get-next-element
3270 (org-element-map tree
'bold
'identity info t
) info
))))
3271 ;; Return nil when no previous element.
3273 (org-test-with-parsed-data "* Headline\na *b*"
3274 (org-export-get-next-element
3275 (org-element-map tree
'bold
'identity info t
) info
)))
3276 ;; Non-exportable elements are ignored.
3278 (let ((org-export-with-timestamps nil
))
3279 (org-test-with-parsed-data "\alpha <2012-03-29 Thu>"
3280 (org-export-get-next-element
3281 (org-element-map tree
'entity
'identity info t
) info
))))
3282 ;; Find next element in secondary strings.
3285 (org-test-with-parsed-data "* a =verb="
3287 (org-export-get-next-element
3288 (org-element-map tree
'plain-text
'identity info t
) info
)))))
3291 (org-test-with-parsed-data "* /italic/ =verb="
3293 (org-export-get-next-element
3294 (org-element-map tree
'italic
'identity info t
) info
)))))
3295 ;; Find next element in document keywords.
3298 (org-test-with-parsed-data "#+TITLE: a =verb="
3300 (org-export-get-next-element
3302 (plist-get info
:title
) 'plain-text
'identity info t
) info
)))))
3303 ;; Find next element in parsed affiliated keywords.
3306 (org-test-with-parsed-data "#+CAPTION: a =verb=\nParagraph"
3308 (org-export-get-next-element
3309 (org-element-map tree
'plain-text
'identity info t nil t
) info
)))))
3310 ;; With optional argument N, return a list containing all the
3311 ;; following elements.
3314 '(bold code underline
)
3315 (org-test-with-parsed-data "_a_ /b/ *c* ~d~ _e_"
3317 (org-export-get-next-element
3318 (org-element-map tree
'italic
'identity info t
) info t
)))))
3319 ;; When N is a positive integer, return a list containing up to
3320 ;; N following elements.
3324 (org-test-with-parsed-data "_a_ /b/ *c* ~d~ _e_"
3326 (org-export-get-next-element
3327 (org-element-map tree
'italic
'identity info t
) info
2))))))
3329 (ert-deftest test-org-export
/get-previous-element
()
3330 "Test `org-export-get-previous-element' specifications."
3334 (org-test-with-parsed-data "* Headline\na *b*"
3335 (org-export-get-previous-element
3336 (org-element-map tree
'bold
'identity info t
) info
))))
3337 ;; Return nil when no previous element.
3339 (org-test-with-parsed-data "* Headline\n*a* b"
3340 (org-export-get-previous-element
3341 (org-element-map tree
'bold
'identity info t
) info
)))
3342 ;; Non-exportable elements are ignored.
3344 (let ((org-export-with-timestamps nil
))
3345 (org-test-with-parsed-data "<2012-03-29 Thu> \alpha"
3346 (org-export-get-previous-element
3347 (org-element-map tree
'entity
'identity info t
) info
))))
3348 ;; Find previous element in secondary strings.
3351 (org-test-with-parsed-data "* =verb= a"
3353 (org-export-get-previous-element
3354 (org-element-map tree
'plain-text
'identity info t
) info
)))))
3357 (org-test-with-parsed-data "* =verb= /italic/"
3359 (org-export-get-previous-element
3360 (org-element-map tree
'italic
'identity info t
) info
)))))
3361 ;; Find previous element in document keywords.
3364 (org-test-with-parsed-data "#+TITLE: =verb= a"
3366 (org-export-get-previous-element
3368 (plist-get info
:title
) 'plain-text
'identity info t
) info
)))))
3369 ;; Find previous element in parsed affiliated keywords.
3372 (org-test-with-parsed-data "#+CAPTION: =verb= a\nParagraph"
3374 (org-export-get-previous-element
3375 (org-element-map tree
'plain-text
'identity info t nil t
) info
)))))
3376 ;; With optional argument N, return a list containing up to
3377 ;; N previous elements.
3379 (equal '(underline italic bold
)
3380 (org-test-with-parsed-data "_a_ /b/ *c* ~d~"
3382 (org-export-get-previous-element
3383 (org-element-map tree
'code
'identity info t
) info t
)))))
3384 ;; When N is a positive integer, return a list containing up to
3385 ;; N previous elements.
3387 (equal '(italic bold
)
3388 (org-test-with-parsed-data "_a_ /b/ *c* ~d~"
3390 (org-export-get-previous-element
3391 (org-element-map tree
'code
'identity info t
) info
2))))))
3395 ;;; test-org-export.el end here