Files
pandoc/test/writer.texinfo
T
Albert KrewinkelandAner Lucero 909ced5153 Support complex figures. [API change]
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>
2023-01-13 09:13:27 -08:00

1044 lines
14 KiB
Plaintext

\input texinfo
@documentencoding UTF-8
@macro textstrikeout{text}
~~\text\~~
@end macro
@ifnottex
@paragraphindent 0
@end ifnottex
@titlepage
@title Pandoc Test Suite
@author John MacFarlane
@author Anonymous
July 17, 2006
@end titlepage
@node Top
@top Pandoc Test Suite
This is a set of tests for pandoc. Most of them are adapted from John Gruber's
markdown test suite.
@iftex
@bigskip@hrule@bigskip
@end iftex
@ifnottex
------------------------------------------------------------------------
@end ifnottex
@menu
* Headers::
* Level 1::
* Paragraphs::
* Block Quotes::
* Code Blocks::
* Lists::
* Definition Lists::
* HTML Blocks::
* Inline Markup::
* Smart quotes ellipses dashes::
* LaTeX::
* Special Characters::
* Links::
* Images::
* Footnotes::
@end menu
@node Headers
@chapter Headers
@anchor{#headers}
@menu
* Level 2 with an embedded link::
@end menu
@node Level 2 with an embedded link
@section Level 2 with an @uref{/url,embedded link}
@anchor{#level-2-with-an-embedded-link}
@menu
* Level 3 with emphasis::
@end menu
@node Level 3 with emphasis
@subsection Level 3 with @emph{emphasis}
@anchor{#level-3-with-emphasis}
@menu
* Level 4::
@end menu
@node Level 4
@subsubsection Level 4
@anchor{#level-4}
Level 5
@node Level 1
@chapter Level 1
@anchor{#level-1}
@menu
* Level 2 with emphasis::
* Level 2::
@end menu
@node Level 2 with emphasis
@section Level 2 with @emph{emphasis}
@anchor{#level-2-with-emphasis}
@menu
* Level 3::
@end menu
@node Level 3
@subsection Level 3
@anchor{#level-3}
with no blank line
@node Level 2
@section Level 2
@anchor{#level-2}
with no blank line
@iftex
@bigskip@hrule@bigskip
@end iftex
@ifnottex
------------------------------------------------------------------------
@end ifnottex
@node Paragraphs
@chapter Paragraphs
@anchor{#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. * criminey.
There should be a hard line break@*
here.
@iftex
@bigskip@hrule@bigskip
@end iftex
@ifnottex
------------------------------------------------------------------------
@end ifnottex
@node Block Quotes
@chapter Block Quotes
@anchor{#block-quotes}
E-mail style:
@quotation
This is a block quote. It is pretty short.
@end quotation
@quotation
Code in a block quote:
@verbatim
sub status {
print "working";
}
@end verbatim
A list:
@enumerate
@item
item one
@item
item two
@end enumerate
Nested block quotes:
@quotation
nested
@end quotation
@quotation
nested
@end quotation
@end quotation
This should not be a block quote: 2 > 1.
And a following paragraph.
@iftex
@bigskip@hrule@bigskip
@end iftex
@ifnottex
------------------------------------------------------------------------
@end ifnottex
@node Code Blocks
@chapter Code Blocks
@anchor{#code-blocks}
Code:
@verbatim
---- (should be four hyphens)
sub status {
print "working";
}
this code block is indented by one tab
@end verbatim
And:
@verbatim
this code block is indented by two tabs
These should not be escaped: \$ \\ \> \[ \{
@end verbatim
@iftex
@bigskip@hrule@bigskip
@end iftex
@ifnottex
------------------------------------------------------------------------
@end ifnottex
@node Lists
@chapter Lists
@anchor{#lists}
@menu
* Unordered::
* Ordered::
* Nested::
* Tabs and spaces::
* Fancy list markers::
@end menu
@node Unordered
@section Unordered
@anchor{#unordered}
Asterisks tight:
@itemize
@item
asterisk 1
@item
asterisk 2
@item
asterisk 3
@end itemize
Asterisks loose:
@itemize
@item
asterisk 1
@item
asterisk 2
@item
asterisk 3
@end itemize
Pluses tight:
@itemize
@item
Plus 1
@item
Plus 2
@item
Plus 3
@end itemize
Pluses loose:
@itemize
@item
Plus 1
@item
Plus 2
@item
Plus 3
@end itemize
Minuses tight:
@itemize
@item
Minus 1
@item
Minus 2
@item
Minus 3
@end itemize
Minuses loose:
@itemize
@item
Minus 1
@item
Minus 2
@item
Minus 3
@end itemize
@node Ordered
@section Ordered
@anchor{#ordered}
Tight:
@enumerate
@item
First
@item
Second
@item
Third
@end enumerate
and:
@enumerate
@item
One
@item
Two
@item
Three
@end enumerate
Loose using tabs:
@enumerate
@item
First
@item
Second
@item
Third
@end enumerate
and using spaces:
@enumerate
@item
One
@item
Two
@item
Three
@end enumerate
Multiple paragraphs:
@enumerate
@item
Item 1, graf one.
Item 1. graf two. The quick brown fox jumped over the lazy dog's back.
@item
Item 2.
@item
Item 3.
@end enumerate
@node Nested
@section Nested
@anchor{#nested}
@itemize
@item
Tab
@itemize
@item
Tab
@itemize
@item
Tab
@end itemize
@end itemize
@end itemize
Here's another:
@enumerate
@item
First
@item
Second:
@itemize
@item
Fee
@item
Fie
@item
Foe
@end itemize
@item
Third
@end enumerate
Same thing but with paragraphs:
@enumerate
@item
First
@item
Second:
@itemize
@item
Fee
@item
Fie
@item
Foe
@end itemize
@item
Third
@end enumerate
@node Tabs and spaces
@section Tabs and spaces
@anchor{#tabs-and-spaces}
@itemize
@item
this is a list item indented with tabs
@item
this is a list item indented with spaces
@itemize
@item
this is an example list item indented with tabs
@item
this is an example list item indented with spaces
@end itemize
@end itemize
@node Fancy list markers
@section Fancy list markers
@anchor{#fancy-list-markers}
@enumerate 2
@item
begins with 2
@item
and now 3
with a continuation
@enumerate 4
@item
sublist with roman numerals, starting with 4
@item
more items
@enumerate A
@item
a subsublist
@item
a subsublist
@end enumerate
@end enumerate
@end enumerate
Nesting:
@enumerate A
@item
Upper Alpha
@enumerate
@item
Upper Roman.
@enumerate 6
@item
Decimal start with 6
@enumerate c
@item
Lower alpha with paren
@end enumerate
@end enumerate
@end enumerate
@end enumerate
Autonumbering:
@enumerate
@item
Autonumber.
@item
More.
@enumerate
@item
Nested.
@end enumerate
@end enumerate
Should not be a list item:
M.A.@ 2007
B. Williams
@iftex
@bigskip@hrule@bigskip
@end iftex
@ifnottex
------------------------------------------------------------------------
@end ifnottex
@node Definition Lists
@chapter Definition Lists
@anchor{#definition-lists}
Tight using spaces:
@table @asis
@item apple
red fruit
@item orange
orange fruit
@item banana
yellow fruit
@end table
Tight using tabs:
@table @asis
@item apple
red fruit
@item orange
orange fruit
@item banana
yellow fruit
@end table
Loose:
@table @asis
@item apple
red fruit
@item orange
orange fruit
@item banana
yellow fruit
@end table
Multiple blocks with italics:
@table @asis
@item @emph{apple}
red fruit
contains seeds, crisp, pleasant to taste
@item @emph{orange}
orange fruit
@verbatim
{ orange code block }
@end verbatim
@quotation
orange block quote
@end quotation
@end table
Multiple definitions, tight:
@table @asis
@item apple
red fruit
computer
@item orange
orange fruit
bank
@end table
Multiple definitions, loose:
@table @asis
@item apple
red fruit
computer
@item orange
orange fruit
bank
@end table
Blank line after term, indented marker, alternate markers:
@table @asis
@item apple
red fruit
computer
@item orange
orange fruit
@enumerate
@item
sublist
@item
sublist
@end enumerate
@end table
@node HTML Blocks
@chapter HTML Blocks
@anchor{#html-blocks}
Simple block on one line:
foo
And nested without indentation:
foo
bar
Interpreted markdown in a table:
This is @emph{emphasized}
And this is @strong{strong}
Here's a simple block:
foo
This should be a code block, though:
@verbatim
<div>
foo
</div>
@end verbatim
As should this:
@verbatim
<div>foo</div>
@end verbatim
Now, nested:
foo
This should just be an HTML comment:
Multiline:
Code block:
@verbatim
<!-- Comment -->
@end verbatim
Just plain comment, with trailing spaces on the line:
Code:
@verbatim
<hr />
@end verbatim
Hr's:
@iftex
@bigskip@hrule@bigskip
@end iftex
@ifnottex
------------------------------------------------------------------------
@end ifnottex
@node Inline Markup
@chapter Inline Markup
@anchor{#inline-markup}
This is @emph{emphasized}, and so @emph{is this}.
This is @strong{strong}, and so @strong{is this}.
An @emph{@uref{/url,emphasized link}}.
@strong{@emph{This is strong and em.}}
So is @strong{@emph{this}} word.
@strong{@emph{This is strong and em.}}
So is @strong{@emph{this}} word.
This is code: @code{>}, @code{$}, @code{\}, @code{\$}, @code{<html>}.
@textstrikeout{This is @emph{strikeout}.}
Superscripts: a@sup{bc}d a@sup{@emph{hello}} a@sup{hello@ there}.
Subscripts: H@sub{2}O, H@sub{23}O, H@sub{many@ of@ them}O.
These should not be superscripts or subscripts, because of the unescaped spaces:
a^b c^d, a~b c~d.
@iftex
@bigskip@hrule@bigskip
@end iftex
@ifnottex
------------------------------------------------------------------------
@end ifnottex
@node Smart quotes ellipses dashes
@chapter Smart quotes, ellipses, dashes
@anchor{#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{code}' and a
``@uref{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@dots{}and@dots{}and@dots{}.
@iftex
@bigskip@hrule@bigskip
@end iftex
@ifnottex
------------------------------------------------------------------------
@end ifnottex
@node LaTeX
@chapter LaTeX
@anchor{#latex}
@itemize
@item
@tex
\cite[22-23]{smith.1899}
@end tex
@item
@math{2+2=4}
@item
@math{x \in y}
@item
@math{\alpha \wedge \omega}
@item
@math{223}
@item
@math{p}-Tree
@item
Here's some display math:
@math{\frac{d}{dx}f(x)=\lim_{h\to 0}\frac{f(x+h)-f(x)}{h}}
@item
Here's one that has a line break in it: @math{\alpha + \omega \times x^2}.
@end itemize
These shouldn't be math:
@itemize
@item
To get the famous equation, write @code{$e = mc^2$}.
@item
$22,000 is a @emph{lot} of money. So is $34,000. (It worked if ``lot'' is
emphasized.)
@item
Shoes ($20) and socks ($5).
@item
Escaped @code{$}: $73 @emph{this should be emphasized} 23$.
@end itemize
Here's a LaTeX table:
@tex
\begin{tabular}{|l|l|}\hline
Animal & Number \\ \hline
Dog & 2 \\
Cat & 1 \\ \hline
\end{tabular}
@end tex
@iftex
@bigskip@hrule@bigskip
@end iftex
@ifnottex
------------------------------------------------------------------------
@end ifnottex
@node Special Characters
@chapter Special Characters
@anchor{#special-characters}
Here is some unicode:
@itemize
@item
I hat: Î
@item
o umlaut: ö
@item
section: §
@item
set membership: ∈
@item
copyright: ©
@end itemize
AT&T has an ampersand in their name.
AT&T is another way to write it.
This & that.
4 < 5.
6 > 5.
Backslash: \
Backtick: `
Asterisk: *
Underscore: _
Left brace: @{
Right brace: @}
Left bracket: [
Right bracket: ]
Left paren: (
Right paren: )
Greater-than: >
Hash: #
Period: .
Bang: !
Plus: +
Minus: -
@iftex
@bigskip@hrule@bigskip
@end iftex
@ifnottex
------------------------------------------------------------------------
@end ifnottex
@node Links
@chapter Links
@anchor{#links}
@menu
* Explicit::
* Reference::
* With ampersands::
* Autolinks::
@end menu
@node Explicit
@section Explicit
@anchor{#explicit}
Just a @uref{/url/,URL}.
@uref{/url/,URL and title}.
@uref{/url/,URL and title}.
@uref{/url/,URL and title}.
@uref{/url/,URL and title}
@uref{/url/,URL and title}
@uref{/url/with_underscore,with_underscore}
@uref{mailto:nobody@@nowhere.net,Email link}
@uref{,Empty}.
@node Reference
@section Reference
@anchor{#reference}
Foo @uref{/url/,bar}.
With @uref{/url/,embedded [brackets]}.
@uref{/url/,b} by itself should be a link.
Indented @uref{/url,once}.
Indented @uref{/url,twice}.
Indented @uref{/url,thrice}.
This should [not][] be a link.
@verbatim
[not]: /url
@end verbatim
Foo @uref{/url/,bar}.
Foo @uref{/url/,biz}.
@node With ampersands
@section With ampersands
@anchor{#with-ampersands}
Here's a @uref{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: @uref{http://att.com/,AT&T}.
Here's an @uref{/script?foo=1&bar=2,inline link}.
Here's an @uref{/script?foo=1&bar=2,inline link in pointy braces}.
@node Autolinks
@section Autolinks
@anchor{#autolinks}
With an ampersand: @url{http://example.com/?foo=1&bar=2}
@itemize
@item
In a list?
@item
@url{http://example.com/}
@item
It should.
@end itemize
An e-mail address: @uref{mailto:nobody@@nowhere.net,nobody@@nowhere.net}
@quotation
Blockquoted: @url{http://example.com/}
@end quotation
Auto-links should not occur here: @code{<http://example.com/>}
@verbatim
or here: <http://example.com/>
@end verbatim
@iftex
@bigskip@hrule@bigskip
@end iftex
@ifnottex
------------------------------------------------------------------------
@end ifnottex
@node Images
@chapter Images
@anchor{#images}
From ``Voyage dans la Lune'' by Georges Melies (1902):
@float
@image{lalune,,,lalune,jpg}
@caption{lalune}
@end float
Here is a movie @image{movie,,,movie,jpg} icon.
@iftex
@bigskip@hrule@bigskip
@end iftex
@ifnottex
------------------------------------------------------------------------
@end ifnottex
@node Footnotes
@chapter Footnotes
@anchor{#footnotes}
Here is a footnote reference,@footnote{Here is the footnote. It can go anywhere
after the footnote reference. It need not be placed at the end of the document.}
and another.@footnote{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).
@verbatim
{ <code> }
@end verbatim
If you want, you can indent every line, but you can also be lazy and just indent
the first line of each block.} This should @emph{not} be a footnote reference,
because it contains a space.[^my note] Here is an inline note.@footnote{This is
@emph{easier} to type. Inline notes may contain @uref{http://google.com,links}
and @code{]} verbatim characters, as well as [bracketed text].}
@quotation
Notes can go in quotes.@footnote{In quote.}
@end quotation
@enumerate
@item
And in list items.@footnote{In list.}
@end enumerate
This paragraph should not be part of the note, as it is not indented.
@bye