structuredtext-checkins Mailing List for reStructuredText (Page 3)

Status: Pre-Alpha

Brought to you by: goodger

structuredtext-checkins — CVS checkin messages

You can subscribe to this list here.

2001	_Jan	_Feb	_Mar	_Apr	_May	_Jun	_Jul	_Aug (83)	_Sep (171)	_Oct (49)	_Nov (58)	_Dec
2002	_Jan (34)	_Feb (76)	_Mar (111)	_Apr (47)	_May	_Jun	_Jul	_Aug	_Sep	_Oct	_Nov	_Dec

Flat | Threaded

<< < 1 2 3 4 5 .. 26 > >> (Page 3 of 26)

[Structuredtext-checkins] CVS: restructuredtext/spec problems.txt,1.6,1.7

From: David G. <go...@us...> - 2002-03-28 04:27:46

Update of /cvsroot/structuredtext/restructuredtext/spec
In directory usw-pr-cvs1:/tmp/cvs-serv7323/restructuredtext/spec

Modified Files:
	problems.txt 
Log Message:
Clarifications, updates, & fixes.

Index: problems.txt
===================================================================
RCS file: /cvsroot/structuredtext/restructuredtext/spec/problems.txt,v
retrieving revision 1.6
retrieving revision 1.7
diff -C2 -d -r1.6 -r1.7
*** problems.txt	16 Mar 2002 05:35:15 -0000	1.6
--- problems.txt	28 Mar 2002 04:27:44 -0000	1.7
***************
*** 750,754 ****
  .. _StructuredText:
     http://dev.zope.org/Members/jim/StructuredTextWiki/FrontPage
! .. _Setext: http://www.bsdi.com/setext
  .. _reStructuredText: http://structuredtext.sourceforge.net
  .. _detailed description:
--- 750,754 ----
  .. _StructuredText:
     http://dev.zope.org/Members/jim/StructuredTextWiki/FrontPage
! .. _Setext: http://docutils.sourceforge.net/mirror/setext.html
  .. _reStructuredText: http://structuredtext.sourceforge.net
  .. _detailed description:

[Structuredtext-checkins] CVS: restructuredtext/spec introduction.txt,1.8,1.9

From: David G. <go...@us...> - 2002-03-28 04:27:34

Update of /cvsroot/structuredtext/restructuredtext/spec
In directory usw-pr-cvs1:/tmp/cvs-serv7183/restructuredtext/spec

Modified Files:
	introduction.txt 
Log Message:
Clarifications, updates, & fixes.

Index: introduction.txt
===================================================================
RCS file: /cvsroot/structuredtext/restructuredtext/spec/introduction.txt,v
retrieving revision 1.8
retrieving revision 1.9
diff -C2 -d -r1.8 -r1.9
*** introduction.txt	16 Mar 2002 05:31:40 -0000	1.8
--- introduction.txt	28 Mar 2002 04:27:31 -0000	1.9
***************
*** 28,32 ****
  .. _StructuredText:
      http://dev.zope.org/Members/jim/StructuredTextWiki/FrontPage
! .. _Setext: http://www.bsdi.com/setext
  .. _Python Docstring Processing System:
  .. _Docstring Processing System: http://docstring.sourceforge.net/
--- 28,32 ----
  .. _StructuredText:
      http://dev.zope.org/Members/jim/StructuredTextWiki/FrontPage
! .. _Setext: http://docutils.sourceforge.net/mirror/setext.html
  .. _Python Docstring Processing System:
  .. _Docstring Processing System: http://docstring.sourceforge.net/
***************
*** 147,156 ****
  
  reStructuredText_, the specification, is based on StructuredText_ and
! Setext_.  StructuredText was developed by Jim Fulton of `Digital
! Creations`_ and first released in 1996.  It is now released as a part
! of the open-source 'Z Object Publishing Environment' (ZOPE_).  Ian
! Feldman's and Tony Sanders' earlier Setext_ specification was either
! an influence on StructuredText or, by their similarities, at least
! evidence of the correctness of this approach.
  
  I discovered StructuredText_ in late 1999 while searching for a way to
--- 147,156 ----
  
  reStructuredText_, the specification, is based on StructuredText_ and
! Setext_.  StructuredText was developed by Jim Fulton of `Zope
! Corporation`_ (formerly Digital Creations) and first released in 1996.
! It is now released as a part of the open-source 'Z Object Publishing
! Environment' (ZOPE_).  Ian Feldman's and Tony Sanders' earlier Setext_
! specification was either an influence on StructuredText or, by their
! similarities, at least evidence of the correctness of this approach.
  
  I discovered StructuredText_ in late 1999 while searching for a way to
***************
*** 175,181 ****
  overwhelming.
  
! Recently, development on StructuredTextNG_ ("Next Generation") has
! begun at Digital Creations.  It seems to have many improvements, but
! still suffers from many of the problems of classic StructuredText.
  
  I decided that a complete rewrite was in order, and even started a
--- 175,182 ----
  overwhelming.
  
! In 2000, development on StructuredTextNG_ ("Next Generation") began at
! `Zope Corporation`_ (then Digital Creations).  It seems to have many
! improvements, but still suffers from many of the problems of classic
! StructuredText.
  
  I decided that a complete rewrite was in order, and even started a
***************
*** 271,275 ****
  
  
! .. _Digital Creations: http://www.digicool.com
  .. _ZOPE: http://www.zope.org
  .. _pythondoc: http://starship.python.net/crew/danilo/pythondoc/
--- 272,276 ----
  
  
! .. _Zope Corporation: http://www.zope.com
  .. _ZOPE: http://www.zope.org
  .. _pythondoc: http://starship.python.net/crew/danilo/pythondoc/

[Structuredtext-checkins] CVS: restructuredtext/spec alternatives.txt,1.18,1.19

From: David G. <go...@us...> - 2002-03-28 04:27:21

Update of /cvsroot/structuredtext/restructuredtext/spec
In directory usw-pr-cvs1:/tmp/cvs-serv7048/restructuredtext/spec

Modified Files:
	alternatives.txt 
Log Message:
Clarifications, updates, & fixes.

Index: alternatives.txt
===================================================================
RCS file: /cvsroot/structuredtext/restructuredtext/spec/alternatives.txt,v
retrieving revision 1.18
retrieving revision 1.19
diff -C2 -d -r1.18 -r1.19
*** alternatives.txt	16 Mar 2002 05:35:08 -0000	1.18
--- alternatives.txt	28 Mar 2002 04:27:18 -0000	1.19
***************
*** 1,5 ****
! ================================================
!  Record of reStructuredText Syntax Alternatives
! ================================================
  :Author: David Goodger
  :Contact: go...@us...
--- 1,5 ----
! ==================================================
!  A Record of reStructuredText Syntax Alternatives
! ==================================================
  :Author: David Goodger
  :Contact: go...@us...
***************
*** 14,18 ****
  full details of the established syntax.
  
! .. _Setext: http://www.bsdi.com/setext
  .. _StructuredText:
     http://dev.zope.org/Members/jim/StructuredTextWiki/FrontPage
--- 14,18 ----
  full details of the established syntax.
  
! .. _Setext: http://docutils.sourceforge.net/mirror/setext.html
  .. _StructuredText:
     http://dev.zope.org/Members/jim/StructuredTextWiki/FrontPage

[Structuredtext-checkins] CVS: restructuredtext/test/test_states test_targets.py,1.18,1.19

From: David G. <go...@us...> - 2002-03-28 04:20:57

Update of /cvsroot/structuredtext/restructuredtext/test/test_states
In directory usw-pr-cvs1:/tmp/cvs-serv2775/restructuredtext/test/test_states

Modified Files:
	test_targets.py 
Log Message:
updated

Index: test_targets.py
===================================================================
RCS file: /cvsroot/structuredtext/restructuredtext/test/test_states/test_targets.py,v
retrieving revision 1.18
retrieving revision 1.19
diff -C2 -d -r1.18 -r1.19
*** test_targets.py	16 Mar 2002 05:29:51 -0000	1.18
--- test_targets.py	28 Mar 2002 04:20:55 -0000	1.19
***************
*** 173,177 ****
      <system_message level="2" refid="id1" type="WARNING">
          <paragraph>
!             Duplicate explicit target name: "target"
      <target dupname="target" id="id1" refuri="second">
  """],
--- 173,177 ----
      <system_message level="2" refid="id1" type="WARNING">
          <paragraph>
!             Duplicate explicit target name: "target".
      <target dupname="target" id="id1" refuri="second">
  """],
***************
*** 190,194 ****
      <system_message level="1" refid="id1" type="INFO">
          <paragraph>
!             Duplicate explicit target name: "target"
      <target id="id1" name="target" refuri="first">
  """],
--- 190,194 ----
      <system_message level="1" refid="id1" type="INFO">
          <paragraph>
!             Duplicate explicit target name: "target".
      <target id="id1" name="target" refuri="first">
  """],
***************
*** 220,224 ****
          <system_message level="1" refid="id1" type="INFO">
              <paragraph>
!                 Duplicate implicit target name: "title"
          <paragraph>
              Paragraph.
--- 220,224 ----
          <system_message level="1" refid="id1" type="INFO">
              <paragraph>
!                 Duplicate implicit target name: "title".
          <paragraph>
              Paragraph.
***************
*** 243,247 ****
          <system_message level="1" refid="id1" type="INFO">
              <paragraph>
!                 Duplicate implicit target name: "title"
          <target id="id1" name="title">
          <paragraph>
--- 243,247 ----
          <system_message level="1" refid="id1" type="INFO">
              <paragraph>
!                 Duplicate implicit target name: "title".
          <target id="id1" name="title">
          <paragraph>
***************
*** 272,276 ****
      <system_message level="2" refid="id1" type="WARNING">
          <paragraph>
!             Duplicate explicit target name: "title"
      <target dupname="title" id="id1">
      <paragraph>
--- 272,276 ----
      <system_message level="2" refid="id1" type="WARNING">
          <paragraph>
!             Duplicate explicit target name: "title".
      <target dupname="title" id="id1">
      <paragraph>
***************
*** 278,282 ****
      <system_message level="2" refid="id2" type="WARNING">
          <paragraph>
!             Duplicate explicit target name: "title"
      <target dupname="title" id="id2">
      <paragraph>
--- 278,282 ----
      <system_message level="2" refid="id2" type="WARNING">
          <paragraph>
!             Duplicate explicit target name: "title".
      <target dupname="title" id="id2">
      <paragraph>
***************
*** 315,319 ****
              <system_message level="1" refid="id1" type="INFO">
                  <paragraph>
!                     Duplicate implicit target name: "target"
              <paragraph>
                  Citation target.
--- 315,319 ----
              <system_message level="1" refid="id1" type="INFO">
                  <paragraph>
!                     Duplicate implicit target name: "target".
              <paragraph>
                  Citation target.
***************
*** 321,330 ****
              <system_message level="2" refid="id2" type="WARNING">
                  <paragraph>
!                     Duplicate explicit target name: "target"
              <paragraph>
                  Autonumber-labeled footnote target.
          <system_message level="2" refid="id3" type="WARNING">
              <paragraph>
!                 Duplicate explicit target name: "target"
          <target dupname="target" id="id3">
          <paragraph>
--- 321,330 ----
              <system_message level="2" refid="id2" type="WARNING">
                  <paragraph>
