summaryrefslogtreecommitdiff
path: root/README
diff options
context:
space:
mode:
authorfiddlosopher <fiddlosopher@788f1e2b-df1e-0410-8736-df70ead52e1b>2007-03-11 07:53:21 +0000
committerfiddlosopher <fiddlosopher@788f1e2b-df1e-0410-8736-df70ead52e1b>2007-03-11 07:53:21 +0000
commit44cec96e61271575c5464adaba90180559898c1d (patch)
tree7fa9b03fc393c728de1ac06c72da2b5169c96c7f /README
parent2e794fdf37dce8dd1ab5e385b5b3e38bef5f4364 (diff)
New syntax documentation for definition lists. Now we
require a ':' at the beginning of the definition; otherwise, too many false positives for definition lists. git-svn-id: https://pandoc.googlecode.com/svn/trunk@570 788f1e2b-df1e-0410-8736-df70ead52e1b
Diffstat (limited to 'README')
-rw-r--r--README16
1 files changed, 9 insertions, 7 deletions
diff --git a/README b/README
index 5e70ec51e..501b79c6c 100644
--- a/README
+++ b/README
@@ -425,24 +425,26 @@ Definition lists
----------------
Pandoc supports definition lists, using a syntax inspired by
-[reStructuredText]'s definition list syntax:
+[PHP Markdown Extra] and [reStructuredText]:
+
+ [PHP Markdown Extra]: http://www.michelf.com/projects/php-markdown/extra/
Term 1
- Definition 1
+ : Definition 1
Term 2
- Definition 2
+ : Definition 2
Second paragraph of definition 2.
The terms must fit on one line, but they may contain arbitrary inline
markup (emphasis, links, etc.). The definition must begin on the line
-after the term, indented by one tab stop. The definition consists of
+after the term, and must begin with a colon. The definition consists of
one or more block elements (paragraph, code block, list, etc.).
Each block must be indented one tab stop.
Term *with inline markup*
- Here is the definition. It may
+ : Here is the definition. It may
contain multiple blocks. Here is some code:
{* my code *}
@@ -456,9 +458,9 @@ compact definition list, do not leave space between the definition and
the next term:
Term 1
- Definition 1
+ : Definition 1
Term 2
- Definition 2
+ : Definition 2
Reference links
---------------