git.iko.soy/typeable/pandoc
on master help sign in
Documented pandoc 1.3's definition lists in README.

Unfortunately, this wasn't done before the release. git-svn-id: https://pandoc.googlecode.com/svn/trunk@1669 788f1e2b-df1e-0410-8736-df70ead52e1b

commitf48a4a800f3cbb3a8ccbfaaa15c43d882d40a9e3 authorfiddlosopher <fiddlosopher@788f1e2b-df1e-0410-8736-df70ead52e1b> dateTue 29 Dec 2009, 20:57 (17 years ago) parent5df3ec1
1 file changed+27−25
README+27−25
README+27−25
@@ -583,41 +583,43 @@ Definition lists
583583----------------
584584
585585Pandoc supports definition lists, using a syntax inspired by
586−[PHP Markdown Extra] and [reStructuredText]:
587−
588− [PHP Markdown Extra]: http://www.michelf.com/projects/php-markdown/extra/
586+[PHP Markdown Extra] and [reStructuredText]:[^3]
589587
590588 Term 1
591− : Definition 1
592589
593− Term 2
594− : Definition 2
590+ : Definition 1
595591
596− : Second paragraph of definition 2.
592+ Term 2 with *inline markup*
597593
598−Each term must fit on one line. The definition must begin on the line
599−after the term. The definition consists of one or more block elements
600−(paragraph, code block, list, etc.), each beginning with a colon and
601−(aside from the colon) indented one tab stop.
594+ : Definition 2
602595
603− Term *with inline markup*
604− : Here is the definition. It may contain multiple blocks.
605− Here is some code:
596+ { some code, part of Definition 2 }
606597
607− : {* my code *}
598+ Third paragraph of definition 2.
608599
609− : Here is the third paragraph of this definition.
600+Each term must fit on one line, which may optionally be followed by
601+a blank line, and must be followed by one or more definitions.
602+A definition begins with a colon or tilde, which may be indented one
603+or two spaces. A term may have multiple definitions, and each definition
604+may consist of one or more block elements (paragraph, code block, list,
605+etc.), each indented one tab stop.
610606
611−If you leave space after the definition (as in the first example above),
612−the definitions will be considered paragraphs. In some output formats,
613−this will mean greater spacing between term/definition pairs. For a
614−compact definition list, do not leave space between the definition and
615−the next term:
607+If you leave space after the definition (as in the example above),
608+the blocks of the definitions will be considered paragraphs. In some
609+output formats, this will mean greater spacing between term/definition
610+pairs. For a compact definition list, do not leave space between the
611+definition and the next term:
616612
617613 Term 1
618− : Definition 1
614+ ~ Definition 1
619615 Term 2
620− : Definition 2
616+ ~ Definition 2a
617+ ~ Definition 2b
618+
619+[^3]: I have also been influenced by the suggestions of [David Wheeler]
620+(http://www.justatheory.com/computers/markup/modest-markdown-proposal.html).
621+
622+[PHP Markdown Extra]: http://www.michelf.com/projects/php-markdown/extra/
621623
622624Reference links
623625---------------
@@ -691,7 +693,7 @@ Simple tables look like this:
691693
692694The headers and table rows must each fit on one line. Column
693695alignments are determined by the position of the header text relative
694−to the dashed line below it:[^3]
696+to the dashed line below it:[^4]
695697
696698 - If the dashed line is flush with the header text on the right side
697699 but extends beyond it on the left, the column is right-aligned.
@@ -702,7 +704,7 @@ to the dashed line below it:[^3]
702704 - If the dashed line is flush with the header text on both sides,
703705 the default alignment is used (in most cases, this will be left).
704706
705−[^3]: This scheme is due to Michel Fortin, who proposed it on the
707+[^4]: This scheme is due to Michel Fortin, who proposed it on the
706708 [Markdown discussion list](http://six.pairlist.net/pipermail/markdown-discuss/2005-March/001097.html).
707709
708710The table must end with a blank line, or a line of dashes followed by