!                     Duplicate explicit target name: "target".
              <paragraph>
                  Autonumber-labeled footnote target.
          <system_message level="2" refid="id3" type="WARNING">
              <paragraph>
!                 Duplicate explicit target name: "target".
          <target dupname="target" id="id3">
          <paragraph>
***************
*** 332,336 ****
          <system_message level="2" refid="id4" type="WARNING">
              <paragraph>
!                 Duplicate explicit target name: "target"
          <target dupname="target" id="id4" refuri="Explicit_external_target">
  """],
--- 332,336 ----
          <system_message level="2" refid="id4" type="WARNING">
              <paragraph>
!                 Duplicate explicit target name: "target".
          <target dupname="target" id="id4" refuri="Explicit_external_target">
  """],

[Structuredtext-checkins] CVS: restructuredtext/test/test_states test_substitutions.py,1.8,1.9

From: David G. <go...@us...> - 2002-03-28 04:20:40

Update of /cvsroot/structuredtext/restructuredtext/test/test_states
In directory usw-pr-cvs1:/tmp/cvs-serv2497/restructuredtext/test/test_states

Modified Files:
	test_substitutions.py 
Log Message:
updated

Index: test_substitutions.py
===================================================================
RCS file: /cvsroot/structuredtext/restructuredtext/test/test_states/test_substitutions.py,v
retrieving revision 1.8
retrieving revision 1.9
diff -C2 -d -r1.8 -r1.9
*** test_substitutions.py	13 Mar 2002 02:30:53 -0000	1.8
--- test_substitutions.py	28 Mar 2002 04:20:37 -0000	1.9
***************
*** 110,114 ****
      <system_message level="3" type="ERROR">
          <paragraph>
!             Duplicate substitution definition name: "symbol"
      <substitution_definition name="symbol">
          <image alt="symbol" uri="symbol.png">
--- 110,114 ----
      <system_message level="3" type="ERROR">
          <paragraph>
!             Duplicate substitution definition name: "symbol".
      <substitution_definition name="symbol">
          <image alt="symbol" uri="symbol.png">

[Structuredtext-checkins] CVS: restructuredtext/test/test_states test_footnotes.py,1.15,1.16

From: David G. <go...@us...> - 2002-03-28 04:20:23

Update of /cvsroot/structuredtext/restructuredtext/test/test_states
In directory usw-pr-cvs1:/tmp/cvs-serv2171/restructuredtext/test/test_states

Modified Files:
	test_footnotes.py 
Log Message:
updated

Index: test_footnotes.py
===================================================================
RCS file: /cvsroot/structuredtext/restructuredtext/test/test_states/test_footnotes.py,v
retrieving revision 1.15
retrieving revision 1.16
diff -C2 -d -r1.15 -r1.16
*** test_footnotes.py	16 Mar 2002 05:28:57 -0000	1.15
--- test_footnotes.py	28 Mar 2002 04:20:20 -0000	1.16
***************
*** 239,243 ****
          <system_message level="2" refid="id1" type="WARNING">
              <paragraph>
!                 Duplicate explicit target name: "five"
          <paragraph>
              Auto-numbered footnote 5 again (duplicate).
--- 239,243 ----
          <system_message level="2" refid="id1" type="WARNING">
              <paragraph>
!                 Duplicate explicit target name: "five".
          <paragraph>
              Auto-numbered footnote 5 again (duplicate).
***************
*** 306,310 ****
          <system_message level="2" refid="id3" type="WARNING">
              <paragraph>
!                 Duplicate explicit target name: "five"
          <paragraph>
              Auto-numbered footnote 5 again (duplicate).
--- 306,310 ----
          <system_message level="2" refid="id3" type="WARNING">
              <paragraph>
!                 Duplicate explicit target name: "five".
          <paragraph>
              Auto-numbered footnote 5 again (duplicate).

[Structuredtext-checkins] CVS: restructuredtext/tools default.css,1.9,1.10

From: David G. <go...@us...> - 2002-03-28 04:19:21

Update of /cvsroot/structuredtext/restructuredtext/tools
In directory usw-pr-cvs1:/tmp/cvs-serv1165/restructuredtext/tools

Modified Files:
	default.css 
Log Message:
Removed contents -ve space; h3 -> p for topics/admonitions.

Index: default.css
===================================================================
RCS file: /cvsroot/structuredtext/restructuredtext/tools/default.css,v
retrieving revision 1.9
retrieving revision 1.10
diff -C2 -d -r1.9 -r1.10
*** default.css	16 Mar 2002 05:27:38 -0000	1.9
--- default.css	28 Mar 2002 04:19:19 -0000	1.10
***************
*** 29,42 ****
    padding: 1em }
  
! div.attention h3, div.caution h3, div.danger h3, div.error h3,
! div.warning h3 {
    color: red ;
    font-weight: bold ;
    font-family: sans-serif }
  
! div.contents li {
!   margin-top: -20px }
! 
! div.hint h3, div.important h3, div.note h3, div.tip h3 {
    font-weight: bold ;
    font-family: sans-serif }
--- 29,41 ----
    padding: 1em }
  
! div.attention p.admonition-title, div.caution p.admonition-title,
! div.danger p.admonition-title, div.error p.admonition-title,
! div.warning p.admonition-title {
    color: red ;
    font-weight: bold ;
    font-family: sans-serif }
  
! div.hint p.admonition-title, div.important p.admonition-title,
! div.note p.admonition-title, div.tip p.admonition-title {
    font-weight: bold ;
    font-family: sans-serif }
***************
*** 61,66 ****
    padding: 1em }
  
! div.system-message h3 {
!   color: red }
  
  div.topic {
--- 60,66 ----
    padding: 1em }
  
