changeset 1194:5543dd64b1ee

Fix RST enumerated list docs, add RSTTODO in moinwiki docs
author Sam Toyer <samATqxcvDOTnet>
date Fri, 30 Dec 2011 19:55:35 +1000
parents e55b96d76cc9
children a52b5aa085da
files docs/user/moinwiki.rst docs/user/rest.rst
diffstat 2 files changed, 11 insertions(+), 9 deletions(-) [+]
line wrap: on
line diff
--- a/docs/user/moinwiki.rst	Fri Dec 30 17:10:54 2011 +1000
+++ b/docs/user/moinwiki.rst	Fri Dec 30 19:55:35 2011 +1000
@@ -185,6 +185,7 @@
    All Moin Wiki list syntax (including that for unordered lists, ordered lists and definition lists) requires a leading space before each item in the list.
    Unfortunately, reStructuredText does not allow leading whitespace in code samples, so the example markup here will not work if copied verbatim, and requires
    that each line of the list be indented by one space in order to be valid Moin Wiki markup.
+   This is also an **RSTTODO**
 
 Unordered Lists
 ---------------
--- a/docs/user/rest.rst	Fri Dec 30 17:10:54 2011 +1000
+++ b/docs/user/rest.rst	Fri Dec 30 19:55:35 2011 +1000
@@ -201,24 +201,25 @@
 
  1. item 1
  
-   1. item 1.1
+    1. item 1.1
+    #. item 1.2
    
-   2. item 1.2
-   
- 2. item 2
+ #. item 2
 
 **Result**:
 
  1. item 1
  
-   1. item 1.1
+    1. item 1.1
+    #. item 1.2
    
-   2. item 1.2
-   
- 2. item 2
+ #. item 2
    
 **Notes**:
- - The order and the numbering agent have to be maintained by the user. Any character can be used to number the items (e.g. a/A or i/I).
+ - Ordered lists can be automatically enumerated using the ``#`` character as demonstrated above. Note that the first item of an ordered list
+   auto-enumerated in this fashion must use explicit numbering notation (e.g. ``1.``) in order to select the enumeration sequence type
+   (e.g. Roman numerals, Arabic numerals, etc.), initial number (for lists which do not start at "1") and formatting type (e.g. ``1.`` or ``(1)`` or ``1)``). More information on
+   enumerated lists can be found in the `reStructuredText documentation <http://docutils.sourceforge.net/docs/ref/rst/restructuredtext.html#enumerated-lists>`_.
  - One or more blank lines are required before and after reStructuredText lists.
 
 Definition Lists