pandoc/tests/rst-reader.rst

Pandoc Test Suite
#################
Subtitle
^^^^^^^^

:Author: John MacFarlane
:Author: Anonymous
:Date: July 17, 2006
:Revision: 3

Level one header
================

This is a set of tests for pandoc.  Most of them are adapted from
John Gruber's markdown test suite.

Level two header
----------------

Level three
+++++++++++

Level four with *emphasis*
~~~~~~~~~~~~~~~~~~~~~~~~~~

Level five
''''''''''

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.

Horizontal rule:

-----

Another:

****

Block Quotes
============

Here's a block quote:

  This is a block quote.
  It is pretty short.

Here's another, differently indented:

    This is a block quote.
    It's indented with a tab.

    Code in a block quote:: 

        sub status {
            print "working";
        }

    List in a block quote:

    1. item one
    2. item two

    Nested block quotes:

        nested

            nested

Code Blocks
===========

Code:

::

    ---- (should be four hyphens)

    sub status {
        print "working";
    }

::

	this code block is indented by one tab

And::

		this block is indented by two tabs

        These should not be escaped:  \$ \\ \> \[ \{

And:

.. code-block:: python

   def my_function(x):
       return x + 1

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 

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:

#. Autonumber.
#.  More.
    
    #. Nested.

Autonumbering with explicit start:

(d)  item 1
(#)  item 2

Definition
----------

term 1
    Definition 1.

term 2
    Definition 2, paragraph 1.

    Definition 2, paragraph 2.

term with *emphasis* 
    Definition 3.

Field Lists
===========

 :address:  61 Main St.
 :city:  *Nowhere*, MA,
    USA
 :phone: 123-4567

:address:  61 Main St.
:city:  *Nowhere*, MA,
    USA
:phone: 123-4567

HTML Blocks
===========

Simple block on one line:

.. raw:: html

    <div>foo</div>

Now, nested:

.. raw:: html

    <div>
	    <div>
		    <div>
			    foo
		    </div>
	    </div>
    </div>

LaTeX Block
===========

.. raw:: latex

   \begin{tabular}{|l|l|}\hline
   Animal & Number \\ \hline
   Dog    & 2      \\
   Cat    & 1      \\ \hline
   \end{tabular}

Inline Markup
=============

This is *emphasized*. This is **strong**.

This is code: ``>``, ``$``, ``\``, ``\$``, ``<html>``.

This is\ :sub:`subscripted` and this is :sup:`superscripted`\ .

Special Characters
==================

Here is some unicode:

- I hat: Î
- o umlaut: ö
- section: § 
- set membership: ∈
- copyright: ©

AT&T has an ampersand in their name.

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: \-

Links
=====

Explicit:  a `URL </url/>`_.

Two anonymous links:  `the first`__ and `the second`__

__ /url1/
__ /url2/

Reference links:  `link1`_ and `link2`_ and link1_ again.

.. _link1: /url1/
.. _`link2`: /url2/

Here's a `link with an ampersand in the URL`_.

Here's a link with an amersand in the link text: `AT&T </url/>`_.

.. _link with an ampersand in the URL: http://example.com/?foo=1&bar=2

Autolinks: http://example.com/?foo=1&bar=2 and nobody@nowhere.net.

But not here::

    http://example.com/

Images
======

From "Voyage dans la Lune" by Georges Melies (1902):

.. image:: lalune.jpg

.. image:: lalune.jpg
   :height: 2343
   :alt: Voyage dans la Lune

Here is a movie |movie| icon.

.. |movie| image:: movie.jpg

Comments
========

First paragraph

.. comment

..
    Comment block, should not appear in output
    as defined by reStructuredText

Another paragraph

..
    Another comment block.

    This one spans several
    text elements.

    It doesn't end until
    indentation is restored to the
    preceding level.

A third paragraph

Line blocks
===========

| But can a bee be said to be
|     or not to be an entire bee,
|         when half the bee is not a bee,
|             due to some ancient injury?

| Continuation
 line
|   and
       another
initial import git-svn-id: https://pandoc.googlecode.com/svn/trunk@2 788f1e2b-df1e-0410-8736-df70ead52e1b 2006-10-17 16:22:29 +02:00			`Pandoc Test Suite`
			`#################`
			`Subtitle`
			`^^^^^^^^`

			`:Author: John MacFarlane`
			`:Author: Anonymous`
			`:Date: July 17, 2006`
			`:Revision: 3`

			`Level one header`
			`================`

			`This is a set of tests for pandoc. Most of them are adapted from`
			`John Gruber's markdown test suite.`

			`Level two header`
			`----------------`

			`Level three`
			`+++++++++++`

			`Level four with emphasis`
			`~~~~~~~~~~~~~~~~~~~~~~~~~~`

			`Level five`
			`''''''''''`

			`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.`

			`Horizontal rule:`

			`-----`

			`Another:`

			`****`

			`Block Quotes`
			`============`

			`Here's a block quote:`

			`This is a block quote.`
			`It is pretty short.`

			`Here's another, differently indented:`

			`This is a block quote.`
			`It's indented with a tab.`

			`Code in a block quote::`

			`sub status {`
			`print "working";`
			`}`

			`List in a block quote:`

			`1. item one`
			`2. item two`

			`Nested block quotes:`

			`nested`

			`nested`

			`Code Blocks`
			`===========`

			`Code:`

			`::`

			`---- (should be four hyphens)`

			`sub status {`
			`print "working";`
			`}`

			`::`

			`this code block is indented by one tab`

			`And::`

			`this block is indented by two tabs`

			`These should not be escaped: \$ \\ \> \[ \{`

