[Docutils-checkins] docutils/spec notes.txt,1.56,1.57

[David G. <go...@us...>]

Update of /cvsroot/docutils/docutils/spec
In directory usw-pr-cvs1:/tmp/cvs-serv28067/docutils/spec

Modified Files:
	notes.txt 
Log Message:
updated

Index: notes.txt
===================================================================
RCS file: /cvsroot/docutils/docutils/spec/notes.txt,v
retrieving revision 1.56
retrieving revision 1.57
diff -C2 -d -r1.56 -r1.57
*** notes.txt	7 Aug 2002 01:24:51 -0000	1.56
--- notes.txt	9 Aug 2002 01:18:45 -0000	1.57
***************
*** 51,58 ****
    applicable in these languages.
  
- - Text like "``--an-option``" can get wrapped badly in HTML browsers,
-   like "``--\nan-option``".  Should inline literals prevent soft
-   linebreaks?  Allow breaks at whitespace or not at all?
- 
  - @@@ This shouldn't be recognized as a list item::
  
--- 51,54 ----
***************
*** 60,63 ****
--- 56,64 ----
        smart dude.
  
+   Or this::
+ 
+       1. This is the heading of section one
+       =====================================
+ 
    The only problem is, what about this? ::
  
***************
*** 69,72 ****
--- 70,80 ----
        B. So was Carl Sagan.
  
+   But what about this?  Accidents can happen::
+ 
+       A. Einstein was a great influence on
+       B. Physicist, who was a colleague of
+       C. Chemist.  They all worked in
+       Princeton, NJ.
+ 
    Time to put more smarts into the list item recognition code, or
    just document it as a corner case and require escapes?  E.g.::
***************
*** 74,78 ****
        \A. Einstein was a really smart dude.
  
!   (Bug report by Jeremy Hylton.)
  
  
--- 82,86 ----
        \A. Einstein was a really smart dude.
  
!   (Bug reports by Jeremy Hylton and Dmitry Jemerov.)
  
  
***************
*** 86,94 ****
    - Implementation docs.
  
!     - spec/doctree.txt: Doctree nodes (DTD element) semantics:
  
        - External (public) attributes (node.attributes).
!       - Internal attributes (node.*).
!       - Linking mechanism.
  
      - How a Writer works & how to write one
--- 94,110 ----
    - Implementation docs.
  
!     - spec/doctree.txt: Doctree element (DTD element) semantics:
  
        - External (public) attributes (node.attributes).
!       - Internal attributes (node.*). (?)
!       - Linking mechanism. (?)
! 
!       Should this document be about the code (implementation details),
!       or about the DTD (document tree elements)?  I'm having trouble
!       writing it because it's a bit schizo; doesn't know what it is.
!       Perhaps it should simply document the DTD elements, their
!       semantics, and only refer to the implementation.  Descriptions
!       of the classes, their methods, and internal attributes belong in
!       the implementation docs (docstrings for now).
  
      - How a Writer works & how to write one
***************
*** 138,144 ****
    individual features ("meta" etc.) instead of formats ("html" etc.)?
  
- - @@@ Add references to the user docs: bugs to the SF bug tracker,
-   questions to the mailing lists.
- 
  
  Specification
--- 154,157 ----
***************
*** 342,351 ****
    non-alphanumeric non-whitespace character.
  
! - Decide whether or not to implement Simon Budig's "inline external
!   targets" syntax idea, and if so, how:
  
!   - regular directive affecting its indented text block
!   - pragma directive affecting the entire document
!   - or a full-blown addition to the spec & parser
  
  - Add support for pragma (syntax-altering) directives.
--- 355,387 ----
    non-alphanumeric non-whitespace character.
  
! - @@@ Decide whether or not to implement Simon Budig's "inline
!   external targets" syntax idea, and if so, how?
  
!   - As a regular directive affecting its indented text block::
! 
!         .. inline-urls::
! 
!            This is an anonymous `reference <http://www.example.org
!            /reference/>`__ of one word ("reference").  Here is a
!            `phrase reference <http://www.example.org
!            /phrase_reference/>`__.
! 
!   - As a pragma directive affecting the entire document (from that
!     point on).  Perhaps a variation on the regular directive::
! 
!         .. inline-urls:: :pragma:
! 
!         Ordinary paragraphs ...
! 
!         This is an anonymous `reference <http://www.example.org
!         /reference/>`__ of one word ("reference").  Here is a
!         `phrase reference <http://www.example.org
!         /phrase_reference/>`__.
! 
!     Perhaps "``:global:``" instead of "``:pragma:``"?  This pattern
!     could be useful for other pragma directives: local-scope unless
!     explicitly specified as global/pragma.
! 
!   - Or as a full-blown addition to the spec & parser.
  
  - Add support for pragma (syntax-altering) directives.
***************
*** 370,375 ****
    - _`parts.citations`: See `Footnote & Citation Gathering`_.
  
!   - _`parts.sectnum` (section numbering; add support to .contents;
!     could be cmdline option also)
  
    - _`misc.raw`
--- 406,411 ----
    - _`parts.citations`: See `Footnote & Citation Gathering`_.
  
!   - _`parts.sectnum` (automatic section numbering; add support to
!     the "contents" directive; could be cmdline option also)
  
    - _`misc.raw`