aboutsummaryrefslogtreecommitdiff
path: root/tests/rst-reader.rst
blob: 14f57da181ec78c4040c5a5089000cbf88a0f549 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
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

And an |image with a link|.

.. |image with a link| image:: movie.jpg
   :alt:  A movie
   :target: /url

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

Simple Tables
=============

==================  ===========  ==========
col 1               col 2        col 3 
==================  ===========  ==========
r1 a                b            c
r2 d                e            f
==================  ===========  ==========

Headless

==================  ===========  ==========
r1 a                b            c
r2 d                e            f
==================  ===========  ==========


Grid Tables
===========

+------------------+-----------+------------+
| col 1            | col 2     | col 3      |
+==================+===========+============+
| r1 a             | b         | c          |
| r1 bis           | b 2       | c 2        |
+------------------+-----------+------------+
| r2 d             | e         | f          |
+------------------+-----------+------------+

Headless

+------------------+-----------+------------+
| r1 a             | b         | c          |
| r1 bis           | b 2       | c 2        |
+------------------+-----------+------------+
| r2 d             | e         | f          |
+------------------+-----------+------------+

Spaces at ends of lines

+------------------+-----------+------------+  
| r1 a             | b         | c          |
| r1 bis           | b 2       | c 2        | 
+------------------+-----------+------------+
| r2 d             | e         | f          |
+------------------+-----------+------------+

Multiple blocks in a cell

+------------------+-----------+------------+  
| r1 a             | - b       | c          |
|                  | - b 2     | c 2        | 
| r1 bis           | - b 2     | c 2        | 
+------------------+-----------+------------+

Footnotes
=========

[1]_

[#]_

[#]_

[*]_

.. [1] Note with one line.

.. [#] Note with
  continuation line.

.. [#] Note with

  continuation block.

.. [*] Note with
   continuation line

   and a second para.

Not in note.

Math
====

Some inline math :math:`E=mc^2`\ .  Now some
display math:

.. math:: E=mc^2

.. math::

   E = mc^2

.. math::

   E = mc^2

   \alpha = \beta

.. math::
   :label: hithere
   :nowrap:

   E &= mc^2\\
   F &= \pi E

   F &= \gamma \alpha^2

All done.

Default-Role
============

Try changing the default role to a few different things.

.. default-role:: math

Doesn't Break Title Parsing
---------------------------

Inline math: `E=mc^2` or :math:`E=mc^2` or `E=mc^2`:math:.
Other roles: :sup:`super`, `sub`:sub:.

.. math::
    \alpha = beta

    E = mc^2

.. default-role:: sup

Some `of` these :sup:`words` are in `superscript`:sup:.

Reset default-role to the default default.

.. default-role::

And now `some-invalid-string-3231231` is nonsense.

Literal symbols
---------------

2*2 = 4*1