Support for "..code-block" directive in RST reader. Not core RST, but used in Sphinx for code blocks annotated with syntax information. Thanks to Luke Plant for the patch. git-svn-id: https://pandoc.googlecode.com/svn/trunk@1619 788f1e2b-df1e-0410-8736-df70ead52e1b 2009-11-17 04:36:04 +01:00			`And:`

			`.. code-block:: python`

			`def my_function(x):`
			`return x + 1`

initial import git-svn-id: https://pandoc.googlecode.com/svn/trunk@2 788f1e2b-df1e-0410-8736-df70ead52e1b 2006-10-17 16:22:29 +02:00			`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`

Major change in the way ordered lists are handled: + The changes are documented in README, under Lists. + The OrderedList block element now stores information about list number style, list number delimiter, and starting number. + The readers parse this information, when possible. + The writers use this information to style ordered lists. + Test suites have been changed accordingly. Motivation: It's often useful to start lists with numbers other than 1, and to have control over the style of the list. Added to Text.Pandoc.Shared: + camelCaseToHyphenated + toRomanNumeral + anyOrderedListMarker + orderedListMarker + orderedListMarkers Added to Text.Pandoc.ParserCombinators: + charsInBalanced' + withHorizDisplacement + romanNumeral RST writer: + Force blank line before lists, so that sublists will be handled correctly. LaTeX reader: + Fixed bug in parsing of footnotes containing multiple paragraphs, introduced by use of charsInBalanced. Fix: use charsInBalanced' instead. LaTeX header: + use mathletters option in ucs package, so that basic unicode Greek letters will work properly. git-svn-id: https://pandoc.googlecode.com/svn/trunk@834 788f1e2b-df1e-0410-8736-df70ead52e1b 2007-08-08 04:43:15 +02:00			`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:`

			`#. Autonumber.`
			`#. More.`

			`#. Nested.`

RST reader: Allow # to continue list... ...even if the list was started with an explicit marker. For example: A. my list #. continued Resolves Issue #140. Test case also added. git-svn-id: https://pandoc.googlecode.com/svn/trunk@1584 788f1e2b-df1e-0410-8736-df70ead52e1b 2009-06-28 03:38:40 +02:00			`Autonumbering with explicit start:`

			`(d) item 1`
			`(#) item 2`

Added support for definition lists to RST reader. Added a relevant test to the test suite. git-svn-id: https://pandoc.googlecode.com/svn/trunk@782 788f1e2b-df1e-0410-8736-df70ead52e1b 2007-07-23 03:35:03 +02:00			`Definition`
			`----------`

			`term 1`
			`Definition 1.`

			`term 2`
			`Definition 2, paragraph 1.`

			`Definition 2, paragraph 2.`

			`term with emphasis`
			`Definition 3.`

Improvements to RST reader: + Allow field lists to be indented. + Parse the contents of field lists instead of treating them as raw strings. + Represent field lists as definition lists rather than blockquotes. + Fixed bug in which metadata would be overridden if the document contained more than one field list. + Parse fields associated with ..image: blocks, and use the 'alt' field, if present, for image alt text and title. git-svn-id: https://pandoc.googlecode.com/svn/trunk@1050 788f1e2b-df1e-0410-8736-df70ead52e1b 2007-10-13 23:39:17 +02:00			`Field Lists`
			`===========`

			`:address: 61 Main St.`
			`:city: Nowhere, MA,`
			`USA`
			`:phone: 123-4567`

			`:address: 61 Main St.`
			`:city: Nowhere, MA,`
			`USA`
			`:phone: 123-4567`

