[Docutils-checkins] docutils/spec/rst directives.txt,1.6,1.7

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

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

Modified Files:
	directives.txt 
Log Message:
Added the "sectnum" directive.

Index: directives.txt
===================================================================
RCS file: /cvsroot/docutils/docutils/spec/rst/directives.txt,v
retrieving revision 1.6
retrieving revision 1.7
diff -C2 -d -r1.6 -r1.7
*** directives.txt	7 Aug 2002 01:11:40 -0000	1.6
--- directives.txt	13 Aug 2002 01:00:28 -0000	1.7
***************
*** 10,13 ****
--- 10,21 ----
  reStructuredText parser.
  
+ Directives have the following syntax::
+ 
+     +-------+--------------------------+
+     | ".. " | directive type "::" data |
+     +-------+ directive block          |
+             |                          |
+             +--------------------------+
+ 
  
  .. contents::
***************
*** 236,240 ****
  ``depth`` : integer
      The number of section levels that are collected in the table of
!     contents.
  ``local`` : empty
      Generate a local table of contents.  Entries will only include
--- 244,248 ----
  ``depth`` : integer
      The number of section levels that are collected in the table of
!     contents.  The default is unlimited depth.
  ``local`` : empty
      Generate a local table of contents.  Entries will only include
***************
*** 246,260 ****
  
  
! Footnotes
! =========
  
! **NOT IMPLEMENTED YET**
  
! DTD elements: pending, topic.
  
! @@@
  
  
! Citations
  =========
  
--- 254,287 ----
  
  
! Automatic Section Numbering
! ===========================
  
! DTD elements: pending, generated.
  
! Directive block: directive data and following indented lines (up to
! the first blank line) are interpreted as optional attributes.
  
! The "sectnum" (or "section-autonumbering") directive automatically
! numbers sections and subsections in a document.  Section numbers of
! the "multiple enumeration" form, where each level has a number,
! separated by periods.  For example, the title of section 1, subsection
! 2, subsubsection 3 would have "1.2.3" prefixed.  
! 
! The "sectnum" directive does its work in two passes: initial parse and
! transform.  During the initial parse, a "pending" element is generated
! which acts as a placeholder, storing any attributes internally.  At a
! later stage in the processing, the "pending" element triggers a
! transform, which adds section numbers to titles.  Section numbers are
! enclosed in a "generated" element, and titles have their "auto"
! attribute set to "1".
  
+ The following attributes are recognized:
  
! ``depth`` : integer
!     The number of section levels that are numbered by this directive.
!     The default is unlimited depth.
! 
! 
! Footnotes
  =========
  
***************
*** 266,275 ****
  
  
! Topic
! =====
  
  **NOT IMPLEMENTED YET**
  
! DTD element: topic.
  
  @@@
--- 293,302 ----
  
  
! Citations
! =========
  
  **NOT IMPLEMENTED YET**
  
! DTD elements: pending, topic.
  
  @@@