git.iko.soy/typeable/pandoc
on master help sign in
Documented pandoc 1.3's definition lists in README.
f48a4a8fiddlosopher
README+27−25
@@ -583,41 +583,43 @@ Definition lists
583----------------
583----------------
584
584
585Pandoc supports definition lists, using a syntax inspired by
585Pandoc supports definition lists, using a syntax inspired by
586−[PHP Markdown Extra] and [reStructuredText]:
586+[PHP Markdown Extra] and [reStructuredText]:[^3]
587−
588− [PHP Markdown Extra]: http://www.michelf.com/projects/php-markdown/extra/
589
587
590 Term 1
588 Term 1
591− : Definition 1
592
589
593− Term 2
594− : Definition 2
590+ : Definition 1
595
591
596− : Second paragraph of definition 2.
592+ Term 2 with *inline markup*
597
593
598−Each term must fit on one line. The definition must begin on the line
594+ : Definition 2
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.
602
595
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 }
606
597
607− : {* my code *}
598+ Third paragraph of definition 2.
608
599
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.
610
606
611−If you leave space after the definition (as in the first example above),
607+If you leave space after the definition (as in the example above),
612−the definitions will be considered paragraphs. In some output formats,
608+the blocks of the definitions will be considered paragraphs. In some
613−this will mean greater spacing between term/definition pairs. For a
609+output formats, this will mean greater spacing between term/definition
614−compact definition list, do not leave space between the definition and
610+pairs. For a compact definition list, do not leave space between the
615−the next term:
611+definition and the next term:
616
612
617 Term 1
613 Term 1
618− : Definition 1
614+ ~ Definition 1
619 Term 2
615 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/
621
623
622Reference links
624Reference links
623---------------
625---------------
@@ -691,7 +693,7 @@ Simple tables look like this:
691
693
692The headers and table rows must each fit on one line. Column
694The headers and table rows must each fit on one line. Column
693alignments are determined by the position of the header text relative
695alignments 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]
695
697
696 - If the dashed line is flush with the header text on the right side
698 - If the dashed line is flush with the header text on the right side
697 but extends beyond it on the left, the column is right-aligned.
699 but extends beyond it on the left, the column is right-aligned.
@@ -702,7 +704,7 @@ to the dashed line below it:[^3]
702 - If the dashed line is flush with the header text on both sides,
704 - If the dashed line is flush with the header text on both sides,
703 the default alignment is used (in most cases, this will be left).
705 the default alignment is used (in most cases, this will be left).
704
706
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
706 [Markdown discussion list](http://six.pairlist.net/pipermail/markdown-discuss/2005-March/001097.html).
708 [Markdown discussion list](http://six.pairlist.net/pipermail/markdown-discuss/2005-March/001097.html).
707
709
708The table must end with a blank line, or a line of dashes followed by
710The table must end with a blank line, or a line of dashes followed by