fiddlosopher 23df0ed176 Extensive changes stemming from a rethinking of the Pandoc data

structure. Key and Note blocks have been removed. Link and image URLs
are now stored directly in Link and Image inlines, and note blocks
are stored in Note inlines. This requires changes in both parsers
and writers. Markdown and RST parsers need to extract data from key
and note blocks and insert them into the relevant inline elements.
Other parsers can be simplified, since there is no longer any need to
construct separate key and note blocks. Markdown, RST, and HTML writers
need to construct lists of notes; Markdown and RST writers need to
construct lists of link references (when the --reference-links option
is specified); and the RST writer needs to construct a list of image
substitution references. All writers have been rewritten to use the
State monad when state is required. This rewrite yields a small speed
boost and considerably cleaner code.

* Text/Pandoc/Definition.hs:
+ blocks: removed Key and Note
+ inlines: removed NoteRef, added Note
+ modified Target: there is no longer a 'Ref' target; all targets
are explicit URL, title pairs

* Text/Pandoc/Shared.hs:

+ Added 'Reference', 'isNoteBlock', 'isKeyBlock', 'isLineClump',
used in some of the readers.
+ Removed 'generateReference', 'keyTable', 'replaceReferenceLinks',
'replaceRefLinksBlockList', along with some auxiliary functions
used only by them. These are no longer needed, since
reference links are resolved in the Markdown and RST readers.
+ Moved 'inTags', 'selfClosingTag', 'inTagsSimple', and 'inTagsIndented'
to the Docbook writer, since that is now the only module that uses
them.
+ Changed name of 'escapeSGMLString' to 'escapeStringForXML'
+ Added KeyTable and NoteTable types
+ Removed fields from ParserState; 'stateKeyBlocks', 'stateKeysUsed',
'stateNoteBlocks', 'stateNoteIdentifiers', 'stateInlineLinks'.
Added 'stateKeys' and 'stateNotes'.
+ Added clause for Note to 'prettyBlock'.
+ Added 'writerNotes', 'writerReferenceLinks' fields to WriterOptions.

* Text/Pandoc/Entities.hs: Renamed 'escapeSGMLChar' and
'escapeSGMLString' to 'escapeCharForXML' and 'escapeStringForXML'

* Text/ParserCombinators/Pandoc.hs: Added lineClump parser: parses a raw
line block up to and including following blank lines.

* Main.hs: Replaced --inline-links with --reference-links.

* README:
+ Documented --reference-links and removed description of --inline-links.
+ Added note that footnotes may occur anywhere in the document, but must
be at the outer level, not embedded in block elements.

* man/man1/pandoc.1, man/man1/html2markdown.1: Removed --inline-links
option, added --reference-links option

* Markdown and RST readers:
+ Rewrote to fit new Pandoc definition. Since there are no longer
Note or Key blocks, all note and key blocks are parsed on a first pass
through the document. Once tables of notes and keys have been constructed,
the remaining parts of the document are reassembled and parsed.
+ Refactored link parsers.

* LaTeX and HTML readers: Rewrote to fit new Pandoc definition. Since
there are no longer Note or Key blocks, notes and references can be
parsed in a single pass through the document.

* RST, Markdown, and HTML writers: Rewrote using state monad new Pandoc
and definition. State is used to hold lists of references footnotes to
and be printed at the end of the document.

* RTF and LaTeX writers: Rewrote using new Pandoc definition. (Because
of the different treatment of footnotes, the "notes" parameter is no
longer needed in the block and inline conversion functions.)

* Docbook writer:
+ Moved the functions 'attributeList', 'inTags', 'selfClosingTag',
'inTagsSimple', 'inTagsIndented' from Text/Pandoc/Shared, since
they are now used only by the Docbook writer.
+ Rewrote using new Pandoc definition. (Because of the different
treatment of footnotes, the "notes" parameter is no longer needed
in the block and inline conversion functions.)

* Updated test suite

* Throughout: old haskell98 module names replaced by hierarchical module
names, e.g. List by Data.List.

* debian/control: Include libghc6-xhtml-dev instead of libghc6-html-dev
in "Build-Depends."

* cabalize:
+ Remove haskell98 from BASE_DEPENDS (since now the new hierarchical
module names are being used throughout)
+ Added mtl to BASE_DEPENDS (needed for state monad)
+ Removed html from GHC66_DEPENDS (not needed since xhtml is now used)

