Update of /cvsroot/docstring/dps/spec
In directory usw-pr-cvs1:/tmp/cvs-serv8539/dps/spec
Modified Files:
doctree.txt
Log Message:
updated
Index: doctree.txt
===================================================================
RCS file: /cvsroot/docstring/dps/spec/doctree.txt,v
retrieving revision 1.4
retrieving revision 1.5
diff -C2 -d -r1.4 -r1.5
*** doctree.txt 2001/10/31 05:55:39 1.4
--- doctree.txt 2001/11/06 01:07:59 1.5
***************
*** 9,16 ****
This document describes the internal data structure representing
document trees in the Python Docstring Processing System. The data
! structure is defined by classes in the ``dps.nodes`` module. It is
! also formally described by the `Generic Plaintext Document Interface
! DTD`_ XML document type definition, gpdi.dtd_, which is the definitive
! source for element hierarchy details.
Below is a simplified diagram of the hierarchy of element types in the
--- 9,16 ----
This document describes the internal data structure representing
document trees in the Python Docstring Processing System. The data
! structure is defined by the hierarchy of classes in the ``dps.nodes``
! module. It is also formally described by the `Generic Plaintext
! Document Interface DTD`_ XML document type definition, gpdi.dtd_,
! which is the definitive source for element hierarchy details.
Below is a simplified diagram of the hierarchy of element types in the
***************
*** 39,45 ****
-------------------
! Element Reference
-------------------
The elements making up DPS document trees can be categorized into the
following groups:
--- 39,50 ----
-------------------
! Element Hierarchy
-------------------
+ A class hierarchy has been implemented in nodes.py where the position
+ of the element (the level at which it can occur) is significant. E.G.,
+ Root, Structural, Body, Inline classes etc. Certain transformations
+ will be easier because we can use isinstance() on them.
+
The elements making up DPS document trees can be categorized into the
following groups:
***************
*** 66,76 ****
important_
! - _`Special body elements`: target_, directive_, comment_,
! system_warning_
- _`Inline elements`: emphasis_, strong_, interpreted_, literal_,
! reference_, target_, footnote_reference_, image_
``document``
============
--- 71,102 ----
important_
! - _`Special body elements`: target_, directive_, substitution_
! comment_, system_warning_
- _`Inline elements`: emphasis_, strong_, interpreted_, literal_,
! reference_, target_, footnote_reference_, substitution_reference_,
! image_
+ ``Node``
+ ========
+
+
+ ``Text``
+ ========
+
+
+ ``Element``
+ ===========
+
+
+ ``TextElement``
+ ===============
+
+
+ -------------------
+ Element Reference
+ -------------------
+
``document``
============
***************
*** 237,241 ****
Paragraph
! There are several possibilities for the implementation. Solution #2
was chosen.
--- 263,267 ----
Paragraph
! There are several possibilities for the implementation. Solution 3
was chosen.
***************
*** 281,286 ****
grouped within a <BODY> element.
- This solution has been chosen.
-
3. Implement them as "transitions", empty elements::
--- 307,310 ----
***************
*** 300,303 ****
--- 324,330 ----
"transition" smells bad. A transition isn't a thing itself, it's
the space between two divisions.
+
+ This solution has been chosen for incorporation into the document
+ tree.
|