[Doc-SIG] docutils status report

[Fred L. Drake, Jr.]

--KkM6q1xuaq
Content-Type: text/plain; charset=us-ascii
Content-Description: message body and .signature
Content-Transfer-Encoding: 7bit


Tony J Ibbs (Tibs) writes:
 >   7. Recognise numbered list items (but the final dot *is* required,
 >      otherwise 3 above will fail on::

  I like this adjustment.

 >      Note that one won't be able to do::
 > 
 >         And the final number is
 >         1.
 > 
 >      without a spurious list, but I reckon we can live with that!
 >      (We have to pay for apparent simplicity with true complexity.)

  Perhaps also require some text after the number in order to break
the paragraph and start a numbered list.  Seems like a reasonable
sanity check.

 >  A. Move the datastructure to a DOM model (probably based on
 >     Python 2.0's mindom.py). DOM looks sensible because it is
 >     (erm) fashionable, and if I use minidom then I get XML
 >     output for free.

  I'm not sure what you mean a "DOM model"; why not use the DOM with
a specific structure?  I've attached a short DTD I came up with while
thinking about structured text & such.  ;)

 >  D. Document what it does, so that David and company can haggle over the
 >     exact syntax supported. This obviously includes making sure the
 >     whole thing has nice (correct) docstrings throughout.

  There's documenting the code, and the format.  Concentrate on the
later before worrying about the former.


  -Fred

-- 
Fred L. Drake, Jr.  <fdrake at acm.org>
PythonLabs at Digital Creations


--KkM6q1xuaq
Content-Type: text/plain
Content-Description: potential STNG DTD
Content-Disposition: inline;
	filename="basic.dtd"
Content-Transfer-Encoding: 7bit

<!-- This DTD should provide enough to support everything available in
     StructuredTextNG.
  -->

<!ELEMENT document (section|title|p|ol|ul|pre)*>

<!ELEMENT section (title?, (section|p|ol|ul|pre)*)>
<!ELEMENT title (#PCDATA|a|code|em|strong|u)*>

<!ELEMENT ol (li+)>
<!ELEMENT ul (li+)>

<!ELEMENT li (p|ol|ul|pre|section)+>

<!ELEMENT p (#PCDATA|a|code|em|strong|u)*>

<!ELEMENT pre (#PCDATA)>
<!ATTLIST pre xml:space (default|preserve) #FIXED "preserve">

<!ELEMENT a (#PCDATA|code|em|strong|u)*>
<!ELEMENT code (#PCDATA|a|em|strong|u)*>
<!ELEMENT em (#PCDATA|a|code|strong|u)*>
<!ELEMENT strong (#PCDATA|a|code|em|u)*>
<!ELEMENT u (#PCDATA|a|code|em|strong)*>

<!ATTLIST a href CDATA #REQUIRED>

--KkM6q1xuaq--