git-svn-id: https://pandoc.googlecode.com/svn/trunk@580 788f1e2b-df1e-0410-8736-df70ead52e1b

2007-04-10 01:56:50 +00:00

7.8 KiB

Raw Blame History

% Pandoc Test Suite % John MacFarlane, Anonymous % 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 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. * criminey.

There should be a hard line break
here.

Block Quotes

E-mail style:

This is a block quote. It is pretty short.

Code in a block quote:
sub status {
    print "working";
}
A list:

item one

item two

Nested block quotes:

nested

nested

This should not be a block quote: 2 > 1.

Box-style:

Example:

sub status {
    print "working";
}

do laundry

take out the trash

Here's a nested one:

Joe said:

Don't quote me.

And a following paragraph.

Code Blocks

Code:

---- (should be four hyphens)

sub status {
    print "working";
}

this code block is indented by one tab

And:

    this code block is indented by two tabs

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

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:

First
Second
Third

and:

One
Two
Three

Loose using tabs:

First
Second
Third

and using spaces:

One
Two
Three

Multiple paragraphs:

Item 1, graf one.

Item 1. graf two. The quick brown fox jumped over the lazy dog's back.
Item 2.
Item 3.

Nested

Tab
- Tab
  - Tab

Here's another:

First
Second:
- Fee
- Fie
- Foe
Third

Same thing but with paragraphs:

First
Second:
- Fee
- Fie
- Foe
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

HTML Blocks

Simple block on one line:

foo

And nested without indentation:

foo

bar

Interpreted markdown in a table:

This is *emphasized*

And this is **strong**

Here's a simple block:

foo

This should be a code block, though:

<div>
    foo
</div>

As should this:

<div>foo</div>

Now, nested:

foo

This should just be an HTML comment:

Multiline:

Code block:

<!-- Comment -->

Just plain comment, with trailing spaces on the line:

Code:

<hr />

Hr's:

Inline Markup

This is emphasized, and so is this.

This is strong, and so is this.

An emphasized link.

This is strong and em.

So is this word.

This is strong and em.

So is this word.

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

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 "quoted link".

Some dashes: one--two--three--four--five.

Dashes between numbers: 5-7, 255-66, 1987-1999.

Ellipses...and...and....

LaTeX

\cite[22-23]{smith.1899}
\doublespacing
2+2=4
x \in y
\alpha \wedge \omega
223
$p$-Tree
\frac{d}{dx}f(x)=\lim_{h\to 0}\frac{f(x+h)-f(x)}{h}
Here's one that has a line break in it: \alpha + \omega \times x^2.

These shouldn't be math:

To get the famous equation, write $e = mc^2$ .
$22,000 is a lot of money. So is $34,000. (It worked if "lot" is emphasized.)
Escaped $: 73 *this should be emphasized* 23.

Here's a LaTeX table:

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

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

Just a URL.

URL and title.

[URL and title](/url/ "title with "quotes" in it")

URL and title

with_underscore

Email link

Empty.

Reference

Foo bar.

With embedded [brackets].

b by itself should be a link.

Indented once.

Indented twice.

Indented thrice.

This should [not][] be a link.

[not]: /url

Foo [bar](/url/ "Title with "quotes" inside").

Foo [biz](/url/ "Title with "quote" inside").

With ampersands

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

Here's a link with an amersand in the link text: AT&T.

Here's an inline link.

Here's an 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: nobody@nowhere.net

Blockquoted: http://example.com/

Auto-links should not occur here: <http://example.com/>

or here: <http://example.com/>

Images

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

Here is a movie icon.

Footnotes

Here is a footnote reference,¹ and another.² This should not be a footnote reference, because it contains a space.[^my note] Here is an inline note.³

Notes can go in quotes.⁴

And in list items.⁵

This paragraph should not be part of the note, as it is not indented.

Here is the footnote. It can go anywhere after the footnote reference. It need not be placed at the end of the document. ↩︎
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).
```
  { <code> }
```
If you want, you can indent every line, but you can also be lazy and just indent the first line of each block. ↩︎
This is easier to type. Inline notes may contain links and ] verbatim characters. ↩︎
In quote. ↩︎
In list. ↩︎

7.8 KiB Raw Blame History