mirror of
https://github.com/jgm/pandoc.git
synced 2026-08-23 08:46:56 +00:00
Thanks and credit go to Aner Lucero, who laid the groundwork for this feature in the 2021 GSoC project. He contributed many changes, including modifications to the readers for HTML, JATS, and LaTeX, and to the HTML and JATS writers. Shared (Albert Krewinkel): - The new function `figureDiv`, exported from `Text.Pandoc.Shared`, offers a standardized way to convert a figure into a Div element. Readers (Aner Lucero): - HTML reader: `<figure>` elements are parsed as figures, with the caption taken from the respective `<figcaption>` elements. - JATS reader: The `<fig>` and `<caption>` elements are parsed into figure elements, even if the contents is more complex. - LaTeX reader: support for figures with non-image contents and for subfigures. - Markdown reader: paragraphs containing just an image are treated as figures if the `implicit_figures` extension is enabled. The identifier is used as the figure's identifier and the image description is also used as figure caption; all other attributes are treated as belonging to the image. Writers (Aner Lucero, Albert Krewinkel): - DokuWiki, Haddock, Jira, Man, MediaWiki, Ms, Muse, PPTX, RTF, TEI, ZimWiki writers: Figures are rendered like Div elements. - Asciidoc writer: The figure contents is unwrapped; each image in the the figure becomes a separate figure. - Classic custom writers: Figures are passed to the global function `Figure(caption, contents, attr)`, where `caption` and `contents` are strings and `attr` is a table of key-value pairs. - ConTeXt writer: Figures are wrapped in a "placefigure" environment with `\startplacefigure`/`\endplacefigure`, adding the features caption and listing title as properties. Subfigures are place in a single row with the `\startfloatcombination` environment. - DocBook writer: Uses `mediaobject` elements, unless the figure contains subfigures or tables, in which case the figure content is unwrapped. - Docx writer: figures with multiple content blocks are rendered as tables with style `FigureTable`; like before, single-image figures are still output as paragraphs with style `Figure` or `Captioned Figure`, depending on whether a caption is attached. - DokuWiki writer: Caption and "alt-text" are no longer combined. The alt text of a figure will now be lost in the conversion. - FB2 writer: The figure caption is added as alt text to the images in the figure; pre-existing alt texts are kept. - ICML writer: Only single-image figures are supported. The contents of figures with additional elements gets unwrapped. - HTML writer: the alt text is no longer constructed from the caption, as was the case with implicit figures. This reduces duplication, but comes at the risk of images that are missing alt texts. Authors should take care to provide alt texts for all images. Some readers, most notably the Markdown reader with the `implicit_figures` extension, add a caption that's identical to the image description. The writer checks for this and adds an `aria-hidden` attribute to the `<figcaption>` element in that case. - JATS writer: The `<fig>` and `<caption>` elements are used write figures. - LaTeX writer: complex figures, e.g. with non-image contents and subfigures, are supported. The `subfigure` template variable is set if the document contains subfigures, triggering the conditional loading of the *subcaption* package. Contants of figures that contain tables are become unwrapped, as longtable environments are not allowed within figures. - Markdown writer: figures are output as implicit figures if possible, via HTML if the `raw_html` extension is enabled, and as Div elements otherwise. - OpenDocument writer: A separate paragraph is generated for each block element in a figure, each with style `FigureWithCaption`. Behavior for single-image figures therefore remains unchanged. - Org writer: Only the first element in a figure is given a caption; additional block elements in the figure are appended without any caption being added. - RST writer: Single-image figures are supported as before; the contents of more complex images become nested in a container of type `float`. - Texinfo writer: Figures are rendered as float with type `figure`. - Textile writer: Figures are rendered with the help of HTML elements. - XWiki: Figures are placed in a group. Co-authored-by: Aner Lucero <4rgento@gmail.com>
721 lines
10 KiB
Plaintext
721 lines
10 KiB
Plaintext
#author John MacFarlane; Anonymous
|
||
#title Pandoc Test Suite
|
||
#date July 17, 2006
|
||
|
||
This is a set of tests for pandoc. Most of them are adapted from John Gruber’s
|
||
markdown test suite.
|
||
|
||
----
|
||
|
||
* Headers
|
||
|
||
** Level 2 with an [[/url][embedded link]]
|
||
|
||
*** Level 3 with *emphasis*
|
||
|
||
**** Level 4
|
||
|
||
***** Level 5
|
||
|
||
* Level 1
|
||
|
||
** Level 2 with *emphasis*
|
||
|
||
*** Level 3
|
||
|
||
with no blank line
|
||
|
||
** Level 2
|
||
|
||
with no blank line
|
||
|
||
----
|
||
|
||
* Paragraphs
|
||
|
||
Here’s a regular paragraph.
|
||
|
||
In Markdown 1.0.0 and earlier. Version 8. This line turns into a list item.
|
||
Because a hard-wrapped line in the middle of a paragraph looked like a list
|
||
item.
|
||
|
||
Here’s one with a bullet. <verbatim>*</verbatim> criminey.
|
||
|
||
There should be a hard line break<br>
|
||
here.
|
||
|
||
----
|
||
|
||
* Block Quotes
|
||
|
||
E-mail style:
|
||
|
||
<quote>
|
||
This is a block quote. It is pretty short.
|
||
</quote>
|
||
|
||
<quote>
|
||
Code in a block quote:
|
||
|
||
<example>
|
||
sub status {
|
||
print "working";
|
||
}
|
||
</example>
|
||
|
||
A list:
|
||
|
||
1. item one
|
||
2. item two
|
||
|
||
Nested block quotes:
|
||
|
||
<quote>
|
||
nested
|
||
</quote>
|
||
|
||
<quote>
|
||
nested
|
||
</quote>
|
||
</quote>
|
||
|
||
This should not be a block quote: 2 > 1.
|
||
|
||
And a following paragraph.
|
||
|
||
----
|
||
|
||
* Code Blocks
|
||
|
||
Code:
|
||
|
||
<example>
|
||
---- (should be four hyphens)
|
||
|
||
sub status {
|
||
print "working";
|
||
}
|
||
|
||
this code block is indented by one tab
|
||
</example>
|
||
|
||
And:
|
||
|
||
<example>
|
||
this code block is indented by two tabs
|
||
|
||
These should not be escaped: \$ \\ \> \[ \{
|
||
</example>
|
||
|
||
----
|
||
|
||
* Lists
|
||
|
||
** Unordered
|
||
|
||
Asterisks tight:
|
||
|
||
- asterisk 1
|
||
- asterisk 2
|
||
- asterisk 3
|
||
|
||
Asterisks loose:
|
||
|
||
- asterisk 1
|
||
- asterisk 2
|
||
- asterisk 3
|
||
|
||
Pluses tight:
|
||
|
||
- Plus 1
|
||
- Plus 2
|
||
- Plus 3
|
||
|
||
Pluses loose:
|
||
|
||
- Plus 1
|
||
- Plus 2
|
||
- Plus 3
|
||
|
||
Minuses tight:
|
||
|
||
- Minus 1
|
||
- Minus 2
|
||
- Minus 3
|
||
|
||
Minuses loose:
|
||
|
||
- Minus 1
|
||
- Minus 2
|
||
- Minus 3
|
||
|
||
** Ordered
|
||
|
||
Tight:
|
||
|
||
1. First
|
||
2. Second
|
||
3. Third
|
||
|
||
and:
|
||
|
||
1. One
|
||
2. Two
|
||
3. Three
|
||
|
||
Loose using tabs:
|
||
|
||
1. First
|
||
2. Second
|
||
3. Third
|
||
|
||
and using spaces:
|
||
|
||
1. One
|
||
2. Two
|
||
3. Three
|
||
|
||
Multiple paragraphs:
|
||
|
||
1. Item 1, graf one.
|
||
|
||
Item 1. graf two. The quick brown fox jumped over the lazy dog’s back.
|
||
2. Item 2.
|
||
3. Item 3.
|
||
|
||
** Nested
|
||
|
||
- Tab
|
||
- Tab
|
||
- Tab
|
||
|
||
Here’s another:
|
||
|
||
1. First
|
||
2. Second:
|
||
- Fee
|
||
- Fie
|
||
- Foe
|
||
3. Third
|
||
|
||
Same thing but with paragraphs:
|
||
|
||
1. First
|
||
2. Second:
|
||
|
||
- Fee
|
||
- Fie
|
||
- Foe
|
||
3. Third
|
||
|
||
** Tabs and spaces
|
||
|
||
- this is a list item indented with tabs
|
||
- this is a list item indented with spaces
|
||
|
||
- this is an example list item indented with tabs
|
||
- this is an example list item indented with spaces
|
||
|
||
** Fancy list markers
|
||
|
||
2. begins with 2
|
||
3. and now 3
|
||
|
||
with a continuation
|
||
|
||
iv. sublist with roman numerals, starting with 4
|
||
v. more items
|
||
A. a subsublist
|
||
B. a subsublist
|
||
|
||
Nesting:
|
||
|
||
A. Upper Alpha
|
||
I. Upper Roman.
|
||
6. Decimal start with 6
|
||
c. Lower alpha with paren
|
||
|
||
Autonumbering:
|
||
|
||
1. Autonumber.
|
||
2. More.
|
||
1. Nested.
|
||
|
||
Should not be a list item:
|
||
|
||
M.A. 2007
|
||
|
||
B. Williams
|
||
|
||
----
|
||
|
||
* Definition Lists
|
||
|
||
Tight using spaces:
|
||
|
||
apple :: red fruit
|
||
orange :: orange fruit
|
||
banana :: yellow fruit
|
||
|
||
Tight using tabs:
|
||
|
||
apple :: red fruit
|
||
orange :: orange fruit
|
||
banana :: yellow fruit
|
||
|
||
Loose:
|
||
|
||
apple :: red fruit
|
||
orange :: orange fruit
|
||
banana :: yellow fruit
|
||
|
||
Multiple blocks with italics:
|
||
|
||
*apple* :: red fruit
|
||
|
||
contains seeds, crisp, pleasant to taste
|
||
*orange* :: orange fruit
|
||
|
||
<example>
|
||
{ orange code block }
|
||
</example>
|
||
|
||
<quote>
|
||
orange block quote
|
||
</quote>
|
||
|
||
Multiple definitions, tight:
|
||
|
||
apple :: red fruit
|
||
:: computer
|
||
orange :: orange fruit
|
||
:: bank
|
||
|
||
Multiple definitions, loose:
|
||
|
||
apple :: red fruit
|
||
:: computer
|
||
orange :: orange fruit
|
||
:: bank
|
||
|
||
Blank line after term, indented marker, alternate markers:
|
||
|
||
apple :: red fruit
|
||
:: computer
|
||
orange :: orange fruit
|
||
|
||
1. sublist
|
||
2. sublist
|
||
|
||
* HTML Blocks
|
||
|
||
Simple block on one line:
|
||
|
||
foo
|
||
And nested without indentation:
|
||
|
||
foo
|
||
|
||
bar
|
||
Interpreted markdown in a table:
|
||
|
||
<literal style="html">
|
||
<table>
|
||
</literal>
|
||
|
||
<literal style="html">
|
||
<tr>
|
||
</literal>
|
||
|
||
<literal style="html">
|
||
<td>
|
||
</literal>
|
||
|
||
This is *emphasized*
|
||
|
||
<literal style="html">
|
||
</td>
|
||
</literal>
|
||
|
||
<literal style="html">
|
||
<td>
|
||
</literal>
|
||
|
||
And this is **strong**
|
||
|
||
<literal style="html">
|
||
</td>
|
||
</literal>
|
||
|
||
<literal style="html">
|
||
</tr>
|
||
</literal>
|
||
|
||
<literal style="html">
|
||
</table>
|
||
</literal>
|
||
|
||
<literal style="html">
|
||
<script type="text/javascript">document.write('This *should not* be interpreted as markdown');</script>
|
||
</literal>
|
||
|
||
Here’s a simple block:
|
||
|
||
foo
|
||
|
||
This should be a code block, though:
|
||
|
||
<example>
|
||
<div>
|
||
foo
|
||
</div>
|
||
</example>
|
||
|
||
As should this:
|
||
|
||
<example>
|
||
<div>foo</div>
|
||
</example>
|
||
|
||
Now, nested:
|
||
|
||
foo
|
||
This should just be an HTML comment:
|
||
|
||
<literal style="html">
|
||
<!-- Comment -->
|
||
</literal>
|
||
|
||
Multiline:
|
||
|
||
<literal style="html">
|
||
<!--
|
||
Blah
|
||
Blah
|
||
-->
|
||
</literal>
|
||
|
||
<literal style="html">
|
||
<!--
|
||
This is another comment.
|
||
-->
|
||
</literal>
|
||
|
||
Code block:
|
||
|
||
<example>
|
||
<!-- Comment -->
|
||
</example>
|
||
|
||
Just plain comment, with trailing spaces on the line:
|
||
|
||
<literal style="html">
|
||
<!-- foo -->
|
||
</literal>
|
||
|
||
Code:
|
||
|
||
<example>
|
||
<hr />
|
||
</example>
|
||
|
||
Hr’s:
|
||
|
||
<literal style="html">
|
||
<hr>
|
||
</literal>
|
||
|
||
<literal style="html">
|
||
<hr />
|
||
</literal>
|
||
|
||
<literal style="html">
|
||
<hr />
|
||
</literal>
|
||
|
||
<literal style="html">
|
||
<hr>
|
||
</literal>
|
||
|
||
<literal style="html">
|
||
<hr />
|
||
</literal>
|
||
|
||
<literal style="html">
|
||
<hr />
|
||
</literal>
|
||
|
||
<literal style="html">
|
||
<hr class="foo" id="bar" />
|
||
</literal>
|
||
|
||
<literal style="html">
|
||
<hr class="foo" id="bar" />
|
||
</literal>
|
||
|
||
<literal style="html">
|
||
<hr class="foo" id="bar">
|
||
</literal>
|
||
|
||
----
|
||
|
||
* Inline Markup
|
||
|
||
This is *emphasized*, and so *is this*.
|
||
|
||
This is **strong**, and so **is this**.
|
||
|
||
An *[[/url][emphasized link]]*.
|
||
|
||
***This is strong and em.***
|
||
|
||
So is ***this*** word.
|
||
|
||
***This is strong and em.***
|
||
|
||
So is ***this*** word.
|
||
|
||
This is code: =>=, =$=, =\=, =\$=, =<html>=.
|
||
|
||
<del>This is *strikeout*.</del>
|
||
|
||
Superscripts: a<sup>bc</sup>d a<sup>*hello*</sup> a<sup>hello there</sup>.
|
||
|
||
Subscripts: H<sub>2</sub>O, H<sub>23</sub>O, H<sub>many of them</sub>O.
|
||
|
||
These should not be superscripts or subscripts, because of the unescaped spaces:
|
||
a^b c^d, a~b c~d.
|
||
|
||
----
|
||
|
||
* Smart quotes, ellipses, dashes
|
||
|
||
“Hello,” said the spider. “‘Shelob’ is my name.”
|
||
|
||
‘A’, ‘B’, and ‘C’ are letters.
|
||
|
||
‘Oak,’ ‘elm,’ and ‘beech’ are names of trees. So is ‘pine.’
|
||
|
||
‘He said, “I want to go.”’ Were you alive in the 70’s?
|
||
|
||
Here is some quoted ‘=code=’ and a “[[http://example.com/?foo=1&bar=2][quoted
|
||
link]]”.
|
||
|
||
Some dashes: one—two — three—four — five.
|
||
|
||
Dashes between numbers: 5–7, 255–66, 1987–1999.
|
||
|
||
Ellipses…and…and….
|
||
|
||
----
|
||
|
||
* LaTeX
|
||
|
||
- <literal style="tex">\cite[22-23]{smith.1899}</literal>
|
||
- <verbatim>2 + 2 = 4</verbatim>
|
||
- *x* ∈ *y*
|
||
- *α* ∧ *ω*
|
||
- 223
|
||
- *p*-Tree
|
||
- Here’s some display math:
|
||
<verbatim>$$\frac{d}{dx}f(x)=\lim_{h\to 0}\frac{f(x+h)-f(x)}{h}$$</verbatim>
|
||
- Here’s one that has a line break in it: *α* + *ω* × *x*<sup>2</sup>.
|
||
|
||
These shouldn’t be math:
|
||
|
||
- To get the famous equation, write <code>$e = mc^2$</code>.
|
||
- $22,000 is a *lot* of money. So is $34,000. (It worked if “lot” is
|
||
emphasized.)
|
||
- Shoes ($20) and socks ($5).
|
||
- Escaped =$=: $73 *this should be emphasized* 23$.
|
||
|
||
Here’s a LaTeX table:
|
||
|
||
<literal style="tex">
|
||
\begin{tabular}{|l|l|}\hline
|
||
Animal & Number \\ \hline
|
||
Dog & 2 \\
|
||
Cat & 1 \\ \hline
|
||
\end{tabular}
|
||
</literal>
|
||
|
||
----
|
||
|
||
* Special Characters
|
||
|
||
Here is some unicode:
|
||
|
||
- I hat: Î
|
||
- o umlaut: ö
|
||
- section: §
|
||
- set membership: ∈
|
||
- copyright: ©
|
||
|
||
AT&T has an ampersand in their name.
|
||
|
||
AT&T is another way to write it.
|
||
|
||
This & that.
|
||
|
||
4 <verbatim><</verbatim> 5.
|
||
|
||
6 > 5.
|
||
|
||
Backslash: \
|
||
|
||
Backtick: `
|
||
|
||
Asterisk: <verbatim>*</verbatim>
|
||
|
||
Underscore: _
|
||
|
||
Left brace: {
|
||
|
||
Right brace: }
|
||
|
||
Left bracket: [
|
||
|
||
Right bracket: ]
|
||
|
||
Left paren: (
|
||
|
||
Right paren: )
|
||
|
||
Greater-than: >
|
||
|
||
Hash: <verbatim>#</verbatim>
|
||
|
||
Period: .
|
||
|
||
Bang: !
|
||
|
||
Plus: +
|
||
|
||
Minus: -
|
||
|
||
----
|
||
|
||
* Links
|
||
|
||
** Explicit
|
||
|
||
Just a [[/url/][URL]].
|
||
|
||
[[/url/][URL and title]].
|
||
|
||
[[/url/][URL and title]].
|
||
|
||
[[/url/][URL and title]].
|
||
|
||
[[/url/][URL and title]]
|
||
|
||
[[/url/][URL and title]]
|
||
|
||
[[/url/with_underscore][with_underscore]]
|
||
|
||
[[mailto:nobody@nowhere.net][Email link]]
|
||
|
||
[[][Empty]].
|
||
|
||
** Reference
|
||
|
||
Foo [[/url/][bar]].
|
||
|
||
With [[/url/][embedded <verbatim>[brackets]</verbatim>]].
|
||
|
||
[[/url/][b]] by itself should be a link.
|
||
|
||
Indented [[/url][once]].
|
||
|
||
Indented [[/url][twice]].
|
||
|
||
Indented [[/url][thrice]].
|
||
|
||
This should [not][] be a link.
|
||
|
||
<example>
|
||
[not]: /url
|
||
</example>
|
||
|
||
Foo [[/url/][bar]].
|
||
|
||
Foo [[/url/][biz]].
|
||
|
||
** With ampersands
|
||
|
||
Here’s a [[http://example.com/?foo=1&bar=2][link with an ampersand in the URL]].
|
||
|
||
Here’s a link with an amersand in the link text: [[http://att.com/][AT&T]].
|
||
|
||
Here’s an [[/script?foo=1&bar=2][inline link]].
|
||
|
||
Here’s an [[/script?foo=1&bar=2][inline link in pointy braces]].
|
||
|
||
** Autolinks
|
||
|
||
With an ampersand: [[http://example.com/?foo=1&bar=2]]
|
||
|
||
- In a list?
|
||
- [[http://example.com/]]
|
||
- It should.
|
||
|
||
An e-mail address: [[mailto:nobody@nowhere.net][nobody@nowhere.net]]
|
||
|
||
<quote>
|
||
Blockquoted: [[http://example.com/]]
|
||
</quote>
|
||
|
||
Auto-links should not occur here: =<http://example.com/>=
|
||
|
||
<example>
|
||
or here: <http://example.com/>
|
||
</example>
|
||
|
||
----
|
||
|
||
* Images
|
||
|
||
From “Voyage dans la Lune” by Georges Melies (1902):
|
||
|
||
[[lalune.jpg][Voyage dans la Lune]]
|
||
lalune
|
||
Here is a movie [[movie.jpg][movie]] icon.
|
||
|
||
----
|
||
|
||
* Footnotes
|
||
|
||
Here is a footnote reference,[1] and another.[2] This should *not* be a footnote
|
||
reference, because it contains a space.[^my note] Here is an inline note.[3]
|
||
|
||
<quote>
|
||
Notes can go in quotes.[4]
|
||
</quote>
|
||
|
||
1. And in list items.[5]
|
||
|
||
This paragraph should not be part of the note, as it is not indented.
|
||
|
||
[1] Here is the footnote. It can go anywhere after the footnote reference. It
|
||
need not be placed at the end of the document.
|
||
|
||
[2] Here’s the long note. This one contains multiple blocks.
|
||
|
||
Subsequent blocks are indented to show that they belong to the footnote (as
|
||
with list items).
|
||
|
||
<example>
|
||
{ <code> }
|
||
</example>
|
||
|
||
If you want, you can indent every line, but you can also be lazy and just
|
||
indent the first line of each block.
|
||
|
||
[3] This is *easier* to type. Inline notes may contain
|
||
[[http://google.com][links]] and =]= verbatim characters, as well as
|
||
[bracketed text].
|
||
|
||
[4] In quote.
|
||
|
||
[5] In list.
|