aboutsummaryrefslogtreecommitdiff
path: root/README
diff options
context:
space:
mode:
authorJohn MacFarlane <jgm@berkeley.edu>2010-07-11 22:47:52 -0700
committerJohn MacFarlane <jgm@berkeley.edu>2010-07-11 22:47:52 -0700
commit0181e66250302516863eaa4e25bb5b4b10807e2b (patch)
tree39671e549071f33df58d642e784a4063b7c283f0 /README
parentcfb27ece34405833592697147276f5bf6418224c (diff)
parent6972c0b5b040f3de998d936e6ddf8580ecfa7b30 (diff)
downloadpandoc-0181e66250302516863eaa4e25bb5b4b10807e2b.tar.gz
Merge branch 'atlists'. Added auto-numbered example lists.
Diffstat (limited to 'README')
-rw-r--r--README36
1 files changed, 31 insertions, 5 deletions
diff --git a/README b/README
index fac6251aa..2e2a14e3f 100644
--- a/README
+++ b/README
@@ -583,12 +583,12 @@ which allows only the following characters to be backslash-escaped:
\`*_{}[]()>#+-.!
A backslash-escaped space is parsed as a nonbreaking space. It will
-appear in TeX output as '`~`' and in HTML and XML as '`\&#160;`' or
-'`\&nbsp;`'.
+appear in TeX output as `~` and in HTML and XML as `\&#160;` or
+`\&nbsp;`.
A backslash-escaped newline (i.e. a backslash occurring at the end of
a line) is parsed as a hard line break. It will appear in TeX output as
-'`\\`' and in HTML as '`<br />`'. This is a nice alternative to
+`\\` and in HTML as `<br />`. This is a nice alternative to
markdown's "invisible" way of indicating hard line breaks using
two trailing spaces on a line.
@@ -666,7 +666,7 @@ capital letter with a period, by at least two spaces.[^2]
escape can be used:
(C\) 2007 Joe Smith
-
+
Pandoc also pays attention to the type of list marker used, and to the
starting number, and both of these are preserved where possible in the
output format. Thus, the following yields a list with numbers followed
@@ -688,12 +688,38 @@ So, the following yields a list numbered sequentially starting from 2:
1. Four
* Five
-If default list markers are desired, use '`#.`':
+If default list markers are desired, use `#.`:
#. one
#. two
#. three
+Numbered examples
+-----------------
+
+The special list marker `@` can be used for sequentially numbered
+examples. The first list item with a `@` marker will be numbered '1',
+the next '2', and so on, throughout the document. The numbered examples
+need not occur in a single list; each new list using `@` will take up
+where the last stopped. So, for example:
+
+ (@) My first example will be numbered (1).
+ (@) My second example will be numbered (2).
+
+ Explanation of examples.
+
+ (@) My third example will be numbered (3).
+
+Numbered examples can be labeled and referred to later in the
+document:
+
+ (@good) This is a good example.
+
+ As (@good) illustrates, ...
+
+The label can be any string of alphanumeric characters, underscores,
+or hyphens. The example must occur before the reference.
+
Definition lists
----------------