! div.system-message p.system-message-title {
!   color: red ;
!   font-weight: bold }
  
  div.topic {

[Structuredtext-checkins] CVS: restructuredtext/tools test.txt,1.8,1.9

From: David G. <go...@us...> - 2002-03-28 04:18:08

Update of /cvsroot/structuredtext/restructuredtext/tools
In directory usw-pr-cvs1:/tmp/cvs-serv32411/restructuredtext/tools

Modified Files:
	test.txt 
Log Message:
Added a bad reference.

Index: test.txt
===================================================================
RCS file: /cvsroot/structuredtext/restructuredtext/tools/test.txt,v
retrieving revision 1.8
retrieving revision 1.9
diff -C2 -d -r1.8 -r1.9
*** test.txt	16 Mar 2002 05:27:02 -0000	1.8
--- test.txt	28 Mar 2002 04:18:05 -0000	1.9
***************
*** 270,273 ****
--- 270,275 ----
  __ Targets_
  
+ Here's a `hyperlink reference without a target`_.
+ 
  Directives
  ----------

[Structuredtext-checkins] CVS: restructuredtext HISTORY.txt,1.46,1.47

From: David G. <go...@us...> - 2002-03-16 05:45:14

Update of /cvsroot/structuredtext/restructuredtext
In directory usw-pr-cvs1:/tmp/cvs-serv19298/restructuredtext

Modified Files:
	HISTORY.txt 
Log Message:
updated

Index: HISTORY.txt
===================================================================
RCS file: /cvsroot/structuredtext/restructuredtext/HISTORY.txt,v
retrieving revision 1.46
retrieving revision 1.47
diff -C2 -d -r1.46 -r1.47
*** HISTORY.txt	16 Mar 2002 05:42:39 -0000	1.46
--- HISTORY.txt	16 Mar 2002 05:45:11 -0000	1.47
***************
*** 143,146 ****
--- 143,150 ----
    admonition directives 'note', 'caution', etc. Added to project.
  
+ * restructuredtext/directives/components.py: Implementation of
+   document components directives 'contents', 'footnotes', etc. Added
+   to project.
+ 
  * restructuredtext/directives/images.py: Implementation of
    directives 'image' & 'figure'. Added to project.

[Structuredtext-checkins] CVS: restructuredtext/restructuredtext/directives components.py,NONE,1.1

From: David G. <go...@us...> - 2002-03-16 05:43:48

Update of /cvsroot/structuredtext/restructuredtext/restructuredtext/directives
In directory usw-pr-cvs1:/tmp/cvs-serv19102/restructuredtext/restructuredtext/directives

Added Files:
	components.py 
Log Message:
Document component directives: "contents", "footnotes", "citations", etc.

--- NEW FILE: components.py ---
#! /usr/bin/env python

"""
:Author: David Goodger
:Contact: go...@us...
:Revision: $Revision: 1.1 $
:Date: $Date: 2002/03/16 05:43:45 $
:Copyright: This module has been placed in the public domain.

Document component directives.
"""

__docformat__ = 'reStructuredText'

__all__ = ['contents']


from dps import nodes
import dps.transforms.components


contents_attribute_spec = {'depth': int,
                           'local': (lambda x: x)}

def contents(match, typename, data, state, statemachine, attributes):
    lineno = statemachine.abslineno()
    lineoffset = statemachine.lineoffset
    datablock, indent, offset, blankfinish = \
          statemachine.getfirstknownindented(match.end(), uptoblank=1)
    blocktext = '\n'.join(statemachine.inputlines[
          lineoffset : lineoffset + len(datablock) + 1])
    for i in range(len(datablock)):
        if datablock[i][:1] == ':':
            attlines = datablock[i:]
            datablock = datablock[:i]
            break
    else:
        attlines = []
        i = 0
    titletext = ' '.join([line.strip() for line in datablock])
    if titletext:
        textnodes, messages = state.inline_text(titletext, lineno)
        title = nodes.title(titletext, '', *textnodes)
    else:
        messages = []
        title = None
    pending = nodes.pending(dps.transforms.components.Contents, 'last_reader',
                            {'title': title}, blocktext)
    if attlines:
        success, data, blankfinish = state.parse_extension_attributes(
              contents_attribute_spec, attlines, blankfinish)
        if success:                     # data is a dict of attributes
            pending.details.update(data)
        else:                           # data is an error string
            error = statemachine.memo.reporter.error(
                  'Error in "%s" directive attributes at line %s:\n%s.'
                  % (match.group(1), lineno, data), '',
                  nodes.literal_block(blocktext, blocktext))
            return [error] + messages, blankfinish
    statemachine.memo.document.note_pending(pending)
    return [pending] + messages, blankfinish

[Structuredtext-checkins] CVS: restructuredtext README.txt,1.4,1.5

From: David G. <go...@us...> - 2002-03-16 05:42:53

Update of /cvsroot/structuredtext/restructuredtext
In directory usw-pr-cvs1:/tmp/cvs-serv18672/restructuredtext

Modified Files:
	README.txt 
Log Message:
updated

Index: README.txt
===================================================================
RCS file: /cvsroot/structuredtext/restructuredtext/README.txt,v
retrieving revision 1.4
retrieving revision 1.5
diff -C2 -d -r1.4 -r1.5
*** README.txt	25 Aug 2001 01:54:52 -0000	1.4
--- README.txt	16 Mar 2002 05:42:50 -0000	1.5
***************
*** 47,51 ****
  
    - quicktest.py: Input reStructuredText, output pretty-printed
!     pseudo-XML.
  
  * spec: The project specification directory. Contains the markup
--- 47,57 ----
  
    - quicktest.py: Input reStructuredText, output pretty-printed
!     pseudo-XML and various other forms.
! 
!   - publish.py: A minimal example of a complete Docutils system, using
!     the "standalone" reader and "pformat" writer.
! 
!   - html.py: Read standalone reStructuredText documents and write
!     HTML4/CSS1.  Uses the default.css stylesheet.
  
  * spec: The project specification directory. Contains the markup

[Structuredtext-checkins] CVS: restructuredtext HISTORY.txt,1.45,1.46

From: David G. <go...@us...> - 2002-03-16 05:42:42

Update of /cvsroot/structuredtext/restructuredtext
In directory usw-pr-cvs1:/tmp/cvs-serv18572/restructuredtext

Modified Files:
	HISTORY.txt 
Log Message:
updated

Index: HISTORY.txt
===================================================================
RCS file: /cvsroot/structuredtext/restructuredtext/HISTORY.txt,v
retrieving revision 1.45
retrieving revision 1.46
diff -C2 -d -r1.45 -r1.46
*** HISTORY.txt	13 Mar 2002 02:38:23 -0000	1.45
--- HISTORY.txt	16 Mar 2002 05:42:39 -0000	1.46
***************
*** 124,127 ****
--- 124,128 ----
    - Wrapped problematic inline markup in "problematic" elements, added
      links to & from system messages.
+   - Added ``Body.parse_extension_attributes()``.
  
  * restructuredtest/tableparser.py: Added to project. Contains the
***************
*** 209,212 ****
--- 210,215 ----
    - Removed mention of compound enumerators.
    - Updated footnotes.
+   - Removed "Parser Implementation Plan". (It's implemented!)
+   - Revised.
  
  * spec/reStructuredText.txt:

[Structuredtext-checkins] CVS: restructuredtext/docs quickref.html,1.12,1.13

From: David G. <go...@us...> - 2002-03-16 05:42:35

Update of /cvsroot/structuredtext/restructuredtext/docs
In directory usw-pr-cvs1:/tmp/cvs-serv18530/restructuredtext/docs

Modified Files:
	quickref.html 
Log Message:
updated

Index: quickref.html
===================================================================
RCS file: /cvsroot/structuredtext/restructuredtext/docs/quickref.html,v
retrieving revision 1.12
retrieving revision 1.13
diff -C2 -d -r1.12 -r1.13
*** quickref.html	8 Jan 2002 02:41:59 -0000	1.12
--- quickref.html	16 Mar 2002 05:42:32 -0000	1.13
***************
*** 20,24 ****
      <p align="right"><em><a href="http://structuredtext.sourceforge.net/docs/quickref.html">http://structuredtext.sourceforge.net/docs/quickref.html</a></em>
  	<br align="right"><em>Being a cheat-sheet for reStructuredText</em>
! 	<br align="right"><em>Version 0.5 of 2002-01-07</em>
  
  
--- 20,24 ----
      <p align="right"><em><a href="http://structuredtext.sourceforge.net/docs/quickref.html">http://structuredtext.sourceforge.net/docs/quickref.html</a></em>
  	<br align="right"><em>Being a cheat-sheet for reStructuredText</em>
! 	<br align="right"><em>Version 0.6 of 2002-03-15</em>
  
  
***************
*** 49,52 ****
--- 49,53 ----
      <li><a href="#Transitions">Transitions</a></li>
      <li><a href="#Footnotes">Footnotes</a></li>
+     <li><a href="#Citations">Citations</a></li>
      <li><a href="#HyperlinkTargets">Hyperlink Targets</a></li>
      <ul>
***************
*** 128,131 ****
--- 129,137 ----
  
  	<tr valign="top">
+ 	  <td nowrap><samp>citation reference [CIT2002]_</samp>
+ 	  <td>citation reference <a href="#citations">[CIT2002]</a>
+ 	  <td>See <a href="#citations">Citations</a>.
+ 
+ 	<tr valign="top">
  	  <td nowrap><samp>http://structuredtext.sf.net/</samp>
  	  <td><a href="http://structuredtext.sf.net/">http://structuredtext.sf.net/</a>
***************
*** 716,721 ****
  	<tr valign="top">
  	  <td>
! 	    <samp>Footnote&nbsp;references,&nbsp;like&nbsp;[5]_&nbsp;and</samp>
! 	    <br><samp>[RM98]_.&nbsp;Note&nbsp;that&nbsp;footnotes&nbsp;may&nbsp;get</samp>
  	    <br><samp>rearranged,&nbsp;e.g.,&nbsp;to&nbsp;the&nbsp;bottom&nbsp;of</samp>
  	    <br><samp>the&nbsp;"page".</samp>
--- 722,727 ----
  	<tr valign="top">
  	  <td>
! 	    <samp>Footnote&nbsp;references,&nbsp;like&nbsp;[5]_.</samp>
! 	    <br><samp>Note&nbsp;that&nbsp;footnotes&nbsp;may&nbsp;get</samp>
  	    <br><samp>rearranged,&nbsp;e.g.,&nbsp;to&nbsp;the&nbsp;bottom&nbsp;of</samp>
  	    <br><samp>the&nbsp;"page".</samp>
***************
*** 723,749 ****
  	    <p><samp>..&nbsp;[5]&nbsp;A&nbsp;numerical&nbsp;footnote.&nbsp;Note</samp>
  	      <br><samp>&nbsp;&nbsp;&nbsp;there's&nbsp;no&nbsp;colon&nbsp;after&nbsp;the&nbsp;``]``.</samp>
- 	      <br><samp>..&nbsp;[RM98]&nbsp;And&nbsp;a&nbsp;reference</samp>
- 	      <br><samp>&nbsp;&nbsp;&nbsp;(as&nbsp;often&nbsp;used&nbsp;in&nbsp;journals).</samp>
- 
- 	    <p><samp>Footnote&nbsp;labels&nbsp;contain&nbsp;alphanumerics,</samp>
- 	      <br><samp>underlines,&nbsp;hyphens&nbsp;and&nbsp;fullstops.</samp>
- 	      <br><samp>Case&nbsp;is&nbsp;not&nbsp;significant.</samp>
- 
- 	    <p><samp>Given&nbsp;a&nbsp;footnote&nbsp;like&nbsp;[this]_,&nbsp;one</samp>
- 	      <br><samp>can&nbsp;also&nbsp;refer&nbsp;to&nbsp;it&nbsp;like&nbsp;`this`_.</samp>
- 
- 	    <p><samp>..&nbsp;[this]&nbsp;here.</samp>
  
  	  <td>
! 	    Footnote references, like <a href="#5">[5]</a> and
! 	    <a href="#RM98">[RM98]</a>.  Note that footnotes may get
! 	    rearranged, e.g., to the bottom of the "page".
! 
! 	    <p>Footnote labels contain alphanumerics,
! 	      underlines, hyphens and fullstops.
! 	      Case is not significant.
! 
! 	    <p>Given a footnote like <a href="#this">[this]</a>, one
! 	      can also refer to it like <a href="#this">this</a>.
  
  	    <p><table>
--- 729,737 ----
  	    <p><samp>..&nbsp;[5]&nbsp;A&nbsp;numerical&nbsp;footnote.&nbsp;Note</samp>
  	      <br><samp>&nbsp;&nbsp;&nbsp;there's&nbsp;no&nbsp;colon&nbsp;after&nbsp;the&nbsp;``]``.</samp>
  
  	  <td>
! 	    Footnote references, like <sup><a href="#5">[5]</a></sup>.
! 	    Note that footnotes may get rearranged, e.g., to the bottom of
! 	    the "page".
  
  	    <p><table>
***************
*** 752,763 ****
  	      <tr><td><a name="5"><strong>[5]</strong></a><td> A numerical footnote.
  		  Note there's no colon after the <samp>]</samp>.
- 	      <tr><td><a name="RM98"><strong>[RM98]</strong></a><td> And a reference
- 		  (as often used in journals).
- 	      <tr><td><a name="this"><strong>[this]</strong></a><td> here.
            </table>
  
  	<tr valign="top">
  	  <td>
! 	    <samp>Also,&nbsp;autonumbered&nbsp;footnotes&nbsp;are</samp>
  	    <br><samp>possible,&nbsp;like&nbsp;using&nbsp;[#]_&nbsp;and&nbsp;[#]_.</samp>
  	    <p><samp>..&nbsp;[#]&nbsp;This&nbsp;is&nbsp;the&nbsp;first&nbsp;one.</samp>
--- 740,748 ----
  	      <tr><td><a name="5"><strong>[5]</strong></a><td> A numerical footnote.
  		  Note there's no colon after the <samp>]</samp>.
            </table>
  
  	<tr valign="top">
  	  <td>
! 	    <samp>Autonumbered&nbsp;footnotes&nbsp;are</samp>
  	    <br><samp>possible,&nbsp;like&nbsp;using&nbsp;[#]_&nbsp;and&nbsp;[#]_.</samp>
  	    <p><samp>..&nbsp;[#]&nbsp;This&nbsp;is&nbsp;the&nbsp;first&nbsp;one.</samp>
***************
*** 771,780 ****
  	    <p><samp>..&nbsp;[#fourth]&nbsp;a.k.a.&nbsp;fourth_</samp>
  	  <td>
! 	    Also, autonumbered footnotes are
! 	    possible, like using <a href="#auto1">[1]</a>
! 	    and <a href="#auto2">[2]</a>.
  
! 	    <p>They may be assigned 'autonumber labels' - for
! 	      instance, <a href="#fourth">[4]</a> and <a href="#third">[3]</a>.
  	      
  	    <p><table>
--- 756,765 ----
  	    <p><samp>..&nbsp;[#fourth]&nbsp;a.k.a.&nbsp;fourth_</samp>
  	  <td>
! 	    Autonumbered footnotes are possible, like using <sup><a
! 	    href="#auto1">1</a></sup> and <sup><a href="#auto2">2</a></sup>.
  
! 	    <p>They may be assigned 'autonumber labels' - for instance,
! 	      <sup><a href="#fourth">4</a></sup> and <sup><a
! 	      href="#third">3</a></sup>.
  	      
  	    <p><table>
***************
*** 786,795 ****
  	      <tr><td><a name="fourth"><strong>[4]</strong></a><td> a.k.a. <a href="#fourth">fourth</a>
  	    </table>
      </table>
  
!     <p>The numbering of auto-numbered footnotes is determined by the order of
!     the footnotes, not of the references. For auto-numbered footnote references
!     without autonumber labels ("<samp>[#]_</samp>"), the references and
!     footnotes must be in the same relative order.
  
      <h2><a href="#contents" name="HyperlinkTargets">Hyperlink Targets</a></h2>
--- 771,854 ----
  	      <tr><td><a name="fourth"><strong>[4]</strong></a><td> a.k.a. <a href="#fourth">fourth</a>
  	    </table>
+ 
+ 	<tr valign="top">
+ 	  <td>
+ 	    <samp>Auto-symbol&nbsp;footnotes&nbsp;are&nbsp;also</samp>
+ 	    <br><samp>possible,&nbsp;like&nbsp;this:&nbsp;[*]_&nbsp;and&nbsp;[*]_.</samp>
+ 	    <p><samp>..&nbsp;[*]&nbsp;This&nbsp;is&nbsp;the&nbsp;first&nbsp;one.</samp>
+ 	      <br><samp>..&nbsp;[*]&nbsp;This&nbsp;is&nbsp;the&nbsp;second&nbsp;one.</samp>
+ 
+ 	  <td>
+ 	    Auto-symbol footnotes are also
+ 	    possible, like this: <sup><a href="#symbol1">*</a></sup>
+ 	    and <sup><a href="#symbol2">&dagger;</a></sup>.
+ 
+ 	    <p><table>
+ 	      <tr><td colspan="2"><hr>
+ 		  <!-- <tr><td colspan="2">Footnotes: -->
+ 	      <tr><td><a name="symbol1"><strong>[*]</strong></a><td> This is the first symbol footnote
+ 	      <tr><td><a name="symbol2"><strong>[&dagger;]</strong></a><td> This is the second one.
+ 	    </table>
+ 
      </table>
  
!     <p>The numbering of auto-numbered footnotes is determined by the
!     order of the footnotes, not of the references. For auto-numbered
!     footnote references without autonumber labels
!     ("<samp>[#]_</samp>"), the references and footnotes must be in the
!     same relative order. Similarly for auto-symbol footnotes
!     ("<samp>[*]_</samp>").
! 
!     <h2><a href="#contents" name="Citations">Citations</a></h2>
! 
!     <p>(<a href="http://structuredtext.sourceforge.net/spec/reStructuredText.html#citations">details?</a>)
! 
!     <p><table border="1" width="100%" bgcolor="#ffffcc" cellpadding="3">
!       <thead>
! 	<tr align="left" bgcolor="#99CCFF">
! 	  <th width="50%">Plain text
! 	  <th width="50%">Typical result
!       </thead>
!       <tbody>
! 
! 	<tr valign="top">
! 	  <td>
! 	    <samp>Citation&nbsp;references,&nbsp;like&nbsp;[CIT2002]_.</samp>
! 	    <br><samp>Note&nbsp;that&nbsp;citations&nbsp;may&nbsp;get</samp>
! 	    <br><samp>rearranged,&nbsp;e.g.,&nbsp;to&nbsp;the&nbsp;bottom&nbsp;of</samp>
! 	    <br><samp>the&nbsp;"page".</samp>
! 
! 	    <p><samp>..&nbsp;[CIT2002]&nbsp;A&nbsp;citation</samp>
! 	      <br><samp>&nbsp;&nbsp;&nbsp;(as&nbsp;often&nbsp;used&nbsp;in&nbsp;journals).</samp>
! 
! 	    <p><samp>Citation&nbsp;labels&nbsp;contain&nbsp;alphanumerics,</samp>
! 	      <br><samp>underlines,&nbsp;hyphens&nbsp;and&nbsp;fullstops.</samp>
! 	      <br><samp>Case&nbsp;is&nbsp;not&nbsp;significant.</samp>
! 
! 	    <p><samp>Given&nbsp;a&nbsp;citation&nbsp;like&nbsp;[this]_,&nbsp;one</samp>
! 	      <br><samp>can&nbsp;also&nbsp;refer&nbsp;to&nbsp;it&nbsp;like&nbsp;this_.</samp>
! 
! 	    <p><samp>..&nbsp;[this]&nbsp;here.</samp>
! 
! 	  <td>
! 	    Citation references, like <a href="#cit2002">[CIT2002]</a>.
!         Note that citations may get rearranged, e.g., to the bottom of
!         the "page".
! 
! 	    <p>Citation labels contain alphanumerics, underlines, hyphens
! 	      and fullstops.  Case is not significant.
! 
! 	    <p>Given a citation like <a href="#this">[this]</a>, one
! 	      can also refer to it like <a href="#this">this</a>.
! 
! 	    <p><table>
! 	      <tr><td colspan="2"><hr>
! 		  <!-- <tr><td colspan="2">Citations: -->
! 	      <tr><td><a name="cit2002"><strong>[CIT2002]</strong></a><td> A citation
! 		  (as often used in journals).
! 	      <tr><td><a name="this"><strong>[this]</strong></a><td> here.
!           </table>
! 
!     </table>
  
      <h2><a href="#contents" name="HyperlinkTargets">Hyperlink Targets</a></h2>
***************
*** 909,915 ****
  	<p>(<a href="http://structuredtext.sourceforge.net/spec/reStructuredText.html#implicit_hyperlink_targets">details?</a>)
  
!     <p>Section titles and footnotes automatically generate hyperlink
!     targets (the title text or footnote label is used as the hyperlink
!     name).
  
      <p><table border="1" width="100%" bgcolor="#ffffcc" cellpadding="3">	<tr align="left" bgcolor="#99CCFF">
--- 968,974 ----
  	<p>(<a href="http://structuredtext.sourceforge.net/spec/reStructuredText.html#implicit_hyperlink_targets">details?</a>)
  
!     <p>Section titles, footnotes, and citations automatically generate
!     hyperlink targets (the title text or footnote/citation label is
!     used as the hyperlink name).
  
      <p><table border="1" width="100%" bgcolor="#ffffcc" cellpadding="3">	<tr align="left" bgcolor="#99CCFF">
***************
*** 1025,1033 ****
  	(<a href="mailto:to...@ls..."><tt>to...@ls...</tt></a> or
  	<a href="mailto:ti...@ti..."><tt>ti...@ti...</tt></a>)
!     and David Goodger (<a href="mailto:go...@us...">go...@us...</a>)
      </address>
      <!-- Created: Fri Aug 03 09:11:57 GMT Daylight Time 2001 -->
      <!-- hhmts start -->
! Last modified: Mon Jan 07 21:29 EST 2002
  <!-- hhmts end -->
    </body>
--- 1084,1093 ----
  	(<a href="mailto:to...@ls..."><tt>to...@ls...</tt></a> or
  	<a href="mailto:ti...@ti..."><tt>ti...@ti...</tt></a>)
!     and David Goodger
!     (<a href="mailto:go...@us...">go...@us...</a>)
      </address>
      <!-- Created: Fri Aug 03 09:11:57 GMT Daylight Time 2001 -->
      <!-- hhmts start -->
! Last modified: Fri Mar 15 21:44 EST 2002
  <!-- hhmts end -->
    </body>

[Structuredtext-checkins] CVS: restructuredtext/restructuredtext/directives __init__.py,1.8,1.9

From: David G. <go...@us...> - 2002-03-16 05:41:39

Update of /cvsroot/structuredtext/restructuredtext/restructuredtext/directives
In directory usw-pr-cvs1:/tmp/cvs-serv18272/restructuredtext/restructuredtext/directives

Modified Files:
	__init__.py 
Log Message:
docstring

Index: __init__.py
===================================================================
RCS file: /cvsroot/structuredtext/restructuredtext/restructuredtext/directives/__init__.py,v
retrieving revision 1.8
retrieving revision 1.9
diff -C2 -d -r1.8 -r1.9
*** __init__.py	7 Mar 2002 03:27:49 -0000	1.8
--- __init__.py	16 Mar 2002 05:41:36 -0000	1.9
***************
*** 34,37 ****
--- 34,38 ----
  __all__ = ['directive']
  
+ 
  _directive_registry = {
        'attention': ('admonitions', 'attention'),
***************
*** 65,68 ****
--- 66,72 ----
  
  def directive(directivename, languagemodule):
+     """
+     Locate and return a directive function from its language-dependent name.
+     """
      normname = directivename.lower()
      if _directives.has_key(normname):

[Structuredtext-checkins] CVS: restructuredtext/restructuredtext/directives images.py,1.9,1.10

From: David G. <go...@us...> - 2002-03-16 05:40:19

Update of /cvsroot/structuredtext/restructuredtext/restructuredtext/directives
In directory usw-pr-cvs1:/tmp/cvs-serv17609/restructuredtext/restructuredtext/directives

Modified Files:
	images.py 
Log Message:
  - Changed extension attribute syntax.

Index: images.py
===================================================================
RCS file: /cvsroot/structuredtext/restructuredtext/restructuredtext/directives/images.py,v
retrieving revision 1.9
retrieving revision 1.10
diff -C2 -d -r1.9 -r1.10
*** images.py	13 Mar 2002 02:37:06 -0000	1.9
--- images.py	16 Mar 2002 05:40:16 -0000	1.10
***************
*** 58,95 ****
          return [error], blankfinish
      if attlines:
!         node = nodes.field_list()
!         newlineoffset, blankfinish = state.nestedlistparse(
!               attlines, attoffset, node, initialstate='FieldList',
!               blankfinish=blankfinish) #, statemachinekwargs=imageSMkwargs)
!         if (newlineoffset - attoffset) != len(attlines):
!             # incomplete parse of block
!             blocktext = '\n'.join(statemachine.inputlines[
!                   lineoffset : statemachine.lineoffset + 1])
!             msg = statemachine.memo.reporter.error(
!                   'Invalid attribute block for image directive at line %s.' 
!                   % lineno, '', nodes.literal_block(blocktext, blocktext))
!             return [msg], blankfinish
!         try:
!             imageatts = utils.extract_extension_attributes(
!                   node, image_attribute_spec)
!         except KeyError, detail:
!             error = statemachine.memo.reporter.error(
!                   'Unknown image attribute at line %s: "%s".'
!                   % (lineno, detail), '',
!                   nodes.literal_block(blocktext, blocktext))
!             return [error], blankfinish
!         except ValueError, detail:
!             error = statemachine.memo.reporter.error(
!                   'Invalid image attribute value at line %s:\n%s.'
!                   % (lineno, detail), '',
!                   nodes.literal_block(blocktext, blocktext))
!             return [error], blankfinish
!         except utils.ExtensionAttributeError, detail:
              error = statemachine.memo.reporter.error(
!                   'Invalid image attribute data at line %s:\n%s.'
!                   % (lineno, detail), '',
                    nodes.literal_block(blocktext, blocktext))
              return [error], blankfinish
-         attributes.update(imageatts)
      attributes['uri'] = reference
      imagenode = nodes.image(blocktext, **attributes)
--- 58,71 ----
          return [error], blankfinish
      if attlines:
!         success, data, blankfinish = state.parse_extension_attributes(
!               image_attribute_spec, attlines, blankfinish)
!         if success:                     # data is a dict of attributes
!             attributes.update(data)
!         else:                           # data is an error string
              error = statemachine.memo.reporter.error(
!                   'Error in "%s" directive attributes at line %s:\n%s.'
!                   % (match.group(1), lineno, data), '',
                    nodes.literal_block(blocktext, blocktext))
              return [error], blankfinish
      attributes['uri'] = reference
      imagenode = nodes.image(blocktext, **attributes)

[Structuredtext-checkins] CVS: restructuredtext/restructuredtext/directives html.py,1.6,1.7

From: David G. <go...@us...> - 2002-03-16 05:39:38

Update of /cvsroot/structuredtext/restructuredtext/restructuredtext/directives
In directory usw-pr-cvs1:/tmp/cvs-serv17473/restructuredtext/restructuredtext/directives

Modified Files:
	html.py 
Log Message:
*** empty log message ***

Index: html.py
===================================================================
RCS file: /cvsroot/structuredtext/restructuredtext/restructuredtext/directives/html.py,v
retrieving revision 1.6
retrieving revision 1.7
diff -C2 -d -r1.6 -r1.7
*** html.py	13 Mar 2002 02:37:35 -0000	1.6
--- html.py	16 Mar 2002 05:39:36 -0000	1.7
***************
*** 36,40 ****
                    lineoffset : statemachine.lineoffset+1])
              msg = statemachine.memo.reporter.error(
!                   'Invalid meta directive at line %s.' 
                    % statemachine.abslineno(), '',
                    nodes.literal_block(blocktext, blocktext))
--- 36,40 ----
                    lineoffset : statemachine.lineoffset+1])
              msg = statemachine.memo.reporter.error(
!                   'Invalid meta directive at line %s.'
                    % statemachine.abslineno(), '',
                    nodes.literal_block(blocktext, blocktext))

[Structuredtext-checkins] CVS: restructuredtext/restructuredtext states.py,1.48,1.49

From: David G. <go...@us...> - 2002-03-16 05:38:33

Update of /cvsroot/structuredtext/restructuredtext/restructuredtext
In directory usw-pr-cvs1:/tmp/cvs-serv17137/restructuredtext/restructuredtext

Modified Files:
	states.py 
Log Message:
  - Added Body.parse_extension_attributes().

Index: states.py
===================================================================
RCS file: /cvsroot/structuredtext/restructuredtext/restructuredtext/states.py,v
retrieving revision 1.48
retrieving revision 1.49
diff -C2 -d -r1.48 -r1.49
*** states.py	12 Mar 2002 03:27:17 -0000	1.48
--- states.py	16 Mar 2002 05:38:29 -0000	1.49
***************
*** 1502,1505 ****
--- 1502,1537 ----
          return [error], blankfinish
  
+     def parse_extension_attributes(self, attribute_spec, datalines, blankfinish):
+         """
+         Parse `datalines` for a field list containing extension attributes
+         matching `attribute_spec`.
+ 
+         :Parameters:
+             - `attribute_spec`: a mapping of attribute name to conversion
+               function, which should raise an exception on bad input.
+             - `datalines`: a list of input strings.
+             - `blankfinish`:
+ 
+         :Return:
+             - Success value, 1 or 0.
+             - An attribute dictionary on success, an error string on failure.
+             - Updated `blankfinish` flag.
+         """
+         node = nodes.field_list()
+         newlineoffset, blankfinish = self.nestedlistparse(
+               datalines, 0, node, initialstate='FieldList',
+               blankfinish=blankfinish)
+         if newlineoffset != len(datalines): # incomplete parse of block
+             return 0, 'invalid attribute block', blankfinish
+         try:
+             attributes = utils.extract_extension_attributes(node, attribute_spec)
+         except KeyError, detail:
+             return 0, ('unknown attribute: "%s"' % detail), blankfinish
+         except (ValueError, TypeError), detail:
+             return 0, ('invalid attribute value:\n%s' % detail), blankfinish
+         except utils.ExtensionAttributeError, detail:
+             return 0, ('invalid attribute data: %s' % detail), blankfinish
+         return 1, attributes, blankfinish
+ 
      def comment(self, match):
          if not match.string[match.end():].strip() \

[Structuredtext-checkins] CVS: restructuredtext/restructuredtext tableparser.py,1.1,1.2

From: David G. <go...@us...> - 2002-03-16 05:36:11

Update of /cvsroot/structuredtext/restructuredtext/restructuredtext
In directory usw-pr-cvs1:/tmp/cvs-serv16310/restructuredtext/restructuredtext

Modified Files:
	tableparser.py 
Log Message:
whitespace

Index: tableparser.py
===================================================================
RCS file: /cvsroot/structuredtext/restructuredtext/restructuredtext/tableparser.py,v
retrieving revision 1.1
retrieving revision 1.2
diff -C2 -d -r1.1 -r1.2
*** tableparser.py	13 Sep 2001 02:28:51 -0000	1.1
--- tableparser.py	16 Mar 2002 05:36:07 -0000	1.2
***************
*** 87,91 ****
          """
          Analyze the text `block` and return a table data structure.
!         
          Given a plaintext-graphic table in `block` (list of lines of text; no
          whitespace padding), parse the table, construct and return the data
--- 87,91 ----
          """
          Analyze the text `block` and return a table data structure.
! 
          Given a plaintext-graphic table in `block` (list of lines of text; no
          whitespace padding), parse the table, construct and return the data
***************
*** 136,140 ****
          top-to-bottom order, keeping track of how much of each text column has
          been seen.
!         
          We'll end up knowing all the row and column boundaries, cell positions
          and their dimensions.
--- 136,140 ----
          top-to-bottom order, keeping track of how much of each text column has
          been seen.
! 
          We'll end up knowing all the row and column boundaries, cell positions
          and their dimensions.

[Structuredtext-checkins] CVS: restructuredtext/spec rst-notes.txt,1.38,1.39

From: David G. <go...@us...> - 2002-03-16 05:35:47

Update of /cvsroot/structuredtext/restructuredtext/spec
In directory usw-pr-cvs1:/tmp/cvs-serv16140/restructuredtext/spec

Modified Files:
	rst-notes.txt 
Log Message:
*** empty log message ***

Index: rst-notes.txt
===================================================================
RCS file: /cvsroot/structuredtext/restructuredtext/spec/rst-notes.txt,v
retrieving revision 1.38
retrieving revision 1.39
diff -C2 -d -r1.38 -r1.39
*** rst-notes.txt	12 Mar 2002 03:34:22 -0000	1.38
--- rst-notes.txt	16 Mar 2002 05:35:44 -0000	1.39
***************
*** 5,8 ****
--- 5,9 ----
  :Revision: $Revision$
  
+ .. contents::
  
  To Do
***************
*** 53,57 ****
    How to represent character entities in the text though? Probably as
    Unicode.
!   
    Which component is responsible for this, the parser, the reader, or
    the writer?
--- 54,58 ----
    How to represent character entities in the text though? Probably as
    Unicode.
! 
    Which component is responsible for this, the parser, the reader, or
    the writer?
***************
*** 111,114 ****
--- 112,117 ----
  
  - Allow directives to be added at run-time.
+ 
+ - Use the language module for directive attribute names?
  
  - Allow syntax constructs to be added or disabled at run-time.

[Structuredtext-checkins] CVS: restructuredtext/spec reStructuredText.txt,1.43,1.44

From: David G. <go...@us...> - 2002-03-16 05:35:31

Update of /cvsroot/structuredtext/restructuredtext/spec
In directory usw-pr-cvs1:/tmp/cvs-serv15943/restructuredtext/spec

Modified Files:
	reStructuredText.txt 
Log Message:
  - Added "contents".
  - Minor edits.

Index: reStructuredText.txt
===================================================================
RCS file: /cvsroot/structuredtext/restructuredtext/spec/reStructuredText.txt,v
retrieving revision 1.43
retrieving revision 1.44
diff -C2 -d -r1.43 -r1.44
*** reStructuredText.txt	13 Mar 2002 02:35:15 -0000	1.43
--- reStructuredText.txt	16 Mar 2002 05:35:29 -0000	1.44
***************
*** 34,37 ****
--- 34,40 ----
  
  
+ .. contents::
+ 
+ 
  -----------------------
   Quick Syntax Overview
***************
*** 1316,1320 ****
  .. [#] This list was inspired by the list of symbols for "Note
     Reference Marks" in The Chicago Manual of Style, 14th edition,
!    section 12.51.  "Parallels" (``||``) were given in CMoS instead of
     the pilcrow.  The last four symbols (the card suits) were added
     arbitrarily.
--- 1319,1323 ----
  .. [#] This list was inspired by the list of symbols for "Note
     Reference Marks" in The Chicago Manual of Style, 14th edition,
!    section 12.51.  "Parallels" ("\|\|") were given in CMoS instead of
     the pilcrow.  The last four symbols (the card suits) were added
     arbitrarily.
***************
*** 1342,1346 ****
         with label "1" exists.  The order of the footnotes is used to
         determine numbering, not the order of the footnote references.
!     
      .. [#] This footnote will be labeled "3".  It is the second
         auto-numbered footnote, but footnote label "2" is already used.
--- 1345,1349 ----
         with label "1" exists.  The order of the footnotes is used to
         determine numbering, not the order of the footnote references.
! 
      .. [#] This footnote will be labeled "3".  It is the second
         auto-numbered footnote, but footnote label "2" is already used.
***************
*** 2179,2183 ****
  For example::
  
!     Please refer to the fine manual [GVR2001]_.
  
  See Citations_ for the citation itself.
--- 2182,2186 ----
  For example::
  
!     Here is a citation reference: [CIT2002]_.
  
  See Citations_ for the citation itself.
***************
*** 2245,2249 ****
     - Hierarchical identifiers begin with one or two slashes and may
       use slashes to separate hierarchical components of the path.
!      Examples are web pages and FTP sites:
  
           http://www.python.org
--- 2248,2252 ----
     - Hierarchical identifiers begin with one or two slashes and may
       use slashes to separate hierarchical components of the path.
!      Examples are web pages and FTP sites::
  
           http://www.python.org

[Structuredtext-checkins] CVS: restructuredtext/spec problems.txt,1.5,1.6

From: David G. <go...@us...> - 2002-03-16 05:35:18

Update of /cvsroot/structuredtext/restructuredtext/spec
In directory usw-pr-cvs1:/tmp/cvs-serv15859/restructuredtext/spec

Modified Files:
	problems.txt 
Log Message:
  - Added "contents".
  - Minor edits.

Index: problems.txt
===================================================================
RCS file: /cvsroot/structuredtext/restructuredtext/spec/problems.txt,v
retrieving revision 1.5
retrieving revision 1.6
diff -C2 -d -r1.5 -r1.6
*** problems.txt	1 Sep 2001 15:47:42 -0000	1.5
--- problems.txt	16 Mar 2002 05:35:15 -0000	1.6
***************
*** 126,136 ****
  candidates?
  
! 1. ! (http://dev.zope.org/Members/jim/StructuredTextWiki/NGEscaping)
! 2. \
! 3. ~
  4. doubling of characters
  
! The best choice for this is the backslash (\). It's "the single most
! popular escaping character in the world!", therefore familiar and
  unsurprising. Since characters only need to be escaped under special
  circumstances, which are typically those explaining technical
--- 126,136 ----
  candidates?
  
! 1. ``!`` (http://dev.zope.org/Members/jim/StructuredTextWiki/NGEscaping)
! 2. ``\``
! 3. ``~``
  4. doubling of characters
  
! The best choice for this is the backslash (``\``). It's "the single
! most popular escaping character in the world!", therefore familiar and
  unsurprising. Since characters only need to be escaped under special
  circumstances, which are typically those explaining technical
***************
*** 190,194 ****
  StructuredText_ includes 'o' as a bullet character. This is dangerous
  and counter to the language-independent nature of the markup. There
! are many languages in which 'o' is a word. For example, in Spanish:
  
      Llamame a la casa
--- 190,194 ----
  StructuredText_ includes 'o' as a bullet character. This is dangerous
  and counter to the language-independent nature of the markup. There
! are many languages in which 'o' is a word. For example, in Spanish::
  
      Llamame a la casa
***************
*** 197,201 ****
      (Call me at home or at work.)
  
! And in Japanese (when romanized):
  
      Senshuu no doyoubi ni tegami
--- 197,201 ----
      (Call me at home or at work.)
  
! And in Japanese (when romanized)::
  
      Senshuu no doyoubi ni tegami
***************
*** 304,308 ****
--- 304,310 ----
      Section Title
      -------------
+ 
      ::
+ 
          print "this is example literal"
  
***************
*** 357,362 ****
  
         ============ ============ ============ ==============
           Column 1     Column 2    Column 3 & 4 span (Row 1)
!        ============ ============ ===========================
             Column 1 & 2 span       Column 3    - Column 4
         ------------------------- ------------  - Row 2 & 3
--- 359,366 ----
  
         ============ ============ ============ ==============
+          Header 1     Header 2     Header 3     Header 4
+        ============ ============ ============ ==============
           Column 1     Column 2    Column 3 & 4 span (Row 1)
!        ------------ ------------ ---------------------------
             Column 1 & 2 span       Column 3    - Column 4
         ------------------------- ------------  - Row 2 & 3
***************
*** 389,393 ****
  recognition rules. These recognition rules define the context of
  markup start-strings and end-strings, allowing markup characters to be
! used in non-markup contexts without a problem (or even a backslash).
  So we can say, "Use asterisks (*) around words or phrases to
  *emphasisze* them." The '(*)' will not be recognized as markup. This
--- 393,397 ----
  recognition rules. These recognition rules define the context of
  markup start-strings and end-strings, allowing markup characters to be
! used in most non-markup contexts without a problem (or a backslash).
  So we can say, "Use asterisks (*) around words or phrases to
  *emphasisze* them." The '(*)' will not be recognized as markup. This
***************
*** 476,486 ****
          Does ``a[b] = 'c' + "d" + `2^3\``` work?
  
! Backquotes (#9) are the best choice. They are unobtrusive and
  relatviely rarely used (more rarely than ' or ", anyhow). Backquotes
  have the connotation of 'quotes', which other options (like carets,
! #10) don't. When used within literals, they can be escaped (\`).
  
! Analogously with *emph* & **strong**, double-backquotes (#12) could be
! used for inline literals. If single-backquotes are used for
  'interpreted text' (context-sensitive domain-specific descriptive
  markup) such as function name hyperlinks in Python docstrings, then
--- 480,490 ----
          Does ``a[b] = 'c' + "d" + `2^3\``` work?
  
! Backquotes (#9 & #12) are the best choice. They are unobtrusive and
  relatviely rarely used (more rarely than ' or ", anyhow). Backquotes
  have the connotation of 'quotes', which other options (like carets,
! #10) don't.
  
! Analogously with ``*emph*`` & ``**strong**``, double-backquotes (#12)
! could be used for inline literals. If single-backquotes are used for
  'interpreted text' (context-sensitive domain-specific descriptive
  markup) such as function name hyperlinks in Python docstrings, then
***************
*** 489,498 ****
  would be that backslash-escaping would no longer be necessary for
  embedded single-backquotes; however, embedded double-backquotes (in an
! end-string context) would be illegal.
  
! Alternative choices are carets (#10) and TeX-style quotes (#11). For
! examples of TeX-style quoting, see:
  
!     http://www.zope.org/Members/jim/StructuredTextWiki/CustomizingTheDocumentProcessor
  
  Some existing uses of backquotes:
--- 493,505 ----
  would be that backslash-escaping would no longer be necessary for
  embedded single-backquotes; however, embedded double-backquotes (in an
! end-string context) would be illegal. See `Backquotes in
! Phrase-Links`__ in `Record of reStructuredText Syntax Alternatives`__.
  
! __ alternatives.html#backquotes-in-phrase-links
! __ alternatives.html
  
! Alternative choices are carets (#10) and TeX-style quotes (#11). For
! examples of TeX-style quoting, see
! http://www.zope.org/Members/jim/StructuredTextWiki/CustomizingTheDocumentProcessor.
  
  Some existing uses of backquotes:
***************
*** 531,536 ****
  option.
  
  
! HyperLinks
  ==========
  
--- 538,546 ----
  option.
  
+ reStructuredText will use double backquotes for inline literals, and
+ single backqoutes for interpreted text.
+ 
  
! Hyperlinks
  ==========
  
***************
*** 594,598 ****
         .. _hyperlink http://www.123.xyz
  
!    Setext used 'underscores_instead_of_spaces_' for phrase links.
  
  With some modification, alternative 3 best satisfies the design goals.
--- 604,608 ----
         .. _hyperlink http://www.123.xyz
  
!    Setext used ``underscores_instead_of_spaces_`` for phrase links.
  
  With some modification, alternative 3 best satisfies the design goals.
***************
*** 626,632 ****
  #3 wins.
  
! The same trailing underscore markup can also be used for footnote
! references, removing the problem with ordinary bracketed text and
! Python lists::
  
      Please refer to the fine manual [GVR2000]_.
--- 636,642 ----
  #3 wins.
  
! The same trailing underscore markup can also be used for footnote and
! citation references, removing the problem with ordinary bracketed text
! and Python lists::
  
      Please refer to the fine manual [GVR2000]_.
***************
*** 667,680 ****
      This internal hyperlink will take us to the footnotes_ area below.
  
!     Here is a one-word_ indirect hyperlink.
  
!     Here is `an indirect hyperlink phrase`_.
  
      .. _footnotes:
      .. [1] Footnote text goes here.
  
!     .. indirect hyperlink target mappings:
      .. _one-word: http://www.123.xyz
!     .. _an indirect hyperlink phrase: http://www.123.xyz
  
  The presence or absence of a colon after the target link
--- 677,690 ----
      This internal hyperlink will take us to the footnotes_ area below.
  
!     Here is a one-word_ external hyperlink.
  
!     Here is `a hyperlink phrase`_.
  
      .. _footnotes:
      .. [1] Footnote text goes here.
  
!     .. external hyperlink target mappings:
      .. _one-word: http://www.123.xyz
!     .. _a hyperlink phrase: http://www.123.xyz
  
  The presence or absence of a colon after the target link

[Structuredtext-checkins] CVS: restructuredtext/spec alternatives.txt,1.17,1.18

From: David G. <go...@us...> - 2002-03-16 05:35:11

Update of /cvsroot/structuredtext/restructuredtext/spec
In directory usw-pr-cvs1:/tmp/cvs-serv15777/restructuredtext/spec

Modified Files:
	alternatives.txt 
Log Message:
  - Added "contents".
  - Minor edits.

Index: alternatives.txt
===================================================================
RCS file: /cvsroot/structuredtext/restructuredtext/spec/alternatives.txt,v
retrieving revision 1.17
retrieving revision 1.18
diff -C2 -d -r1.17 -r1.18
*** alternatives.txt	7 Mar 2002 03:44:32 -0000	1.17
--- alternatives.txt	16 Mar 2002 05:35:08 -0000	1.18
***************
*** 23,26 ****
--- 23,29 ----
  
  
+ .. contents::
+ 
+ 
  Field Lists
  ===========
***************
*** 72,76 ****
     Disadvantage: cumbersome.
  
!    Conclusion: rejected.
  
  4. Use Javadoc-style::
--- 75,80 ----
     Disadvantage: cumbersome.
  
!    Conclusion: rejected for the general case (but such a directive
!    could certainly be written).
  
  4. Use Javadoc-style::
***************
*** 91,95 ****
  
     Advantages: unambiguous, obvious (*almost* RFC822-compliant),
!    flexible, perhaps even elegant. Disadvantage: no precedent, not
     quite RFC822-compliant.
  
--- 95,99 ----
  
     Advantages: unambiguous, obvious (*almost* RFC822-compliant),
!    flexible, perhaps even elegant. Disadvantages: no precedent, not
     quite RFC822-compliant.
  
***************
*** 337,341 ****
  
     * Except for the colon (a delimiter necessary to allow for
!      phrase-links), hyperlink target ``.. _blah:" comes from Setext.
     * Comment syntax from Setext.
     * Footnote syntax from StructuredText ("named links").
--- 341,345 ----
  
     * Except for the colon (a delimiter necessary to allow for
!      phrase-links), hyperlink target ``.. _blah:`` comes from Setext.
     * Comment syntax from Setext.
     * Footnote syntax from StructuredText ("named links").
***************
*** 632,636 ****
     alternative 4, below.
  
! Syntax alternatives for the definition::
  
  1. Use the existing directive syntax, with a predefined directive such
--- 636,640 ----
     alternative 4, below.
  
! Syntax alternatives for the definition:
  
  1. Use the existing directive syntax, with a predefined directive such
***************
*** 885,889 ****
      would typically use the horizontal line for true footnotes.
  
! + Footnote references::
  
    - Current syntax::
--- 889,893 ----
      would typically use the horizontal line for true footnotes.
  
! + Footnote references:
  
    - Current syntax::

[Structuredtext-checkins] CVS: restructuredtext/spec directives.txt,1.10,1.11

From: David G. <go...@us...> - 2002-03-16 05:34:21

Update of /cvsroot/structuredtext/restructuredtext/spec
In directory usw-pr-cvs1:/tmp/cvs-serv15348/restructuredtext/spec

Modified Files:
	directives.txt 
Log Message:
  - Added "local" attribute to "contents".

Index: directives.txt
===================================================================
RCS file: /cvsroot/structuredtext/restructuredtext/spec/directives.txt,v
retrieving revision 1.10
retrieving revision 1.11
diff -C2 -d -r1.10 -r1.11
*** directives.txt	7 Mar 2002 03:40:15 -0000	1.10
--- directives.txt	16 Mar 2002 05:34:19 -0000	1.11
***************
*** 10,14 ****
  reStructuredText parser.
  
! .. contents:: :depth: 2
  
  
--- 10,15 ----
  reStructuredText parser.
  
! 
! .. contents::
  
  
***************
*** 187,191 ****
  
      .. contents:: Table of Contents
!     
  The title may span lines, although it is not recommended::
  
--- 188,192 ----
  
      .. contents:: Table of Contents
! 
  The title may span lines, although it is not recommended::
  
***************
*** 208,211 ****
--- 209,216 ----
      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
+     subsections of the section in which the directive is given.  If no
+     explicit title is given, the table of contents will not be titled.

[Structuredtext-checkins] CVS: restructuredtext/spec introduction.txt,1.7,1.8

From: David G. <go...@us...> - 2002-03-16 05:31:43

Update of /cvsroot/structuredtext/restructuredtext/spec
In directory usw-pr-cvs1:/tmp/cvs-serv13981/restructuredtext/spec

Modified Files:
	introduction.txt 
Log Message:
  - Removed "Parser Implementation Plan". (It's implemented!)
  - Revised.

Index: introduction.txt
===================================================================
RCS file: /cvsroot/structuredtext/restructuredtext/spec/introduction.txt,v
retrieving revision 1.7
retrieving revision 1.8
diff -C2 -d -r1.7 -r1.8
*** introduction.txt	13 Nov 2001 03:16:54 -0000	1.7
--- introduction.txt	16 Mar 2002 05:31:40 -0000	1.8
***************
*** 8,12 ****
  
  reStructuredText_ is an easy-to-read, what-you-see-is-what-you-get
! plaintext markup syntax and parser system. It is useful for in-line
  program documentation (such as Python docstrings), for quickly
  creating simple web pages, and for standalone documents.
--- 8,12 ----
  
  reStructuredText_ is an easy-to-read, what-you-see-is-what-you-get
! plaintext markup syntax and parser system.  It is useful for in-line
  program documentation (such as Python docstrings), for quickly
  creating simple web pages, and for standalone documents.
***************
*** 15,35 ****
  
  reStructuredText is designed for extensibility for specific
! application domains. It is a candidate markup syntax for the `Python
  Docstring Processing System`_.
  
! This document defines the goals_ of reStructuredText, provides a
! history_ of the project, and outlines a `parser implementation plan`_.
! It is also written with the reStructuredText markup, therefore serves
! as an example of its use. Please also see an analysis of the problems
! of StructuredText, and the reStructuredText markup specification
! itself (general and Python extensions), all on the project's web site,
! http://structuredtext.sourceforge.net/.
  
! .. _reStructuredText: http://structuredtext.sourceforge.net
  .. _StructuredText:
      http://dev.zope.org/Members/jim/StructuredTextWiki/FrontPage
  .. _Setext: http://www.bsdi.com/setext
  .. _Python Docstring Processing System:
!     http://docstring.sourceforge.net
  
  
--- 15,38 ----
  
  reStructuredText is designed for extensibility for specific
! application domains.  It is a candidate markup syntax for the `Python
  Docstring Processing System`_.
  
! This document defines the goals_ of reStructuredText and provides a
! history_ of the project.  It is written using the reStructuredText
! markup, and therefore serves as an example of its use.  Please also
! see an analysis of the `problems with StructuredText`_, and the
! `reStructuredText markup specification`_ itself, all on the project's
! web site, http://structuredtext.sourceforge.net/.
  
! .. _reStructuredText: http://structuredtext.sourceforge.net/
  .. _StructuredText:
      http://dev.zope.org/Members/jim/StructuredTextWiki/FrontPage
  .. _Setext: http://www.bsdi.com/setext
  .. _Python Docstring Processing System:
! .. _Docstring Processing System: http://docstring.sourceforge.net/
! .. _Problems with StructuredText:
!     http://structuredtext.sourceforge.net/spec/problems.txt
! .. _reStructuredText Markup Specification:
!     http://structuredtext.sourceforge.net/spec/reStructuredText.txt
  
  
***************
*** 39,43 ****
  The primary goal of reStructuredText_ is to define a markup syntax for
  use in Python docstrings and other documentation domains, that is
! readable and simple, yet powerful enough for non-trivial use. The
  intended purpose of the reStructuredText markup is twofold:
  
--- 42,46 ----
  The primary goal of reStructuredText_ is to define a markup syntax for
  use in Python docstrings and other documentation domains, that is
! readable and simple, yet powerful enough for non-trivial use.  The
  intended purpose of the reStructuredText markup is twofold:
  
***************
*** 48,56 ****
  
  The secondary goal of reStructuredText is to be accepted by the Python
! community (by way of being blessed by PythonLabs and the BDFL [1]_) as
  a standard for Python inline documentation (possibly one of several
  standards, to account for taste).
  
! .. [1] Python's creator and "Benevolent Dictator For Life",
     Guido van Rossum.
  
--- 51,59 ----
  
  The secondary goal of reStructuredText is to be accepted by the Python
! community (by way of being blessed by PythonLabs and the BDFL [#]_) as
  a standard for Python inline documentation (possibly one of several
  standards, to account for taste).
  
! .. [#] Python's creator and "Benevolent Dictator For Life",
     Guido van Rossum.
  
***************
*** 58,103 ****
  beginning with the most important:
  
! 1. Readable: The marked-up text must be easy to read without any prior
!    knowledge of the markup language. It should be as easily read in
!    raw form as in processed form.
  
! 2. Unobtrusive: The markup that is used should be as simple and
!    unobtrusive as possible. The simplicity of markup constructs should
!    be roughly proporional to their frequency of use. The most common
!    constructs, with natural and obvious markup, should be the simplest
!    and most unobtrusive. Less common contstructs, for which there is
!    no natural or obvious markup, should be distinctive.
  
! 3. Unambiguous: The rules for markup must not be open for
!    interpretation. For any given input, there should be one and only
     one possible output (including error output).
  
! 4. Unsurprising: Markup constructs should not cause unexpected output
!    upon processing. As a fallback, there must be a way to prevent
     unwanted markup processing when a markup construct is used in a
     non-markup context (for example, when documenting the markup syntax
     itself).
  
! 5. Intuitive: Markup should be as obvious and easily remembered as
!    possible, for the author as well as for the reader. Constructs
     should take their cues from such naturally occurring sources as
!    plaintext email messages and newsgroup postings.
  
! 6. Easy: It should be easy to mark up text using any ordinary text
     editor.
  
! 7. Scalable: The markup should be applicable regardless of the length
     of the text.
  
! 8. Powerful: The markup should provide enough constructs to produce a
     reasonably rich structured document.
  
! 9. Language-neutral: The markup should apply to multiple natural (as
     well as artificial) languages, not only English.
  
! 10. Extensible: The markup should provide a simple syntax and
!     interface for adding more complex general markup, and custom markup.
  
! 11. Output-format-neutral: The markup will be appropriate for
      processing to multiple output formats, and will not be biased
      toward any particular format.
--- 61,108 ----
  beginning with the most important:
  
! 1. Readable.  The marked-up text must be easy to read without any
!    prior knowledge of the markup language.  It should be as easily
!    read in raw form as in processed form.
  
! 2. Unobtrusive.  The markup that is used should be as simple and
!    unobtrusive as possible.  The simplicity of markup constructs
!    should be roughly proporional to their frequency of use.  The most
!    common constructs, with natural and obvious markup, should be the
!    simplest and most unobtrusive.  Less common contstructs, for which
!    there is no natural or obvious markup, should be distinctive.
  
! 3. Unambiguous.  The rules for markup must not be open for
!    interpretation.  For any given input, there should be one and only
     one possible output (including error output).
  
! 4. Unsurprising.  Markup constructs should not cause unexpected output
!    upon processing.  As a fallback, there must be a way to prevent
     unwanted markup processing when a markup construct is used in a
     non-markup context (for example, when documenting the markup syntax
     itself).
  
! 5. Intuitive.  Markup should be as obvious and easily remembered as
!    possible, for the author as well as for the reader.  Constructs
     should take their cues from such naturally occurring sources as
!    plaintext email messages, newsgroup postings, and text
!    documentation such as README.txt files.
  
! 6. Easy.  It should be easy to mark up text using any ordinary text
     editor.
  
! 7. Scalable.  The markup should be applicable regardless of the length
     of the text.
  
! 8. Powerful.  The markup should provide enough constructs to produce a
     reasonably rich structured document.
  
! 9. Language-neutral.  The markup should apply to multiple natural (as
     well as artificial) languages, not only English.
  
! 10. Extensible.  The markup should provide a simple syntax and
!     interface for adding more complex general markup, and custom
!     markup.
  
! 11. Output-format-neutral.  The markup will be appropriate for
      processing to multiple output formats, and will not be biased
      toward any particular format.
***************
*** 109,116 ****
  docstring semantics, such as docstring contents or docstring length.
  These issues are orthogonal to the markup syntax and beyond the scope
! of this proposal.
  
  Also, it is not the goal of reStructuredText to maintain compatibility
! with StructuredText_ or Setext_. reStructuredText shamelessly steals
  their great ideas and ignores the not-so-great.
  
--- 114,121 ----
  docstring semantics, such as docstring contents or docstring length.
  These issues are orthogonal to the markup syntax and beyond the scope
! of this specification.
  
  Also, it is not the goal of reStructuredText to maintain compatibility
! with StructuredText_ or Setext_.  reStructuredText shamelessly steals
  their great ideas and ignores the not-so-great.
  
***************
*** 119,123 ****
      Due to the nature of the problem we're trying to solve (or,
      perhaps, due to the nature of the proposed solution), the above
!     goals unavoidably conflict. I have tried to extract and distill
      the wisdom accumulated over the years in the Python Doc-SIG_
      mailing list and elsewhere, to come up with a coherent and
--- 124,128 ----
      Due to the nature of the problem we're trying to solve (or,
      perhaps, due to the nature of the proposed solution), the above
!     goals unavoidably conflict.  I have tried to extract and distill
      the wisdom accumulated over the years in the Python Doc-SIG_
      mailing list and elsewhere, to come up with a coherent and
***************
*** 126,135 ****
  
      There will inevitably be people who disagree with my particular
!     choices. Some desire finer control over their markup, others
!     prefer less. Some are concerned with very short docstrings, others
!     with full-length documents. This specification is an effort to
!     provide a reasonably rich set of markup constructs in a reasonably
!     simple form, that should satisfy a reasonably large group of
!     reasonable people.
  
      David Goodger (go...@us...), 2001-04-20
--- 131,140 ----
  
      There will inevitably be people who disagree with my particular
!     choices.  Some desire finer control over their markup, others
!     prefer less.  Some are concerned with very short docstrings,
!     others with full-length documents.  This specification is an
!     effort to provide a reasonably rich set of markup constructs in a
!     reasonably simple form, that should satisfy a reasonably large
!     group of reasonable people.
  
      David Goodger (go...@us...), 2001-04-20
***************
*** 142,148 ****
  
  reStructuredText_, the specification, is based on StructuredText_ and
! Setext_. StructuredText was developed by Jim Fulton of `Digital
! Creations`_ and first released in 1996. It is now released as a part
! of the open-source 'Z Object Publishing Environment' (ZOPE_). Ian
  Feldman's and Tony Sanders' earlier Setext_ specification was either
  an influence on StructuredText or, by their similarities, at least
--- 147,153 ----
  
  reStructuredText_, the specification, is based on StructuredText_ and
! Setext_.  StructuredText was developed by Jim Fulton of `Digital
! Creations`_ and first released in 1996.  It is now released as a part
! of the open-source 'Z Object Publishing Environment' (ZOPE_).  Ian
  Feldman's and Tony Sanders' earlier Setext_ specification was either
  an influence on StructuredText or, by their similarities, at least
***************
*** 150,193 ****
  
  I discovered StructuredText_ in late 1999 while searching for a way to
! document the Python modules in one of my projects. Version 1.1 of
! StructuredText was included in Daniel Larsson's pythondoc_. Although I
! was not able to get pythondoc to work for me, I found StructuredText
! to be almost ideal for my needs. I joined the Python Doc-SIG_
  (Documentation Special Interest Group) mailing list and found an
  ongoing discussion of the shortcomings of the StructuredText
! 'standard'. This discussion has been going on since 1996.
  
  I decided to modify the original module with my own extensions and
! some suggested by the Doc-SIG members. I soon realized that the module
! was not written with extension in mind, so I embarked upon a general
! reworking, including adapting it to the 're' regular expression module
! (the original inspiration for the name of this project). Soon after I
! completed the modifications, I discovered that StructuredText.py was
! up to version 1.23 in the ZOPE distribution. Implementing the new
! syntax extensions from version 1.23 proved to be an exercise in
! frustration, as the complexity of the module had become overwhelming.
  
  Recently, development on StructuredTextNG_ ("Next Generation") has
! begun at Digital Creations. It seems to have many improvements, but
  still suffers from many of the problems of classic StructuredText.
  
  I decided that a complete rewrite was in order, and even started a
! SourceForge project, reStructuredText_. My motivations (the 'itches' I
! aim to 'scratch') are as follows:
  
  - I need a standard format for inline documentation of the programs I
!   write. This inline documentation has to be convertible to other
!   useful formats, such as HTML. I believe many others have the same
    need.
  
  - I believe in the Setext/StructuredText idea and want to help
!   formalize the standard. However, I feel the current specifications
    and implementations have flaws that desperately need fixing.
  
  - reStructuredText could form part of the foundation for a
    documentation extraction and processing system, greatly benefitting
!   Python. But it is only a part, not the whole. reStructuredText is a
!   markup language specification and (soon to be) a reference parser
!   implementation, but it does not aspire to be the entire system. I
    don't want reStructuredText or a hypothetical Python documentation
    processor to die stillborn because of overambition.
--- 155,200 ----
  
  I discovered StructuredText_ in late 1999 while searching for a way to
! document the Python modules in one of my projects.  Version 1.1 of
! StructuredText was included in Daniel Larsson's pythondoc_.  Although
! I was not able to get pythondoc to work for me, I found StructuredText
! to be almost ideal for my needs.  I joined the Python Doc-SIG_
  (Documentation Special Interest Group) mailing list and found an
  ongoing discussion of the shortcomings of the StructuredText
! 'standard'.  This discussion has been going on since the inception of
! the mailing list in 1996, and possibly predates it.
  
  I decided to modify the original module with my own extensions and
! some suggested by the Doc-SIG members.  I soon realized that the
! module was not written with extension in mind, so I embarked upon a
! general reworking, including adapting it to the 're' regular
! expression module (the original inspiration for the name of this
! project).  Soon after I completed the modifications, I discovered that
! StructuredText.py was up to version 1.23 in the ZOPE distribution.
! Implementing the new syntax extensions from version 1.23 proved to be
! an exercise in frustration, as the complexity of the module had become
! overwhelming.
  
  Recently, development on StructuredTextNG_ ("Next Generation") has
! begun at Digital Creations.  It seems to have many improvements, but
  still suffers from many of the problems of classic StructuredText.
  
  I decided that a complete rewrite was in order, and even started a
! SourceForge project, reStructuredText_.  My motivations (the 'itches'
! I aim to 'scratch') are as follows:
  
  - I need a standard format for inline documentation of the programs I
!   write.  This inline documentation has to be convertible to other
!   useful formats, such as HTML.  I believe many others have the same
    need.
  
  - I believe in the Setext/StructuredText idea and want to help
!   formalize the standard.  However, I feel the current specifications
    and implementations have flaws that desperately need fixing.
  
  - reStructuredText could form part of the foundation for a
    documentation extraction and processing system, greatly benefitting
!   Python.  But it is only a part, not the whole.  reStructuredText is
!   a markup language specification and a reference parser
!   implementation, but it does not aspire to be the entire system.  I
    don't want reStructuredText or a hypothetical Python documentation
    processor to die stillborn because of overambition.
***************
*** 199,303 ****
  In November 2000 I made the time to enumerate the problems of
  StructuredText and possible solutions, and complete the first draft of
! a specification. This first draft was posted to the Doc-SIG in three
  parts:
  
! - `A Plan for Structured Text`_
! - `Problems With StructuredText`_
! - `reStructuredText: Revised Structured Text Specification`_
  
  In March 2001 a flurry of activity on the Doc-SIG spurred me to
  further revise and refine my specification, the result of which you
! are now reading. An offshoot of the reStructuredText project has been
  the realization that a single markup scheme, no matter how well
! thought out, was not enough. In order to tame the endless debates on
! Doc-SIG, a flexible `Docstring Processing System`_ framework needed to
! be constructed. This framework has become the more important of the
! two projects; reStructuredText has found its place as one possible
! choice for a single component of the larger framework.
  
  The project web site and the first project release were rolled out in
! June 2001, including posting the second draft of the spec to the
! Doc-SIG. Implementation history details can be found in the project
! file, HISTORY.txt_.
! 
! .. _Digital Creations: http://www.digicool.com
! .. _ZOPE: http://www.zope.org
! .. _pythondoc: http://starship.python.net/crew/danilo/pythondoc/
! .. _StructuredTextNG:
!     http://dev.zope.org/Members/jim/StructuredTextWiki/StructuredTextNG
! .. _A Plan for Structured Text:
!     http://mail.python.org/pipermail/doc-sig/2000-November/001239.html
! .. _Problems With StructuredText:
!     http://mail.python.org/pipermail/doc-sig/2000-November/001240.html
! .. _`reStructuredText: Revised Structured Text Specification`:
!     http://mail.python.org/pipermail/doc-sig/2000-November/001241.html
! .. _Docstring Processing System: http://docstring.sourceforge.net
! .. _HISTORY.txt:
!     http://structuredtext.sourceforge.net/HISTORY.txt
! 
! 
! Parser Implementation Plan
! ==========================
! 
! The author will implement a reStructuredText parser in stages, listed
! below. It will be posted to the `project web site`_, and contributions
! (of testing, bug reports, patches, administration, encouragement,
! cookies, large sums of money, etc.) will be welcome. Of course, anyone
! else is free to begin their own implementation of this markup syntax
! or alternatives.
! 
! The parser will be implemented in 4 stages, according to the
! complexity level and expected frequency of use of the syntax
! constructs:
! 
! 1. General markup, level 1
! 
!    + escaping mechanism, using backslash
! 
!    + body elements
! 
!      - paragraphs
!      - literal blocks
!      - bullet lists
!      - directives
!      - comments
! 
!    + inline markup
! 
!      - emphasis
!      - strong
!      - interpreted text
!      - inline literals
! 
!    + structural markup
! 
!      - section headers
! 
! 2. General markup, level 2
  
!    + body elements
  
!      - definition lists
!      - block quotes
!      - footnotes
!      - internal/external/indirect hyperlink targets
  
!    + inline markup
  
!      - standalone (direct external) hyperlinks
!      - hyperlink references
!      - footnote references
  
! 3. General markup, level 3
  
!    + body elements
  
-      - enumerated lists
-      - field lists
-      - option lists
-      - tables
-      - doctest blocks
  
! .. _project web site: http://structuredtest.sourceforge.net/
  
  
--- 206,282 ----
  In November 2000 I made the time to enumerate the problems of
  StructuredText and possible solutions, and complete the first draft of
! a specification.  This first draft was posted to the Doc-SIG in three
  parts:
  
! - `A Plan for Structured Text`__
! - `Problems With StructuredText`__
! - `reStructuredText: Revised Structured Text Specification`__
! 
! __ http://mail.python.org/pipermail/doc-sig/2000-November/001239.html
! __ http://mail.python.org/pipermail/doc-sig/2000-November/001240.html
! __ http://mail.python.org/pipermail/doc-sig/2000-November/001241.html
  
  In March 2001 a flurry of activity on the Doc-SIG spurred me to
  further revise and refine my specification, the result of which you
! are now reading.  An offshoot of the reStructuredText project has been
  the realization that a single markup scheme, no matter how well
! thought out, may not be enough.  In order to tame the endless debates
! on Doc-SIG, a flexible `Docstring Processing System`_ framework needed
! to be constructed.  This framework has become the more important of
! the two projects; reStructuredText_ has found its place as one
! possible choice for a single component of the larger framework.
  
  The project web site and the first project release were rolled out in
! June 2001, including posting the second draft of the spec [#spec-2]_
! and the first draft of PEPs 256, 257, and 258 [#peps-1]_ to the
! Doc-SIG.  These documents and the project implementation proceeded to
! evolve at a rapid pace.  Implementation history details can be found
! in the project file, HISTORY.txt_.
  
! In November 2001, the reStructuredText parser was nearing completion.
! Development of the parser continued with the addition of small
! convenience features, improvements to the syntax, the filling in of
! gaps, and bug fixes.  After a long holiday break, in early 2002 most
! development moved over to the other Docutils components, the
! "Readers", "Writers", and "Transforms".  A "standalone" reader
! (processes standalone text file documents) was completed in February,
! and a basic HTML writer (producing HTML 4.01, using CSS-1) was
! completed in early March.
  
! Version 0.4 of the reStructuredText_ and `Docstring Processing
! System`_ projects were released on @@@.  The two projects were
! immediately merged and renamed "Docutils_", and a 0.1 release soon
! followed.
  
! .. [#spec-2]
!    - `An Introduction to reStructuredText`__
!    - `Problems With StructuredText`__
!    - `reStructuredText Markup Specification`__
!    - `Python Extensions to the reStructuredText Markup
!      Specification`__
  
!    __ http://mail.python.org/pipermail/doc-sig/2001-June/001858.html
!    __ http://mail.python.org/pipermail/doc-sig/2001-June/001859.html
!    __ http://mail.python.org/pipermail/doc-sig/2001-June/001860.html
!    __ http://mail.python.org/pipermail/doc-sig/2001-June/001861.html
  
! .. [#peps-1]
!    - `PEP 256: Docstring Processing System Framework`__
!    - `PEP 258: DPS Generic Implementation Details`__
!    - `PEP 257: Docstring Conventions`__
  
!    __ http://mail.python.org/pipermail/doc-sig/2001-June/001855.html
!    __ http://mail.python.org/pipermail/doc-sig/2001-June/001856.html
!    __ http://mail.python.org/pipermail/doc-sig/2001-June/001857.html
  
  
! .. _Digital Creations: http://www.digicool.com
! .. _ZOPE: http://www.zope.org
! .. _pythondoc: http://starship.python.net/crew/danilo/pythondoc/
! .. _StructuredTextNG:
!     http://dev.zope.org/Members/jim/StructuredTextWiki/StructuredTextNG
! .. _HISTORY.txt:
!     http://structuredtext.sourceforge.net/HISTORY.txt
! .. _Docutils: http://docutils.sourceforge.net/

[Structuredtext-checkins] CVS: restructuredtext/test/test_states test_transitions.py,1.5,1.6

From: David G. <go...@us...> - 2002-03-16 05:30:18

Update of /cvsroot/structuredtext/restructuredtext/test/test_states
In directory usw-pr-cvs1:/tmp/cvs-serv13085/restructuredtext/test/test_states

Modified Files:
	test_transitions.py 
Log Message:
updated

Index: test_transitions.py
===================================================================
RCS file: /cvsroot/structuredtext/restructuredtext/test/test_states/test_transitions.py,v
retrieving revision 1.5
retrieving revision 1.6
diff -C2 -d -r1.5 -r1.6
*** test_transitions.py	12 Mar 2002 03:29:04 -0000	1.5
--- test_transitions.py	16 Mar 2002 05:30:13 -0000	1.6
***************
*** 53,57 ****
  """\
  <document>
!     <section id="id1" name="section 1">
          <title>
              Section 1
--- 53,57 ----
  """\
  <document>
!     <section id="section-1" name="section 1">
          <title>
              Section 1
***************
*** 61,65 ****
          <paragraph>
              Second text division of section 1.
!         <section id="id2" name="section 2">
              <title>
                  Section 2
--- 61,65 ----
          <paragraph>
              Second text division of section 1.
!         <section id="section-2" name="section 2">
              <title>
                  Section 2

Flat | Threaded

<< < 1 2 3 4 5 .. 26 > >> (Page 3 of 26)

2001	Jan	Feb	Mar	Apr	May	Jun	Jul	Aug (83)	Sep (171)	Oct (49)	Nov (58)	Dec
2002	Jan (34)	Feb (76)	Mar (111)	Apr (47)	May	Jun	Jul	Aug	Sep	Oct	Nov	Dec