[Docutils-checkins] sandbox/paultremblay/docutils_nest/doc README.txt,1.2,1.3

[Paul H. T. <pau...@us...>]

Update of /cvsroot/docutils/sandbox/paultremblay/docutils_nest/doc
In directory sc8-pr-cvs1:/tmp/cvs-serv17426/doc

Modified Files:
	README.txt 
Log Message:
removed uneccesary pyc files

Index: README.txt
===================================================================
RCS file: /cvsroot/docutils/sandbox/paultremblay/docutils_nest/doc/README.txt,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -d -r1.2 -r1.3
--- README.txt	8 Jun 2003 18:56:29 -0000	1.2
+++ README.txt	10 Jun 2003 03:12:19 -0000	1.3
@@ -1,4 +1,4 @@
-README: |script_name|
+README: |scriptName|
 ^^^^^^^^^^^^^^^^^^^^^
 :Author: Paul Tremblay
 
@@ -10,43 +10,67 @@
 
 .. contents::
 
-.. |script_name| replace:: docultils-nest.py
+.. |scriptName| replace:: docultils-nest-xml.py
+
+.. |moduleName| replace:: docutils_nest
 
 ========
 Overview
 ========
 
-The script |script_name| in this module are my own extensions to docutils. They change
-inline markup in an rst document to inline tags, allowing you to use rst to
-create XML documents. For example, you might have the following markup in your
-rst document::
+
+The script |scriptName| extends the power of docultils by allowing XML authors
+and developers to include nested inline markup in their documents. While
+docutils allows for infinite nesting on the block level, it limits inline
+markup to one level. The script |scriptName| elminates this shortcomming. An
+XML author could write a document in rst format, and then with |scriptName|
+translate it to robust XML, which he could then further transform to docbook
+or any other form of XML he desired. Any type of XML markup is possible using
+|script_name|.  
+
+In addition to allowing for nested markup, |scriptName| allows you to choose
+any type of inline markup you wish. 
+
+Because users of docutils expressed differences as to how they wanted to mark
+inline text, |scriptName| allows you to customize the markup.
+
+Quick Example
+=============
+
+Let's say you wanted to include a comment in your final XML document, and you want to have a phrase that is emphasized within this comment. You type::
   
   [:comment: Maybe I should include *The Sun Also Rises?*]
 
-If you process this text with the |script_name|, you get::
+
+You then type 
+
+|scriptName| --output my_document.rst
+
+The output is::
 
   <inline arg1 = "comment">Maye I should include <emphasis>The Sun Also
   Rises?</emphasis></inline>
 
-The nested_inline module allows you to choose the way you want to markup your
-inline text in the orignal rst document. For example, you could use
-parenthesis rather than brackets, or choose to place your roles outside the
-group delimeters.  Details are below.
-
 
 Installation
 ============
 
-1. Install the PyXml package.
+1. Install python.
 
-2. Run the configuration script to set the path and location of the configuration file.
+2. Install the docutils package. ()
+
+3. Install the PyXml package. ()
+
+4. Download the 
+
+5. Run the configuration script to set the path and location of the configuration file.
 
    ::
 
      python configure.py target = <desired location of configuration file>
 
    If no target is provided (or you choose not to run the configuration file),
-   the configuration file will be placed in /etc/nest_docutils.
+   the configuration file will be placed in /etc/|moduleName|.
 
 
 3. Install the modules in the usual way:
@@ -59,15 +83,13 @@
 Use
 ===
 
-::
-
-  |script_name| --output <outfile> file.rst
+|scriptName| ``--output <outfile> file.rst``
 
 You *must* specify an output option.
 
-In addition,  you can specify any options you would if running docutils-xml.py::
+In addition,  you can specify any options you would if running docutils-xml.py:
 
-    |script_name| --indents --quiet --output otupt.xml file.rst
+|scriptName| --indents --quiet --output otupt.xml file.rst
 
 
 How to markup your document