1 ;;; test-ox.el --- Tests for ox.el
3 ;; Copyright (C) 2012, 2013 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.
47 DATA is a string containing the data to be parsed. BODY is the
48 body to execute. Parse tree is available under the `tree'
49 variable, and communication channel under `info'.
51 This function calls `org-export-collect-tree-properties'. As
52 such, `:ignore-list' (for `org-element-map') and
53 `:parse-tree' (for `org-export-get-genealogy') properties are
54 already filled in `info'."
55 (declare (debug (form body
)) (indent 1))
56 `(org-test-with-temp-text ,data
57 (let* ((tree (org-element-parse-buffer))
58 (info (org-export-collect-tree-properties
59 tree
(org-export-get-environment))))
66 (ert-deftest test-org-export
/bind-keyword
()
67 "Test reading #+BIND: keywords."
68 ;; Test with `org-export-allow-bind-keywords' set to t.
70 (org-test-with-temp-text "#+BIND: test-ox-var value"
71 (let ((org-export-allow-bind-keywords t
))
72 (org-export-get-environment)
73 (eq test-ox-var
'value
))))
74 ;; Test with `org-export-allow-bind-keywords' set to nil.
76 (org-test-with-temp-text "#+BIND: test-ox-var value"
77 (let ((org-export-allow-bind-keywords nil
))
78 (org-export-get-environment)
79 (boundp 'test-ox-var
))))
80 ;; BIND keywords are case-insensitive.
82 (org-test-with-temp-text "#+bind: test-ox-var value"
83 (let ((org-export-allow-bind-keywords t
))
84 (org-export-get-environment)
85 (eq test-ox-var
'value
))))
86 ;; Preserve order of BIND keywords.
88 (org-test-with-temp-text "#+BIND: test-ox-var 1\n#+BIND: test-ox-var 2"
89 (let ((org-export-allow-bind-keywords t
))
90 (org-export-get-environment)
92 ;; Read BIND keywords in setup files.
94 (org-test-with-temp-text
95 (format "#+SETUPFILE: \"%s/examples/setupfile.org\"" org-test-dir
)
96 (let ((org-export-allow-bind-keywords t
))
97 (org-export-get-environment)
98 (eq variable
'value
))))
99 ;; Verify that bound variables are seen during export.
102 (org-test-with-temp-text "#+BIND: test-ox-var value"
103 (let ((org-export-allow-bind-keywords t
))
105 (org-export-create-backend
107 '((section .
(lambda (s c i
)
108 (if (eq test-ox-var
'value
) "Yes" "No")))))))))))
110 (ert-deftest test-org-export
/parse-option-keyword
()
111 "Test reading all standard #+OPTIONS: items."
114 (org-export--parse-option-keyword
115 "H:1 num:t \\n:t timestamp:t arch:t author:t creator:t d:t email:t
116 *:t e:t ::t f:t pri:t -:t ^:t toc:t |:t tags:t tasks:t <:t todo:t inline:nil
119 1 :preserve-breaks t
:section-numbers t
:time-stamp-file t
120 :with-archived-trees t
:with-author t
:with-creator t
:with-drawers t
121 :with-email t
:with-emphasize t
:with-entities t
:with-fixed-width t
122 :with-footnotes t
:with-inlinetasks nil
:with-priority t
123 :with-special-strings t
:with-statistics-cookies t
:with-sub-superscript t
124 :with-toc t
:with-tables t
:with-tags t
:with-tasks t
:with-timestamps t
125 :with-todo-keywords t
)))
126 ;; Test some special values.
129 (org-export--parse-option-keyword
130 "arch:headline creator:comment d:(\"TEST\")
131 ^:{} toc:1 tags:not-in-toc tasks:todo num:2 <:active")
134 :with-archived-trees headline
:with-creator comment
135 :with-drawers
("TEST") :with-sub-superscript
{} :with-toc
1
136 :with-tags not-in-toc
:with-tasks todo
:with-timestamps active
))))
138 (ert-deftest test-org-export
/get-inbuffer-options
()
139 "Test reading all standard export keywords."
140 ;; Properties should follow buffer order.
143 (org-test-with-temp-text "#+LANGUAGE: fr\n#+CREATOR: Me\n#+EMAIL: email"
144 (org-export--get-inbuffer-options))
145 '(:language
"fr" :creator
"Me" :email
"email")))
146 ;; Parse document keywords.
149 (org-test-with-temp-text "#+AUTHOR: Me"
150 (org-export--get-inbuffer-options))
152 ;; Test `space' behaviour.
155 (org-test-with-temp-text "#+TITLE: Some title\n#+TITLE: with spaces"
156 (org-export--get-inbuffer-options))
157 '(:title
("Some title with spaces"))))
158 ;; Test `newline' behaviour.
161 (org-test-with-temp-text "#+DESCRIPTION: With\n#+DESCRIPTION: two lines"
162 (org-export--get-inbuffer-options))
163 '(:description
"With\ntwo lines")))
164 ;; Test `split' behaviour.
167 (org-test-with-temp-text "#+SELECT_TAGS: a\n#+SELECT_TAGS: b"
168 (org-export--get-inbuffer-options))
169 '(:select-tags
("a" "b"))))
170 ;; Options set through SETUPFILE.
173 (org-test-with-temp-text
174 (format "#+DESCRIPTION: l1
178 #+SETUPFILE: \"%s/examples/setupfile.org\"
184 (org-export--get-inbuffer-options))
185 '(:description
"l1\nl2\nl3":language
"fr" :select-tags
("a" "b" "c")
187 ;; More than one property can refer to the same buffer keyword.
189 (equal '(:k2
"value" :k1
"value")
190 (let ((backend (org-export-create-backend
191 :options
'((:k1
"KEYWORD")
193 (org-test-with-temp-text "#+KEYWORD: value"
194 (org-export--get-inbuffer-options backend
))))))
196 (ert-deftest test-org-export
/get-subtree-options
()
197 "Test setting options from headline's properties."
199 (org-test-with-temp-text "#+TITLE: Title
202 :EXPORT_TITLE: Subtree Title
206 (should (equal (plist-get (org-export-get-environment nil t
) :title
)
207 '("Subtree Title"))))
211 (org-test-with-temp-text "#+OPTIONS: H:1
219 (= 2 (plist-get (org-export-get-environment nil t
) :headline-levels
))))
221 (org-test-with-temp-text "#+DATE: today
224 :EXPORT_DATE: 29-03-2012
228 (should (equal (plist-get (org-export-get-environment nil t
) :date
)
230 ;; Properties with `split' behaviour are stored as a list of
234 (org-test-with-temp-text "#+EXCLUDE_TAGS: noexport
237 :EXPORT_EXCLUDE_TAGS: a b
242 (plist-get (org-export-get-environment nil t
) :exclude-tags
)))))
243 ;; Handle :PROPERTY+: syntax.
246 (org-test-with-temp-text "#+EXCLUDE_TAGS: noexport
249 :EXPORT_EXCLUDE_TAGS: a
250 :EXPORT_EXCLUDE_TAGS+: b
255 (plist-get (org-export-get-environment nil t
) :exclude-tags
)))))
256 ;; Export properties are case-insensitive.
257 (org-test-with-temp-text "* Headline
259 :EXPORT_Date: 29-03-2012
262 (should (equal (plist-get (org-export-get-environment nil t
) :date
)
264 ;; Still grab correct options when section above is empty.
267 (org-test-with-temp-text "* H1\n** H11\n** H12"
268 (progn (forward-line 2)
269 (plist-get (org-export-get-environment nil t
) :title
))))))
271 (ert-deftest test-org-export
/set-title
()
272 "Test title setting."
273 ;; If no title if specified, use file name.
277 (org-test-with-temp-text-in-file "Test"
280 (org-export-create-backend
282 '((template .
(lambda (text info
)
283 (org-element-interpret-data
284 (plist-get info
:title
)))))))
285 (file-name-nondirectory
286 (file-name-sans-extension (buffer-file-name)))))))
287 ;; If no title is specified, and no file is associated to the
288 ;; buffer, use buffer's name.
292 (org-test-with-temp-text "Test"
295 (org-export-create-backend
297 '((template .
(lambda (text info
)
298 (org-element-interpret-data
299 (plist-get info
:title
)))))))
301 ;; If a title is specified, use it.
305 (org-test-with-temp-text-in-file "#+TITLE: Title\nTest"
308 (org-export-create-backend
310 '((template .
(lambda (text info
)
311 (org-element-interpret-data
312 (plist-get info
:title
))))))))))
313 ;; If an empty title is specified, do not set it.
317 (org-test-with-temp-text-in-file "#+TITLE:\nTest"
320 (org-export-create-backend
322 '((template .
(lambda (text info
)
323 (org-element-interpret-data
324 (plist-get info
:title
)))))))))))
326 (ert-deftest test-org-export
/handle-options
()
327 "Test if export options have an impact on output."
328 ;; Test exclude tags for headlines and inlinetasks.
331 (org-test-with-temp-text "* Head1 :noexp:"
332 (org-export-as (org-test-default-backend)
333 nil nil nil
'(:exclude-tags
("noexp"))))))
334 ;; Test include tags for headlines and inlinetasks.
336 (equal "* H2\n** Sub :exp:\n*** Sub Sub\n"
337 (org-test-with-temp-text "* H1\n* H2\n** Sub :exp:\n*** Sub Sub\n* H3"
338 (let ((org-tags-column 0))
339 (org-export-as (org-test-default-backend)
340 nil nil nil
'(:select-tags
("exp")))))))
341 ;; If there is an include tag, ignore the section before the first
344 (equal "* H1 :exp:\nBody\n"
345 (org-test-with-temp-text "First section\n* H1 :exp:\nBody"
346 (let ((org-tags-column 0))
347 (org-export-as (org-test-default-backend)
348 nil nil nil
'(:select-tags
("exp")))))))
350 (equal "* H1 :exp:\n"
351 (org-test-with-temp-text "* H1 :exp:\nBody"
352 (let ((org-tags-column 0))
353 (org-export-as (org-test-default-backend)
354 nil nil nil
'(:select-tags
("exp")))))))
355 ;; Test mixing include tags and exclude tags.
358 "\\* Head1[ \t]+:export:\n\\*\\* Sub-Head2\n"
359 (org-test-with-temp-text "
361 ** Sub-Head1 :noexport:
364 ** Sub-Head1 :export:"
365 (org-export-as (org-test-default-backend) nil nil nil
366 '(:select-tags
("export") :exclude-tags
("noexport"))))))
370 (let ((org-todo-keywords '((sequence "TODO" "DONE"))))
371 (org-test-with-temp-text "* TODO Head1"
372 (org-export-as (org-test-default-backend)
373 nil nil nil
'(:with-tasks nil
))))))
375 (equal "* TODO Head1\n"
376 (let ((org-todo-keywords '((sequence "TODO" "DONE"))))
377 (org-test-with-temp-text "* TODO Head1"
378 (org-export-as (org-test-default-backend)
379 nil nil nil
'(:with-tasks t
))))))
383 (org-test-with-temp-text "* Head1 :archive:"
384 (let ((org-archive-tag "archive"))
385 (org-export-as (org-test-default-backend)
386 nil nil nil
'(:with-archived-trees nil
))))))
389 "\\* Head1[ \t]+:archive:"
390 (org-test-with-temp-text "* Head1 :archive:\nbody\n** Sub-head 2"
391 (let ((org-archive-tag "archive"))
392 (org-export-as (org-test-default-backend) nil nil nil
393 '(:with-archived-trees headline
))))))
396 "\\`\\* Head1[ \t]+:archive:\n\\'"
397 (org-test-with-temp-text "* Head1 :archive:"
398 (let ((org-archive-tag "archive"))
399 (org-export-as (org-test-default-backend)
400 nil nil nil
'(:with-archived-trees t
))))))
403 (string-match "CLOCK: \\[2012-04-29 .* 10:45\\]"
404 (org-test-with-temp-text "CLOCK: [2012-04-29 sun. 10:45]"
405 (org-export-as (org-test-default-backend)
406 nil nil nil
'(:with-clocks t
)))))
409 (org-test-with-temp-text "CLOCK: [2012-04-29 sun. 10:45]"
410 (org-export-as (org-test-default-backend)
411 nil nil nil
'(:with-clocks nil
)))))
415 (org-test-with-temp-text ":TEST:\ncontents\n:END:"
416 (org-export-as (org-test-default-backend)
417 nil nil nil
'(:with-drawers nil
)))))
419 (equal ":TEST:\ncontents\n:END:\n"
420 (org-test-with-temp-text ":TEST:\ncontents\n:END:"
421 (org-export-as (org-test-default-backend)
422 nil nil nil
'(:with-drawers t
)))))
424 (equal ":FOO:\nkeep\n:END:\n"
425 (org-test-with-temp-text ":FOO:\nkeep\n:END:\n:BAR:\nremove\n:END:"
426 (org-export-as (org-test-default-backend)
427 nil nil nil
'(:with-drawers
("FOO"))))))
429 (equal ":FOO:\nkeep\n:END:\n"
430 (org-test-with-temp-text ":FOO:\nkeep\n:END:\n:BAR:\nremove\n:END:"
431 (org-export-as (org-test-default-backend)
432 nil nil nil
'(:with-drawers
(not "BAR"))))))
436 (let ((org-footnote-section nil
))
437 (org-test-with-temp-text "Footnote?[fn:1]\n\n[fn:1] Def"
438 (org-trim (org-export-as (org-test-default-backend)
439 nil nil nil
'(:with-footnotes nil
)))))))
441 (equal "Footnote?[fn:1]\n\n[fn:1] Def"
442 (let ((org-footnote-section nil
))
443 (org-test-with-temp-text "Footnote?[fn:1]\n\n[fn:1] Def"
444 (org-trim (org-export-as (org-test-default-backend)
445 nil nil nil
'(:with-footnotes t
)))))))
447 (when (featurep 'org-inlinetask
)
451 (let ((org-inlinetask-min-level 15))
452 (org-test-with-temp-text "*************** Task"
453 (org-export-as (org-test-default-backend)
454 nil nil nil
'(:with-inlinetasks nil
))))))
458 (let ((org-inlinetask-min-level 15))
459 (org-test-with-temp-text
460 "*************** Task\nContents\n*************** END"
461 (org-export-as (org-test-default-backend)
462 nil nil nil
'(:with-inlinetasks nil
)))))))
466 "CLOSED: \\[2012-04-29 .* 10:45\\]"
467 (let ((org-closed-string "CLOSED:"))
468 (org-test-with-temp-text "CLOSED: [2012-04-29 sun. 10:45]"
469 (org-export-as (org-test-default-backend)
470 nil nil nil
'(:with-planning t
))))))
473 (let ((org-closed-string "CLOSED:"))
474 (org-test-with-temp-text "CLOSED: [2012-04-29 sun. 10:45]"
475 (org-export-as (org-test-default-backend)
476 nil nil nil
'(:with-planning nil
))))))
480 (org-test-with-temp-text
481 "* H1\n :PROPERTIES:\n :PROP: value\n :END:"
482 (org-export-as (org-test-default-backend)
483 nil nil nil
'(:with-properties nil
)))))
485 (equal "* H1\n:PROPERTIES:\n:PROP: value\n:END:\n"
486 (org-test-with-temp-text
487 "* H1\n :PROPERTIES:\n :PROP: value\n :END:"
488 (org-export-as (org-test-default-backend)
489 nil nil nil
'(:with-properties t
)))))
491 (equal "* H1\n:PROPERTIES:\n:B: 2\n:END:\n"
492 (org-test-with-temp-text
493 "* H1\n :PROPERTIES:\n :A: 1\n :B: 2\n:END:"
494 (org-export-as (org-test-default-backend)
495 nil nil nil
'(:with-properties
("B"))))))
496 ;; Statistics cookies.
499 (org-test-with-temp-text "[0/0]"
500 (org-export-as (org-test-default-backend)
501 nil nil nil
'(:with-statistics-cookies nil
))))))
503 (ert-deftest test-org-export
/with-timestamps
()
504 "Test `org-export-with-timestamps' specifications."
508 "\\[2012-04-29 .*? 10:45\\]<2012-04-29 .*? 10:45>"
509 (org-test-with-temp-text "[2012-04-29 sun. 10:45]<2012-04-29 sun. 10:45>"
510 (org-export-as (org-test-default-backend)
511 nil nil nil
'(:with-timestamps t
)))))
516 (org-test-with-temp-text "[2012-04-29 sun. 10:45]<2012-04-29 sun. 10:45>"
517 (org-export-as (org-test-default-backend)
518 nil nil nil
'(:with-timestamps nil
)))))
522 "<2012-03-29 .*?>\n\nParagraph <2012-03-29 .*?>\\[2012-03-29 .*?\\]"
523 (org-test-with-temp-text
524 "<2012-03-29 Thu>[2012-03-29 Thu]
526 Paragraph <2012-03-29 Thu>[2012-03-29 Thu]"
527 (org-export-as (org-test-default-backend)
528 nil nil nil
'(:with-timestamps active
)))))
532 "\\[2012-03-29 .*?\\]\n\nParagraph <2012-03-29 .*?>\\[2012-03-29 .*?\\]"
533 (org-test-with-temp-text
534 "<2012-03-29 Thu>[2012-03-29 Thu]
536 Paragraph <2012-03-29 Thu>[2012-03-29 Thu]"
537 (org-export-as (org-test-default-backend)
538 nil nil nil
'(:with-timestamps inactive
))))))
540 (ert-deftest test-org-export
/comment-tree
()
541 "Test if export process ignores commented trees."
544 (let ((org-comment-string "COMMENT"))
545 (org-test-with-temp-text "* COMMENT Head1"
546 (org-export-as (org-test-default-backend)))))))
548 (ert-deftest test-org-export
/export-scope
()
549 "Test all export scopes."
550 (org-test-with-temp-text "
557 (should (equal (org-export-as (org-test-default-backend) 'subtree
)
558 "text\n*** Head3\n"))
560 (goto-char (point-min))
563 (should (equal (org-export-as (org-test-default-backend) nil
'visible
)
566 (goto-char (point-min))
568 (transient-mark-mode 1)
569 (push-mark (point) t t
)
570 (goto-char (point-at-eol))
571 (should (equal (org-export-as (org-test-default-backend)) "text\n")))
572 ;; Subtree with a code block calling another block outside.
575 (org-test-with-temp-text "
577 #+BEGIN_SRC emacs-lisp :noweb yes :exports results
582 #+BEGIN_SRC emacs-lisp
586 (org-export-as (org-test-default-backend) 'subtree
))))
588 (let ((backend (org-test-default-backend)))
589 (setf (org-export-backend-transcoders backend
)
590 (cons '(template .
(lambda (body i
)
591 (format "BEGIN\n%sEND" body
)))
592 (org-export-backend-transcoders backend
)))
593 (org-test-with-temp-text "Text"
594 (should (equal (org-export-as backend nil nil
'body-only
)
596 (should (equal (org-export-as backend
) "BEGIN\nText\nEND")))))
598 (ert-deftest test-org-export
/output-file-name
()
599 "Test `org-export-output-file-name' specifications."
600 ;; Export from a file: name is built from original file name.
602 (org-test-with-temp-text-in-file "Test"
603 (equal (concat (file-name-as-directory ".")
604 (file-name-nondirectory
605 (file-name-sans-extension (buffer-file-name))))
606 (file-name-sans-extension (org-export-output-file-name ".ext")))))
607 ;; When exporting to subtree, check EXPORT_FILE_NAME property first.
609 (org-test-with-temp-text-in-file
610 "* Test\n :PROPERTIES:\n :EXPORT_FILE_NAME: test\n :END:"
611 (equal (org-export-output-file-name ".ext" t
) "./test.ext")))
612 ;; From a buffer not associated to a file, too.
614 (org-test-with-temp-text
615 "* Test\n :PROPERTIES:\n :EXPORT_FILE_NAME: test\n :END:"
616 (equal (org-export-output-file-name ".ext" t
) "./test.ext")))
617 ;; When provided name is absolute, preserve it.
619 (org-test-with-temp-text
620 (format "* Test\n :PROPERTIES:\n :EXPORT_FILE_NAME: %s\n :END:"
621 (expand-file-name "test"))
622 (file-name-absolute-p (org-export-output-file-name ".ext" t
))))
623 ;; When PUB-DIR argument is provided, use it.
625 (org-test-with-temp-text-in-file "Test"
626 (equal (file-name-directory
627 (org-export-output-file-name ".ext" nil
"dir/"))
629 ;; When returned name would overwrite original file, add EXTENSION
632 (org-test-at-id "75282ba2-f77a-4309-a970-e87c149fe125"
633 (equal (org-export-output-file-name ".org") "./normal.org.org"))))
635 (ert-deftest test-org-export
/expand-include
()
636 "Test file inclusion in an Org buffer."
637 ;; Error when file isn't specified.
639 (org-test-with-temp-text "#+INCLUDE: dummy.org"
640 (org-export-expand-include-keyword)))
641 ;; Full insertion with recursive inclusion.
642 (org-test-with-temp-text
643 (format "#+INCLUDE: \"%s/examples/include.org\"" org-test-dir
)
644 (org-export-expand-include-keyword)
645 (should (equal (buffer-string)
646 "Small Org file with an include keyword.
648 #+BEGIN_SRC emacs-lisp :exports results\n(+ 2 1)\n#+END_SRC
654 ;; Localized insertion.
655 (org-test-with-temp-text
656 (format "#+INCLUDE: \"%s/examples/include.org\" :lines \"1-2\""
658 (org-export-expand-include-keyword)
659 (should (equal (buffer-string)
660 "Small Org file with an include keyword.\n")))
661 ;; Insertion with constraints on headlines level.
664 "* Top heading\n** Heading\nbody\n"
665 (org-test-with-temp-text
667 "* Top heading\n#+INCLUDE: \"%s/examples/include.org\" :lines \"9-\""
669 (org-export-expand-include-keyword)
673 "* Top heading\n* Heading\nbody\n"
674 (org-test-with-temp-text
676 "* Top heading\n#+INCLUDE: \"%s/examples/include.org\" :lines \"9-\" :minlevel 1"
678 (org-export-expand-include-keyword)
680 ;; Inclusion within an example block.
681 (org-test-with-temp-text
682 (format "#+INCLUDE: \"%s/examples/include.org\" :lines \"1-2\" example"
684 (org-export-expand-include-keyword)
688 "#+BEGIN_EXAMPLE\nSmall Org file with an include keyword.\n#+END_EXAMPLE\n")))
689 ;; Inclusion within a src-block.
690 (org-test-with-temp-text
692 "#+INCLUDE: \"%s/examples/include.org\" :lines \"4-5\" src emacs-lisp"
694 (org-export-expand-include-keyword)
695 (should (equal (buffer-string)
696 "#+BEGIN_SRC emacs-lisp\n(+ 2 1)\n#+END_SRC\n"))))
698 (ert-deftest test-org-export
/expand-macro
()
699 "Test macro expansion in an Org buffer."
700 ;; Standard macro expansion.
702 (equal "#+MACRO: macro1 value\nvalue\n"
703 (org-test-with-temp-text "#+MACRO: macro1 value\n{{{macro1}}}"
704 (org-export-as (org-test-default-backend)))))
705 ;; Expand specific macros.
707 (equal "me 2012-03-29 me@here Title\n"
708 (org-test-with-temp-text
714 {{{author}}} {{{date}}} {{{email}}} {{{title}}}"
715 (let ((output (org-export-as (org-test-default-backend))))
716 (substring output
(string-match ".*\n\\'" output
))))))
717 ;; Expand specific macros when property contained a regular macro
721 (org-test-with-temp-text "
722 #+MACRO: macro1 value
723 #+TITLE: {{{macro1}}}
725 (let ((output (org-export-as (org-test-default-backend))))
726 (substring output
(string-match ".*\n\\'" output
))))))
727 ;; Expand macros with templates in included files.
730 (org-test-with-temp-text
731 (format "#+INCLUDE: \"%s/examples/macro-templates.org\"
732 {{{included-macro}}}" org-test-dir
)
733 (let ((output (org-export-as (org-test-default-backend))))
734 (substring output
(string-match ".*\n\\'" output
)))))))
736 (ert-deftest test-org-export
/user-ignore-list
()
737 "Test if `:ignore-list' accepts user input."
738 (let ((backend (org-test-default-backend)))
739 (setf (org-export-backend-transcoders backend
)
740 (cons '(template .
(lambda (body i
)
741 (format "BEGIN\n%sEND" body
)))
742 (org-export-backend-transcoders backend
)))
743 (org-test-with-temp-text "Text"
744 (should (equal (org-export-as backend nil nil
'body-only
)
746 (should (equal (org-export-as backend
) "BEGIN\nText\nEND"))))
750 (let ((org-export-filter-parse-tree-functions
751 '((lambda (data backend info
)
752 ;; Ignore headlines with the word "note" in their title.
753 (org-element-map data
'headline
755 (when (string-match "\\<note\\>"
756 (org-element-property :raw-value
758 (org-export-ignore-element headline info
)))
761 (org-test-with-temp-text "* Head1\n* Head2 (note)\n"
762 (org-export-as (org-test-default-backend)))))))
764 (ert-deftest test-org-export
/before-processing-hook
()
765 "Test `org-export-before-processing-hook'."
768 "#+MACRO: mac val\nTest\n"
769 (org-test-with-temp-text "#+MACRO: mac val\n{{{mac}}} Test"
770 (let ((org-export-before-processing-hook
772 (while (re-search-forward "{{{" nil t
)
773 (let ((object (org-element-context)))
774 (when (eq (org-element-type object
) 'macro
)
776 (org-element-property :begin object
)
777 (org-element-property :end object
)))))))))
778 (org-export-as (org-test-default-backend)))))))
780 (ert-deftest test-org-export
/before-parsing-hook
()
781 "Test `org-export-before-parsing-hook'."
783 (equal "Body 1\nBody 2\n"
784 (org-test-with-temp-text "* Headline 1\nBody 1\n* Headline 2\nBody 2"
785 (let ((org-export-before-parsing-hook
787 (goto-char (point-min))
788 (while (re-search-forward org-outline-regexp-bol nil t
)
790 (point-at-bol) (progn (forward-line) (point))))))))
791 (org-export-as (org-test-default-backend)))))))
795 ;;; Affiliated Keywords
797 (ert-deftest test-org-export
/read-attribute
()
798 "Test `org-export-read-attribute' specifications."
802 (org-export-read-attribute
804 (org-test-with-temp-text "#+ATTR_HTML: :a 1 :b 2\nParagraph"
805 (org-element-at-point)))
807 ;; Return nil on empty attribute.
809 (org-export-read-attribute
811 (org-test-with-temp-text "Paragraph" (org-element-at-point))))
812 ;; Return nil on "nil" string.
814 (equal '(:a nil
:b nil
)
815 (org-export-read-attribute
817 (org-test-with-temp-text "#+ATTR_HTML: :a nil :b nil\nParagraph"
818 (org-element-at-point)))))
819 ;; Return nil on empty string.
821 (equal '(:a nil
:b nil
)
822 (org-export-read-attribute
824 (org-test-with-temp-text "#+ATTR_HTML: :a :b\nParagraph"
825 (org-element-at-point)))))
826 ;; Return empty string when value is "".
829 (org-export-read-attribute
831 (org-test-with-temp-text "#+ATTR_HTML: :a \"\"\nParagraph"
832 (org-element-at-point)))))
833 ;; Return \"\" when value is """".
836 (org-export-read-attribute
838 (org-test-with-temp-text "#+ATTR_HTML: :a \"\"\"\"\nParagraph"
839 (org-element-at-point)))))
840 ;; Ignore text before first property.
843 (org-export-read-attribute
845 (org-test-with-temp-text "#+ATTR_HTML: ignore :a 1\nParagraph"
846 (org-element-at-point))))))
848 (ert-deftest test-org-export
/get-caption
()
849 "Test `org-export-get-caption' specifications."
850 ;; Without optional argument, return long caption
854 (org-test-with-temp-text "#+CAPTION[s]: l\nPara"
855 (org-export-get-caption (org-element-at-point)))))
856 ;; With optional argument, return short caption.
860 (org-test-with-temp-text "#+CAPTION[s]: l\nPara"
861 (org-export-get-caption (org-element-at-point) t
))))
862 ;; Multiple lines are separated by white spaces.
866 (org-test-with-temp-text "#+CAPTION: a\n#+CAPTION: b\nPara"
867 (org-export-get-caption (org-element-at-point))))))
873 (ert-deftest test-org-export
/define-backend
()
874 "Test back-end definition and accessors."
877 (equal '((headline . my-headline-test
))
878 (let (org-export--registered-backends)
879 (org-export-define-backend 'test
'((headline . my-headline-test
)))
880 (org-export-get-all-transcoders 'test
))))
883 (equal '((:filter-headline . my-filter
))
884 (let (org-export--registered-backends)
885 (org-export-define-backend 'test
886 '((headline . my-headline-test
))
887 :filters-alist
'((:filter-headline . my-filter
)))
888 (org-export-backend-filters (org-export-get-backend 'test
)))))
891 (equal '((:prop value
))
892 (let (org-export--registered-backends)
893 (org-export-define-backend 'test
894 '((headline . my-headline-test
))
895 :options-alist
'((:prop value
)))
896 (org-export-backend-options (org-export-get-backend 'test
)))))
899 (equal '(?k
"Test Export" test
)
900 (let (org-export--registered-backends)
901 (org-export-define-backend 'test
902 '((headline . my-headline-test
))
903 :menu-entry
'(?k
"Test Export" test
))
904 (org-export-backend-menu (org-export-get-backend 'test
)))))
907 (equal '(("TEST" . org-element-export-block-parser
))
908 (let (org-export--registered-backends org-element-block-name-alist
)
909 (org-export-define-backend 'test
910 '((headline . my-headline-test
))
911 :export-block
'("test"))
912 org-element-block-name-alist
))))
914 (ert-deftest test-org-export
/define-derived-backend
()
915 "Test `org-export-define-derived-backend' specifications."
916 ;; Error when parent back-end is not defined.
918 (let (org-export--registered-backends)
919 (org-export-define-derived-backend 'test
'parent
)))
920 ;; Append translation table to parent's.
922 (equal '((:headline . test
) (:headline . parent
))
923 (let (org-export--registered-backends)
924 (org-export-define-backend 'parent
'((:headline . parent
)))
925 (org-export-define-derived-backend 'test
'parent
926 :translate-alist
'((:headline . test
)))
927 (org-export-get-all-transcoders 'test
))))
928 ;; Options defined in the new back have priority over those defined
932 (let (org-export--registered-backends)
933 (org-export-define-backend 'parent
934 '((:headline . parent
))
935 :options-alist
'((:a nil nil
'parent
)))
936 (org-export-define-derived-backend 'test
'parent
937 :options-alist
'((:a nil nil
'test
)))
938 (plist-get (org-export--get-global-options
939 (org-export-get-backend 'test
))
942 (ert-deftest test-org-export
/derived-backend-p
()
943 "Test `org-export-derived-backend-p' specifications."
944 ;; Non-nil with direct match.
946 (let (org-export--registered-backends)
947 (org-export-define-backend 'test
'((headline . test
)))
948 (org-export-derived-backend-p 'test
'test
)))
950 (let (org-export--registered-backends)
951 (org-export-define-backend 'test
'((headline . test
)))
952 (org-export-define-derived-backend 'test2
'test
)
953 (org-export-derived-backend-p 'test2
'test2
)))
954 ;; Non-nil with a direct parent.
956 (let (org-export--registered-backends)
957 (org-export-define-backend 'test
'((headline . test
)))
958 (org-export-define-derived-backend 'test2
'test
)
959 (org-export-derived-backend-p 'test2
'test
)))
960 ;; Non-nil with an indirect parent.
962 (let (org-export--registered-backends)
963 (org-export-define-backend 'test
'((headline . test
)))
964 (org-export-define-derived-backend 'test2
'test
)
965 (org-export-define-derived-backend 'test3
'test2
)
966 (org-export-derived-backend-p 'test3
'test
)))
969 (let (org-export--registered-backends)
970 (org-export-define-backend 'test
'((headline . test
)))
971 (org-export-define-backend 'test2
'((headline . test2
)))
972 (org-export-derived-backend-p 'test2
'test
)))
974 (let (org-export--registered-backends)
975 (org-export-define-backend 'test
'((headline . test
)))
976 (org-export-define-backend 'test2
'((headline . test2
)))
977 (org-export-define-derived-backend 'test3
'test2
)
978 (org-export-derived-backend-p 'test3
'test
))))
980 (ert-deftest test-org-export
/get-all-transcoders
()
981 "Test `org-export-get-all-transcoders' specifications."
982 ;; Return nil when back-end cannot be found.
983 (should-not (org-export-get-all-transcoders nil
))
984 ;; Same as `org-export-transcoders' if no parent.
986 (equal '((headline . ignore
))
987 (org-export-get-all-transcoders
988 (org-export-create-backend
989 :transcoders
'((headline . ignore
))))))
990 ;; But inherit from all ancestors whenever possible.
992 (equal '((section . ignore
) (headline . ignore
))
993 (let (org-export--registered-backends)
994 (org-export-define-backend 'b1
'((headline . ignore
)))
995 (org-export-get-all-transcoders
996 (org-export-create-backend
997 :parent
'b1
:transcoders
'((section . ignore
)))))))
999 (equal '((paragraph . ignore
) (section . ignore
) (headline . ignore
))
1000 (let (org-export--registered-backends)
1001 (org-export-define-backend 'b1
'((headline . ignore
)))
1002 (org-export-define-derived-backend 'b2
'b1
1003 :translate-alist
'((section . ignore
)))
1004 (org-export-get-all-transcoders
1005 (org-export-create-backend
1006 :parent
'b2
:transcoders
'((paragraph . ignore
)))))))
1007 ;; Back-end transcoders overrule inherited ones.
1010 (let (org-export--registered-backends)
1011 (org-export-define-backend 'b1
'((headline . a
)))
1012 (cdr (assq 'headline
1013 (org-export-get-all-transcoders
1014 (org-export-create-backend
1015 :parent
'b1
:transcoders
'((headline . b
))))))))))
1017 (ert-deftest test-org-export
/get-all-options
()
1018 "Test `org-export-get-all-options' specifications."
1019 ;; Return nil when back-end cannot be found.
1020 (should-not (org-export-get-all-options nil
))
1021 ;; Same as `org-export-options' if no parent.
1023 (equal '((headline . ignore
))
1024 (org-export-get-all-options
1025 (org-export-create-backend
1026 :options
'((headline . ignore
))))))
1027 ;; But inherit from all ancestors whenever possible.
1029 (equal '((:key2 value2
) (:key1 value1
))
1030 (let (org-export--registered-backends)
1031 (org-export-define-backend 'b1 nil
:options-alist
'((:key1 value1
)))
1032 (org-export-get-all-options
1033 (org-export-create-backend
1034 :parent
'b1
:options
'((:key2 value2
)))))))
1036 (equal '((:key3 value3
) (:key2 value2
) (:key1 value1
))
1037 (let (org-export--registered-backends)
1038 (org-export-define-backend 'b1 nil
:options-alist
'((:key1 value1
)))
1039 (org-export-define-derived-backend 'b2
'b1
1040 :options-alist
'((:key2 value2
)))
1041 (org-export-get-all-options
1042 (org-export-create-backend
1043 :parent
'b2
:options
'((:key3 value3
)))))))
1044 ;; Back-end options overrule inherited ones.
1047 (let (org-export--registered-backends)
1048 (org-export-define-backend 'b1 nil
:options-alist
'((:key1 . a
)))
1050 (org-export-get-all-options
1051 (org-export-create-backend
1052 :parent
'b1
:options
'((:key1 . b
))))))))))
1054 (ert-deftest test-org-export
/get-all-filters
()
1055 "Test `org-export-get-all-filters' specifications."
1056 ;; Return nil when back-end cannot be found.
1057 (should-not (org-export-get-all-filters nil
))
1058 ;; Same as `org-export-filters' if no parent.
1060 (equal '((:filter-headline . ignore
))
1061 (org-export-get-all-filters
1062 (org-export-create-backend
1063 :filters
'((:filter-headline . ignore
))))))
1064 ;; But inherit from all ancestors whenever possible.
1066 (equal '((:filter-section . ignore
) (:filter-headline . ignore
))
1067 (let (org-export--registered-backends)
1068 (org-export-define-backend 'b1
1069 nil
:filters-alist
'((:filter-headline . ignore
)))
1070 (org-export-get-all-filters
1071 (org-export-create-backend
1072 :parent
'b1
:filters
'((:filter-section . ignore
)))))))
1074 (equal '((:filter-paragraph . ignore
)
1075 (:filter-section . ignore
)
1076 (:filter-headline . ignore
))
1077 (let (org-export--registered-backends)
1078 (org-export-define-backend 'b1
1079 nil
:filters-alist
'((:filter-headline . ignore
)))
1080 (org-export-define-derived-backend 'b2
'b1
1081 :filters-alist
'((:filter-section . ignore
)))
1082 (org-export-get-all-filters
1083 (org-export-create-backend
1084 :parent
'b2
:filters
'((:filter-paragraph . ignore
)))))))
1085 ;; Back-end filters overrule inherited ones.
1088 (let (org-export--registered-backends)
1089 (org-export-define-backend 'b1
'((:filter-headline . a
)))
1090 (cdr (assq :filter-headline
1091 (org-export-get-all-filters
1092 (org-export-create-backend
1093 :parent
'b1
:filters
'((:filter-headline . b
))))))))))
1095 (ert-deftest test-org-export
/with-backend
()
1096 "Test `org-export-with-backend' definition."
1097 ;; Error when calling an undefined back-end
1098 (should-error (org-export-with-backend nil
"Test"))
1099 ;; Error when called back-end doesn't have an appropriate
1102 (org-export-with-backend
1103 (org-export-create-backend :transcoders
'((headline . ignore
)))
1105 ;; Otherwise, export using correct transcoder
1108 (let (org-export--registered-backends)
1109 (org-export-define-backend 'test
1110 '((plain-text .
(lambda (text contents info
) "Failure"))))
1111 (org-export-define-backend 'test2
1112 '((plain-text .
(lambda (text contents info
) "Success"))))
1113 (org-export-with-backend 'test2
"Test"))))
1114 ;; Provide correct back-end if transcoder needs to use recursive
1118 (let ((test-back-end
1119 (org-export-create-backend
1121 '((headline .
(lambda (headline contents info
)
1123 (org-element-property :title headline
)
1125 (plain-text .
(lambda (text info
) "Success"))))))
1126 (org-export-string-as
1128 (org-export-create-backend
1130 '((headline .
(lambda (headline contents info
)
1131 (org-export-with-backend
1132 test-back-end headline contents info
))))))))))
1134 (ert-deftest test-org-export
/data-with-backend
()
1135 "Test `org-export-data-with-backend' specifications."
1136 ;; Error when calling an undefined back-end.
1137 (should-error (org-export-data-with-backend nil
"nil" nil
))
1138 ;; Otherwise, export data recursively, using correct back-end.
1142 (org-export-data-with-backend
1144 (org-export-create-backend
1146 '((plain-text .
(lambda (text info
) "Success"))
1147 (bold .
(lambda (bold contents info
) (concat contents
"!")))))
1148 '(:with-emphasize t
)))))
1154 (ert-deftest test-org-export
/export-snippet
()
1155 "Test export snippets transcoding."
1157 (org-test-with-temp-text "@@test:A@@@@t:B@@"
1158 (let ((backend (org-test-default-backend)))
1159 (setf (org-export-backend-name backend
) 'test
)
1160 (setf (org-export-backend-transcoders backend
)
1161 (cons (cons 'export-snippet
1162 (lambda (snippet contents info
)
1163 (when (eq (org-export-snippet-backend snippet
) 'test
)
1164 (org-element-property :value snippet
))))
1165 (org-export-backend-transcoders backend
)))
1166 (let ((org-export-snippet-translation-alist nil
))
1167 (should (equal (org-export-as backend
) "A\n")))
1168 (let ((org-export-snippet-translation-alist '(("t" .
"test"))))
1169 (should (equal (org-export-as backend
) "AB\n")))))
1170 ;; Ignored export snippets do not remove any blank.
1172 (equal "begin end\n"
1173 (org-test-with-parsed-data "begin @@test:A@@ end"
1174 (org-export-data-with-backend
1176 (org-export-create-backend
1178 '((paragraph .
(lambda (paragraph contents info
) contents
))
1179 (section .
(lambda (section contents info
) contents
))))
1186 (ert-deftest test-org-export
/footnotes
()
1187 "Test footnotes specifications."
1188 (let ((org-footnote-section nil
)
1189 (org-export-with-footnotes t
))
1190 ;; 1. Read every type of footnote.
1193 '((1 .
"A\n") (2 .
"B") (3 .
"C") (4 .
"D"))
1194 (org-test-with-parsed-data
1195 "Text[fn:1] [1] [fn:label:C] [fn::D]\n\n[fn:1] A\n\n[1] B"
1196 (org-element-map tree
'footnote-reference
1198 (let ((def (org-export-get-footnote-definition ref info
)))
1199 (cons (org-export-get-footnote-number ref info
)
1200 (if (eq (org-element-property :type ref
) 'inline
) (car def
)
1201 (car (org-element-contents
1202 (car (org-element-contents def
))))))))
1204 ;; 2. Test nested footnotes order.
1207 '((1 .
"fn:1") (2 .
"fn:2") (3 .
"fn:3") (4))
1208 (org-test-with-parsed-data
1209 "Text[fn:1:A[fn:2]] [fn:3].\n\n[fn:2] B [fn:3] [fn::D].\n\n[fn:3] C."
1210 (org-element-map tree
'footnote-reference
1212 (when (org-export-footnote-first-reference-p ref info
)
1213 (cons (org-export-get-footnote-number ref info
)
1214 (org-element-property :label ref
))))
1216 ;; 3. Test nested footnote in invisible definitions.
1217 (org-test-with-temp-text "Text[1]\n\n[1] B [2]\n\n[2] C."
1218 ;; Hide definitions.
1219 (narrow-to-region (point) (point-at-eol))
1220 (let* ((tree (org-element-parse-buffer))
1221 (info (org-combine-plists
1222 `(:parse-tree
,tree
)
1223 (org-export-collect-tree-properties
1224 tree
(org-export-get-environment)))))
1225 ;; Both footnotes should be seen.
1227 (= (length (org-export-collect-footnote-definitions tree info
)) 2))))
1228 ;; 4. Test footnotes definitions collection.
1231 (org-test-with-parsed-data "Text[fn:1:A[fn:2]] [fn:3].
1233 \[fn:2] B [fn:3] [fn::D].
1236 (length (org-export-collect-footnote-definitions tree info
)))))
1237 ;; 5. Test export of footnotes defined outside parsing scope.
1240 "ParagraphOut of scope\n"
1241 (org-test-with-temp-text "[fn:1] Out of scope
1244 (let ((backend (org-test-default-backend)))
1245 (setf (org-export-backend-transcoders backend
)
1246 (cons (cons 'footnote-reference
1247 (lambda (fn contents info
)
1248 (org-element-interpret-data
1249 (org-export-get-footnote-definition fn info
))))
1250 (org-export-backend-transcoders backend
)))
1252 (org-export-as backend
'subtree
)))))
1253 ;; 6. Footnotes without a definition should be provided a fallback
1256 (org-test-with-parsed-data "[fn:1]"
1257 (org-export-get-footnote-definition
1258 (org-element-map tree
'footnote-reference
'identity info t
) info
)))
1259 ;; 7. Footnote section should be ignored in TOC and in headlines
1262 (= 1 (let ((org-footnote-section "Footnotes"))
1263 (length (org-test-with-parsed-data "* H1\n* Footnotes\n"
1264 (org-export-collect-headlines info
))))))
1267 (let ((org-footnote-section "Footnotes"))
1268 (org-test-with-parsed-data "* H1\n* Footnotes\n* H2"
1269 (org-element-map tree
'headline
1271 (when (equal (org-element-property :raw-value hl
) "H2")
1272 (org-export-get-headline-number hl info
)))
1277 ;;; Headlines and Inlinetasks
1279 (ert-deftest test-org-export
/get-relative-level
()
1280 "Test `org-export-get-relative-level' specifications."
1284 (let ((org-odd-levels-only nil
))
1285 (org-test-with-parsed-data "* Headline 1\n** Headline 2"
1286 (org-element-map tree
'headline
1287 (lambda (h) (org-export-get-relative-level h info
))
1292 (let ((org-odd-levels-only nil
))
1293 (org-test-with-parsed-data "** Headline 1\n**** Headline 2"
1294 (org-element-map tree
'headline
1295 (lambda (h) (org-export-get-relative-level h info
))
1298 (ert-deftest test-org-export
/low-level-p
()
1299 "Test `org-export-low-level-p' specifications."
1303 (let ((org-odd-levels-only nil
))
1304 (org-test-with-parsed-data "* Headline 1\n** Headline 2"
1305 (org-element-map tree
'headline
1306 (lambda (h) (if (org-export-low-level-p h info
) 'yes
'no
))
1307 (plist-put info
:headline-levels
1)))))))
1309 (ert-deftest test-org-export
/get-headline-number
()
1310 "Test `org-export-get-headline-number' specifications."
1315 (let ((org-odd-levels-only nil
))
1316 (org-test-with-parsed-data "* Headline 1\n** Headline 2"
1317 (org-element-map tree
'headline
1318 (lambda (h) (org-export-get-headline-number h info
))
1320 ;; Missing levels are replaced with 0.
1324 (let ((org-odd-levels-only nil
))
1325 (org-test-with-parsed-data "* Headline 1\n*** Headline 2"
1326 (org-element-map tree
'headline
1327 (lambda (h) (org-export-get-headline-number h info
))
1330 (ert-deftest test-org-export
/numbered-headline-p
()
1331 "Test `org-export-numbered-headline-p' specifications."
1332 ;; If `:section-numbers' is nil, never number headlines.
1334 (org-test-with-parsed-data "* Headline"
1335 (org-element-map tree
'headline
1336 (lambda (h) (org-export-numbered-headline-p h info
))
1337 (plist-put info
:section-numbers nil
))))
1338 ;; If `:section-numbers' is a number, only number headlines with
1339 ;; a level greater that it.
1343 (org-test-with-parsed-data "* Headline 1\n** Headline 2"
1344 (org-element-map tree
'headline
1345 (lambda (h) (if (org-export-numbered-headline-p h info
) 'yes
'no
))
1346 (plist-put info
:section-numbers
1)))))
1347 ;; Otherwise, headlines are always numbered.
1349 (org-test-with-parsed-data "* Headline"
1350 (org-element-map tree
'headline
1351 (lambda (h) (org-export-numbered-headline-p h info
))
1352 (plist-put info
:section-numbers t
)))))
1354 (ert-deftest test-org-export
/number-to-roman
()
1355 "Test `org-export-number-to-roman' specifications."
1356 ;; If number is negative, return it as a string.
1357 (should (equal (org-export-number-to-roman -
1) "-1"))
1358 ;; Otherwise, return it as a roman number.
1359 (should (equal (org-export-number-to-roman 1449) "MCDXLIX")))
1361 (ert-deftest test-org-export
/get-optional-title
()
1362 "Test `org-export-get-alt-title' specifications."
1363 ;; If ALT_TITLE property is defined, use it.
1366 (org-test-with-parsed-data
1367 "* Headline\n:PROPERTIES:\n:ALT_TITLE: opt\n:END:"
1368 (org-export-get-alt-title
1369 (org-element-map tree
'headline
'identity info t
)
1371 ;; Otherwise, fall-back to regular title.
1373 (equal '("Headline")
1374 (org-test-with-parsed-data "* Headline"
1375 (org-export-get-alt-title
1376 (org-element-map tree
'headline
'identity info t
)
1379 (ert-deftest test-org-export
/get-tags
()
1380 "Test `org-export-get-tags' specifications."
1381 (let ((org-export-exclude-tags '("noexport"))
1382 (org-export-select-tags '("export")))
1383 ;; Standard test: tags which are not a select tag, an exclude tag,
1384 ;; or specified as optional argument shouldn't be ignored.
1386 (org-test-with-parsed-data "* Headline :tag:"
1387 (org-export-get-tags (org-element-map tree
'headline
'identity info t
)
1389 ;; Exclude tags are removed.
1391 (org-test-with-parsed-data "* Headline :noexport:"
1392 (org-export-get-tags (org-element-map tree
'headline
'identity info t
)
1394 ;; Select tags are removed.
1396 (org-test-with-parsed-data "* Headline :export:"
1397 (org-export-get-tags (org-element-map tree
'headline
'identity info t
)
1402 (org-test-with-parsed-data "* Headline :tag:export:"
1403 (org-export-get-tags (org-element-map tree
'headline
'identity info t
)
1405 ;; Tags provided in the optional argument are also ignored.
1407 (org-test-with-parsed-data "* Headline :ignore:"
1408 (org-export-get-tags (org-element-map tree
'headline
'identity info t
)
1410 ;; Allow tag inheritance.
1414 (org-test-with-parsed-data "* Headline :tag:\n** Sub-heading"
1415 (org-element-map tree
'headline
1416 (lambda (hl) (org-export-get-tags hl info nil t
)) info
))))
1417 ;; Tag inheritance checks FILETAGS keywords.
1421 (org-test-with-parsed-data "#+FILETAGS: :a:b:\n* Headline :tag:"
1422 (org-element-map tree
'headline
1423 (lambda (hl) (org-export-get-tags hl info nil t
)) info
))))))
1425 (ert-deftest test-org-export
/get-node-property
()
1426 "Test`org-export-get-node-property' specifications."
1430 (org-test-with-parsed-data "* Headline
1434 (org-export-get-node-property
1435 :PROP
(org-element-map tree
'headline
'identity nil t
)))))
1436 ;; Test inheritance.
1439 (org-test-with-parsed-data "* Parent
1445 (org-export-get-node-property
1446 :PROP
(org-element-map tree
'paragraph
'identity nil t
) t
))))
1447 ;; Cannot return a value before the first headline.
1449 (org-test-with-parsed-data "Paragraph
1454 (org-export-get-node-property
1455 :PROP
(org-element-map tree
'paragraph
'identity nil t
)))))
1457 (ert-deftest test-org-export
/get-category
()
1458 "Test `org-export-get-category' specifications."
1462 (org-test-with-parsed-data "* Headline
1466 (org-export-get-category
1467 (org-element-map tree
'headline
'identity nil t
) info
))))
1468 ;; Test inheritance from a parent headline.
1470 (equal '("value" "value")
1471 (org-test-with-parsed-data "* Headline1
1476 (org-element-map tree
'headline
1477 (lambda (hl) (org-export-get-category hl info
)) info
))))
1478 ;; Test inheritance from #+CATEGORY keyword
1481 (org-test-with-parsed-data "#+CATEGORY: value
1483 (org-export-get-category
1484 (org-element-map tree
'headline
'identity nil t
) info
))))
1485 ;; Test inheritance from file name.
1488 (org-test-with-parsed-data "* Headline"
1489 (let ((info (plist-put info
:input-file
"~/test.org")))
1490 (org-export-get-category
1491 (org-element-map tree
'headline
'identity nil t
) info
)))))
1495 (org-test-with-parsed-data "* Headline"
1496 (org-export-get-category
1497 (org-element-map tree
'headline
'identity nil t
) info
)))))
1499 (ert-deftest test-org-export
/first-sibling-p
()
1500 "Test `org-export-first-sibling-p' specifications."
1505 (org-test-with-parsed-data "* Headline\n** Headline 2\n** Headline 3"
1506 (org-element-map tree
'headline
1507 (lambda (h) (if (org-export-first-sibling-p h info
) 'yes
'no
))
1509 ;; Ignore headlines not exported.
1513 (let ((org-export-exclude-tags '("ignore")))
1514 (org-test-with-parsed-data "* Headline :ignore:\n* Headline 2"
1515 (org-element-map tree
'headline
1516 (lambda (h) (if (org-export-first-sibling-p h info
) 'yes
'no
))
1519 (ert-deftest test-org-export
/last-sibling-p
()
1520 "Test `org-export-last-sibling-p' specifications."
1525 (org-test-with-parsed-data "* Headline\n** Headline 2\n** Headline 3"
1526 (org-element-map tree
'headline
1527 (lambda (h) (if (org-export-last-sibling-p h info
) 'yes
'no
))
1529 ;; Ignore headlines not exported.
1533 (let ((org-export-exclude-tags '("ignore")))
1534 (org-test-with-parsed-data "* Headline\n* Headline 2 :ignore:"
1535 (org-element-map tree
'headline
1536 (lambda (h) (if (org-export-last-sibling-p h info
) 'yes
'no
))
1539 (ert-deftest test-org-export
/handle-inlinetasks
()
1540 "Test inlinetask export."
1541 ;; Inlinetask with an exclude tag.
1542 (when (featurep 'org-inlinetask
)
1546 (let ((org-inlinetask-min-level 3))
1547 (org-test-with-temp-text "*** Inlinetask :noexp:\nContents\n*** end"
1548 (org-export-as (org-test-default-backend)
1549 nil nil nil
'(:exclude-tags
("noexp")))))))
1550 ;; Inlinetask with an include tag.
1553 "* H2\n*** Inline :exp:\n"
1554 (let ((org-inlinetask-min-level 3)
1555 (org-tags-column 0))
1556 (org-test-with-temp-text "* H1\n* H2\n*** Inline :exp:"
1557 (org-export-as (org-test-default-backend)
1558 nil nil nil
'(:select-tags
("exp")))))))
1559 ;; Ignore inlinetask with a TODO keyword and tasks excluded.
1562 (let ((org-todo-keywords '((sequence "TODO" "DONE")))
1563 (org-inlinetask-min-level 3))
1564 (org-test-with-temp-text "*** TODO Inline"
1565 (org-export-as (org-test-default-backend)
1566 nil nil nil
'(:with-tasks nil
))))))))
1572 (ert-deftest test-org-export
/get-date
()
1573 "Test `org-export-get-date' specifications."
1574 ;; Return a properly formatted string when
1575 ;; `org-export-date-timestamp-format' is non-nil and DATE keyword
1576 ;; consists in a single timestamp.
1579 (let ((org-export-date-timestamp-format "%d %m %Y"))
1580 (org-test-with-parsed-data "#+DATE: <2012-03-29 Thu>"
1581 (org-export-get-date info
)))))
1582 ;; Return a secondary string otherwise.
1585 (let ((org-export-date-timestamp-format nil
))
1586 (org-test-with-parsed-data "#+DATE: <2012-03-29 Thu>"
1587 (org-export-get-date info
)))))
1590 (org-test-with-parsed-data "#+DATE: Date"
1591 (org-export-get-date info
))))
1592 ;; Optional argument has precedence over
1593 ;; `org-export-date-timestamp-format'.
1596 (let ((org-export-date-timestamp-format "%d %m %Y"))
1597 (org-test-with-parsed-data "#+DATE: <2012-03-29 Thu>"
1598 (org-export-get-date info
"%d %m"))))))
1604 (ert-deftest test-org-export
/get-coderef-format
()
1605 "Test `org-export-get-coderef-format' specifications."
1606 ;; A link without description returns "%s"
1607 (should (equal (org-export-get-coderef-format "(ref:line)" nil
)
1609 ;; Return "%s" when path is matched within description.
1610 (should (equal (org-export-get-coderef-format "path" "desc (path)")
1612 ;; Otherwise return description.
1613 (should (equal (org-export-get-coderef-format "path" "desc")
1616 (ert-deftest test-org-export
/inline-image-p
()
1617 "Test `org-export-inline-image-p' specifications."
1619 (org-export-inline-image-p
1620 (org-test-with-temp-text "[[#id]]"
1621 (org-element-map (org-element-parse-buffer) 'link
'identity nil t
))
1622 '(("custom-id" .
"id")))))
1624 (ert-deftest test-org-export
/fuzzy-link
()
1625 "Test fuzzy links specifications."
1626 ;; Link to an headline should return headline's number.
1627 (org-test-with-parsed-data
1628 "Paragraph.\n* Head1\n* Head2\n* Head3\n[[Head2]]"
1630 ;; Note: Headline's number is in fact a list of numbers.
1632 (org-element-map tree
'link
1634 (org-export-get-ordinal
1635 (org-export-resolve-fuzzy-link link info
) info
)) info t
))))
1636 ;; Link to a target in an item should return item's number.
1637 (org-test-with-parsed-data
1638 "- Item1\n - Item11\n - <<test>>Item12\n- Item2\n\n\n[[test]]"
1640 ;; Note: Item's number is in fact a list of numbers.
1642 (org-element-map tree
'link
1644 (org-export-get-ordinal
1645 (org-export-resolve-fuzzy-link link info
) info
)) info t
))))
1646 ;; Link to a target in a footnote should return footnote's number.
1647 (org-test-with-parsed-data "
1648 Paragraph[1][2][fn:lbl3:C<<target>>][[test]][[target]]\n[1] A\n\n[2] <<test>>B"
1651 (org-element-map tree
'link
1653 (org-export-get-ordinal
1654 (org-export-resolve-fuzzy-link link info
) info
)) info
))))
1655 ;; Link to a named element should return sequence number of that
1657 (org-test-with-parsed-data
1658 "#+NAME: tbl1\n|1|2|\n#+NAME: tbl2\n|3|4|\n#+NAME: tbl3\n|5|6|\n[[tbl2]]"
1661 (org-element-map tree
'link
1663 (org-export-get-ordinal
1664 (org-export-resolve-fuzzy-link link info
) info
)) info t
))))
1665 ;; Link to a target not within an item, a table, a footnote
1666 ;; reference or definition should return section number.
1667 (org-test-with-parsed-data
1668 "* Head1\n* Head2\nParagraph<<target>>\n* Head3\n[[target]]"
1671 (org-element-map tree
'link
1673 (org-export-get-ordinal
1674 (org-export-resolve-fuzzy-link link info
) info
)) info t
))))
1675 ;; Space are not significant when matching a fuzzy link.
1677 (org-test-with-parsed-data "* Head 1\n[[Head\n 1]]"
1678 (org-element-map tree
'link
1679 (lambda (link) (org-export-resolve-fuzzy-link link info
))
1681 ;; Statistics cookies are ignored for headline match.
1683 (org-test-with-parsed-data "* Head [0/0]\n[[Head]]"
1684 (org-element-map tree
'link
1685 (lambda (link) (org-export-resolve-fuzzy-link link info
))
1688 (org-test-with-parsed-data "* Head [100%]\n[[Head]]"
1689 (org-element-map tree
'link
1690 (lambda (link) (org-export-resolve-fuzzy-link link info
))
1692 ;; Headline match is position dependent.
1696 (org-test-with-parsed-data "* H1\n[[*H1]]\n* H1\n[[*H1]]"
1697 (org-element-map tree
'link
1698 (lambda (link) (org-export-resolve-fuzzy-link link info
)) info
)))))
1700 (ert-deftest test-org-export
/resolve-coderef
()
1701 "Test `org-export-resolve-coderef' specifications."
1702 (let ((org-coderef-label-format "(ref:%s)"))
1703 ;; 1. A link to a "-n -k -r" block returns line number.
1704 (org-test-with-parsed-data
1705 "#+BEGIN_EXAMPLE -n -k -r\nText (ref:coderef)\n#+END_EXAMPLE"
1706 (should (= (org-export-resolve-coderef "coderef" info
) 1)))
1707 (org-test-with-parsed-data
1708 "#+BEGIN_SRC emacs-lisp -n -k -r\n(+ 1 1) (ref:coderef)\n#+END_SRC"
1709 (should (= (org-export-resolve-coderef "coderef" info
) 1)))
1710 ;; 2. A link to a "-n -r" block returns line number.
1711 (org-test-with-parsed-data
1712 "#+BEGIN_EXAMPLE -n -r\nText (ref:coderef)\n#+END_EXAMPLE"
1713 (should (= (org-export-resolve-coderef "coderef" info
) 1)))
1714 (org-test-with-parsed-data
1715 "#+BEGIN_SRC emacs-lisp -n -r\n(+ 1 1) (ref:coderef)\n#+END_SRC"
1716 (should (= (org-export-resolve-coderef "coderef" info
) 1)))
1717 ;; 3. A link to a "-n" block returns coderef.
1718 (org-test-with-parsed-data
1719 "#+BEGIN_SRC emacs-lisp -n\n(+ 1 1) (ref:coderef)\n#+END_SRC"
1720 (should (equal (org-export-resolve-coderef "coderef" info
) "coderef")))
1721 (org-test-with-parsed-data
1722 "#+BEGIN_EXAMPLE -n\nText (ref:coderef)\n#+END_EXAMPLE"
1723 (should (equal (org-export-resolve-coderef "coderef" info
) "coderef")))
1724 ;; 4. A link to a "-r" block returns line number.
1725 (org-test-with-parsed-data
1726 "#+BEGIN_SRC emacs-lisp -r\n(+ 1 1) (ref:coderef)\n#+END_SRC"
1727 (should (= (org-export-resolve-coderef "coderef" info
) 1)))
1728 (org-test-with-parsed-data
1729 "#+BEGIN_EXAMPLE -r\nText (ref:coderef)\n#+END_EXAMPLE"
1730 (should (= (org-export-resolve-coderef "coderef" info
) 1)))
1731 ;; 5. A link to a block without a switch returns coderef.
1732 (org-test-with-parsed-data
1733 "#+BEGIN_SRC emacs-lisp\n(+ 1 1) (ref:coderef)\n#+END_SRC"
1734 (should (equal (org-export-resolve-coderef "coderef" info
) "coderef")))
1735 (org-test-with-parsed-data
1736 "#+BEGIN_EXAMPLE\nText (ref:coderef)\n#+END_EXAMPLE"
1737 (should (equal (org-export-resolve-coderef "coderef" info
) "coderef")))
1738 ;; 6. Correctly handle continued line numbers. A "+n" switch
1739 ;; should resume numbering from previous block with numbered
1740 ;; lines, ignoring blocks not numbering lines in the process.
1741 ;; A "-n" switch resets count.
1742 (org-test-with-parsed-data "
1747 #+BEGIN_SRC emacs-lisp
1751 #+BEGIN_SRC emacs-lisp +n -r
1752 \(+ 1 1) (ref:addition)
1755 #+BEGIN_EXAMPLE -n -r
1756 Another text. (ref:text)
1758 (should (= (org-export-resolve-coderef "addition" info
) 2))
1759 (should (= (org-export-resolve-coderef "text" info
) 1)))
1760 ;; 7. Recognize coderef with user-specified syntax.
1761 (org-test-with-parsed-data
1762 "#+BEGIN_EXAMPLE -l \"[ref:%s]\"\nText. [ref:text]\n#+END_EXAMPLE"
1763 (should (equal (org-export-resolve-coderef "text" info
) "text")))))
1765 (ert-deftest test-org-export
/resolve-fuzzy-link
()
1766 "Test `org-export-resolve-fuzzy-link' specifications."
1767 ;; Match target objects.
1769 (org-test-with-parsed-data "<<target>> [[target]]"
1770 (org-export-resolve-fuzzy-link
1771 (org-element-map tree
'link
'identity info t
) info
)))
1772 ;; Match named elements.
1774 (org-test-with-parsed-data "#+NAME: target\nParagraph\n\n[[target]]"
1775 (org-export-resolve-fuzzy-link
1776 (org-element-map tree
'link
'identity info t
) info
)))
1777 ;; Match exact headline's name.
1779 (org-test-with-parsed-data "* My headline\n[[My headline]]"
1780 (org-export-resolve-fuzzy-link
1781 (org-element-map tree
'link
'identity info t
) info
)))
1782 ;; Targets objects have priority over named elements and headline
1786 (org-test-with-parsed-data
1787 "* target\n#+NAME: target\n<<target>>\n\n[[target]]"
1789 (org-export-resolve-fuzzy-link
1790 (org-element-map tree
'link
'identity info t
) info
)))))
1791 ;; Named elements have priority over headline titles.
1794 (org-test-with-parsed-data
1795 "* target\n#+NAME: target\nParagraph\n\n[[target]]"
1797 (org-export-resolve-fuzzy-link
1798 (org-element-map tree
'link
'identity info t
) info
)))))
1799 ;; If link's path starts with a "*", only match headline titles,
1803 (org-test-with-parsed-data
1804 "* target\n#+NAME: target\n<<target>>\n\n[[*target]]"
1806 (org-export-resolve-fuzzy-link
1807 (org-element-map tree
'link
'identity info t
) info
)))))
1808 ;; Return nil if no match.
1810 (org-test-with-parsed-data "[[target]]"
1811 (org-export-resolve-fuzzy-link
1812 (org-element-map tree
'link
'identity info t
) info
)))
1813 ;; Match fuzzy link even when before first headline.
1816 (org-test-with-parsed-data "[[hl]]\n* hl"
1818 (org-export-resolve-fuzzy-link
1819 (org-element-map tree
'link
'identity info t
) info
))))))
1821 (ert-deftest test-org-export
/resolve-id-link
()
1822 "Test `org-export-resolve-id-link' specifications."
1823 ;; 1. Regular test for custom-id link.
1824 (org-test-with-parsed-data "* Headline1
1831 (org-export-resolve-id-link
1832 (org-element-map tree
'link
'identity info t
) info
)))
1833 ;; 2. Failing test for custom-id link.
1834 (org-test-with-parsed-data "* Headline1
1841 (org-export-resolve-id-link
1842 (org-element-map tree
'link
'identity info t
) info
)))
1843 ;; 3. Test for internal id target.
1844 (org-test-with-parsed-data "* Headline1
1851 (org-export-resolve-id-link
1852 (org-element-map tree
'link
'identity info t
) info
)))
1853 ;; 4. Test for external id target.
1854 (org-test-with-parsed-data "[[id:aaaa]]"
1856 (org-export-resolve-id-link
1857 (org-element-map tree
'link
'identity info t
)
1858 (org-combine-plists info
'(:id-alist
(("aaaa" .
"external-file"))))))))
1860 (ert-deftest test-org-export
/resolve-radio-link
()
1861 "Test `org-export-resolve-radio-link' specifications."
1864 (org-test-with-temp-text "<<<radio>>> radio"
1865 (org-update-radio-target-regexp)
1866 (let* ((tree (org-element-parse-buffer))
1867 (info `(:parse-tree
,tree
)))
1868 (org-export-resolve-radio-link
1869 (org-element-map tree
'link
'identity info t
)
1871 ;; Radio targets are case-insensitive.
1873 (org-test-with-temp-text "<<<RADIO>>> radio"
1874 (org-update-radio-target-regexp)
1875 (let* ((tree (org-element-parse-buffer))
1876 (info `(:parse-tree
,tree
)))
1877 (org-export-resolve-radio-link
1878 (org-element-map tree
'link
'identity info t
)
1880 ;; Radio target with objects.
1882 (org-test-with-temp-text "<<<radio \\alpha>>> radio \\alpha"
1883 (org-update-radio-target-regexp)
1884 (let* ((tree (org-element-parse-buffer))
1885 (info `(:parse-tree
,tree
)))
1886 (org-export-resolve-radio-link
1887 (org-element-map tree
'link
'identity info t
)
1889 ;; Multiple radio targets.
1891 (equal '("radio1" "radio2")
1892 (org-test-with-temp-text "<<<radio1>>> <<<radio2>>> radio1 radio2"
1893 (org-update-radio-target-regexp)
1894 (let* ((tree (org-element-parse-buffer))
1895 (info `(:parse-tree
,tree
)))
1896 (org-element-map tree
'link
1898 (org-element-property
1899 :value
(org-export-resolve-radio-link link info
)))
1901 ;; Radio target is whitespace insensitive.
1903 (org-test-with-temp-text "<<<a radio>>> a\n radio"
1904 (org-update-radio-target-regexp)
1905 (let* ((tree (org-element-parse-buffer))
1906 (info `(:parse-tree
,tree
)))
1907 (org-element-map tree
'link
1908 (lambda (link) (org-export-resolve-radio-link link info
)) info t
)))))
1912 ;;; Src-block and example-block
1914 (ert-deftest test-org-export
/unravel-code
()
1915 "Test `org-export-unravel-code' function."
1916 ;; Code without reference.
1918 (equal '("(+ 1 1)\n")
1919 (org-test-with-temp-text "#+BEGIN_EXAMPLE\n(+ 1 1)\n#+END_EXAMPLE"
1920 (org-export-unravel-code (org-element-at-point)))))
1921 ;; Code with reference.
1923 (equal '("(+ 1 1)\n" (1 .
"test"))
1924 (org-test-with-temp-text
1925 "#+BEGIN_EXAMPLE\n(+ 1 1) (ref:test)\n#+END_EXAMPLE"
1926 (let ((org-coderef-label-format "(ref:%s)"))
1927 (org-export-unravel-code (org-element-at-point))))))
1928 ;; Code with user-defined reference.
1931 '("(+ 1 1)\n" (1 .
"test"))
1932 (org-test-with-temp-text
1933 "#+BEGIN_EXAMPLE -l \"[ref:%s]\"\n(+ 1 1) [ref:test]\n#+END_EXAMPLE"
1934 (let ((org-coderef-label-format "(ref:%s)"))
1935 (org-export-unravel-code (org-element-at-point))))))
1936 ;; Code references keys are relative to the current block.
1938 (equal '("(+ 2 2)\n(+ 3 3)\n" (2 .
"one"))
1939 (org-test-with-temp-text "
1948 (let ((org-coderef-label-format "(ref:%s)"))
1949 (org-export-unravel-code (org-element-at-point)))))))
1951 (ert-deftest test-org-export
/format-code-default
()
1952 "Test `org-export-format-code-default' specifications."
1953 ;; Return the empty string when code is empty.
1956 (org-test-with-parsed-data "#+BEGIN_SRC emacs-lisp\n\n\n#+END_SRC"
1957 (org-export-format-code-default
1958 (org-element-map tree
'src-block
'identity info t
) info
))))
1959 ;; Number lines, two whitespace characters before the actual loc.
1962 (org-test-with-parsed-data
1963 "#+BEGIN_SRC emacs-lisp +n\na\nb\n#+END_SRC"
1964 (org-export-format-code-default
1965 (org-element-map tree
'src-block
'identity info t
) info
))))
1966 ;; Put references 6 whitespace characters after the widest line,
1967 ;; wrapped within parenthesis.
1969 (equal "123 (a)\n1 (b)\n"
1970 (let ((org-coderef-label-format "(ref:%s)"))
1971 (org-test-with-parsed-data
1972 "#+BEGIN_SRC emacs-lisp\n123 (ref:a)\n1 (ref:b)\n#+END_SRC"
1973 (org-export-format-code-default
1974 (org-element-map tree
'src-block
'identity info t
) info
))))))
1980 (ert-deftest test-org-export
/activate-smart-quotes
()
1981 "Test `org-export-activate-smart-quotes' specifications."
1982 ;; Opening double quotes: standard test.
1985 '("some “paragraph")
1986 (let ((org-export-default-language "en"))
1987 (org-test-with-parsed-data "some \"paragraph"
1988 (org-element-map tree
'plain-text
1989 (lambda (s) (org-export-activate-smart-quotes s
:html info
))
1991 ;; Opening quotes: at the beginning of a paragraph.
1995 (let ((org-export-default-language "en"))
1996 (org-test-with-parsed-data "\"begin"
1997 (org-element-map tree
'plain-text
1998 (lambda (s) (org-export-activate-smart-quotes s
:html info
))
2000 ;; Opening quotes: after an object.
2004 (let ((org-export-default-language "en"))
2005 (org-test-with-parsed-data "=verb= \"begin"
2006 (org-element-map tree
'plain-text
2007 (lambda (s) (org-export-activate-smart-quotes s
:html info
))
2009 ;; Closing quotes: standard test.
2012 '("some” paragraph")
2013 (let ((org-export-default-language "en"))
2014 (org-test-with-parsed-data "some\" paragraph"
2015 (org-element-map tree
'plain-text
2016 (lambda (s) (org-export-activate-smart-quotes s
:html info
))
2018 ;; Closing quotes: at the end of a paragraph.
2022 (let ((org-export-default-language "en"))
2023 (org-test-with-parsed-data "end\""
2024 (org-element-map tree
'plain-text
2025 (lambda (s) (org-export-activate-smart-quotes s
:html info
))
2027 ;; Apostrophe: standard test.
2030 '("It shouldn’t fail")
2031 (let ((org-export-default-language "en"))
2032 (org-test-with-parsed-data "It shouldn't fail"
2033 (org-element-map tree
'plain-text
2034 (lambda (s) (org-export-activate-smart-quotes s
:html info
))
2036 ;; Apostrophe: before an object.
2040 (let ((org-export-default-language "en"))
2041 (org-test-with-parsed-data "a'=b="
2042 (org-element-map tree
'plain-text
2043 (lambda (s) (org-export-activate-smart-quotes s
:html info
))
2045 ;; Apostrophe: after an object.
2049 (let ((org-export-default-language "en"))
2050 (org-test-with-parsed-data "=code='s"
2051 (org-element-map tree
'plain-text
2052 (lambda (s) (org-export-activate-smart-quotes s
:html info
))
2054 ;; Special case: isolated quotes.
2056 (equal '("“" "”")
2057 (let ((org-export-default-language "en"))
2058 (org-test-with-parsed-data "\"$x$\""
2059 (org-element-map tree
'plain-text
2060 (lambda (s) (org-export-activate-smart-quotes s
:html info
))
2062 ;; Smart quotes in secondary strings.
2064 (equal '("“" "”")
2065 (let ((org-export-default-language "en"))
2066 (org-test-with-parsed-data "* \"$x$\""
2067 (org-element-map tree
'plain-text
2068 (lambda (s) (org-export-activate-smart-quotes s
:html info
))
2070 ;; Smart quotes in document keywords.
2072 (equal '("“" "”")
2073 (let ((org-export-default-language "en"))
2074 (org-test-with-parsed-data "#+TITLE: \"$x$\""
2075 (org-element-map (plist-get info
:title
) 'plain-text
2076 (lambda (s) (org-export-activate-smart-quotes s
:html info
))
2078 ;; Smart quotes in parsed affiliated keywords.
2080 (equal '("“" "”" "Paragraph")
2081 (let ((org-export-default-language "en"))
2082 (org-test-with-parsed-data "#+CAPTION: \"$x$\"\nParagraph"
2083 (org-element-map tree
'plain-text
2084 (lambda (s) (org-export-activate-smart-quotes s
:html info
))
2085 info nil nil t
))))))
2091 (ert-deftest test-org-export
/special-column
()
2092 "Test if the table's special column is properly recognized."
2093 ;; 1. First column is special if it contains only a special marking
2094 ;; characters or empty cells.
2095 (org-test-with-temp-text "
2099 (org-export-table-has-special-column-p
2101 (org-element-parse-buffer) 'table
'identity nil
'first-match
))))
2102 ;; 2. If the column contains anything else, it isn't special.
2103 (org-test-with-temp-text "
2107 (org-export-table-has-special-column-p
2109 (org-element-parse-buffer) 'table
'identity nil
'first-match
))))
2110 ;; 3. Special marking characters are "#", "^", "*", "_", "/", "$"
2112 (org-test-with-temp-text "
2121 (org-export-table-has-special-column-p
2123 (org-element-parse-buffer) 'table
'identity nil
'first-match
))))
2124 ;; 4. A first column with only empty cells isn't considered as
2126 (org-test-with-temp-text "
2130 (org-export-table-has-special-column-p
2132 (org-element-parse-buffer) 'table
'identity nil
'first-match
)))))
2134 (ert-deftest test-org-export
/table-row-is-special-p
()
2135 "Test `org-export-table-row-is-special-p' specifications."
2136 ;; 1. A row is special if it has a special marking character in the
2138 (org-test-with-parsed-data "| ! | 1 |"
2140 (org-export-table-row-is-special-p
2141 (org-element-map tree
'table-row
'identity nil
'first-match
) info
)))
2142 ;; 2. A row is special when its first field is "/"
2143 (org-test-with-parsed-data "
2147 (org-export-table-row-is-special-p
2148 (org-element-map tree
'table-row
'identity nil
'first-match
) info
)))
2149 ;; 3. A row only containing alignment cookies is also considered as
2151 (org-test-with-parsed-data "| <5> | | <l> | <l22> |"
2153 (org-export-table-row-is-special-p
2154 (org-element-map tree
'table-row
'identity nil
'first-match
) info
)))
2155 ;; 4. Everything else isn't considered as special.
2156 (org-test-with-parsed-data "| \alpha | | c |"
2158 (org-export-table-row-is-special-p
2159 (org-element-map tree
'table-row
'identity nil
'first-match
) info
)))
2160 ;; 5. Table's rules are never considered as special rows.
2161 (org-test-with-parsed-data "|---+---|"
2163 (org-export-table-row-is-special-p
2164 (org-element-map tree
'table-row
'identity nil
'first-match
) info
))))
2166 (ert-deftest test-org-export
/has-header-p
()
2167 "Test `org-export-table-has-header-p' specifications."
2168 ;; 1. With an header.
2169 (org-test-with-parsed-data "
2174 (org-export-table-has-header-p
2175 (org-element-map tree
'table
'identity info
'first-match
)
2177 ;; 2. Without an header.
2178 (org-test-with-parsed-data "
2182 (org-export-table-has-header-p
2183 (org-element-map tree
'table
'identity info
'first-match
)
2185 ;; 3. Don't get fooled with starting and ending rules.
2186 (org-test-with-parsed-data "
2192 (org-export-table-has-header-p
2193 (org-element-map tree
'table
'identity info
'first-match
)
2196 (ert-deftest test-org-export
/table-row-group
()
2197 "Test `org-export-table-row-group' specifications."
2198 ;; 1. A rule creates a new group.
2201 (org-test-with-parsed-data "
2205 (org-element-map tree
'table-row
2207 (if (eq (org-element-property :type row
) 'rule
) 'rule
2208 (org-export-table-row-group row info
)))))))
2209 ;; 2. Special rows are ignored in count.
2213 (org-test-with-parsed-data "
2217 (org-element-map tree
'table-row
2219 (if (eq (org-element-property :type row
) 'rule
) 'rule
2220 (org-export-table-row-group row info
)))
2222 ;; 3. Double rules also are ignored in count.
2224 (equal '(1 rule rule
2)
2225 (org-test-with-parsed-data "
2230 (org-element-map tree
'table-row
2232 (if (eq (org-element-property :type row
) 'rule
) 'rule
2233 (org-export-table-row-group row info
))))))))
2235 (ert-deftest test-org-export
/table-row-number
()
2236 "Test `org-export-table-row-number' specifications."
2237 ;; Standard test. Number is 0-indexed.
2240 (org-test-with-parsed-data "| a | b | c |\n| d | e | f |"
2241 (org-element-map tree
'table-row
2242 (lambda (row) (org-export-table-row-number row info
)) info
))))
2243 ;; Number ignores separators.
2246 (org-test-with-parsed-data "
2250 (org-element-map tree
'table-row
2251 (lambda (row) (org-export-table-row-number row info
)) info
))))
2252 ;; Number ignores special rows.
2255 (org-test-with-parsed-data "
2261 (org-element-map tree
'table-row
2262 (lambda (row) (org-export-table-row-number row info
)) info
)))))
2264 (ert-deftest test-org-export
/table-cell-width
()
2265 "Test `org-export-table-cell-width' specifications."
2266 ;; 1. Width is primarily determined by width cookies. If no cookie
2267 ;; is found, cell's width is nil.
2268 (org-test-with-parsed-data "
2269 | / | <l> | <6> | <l7> |
2274 (mapcar (lambda (cell) (org-export-table-cell-width cell info
))
2275 (org-element-map tree
'table-cell
'identity info
)))))
2276 ;; 2. The last width cookie has precedence.
2277 (org-test-with-parsed-data "
2284 (mapcar (lambda (cell) (org-export-table-cell-width cell info
))
2285 (org-element-map tree
'table-cell
'identity info
)))))
2286 ;; 3. Valid width cookies must have a specific row.
2287 (org-test-with-parsed-data "| <6> | cell |"
2291 (mapcar (lambda (cell) (org-export-table-cell-width cell info
))
2292 (org-element-map tree
'table-cell
'identity
))))))
2294 (ert-deftest test-org-export
/table-cell-alignment
()
2295 "Test `org-export-table-cell-alignment' specifications."
2296 ;; 1. Alignment is primarily determined by alignment cookies.
2298 (equal '(left center right
)
2299 (let ((org-table-number-fraction 0.5)
2300 (org-table-number-regexp "^[0-9]+$"))
2301 (org-test-with-parsed-data "| <l> | <c> | <r> |"
2302 (mapcar (lambda (cell)
2303 (org-export-table-cell-alignment cell info
))
2304 (org-element-map tree
'table-cell
'identity
))))))
2305 ;; 2. The last alignment cookie has precedence.
2307 (equal '(right right right
)
2308 (org-test-with-parsed-data "
2312 (mapcar (lambda (cell) (org-export-table-cell-alignment cell info
))
2313 (org-element-map tree
'table-cell
'identity
)))))
2314 ;; 3. If there's no cookie, cell's contents determine alignment.
2315 ;; A column mostly made of cells containing numbers will align
2316 ;; its cells to the right.
2318 (equal '(right right right
)
2319 (let ((org-table-number-fraction 0.5)
2320 (org-table-number-regexp "^[0-9]+$"))
2321 (org-test-with-parsed-data "
2325 (mapcar (lambda (cell)
2326 (org-export-table-cell-alignment cell info
))
2327 (org-element-map tree
'table-cell
'identity
))))))
2328 ;; 4. Otherwise, they will be aligned to the left.
2330 (equal '(left left left
)
2331 (org-test-with-parsed-data "
2335 (mapcar (lambda (cell)
2336 (org-export-table-cell-alignment cell info
))
2337 (org-element-map tree
'table-cell
'identity info
))))))
2339 (ert-deftest test-org-export
/table-cell-borders
()
2340 "Test `org-export-table-cell-borders' specifications."
2341 ;; 1. Recognize various column groups indicators.
2342 (org-test-with-parsed-data "| / | < | > | <> |"
2345 '((right bottom top
) (left bottom top
) (right bottom top
)
2346 (right left bottom top
))
2347 (mapcar (lambda (cell)
2348 (org-export-table-cell-borders cell info
))
2349 (org-element-map tree
'table-cell
'identity
)))))
2350 ;; 2. Accept shortcuts to define column groups.
2351 (org-test-with-parsed-data "| / | < | < |"
2354 '((right bottom top
) (right left bottom top
) (left bottom top
))
2355 (mapcar (lambda (cell)
2356 (org-export-table-cell-borders cell info
))
2357 (org-element-map tree
'table-cell
'identity
)))))
2358 ;; 3. A valid column groups row must start with a "/".
2359 (org-test-with-parsed-data "
2363 (equal '((top) (top) (bottom) (bottom))
2364 (mapcar (lambda (cell)
2365 (org-export-table-cell-borders cell info
))
2366 (org-element-map tree
'table-cell
'identity
)))))
2367 ;; 4. Take table rules into consideration.
2368 (org-test-with-parsed-data "
2373 (equal '((below top
) (bottom above
))
2374 (mapcar (lambda (cell)
2375 (org-export-table-cell-borders cell info
))
2376 (org-element-map tree
'table-cell
'identity
)))))
2377 ;; 5. Top and (resp. bottom) rules induce both `top' and `above'
2378 ;; (resp. `bottom' and `below') borders. Any special row is
2380 (org-test-with-parsed-data "
2386 (equal '((bottom below top above
))
2388 (mapcar (lambda (cell)
2389 (org-export-table-cell-borders cell info
))
2390 (org-element-map tree
'table-cell
'identity
)))))))
2392 (ert-deftest test-org-export
/table-dimensions
()
2393 "Test `org-export-table-dimensions' specifications."
2394 ;; 1. Standard test.
2395 (org-test-with-parsed-data "
2400 (org-export-table-dimensions
2401 (org-element-map tree
'table
'identity info
'first-match
) info
))))
2402 ;; 2. Ignore horizontal rules and special columns.
2403 (org-test-with-parsed-data "
2410 (org-export-table-dimensions
2411 (org-element-map tree
'table
'identity info
'first-match
) info
)))))
2413 (ert-deftest test-org-export
/table-cell-address
()
2414 "Test `org-export-table-cell-address' specifications."
2415 ;; 1. Standard test: index is 0-based.
2416 (org-test-with-parsed-data "| a | b |"
2418 (equal '((0 .
0) (0 .
1))
2419 (org-element-map tree
'table-cell
2420 (lambda (cell) (org-export-table-cell-address cell info
))
2422 ;; 2. Special column isn't counted, nor are special rows.
2423 (org-test-with-parsed-data "
2428 (org-export-table-cell-address
2429 (car (last (org-element-map tree
'table-cell
'identity info
)))
2431 ;; 3. Tables rules do not count either.
2432 (org-test-with-parsed-data "
2440 (org-export-table-cell-address
2441 (car (last (org-element-map tree
'table-cell
'identity info
)))
2443 ;; 4. Return nil for special cells.
2444 (org-test-with-parsed-data "| / | a |"
2446 (org-export-table-cell-address
2447 (org-element-map tree
'table-cell
'identity nil
'first-match
)
2450 (ert-deftest test-org-export
/get-table-cell-at
()
2451 "Test `org-export-get-table-cell-at' specifications."
2452 ;; 1. Address ignores special columns, special rows and rules.
2453 (org-test-with-parsed-data "
2460 (org-element-contents
2461 (org-export-get-table-cell-at
2463 (org-element-map tree
'table
'identity info
'first-match
)
2465 ;; 2. Return value for a non-existent address is nil.
2466 (org-test-with-parsed-data "| a |"
2468 (org-export-get-table-cell-at
2470 (org-element-map tree
'table
'identity info
'first-match
)
2472 (org-test-with-parsed-data "| / |"
2474 (org-export-get-table-cell-at
2476 (org-element-map tree
'table
'identity info
'first-match
)
2479 (ert-deftest test-org-export
/table-cell-starts-colgroup-p
()
2480 "Test `org-export-table-cell-starts-colgroup-p' specifications."
2481 ;; 1. A cell at a beginning of a row always starts a column group.
2482 (org-test-with-parsed-data "| a |"
2484 (org-export-table-cell-starts-colgroup-p
2485 (org-element-map tree
'table-cell
'identity info
'first-match
)
2487 ;; 2. Special column should be ignored when determining the
2488 ;; beginning of the row.
2489 (org-test-with-parsed-data "
2493 (org-export-table-cell-starts-colgroup-p
2494 (org-element-map tree
'table-cell
'identity info
'first-match
)
2496 ;; 2. Explicit column groups.
2497 (org-test-with-parsed-data "
2503 (org-element-map tree
'table-cell
2505 (if (org-export-table-cell-starts-colgroup-p cell info
) 'yes
'no
))
2508 (ert-deftest test-org-export
/table-cell-ends-colgroup-p
()
2509 "Test `org-export-table-cell-ends-colgroup-p' specifications."
2510 ;; 1. A cell at the end of a row always ends a column group.
2511 (org-test-with-parsed-data "| a |"
2513 (org-export-table-cell-ends-colgroup-p
2514 (org-element-map tree
'table-cell
'identity info
'first-match
)
2516 ;; 2. Special column should be ignored when determining the
2517 ;; beginning of the row.
2518 (org-test-with-parsed-data "
2522 (org-export-table-cell-ends-colgroup-p
2523 (org-element-map tree
'table-cell
'identity info
'first-match
)
2525 ;; 3. Explicit column groups.
2526 (org-test-with-parsed-data "
2532 (org-element-map tree
'table-cell
2534 (if (org-export-table-cell-ends-colgroup-p cell info
) 'yes
'no
))
2537 (ert-deftest test-org-export
/table-row-starts-rowgroup-p
()
2538 "Test `org-export-table-row-starts-rowgroup-p' specifications."
2539 ;; 1. A row at the beginning of a table always starts a row group.
2540 ;; So does a row following a table rule.
2541 (org-test-with-parsed-data "
2548 (org-element-map tree
'table-row
2550 (if (org-export-table-row-starts-rowgroup-p row info
) 'yes
'no
))
2552 ;; 2. Special rows should be ignored when determining the beginning
2554 (org-test-with-parsed-data "
2563 (org-element-map tree
'table-row
2565 (if (org-export-table-row-starts-rowgroup-p row info
) 'yes
'no
))
2568 (ert-deftest test-org-export
/table-row-ends-rowgroup-p
()
2569 "Test `org-export-table-row-ends-rowgroup-p' specifications."
2570 ;; 1. A row at the end of a table always ends a row group. So does
2571 ;; a row preceding a table rule.
2572 (org-test-with-parsed-data "
2579 (org-element-map tree
'table-row
2581 (if (org-export-table-row-ends-rowgroup-p row info
) 'yes
'no
))
2583 ;; 2. Special rows should be ignored when determining the beginning
2585 (org-test-with-parsed-data "
2594 (org-element-map tree
'table-row
2596 (if (org-export-table-row-ends-rowgroup-p row info
) 'yes
'no
))
2599 (ert-deftest test-org-export
/table-row-starts-header-p
()
2600 "Test `org-export-table-row-starts-header-p' specifications."
2601 ;; 1. Only the row starting the first row group starts the table
2603 (org-test-with-parsed-data "
2611 (org-element-map tree
'table-row
2613 (if (org-export-table-row-starts-header-p row info
) 'yes
'no
))
2615 ;; 2. A row cannot start an header if there's no header in the
2617 (org-test-with-parsed-data "
2621 (org-export-table-row-starts-header-p
2622 (org-element-map tree
'table-row
'identity info
'first-match
)
2625 (ert-deftest test-org-export
/table-row-ends-header-p
()
2626 "Test `org-export-table-row-ends-header-p' specifications."
2627 ;; 1. Only the row starting the first row group starts the table
2629 (org-test-with-parsed-data "
2637 (org-element-map tree
'table-row
2639 (if (org-export-table-row-ends-header-p row info
) 'yes
'no
))
2641 ;; 2. A row cannot start an header if there's no header in the
2643 (org-test-with-parsed-data "
2647 (org-export-table-row-ends-header-p
2648 (org-element-map tree
'table-row
'identity info
'first-match
)
2653 ;;; Tables of Contents
2655 (ert-deftest test-org-export
/collect-headlines
()
2656 "Test `org-export-collect-headlines' specifications."
2661 (org-test-with-parsed-data "* H1\n** H2"
2662 (org-export-collect-headlines info
)))))
2663 ;; Do not collect headlines below optional argument.
2667 (org-test-with-parsed-data "* H1\n** H2"
2668 (org-export-collect-headlines info
1)))))
2669 ;; Never collect headlines below maximum headline level.
2673 (org-test-with-parsed-data "#+OPTIONS: H:1\n* H1\n** H2"
2674 (org-export-collect-headlines info
)))))
2678 (org-test-with-parsed-data "#+OPTIONS: H:1\n* H1\n** H2"
2679 (org-export-collect-headlines info
2))))))
2685 (ert-deftest test-org-export
/inner-template
()
2686 "Test `inner-template' translator specifications."
2689 (org-test-with-temp-text "* Headline"
2691 (org-export-create-backend
2693 '((inner-template .
(lambda (contents info
) "Success!"))
2694 (headline .
(lambda (h c i
) "Headline"))))))))
2695 ;; Inner template is applied even in a "body-only" export.
2698 (org-test-with-temp-text "* Headline"
2700 (org-export-create-backend
2701 :transcoders
'((inner-template .
(lambda (c i
) "Success!"))
2702 (headline .
(lambda (h c i
) "Headline"))))
2703 nil nil
'body-only
)))))
2705 (ert-deftest test-org-export
/template
()
2706 "Test `template' translator specifications."
2709 (org-test-with-temp-text "* Headline"
2711 (org-export-create-backend
2712 :transcoders
'((template .
(lambda (contents info
) "Success!"))
2713 (headline .
(lambda (h c i
) "Headline"))))))))
2714 ;; Template is not applied in a "body-only" export.
2717 (org-test-with-temp-text "* Headline"
2719 (org-export-create-backend
2720 :transcoders
'((template .
(lambda (contents info
) "Success!"))
2721 (headline .
(lambda (h c i
) "Headline"))))
2722 nil nil
'body-only
)))))
2728 (ert-deftest test-org-export
/get-next-element
()
2729 "Test `org-export-get-next-element' specifications."
2733 (org-test-with-parsed-data "* Headline\n*a* b"
2734 (org-export-get-next-element
2735 (org-element-map tree
'bold
'identity info t
) info
))))
2736 ;; Return nil when no previous element.
2738 (org-test-with-parsed-data "* Headline\na *b*"
2739 (org-export-get-next-element
2740 (org-element-map tree
'bold
'identity info t
) info
)))
2741 ;; Non-exportable elements are ignored.
2743 (let ((org-export-with-timestamps nil
))
2744 (org-test-with-parsed-data "\alpha <2012-03-29 Thu>"
2745 (org-export-get-next-element
2746 (org-element-map tree
'entity
'identity info t
) info
))))
2747 ;; Find next element in secondary strings.
2750 (org-test-with-parsed-data "* a =verb="
2752 (org-export-get-next-element
2753 (org-element-map tree
'plain-text
'identity info t
) info
)))))
2756 (org-test-with-parsed-data "* /italic/ =verb="
2758 (org-export-get-next-element
2759 (org-element-map tree
'italic
'identity info t
) info
)))))
2760 ;; Find next element in document keywords.
2763 (org-test-with-parsed-data "#+TITLE: a =verb="
2765 (org-export-get-next-element
2767 (plist-get info
:title
) 'plain-text
'identity info t
) info
)))))
2768 ;; Find next element in parsed affiliated keywords.
2771 (org-test-with-parsed-data "#+CAPTION: a =verb=\nParagraph"
2773 (org-export-get-next-element
2774 (org-element-map tree
'plain-text
'identity info t nil t
) info
)))))
2775 ;; With optional argument N, return a list containing all the
2776 ;; following elements.
2779 '(bold code underline
)
2780 (org-test-with-parsed-data "_a_ /b/ *c* ~d~ _e_"
2782 (org-export-get-next-element
2783 (org-element-map tree
'italic
'identity info t
) info t
)))))
2784 ;; When N is a positive integer, return a list containing up to
2785 ;; N following elements.
2789 (org-test-with-parsed-data "_a_ /b/ *c* ~d~ _e_"
2791 (org-export-get-next-element
2792 (org-element-map tree
'italic
'identity info t
) info
2))))))
2794 (ert-deftest test-org-export
/get-previous-element
()
2795 "Test `org-export-get-previous-element' specifications."
2799 (org-test-with-parsed-data "* Headline\na *b*"
2800 (org-export-get-previous-element
2801 (org-element-map tree
'bold
'identity info t
) info
))))
2802 ;; Return nil when no previous element.
2804 (org-test-with-parsed-data "* Headline\n*a* b"
2805 (org-export-get-previous-element
2806 (org-element-map tree
'bold
'identity info t
) info
)))
2807 ;; Non-exportable elements are ignored.
2809 (let ((org-export-with-timestamps nil
))
2810 (org-test-with-parsed-data "<2012-03-29 Thu> \alpha"
2811 (org-export-get-previous-element
2812 (org-element-map tree
'entity
'identity info t
) info
))))
2813 ;; Find previous element in secondary strings.
2816 (org-test-with-parsed-data "* =verb= a"
2818 (org-export-get-previous-element
2819 (org-element-map tree
'plain-text
'identity info t
) info
)))))
2822 (org-test-with-parsed-data "* =verb= /italic/"
2824 (org-export-get-previous-element
2825 (org-element-map tree
'italic
'identity info t
) info
)))))
2826 ;; Find previous element in document keywords.
2829 (org-test-with-parsed-data "#+TITLE: =verb= a"
2831 (org-export-get-previous-element
2833 (plist-get info
:title
) 'plain-text
'identity info t
) info
)))))
2834 ;; Find previous element in parsed affiliated keywords.
2837 (org-test-with-parsed-data "#+CAPTION: =verb= a\nParagraph"
2839 (org-export-get-previous-element
2840 (org-element-map tree
'plain-text
'identity info t nil t
) info
)))))
2841 ;; With optional argument N, return a list containing up to
2842 ;; N previous elements.
2844 (equal '(underline italic bold
)
2845 (org-test-with-parsed-data "_a_ /b/ *c* ~d~"
2847 (org-export-get-previous-element
2848 (org-element-map tree
'code
'identity info t
) info t
)))))
2849 ;; When N is a positive integer, return a list containing up to
2850 ;; N previous elements.
2852 (equal '(italic bold
)
2853 (org-test-with-parsed-data "_a_ /b/ *c* ~d~"
2855 (org-export-get-previous-element
2856 (org-element-map tree
'code
'identity info t
) info
2))))))
2860 ;;; test-org-export.el end here