initial import git-svn-id: https://pandoc.googlecode.com/svn/trunk@2 788f1e2b-df1e-0410-8736-df70ead52e1b 2006-10-17 16:22:29 +02:00			`HTML Blocks`
			`===========`

			`Simple block on one line:`

			`.. raw:: html`

			`<div>foo</div>`

			`Now, nested:`

			`.. raw:: html`

			`<div>`
			`<div>`
			`<div>`
			`foo`
			`</div>`
			`</div>`
			`</div>`

			`LaTeX Block`
			`===========`

			`.. raw:: latex`

			`\begin{tabular}{\|l\|l\|}\hline`
			`Animal & Number \\ \hline`
			`Dog & 2 \\`
			`Cat & 1 \\ \hline`
			`\end{tabular}`

			`Inline Markup`
			`=============`

			`This is emphasized. This is strong.`

			This is code: ``>``, ``$``, ``\``, ``\$``, ``<html>``.

Updated RST reader test. git-svn-id: https://pandoc.googlecode.com/svn/trunk@778 788f1e2b-df1e-0410-8736-df70ead52e1b 2007-07-22 23:32:26 +02:00			This is\ :sub:`subscripted` and this is :sup:`superscripted`\ .

initial import git-svn-id: https://pandoc.googlecode.com/svn/trunk@2 788f1e2b-df1e-0410-8736-df70ead52e1b 2006-10-17 16:22:29 +02:00			`Special Characters`
			`==================`

			`Here is some unicode:`

			`- I hat: Î`
			`- o umlaut: ö`
			`- section: §`
			`- set membership: ∈`
			`- copyright: ©`

			`AT&T has an ampersand in their name.`

			`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: \-`

			`Links`
			`=====`

			Explicit: a `URL </url/>`_.

			Two anonymous links: `the first`__ and `the second`__

			`__ /url1/`
			`__ /url2/`

			Reference links: `link1`_ and `link2`_ and link1_ again.

			`.. _link1: /url1/`
			.. _`link2`: /url2/

			Here's a `link with an ampersand in the URL`_.

			Here's a link with an amersand in the link text: `AT&T </url/>`_.

			`.. _link with an ampersand in the URL: http://example.com/?foo=1&bar=2`

			`Autolinks: http://example.com/?foo=1&bar=2 and nobody@nowhere.net.`

			`But not here::`

			`http://example.com/`

			`Images`
			`======`

			`From "Voyage dans la Lune" by Georges Melies (1902):`

			`.. image:: lalune.jpg`

Improvements to RST reader: + Allow field lists to be indented. + Parse the contents of field lists instead of treating them as raw strings. + Represent field lists as definition lists rather than blockquotes. + Fixed bug in which metadata would be overridden if the document contained more than one field list. + Parse fields associated with ..image: blocks, and use the 'alt' field, if present, for image alt text and title. git-svn-id: https://pandoc.googlecode.com/svn/trunk@1050 788f1e2b-df1e-0410-8736-df70ead52e1b 2007-10-13 23:39:17 +02:00			`.. image:: lalune.jpg`
			`:height: 2343`
			`:alt: Voyage dans la Lune`

initial import git-svn-id: https://pandoc.googlecode.com/svn/trunk@2 788f1e2b-df1e-0410-8736-df70ead52e1b 2006-10-17 16:22:29 +02:00			`Here is a movie \|movie\| icon.`

			`.. \|movie\| image:: movie.jpg`
Fixed parsing of RST comment blocks. Modified 'unknown directive' in RST reader. Added RST reader tests for comment blocks. Resolves Issue #86 and Debian Bug#500662. git-svn-id: https://pandoc.googlecode.com/svn/trunk@1484 788f1e2b-df1e-0410-8736-df70ead52e1b 2008-11-06 17:49:45 +01:00
			`Comments`
			`========`

			`First paragraph`

			`.. comment`

			`..`
			`Comment block, should not appear in output`
			`as defined by reStructuredText`

			`Another paragraph`

			`..`
			`Another comment block.`

			`This one spans several`
			`text elements.`

			`It doesn't end until`
			`indentation is restored to the`
			`preceding level.`

			`A third paragraph`

Allow continuation lines in line blocks. Also added test cases for line blocks for RST reader. Resolves Issue #149. git-svn-id: https://pandoc.googlecode.com/svn/trunk@1583 788f1e2b-df1e-0410-8736-df70ead52e1b 2009-06-25 04:01:41 +02:00			`Line blocks`
			`===========`

			`\| But can a bee be said to be`
			`\| or not to be an entire bee,`
			`\| when half the bee is not a bee,`
			`\| due to some ancient injury?`

			`\| Continuation`
			`line`
			`\| and`
			`another`