[Lxml-checkins] r39291 - lxml/trunk/doc

scoder at codespeak.net scoder at codespeak.net
Wed Feb 21 16:05:38 CET 2007 

Author: scoder
Date: Wed Feb 21 16:05:34 2007
New Revision: 39291

Modified:
   lxml/trunk/doc/main.txt
Log:
first take on a major restructuring in doc/main.txt

Modified: lxml/trunk/doc/main.txt
==============================================================================
--- lxml/trunk/doc/main.txt	(original)
+++ lxml/trunk/doc/main.txt	Wed Feb 21 16:05:34 2007
@@ -25,104 +25,68 @@
 .. _`lxml at the Python cheeseshop`: http://cheeseshop.python.org/pypi/lxml/
 .. _`this key`: pubkey.asc
 
+The latest version is `lxml 1.2`_, released 2007-02-20 (`changes for 1.2`_).
+`Older versions`_ are listed below.
+
+.. _`lxml 1.2`: lxml-1.2.tgz
+.. _`CHANGES for 1.2`: changes-1.2.html
+.. _`Older versions`: #old-versions
+
 Please take a look at the `installation instructions`_!
 
 .. _`installation instructions`: installation.html
 
-* `lxml 1.2`_, released 2007-02-20 (`changes for 1.2`_)
+It's also possible to check out the latest development version of lxml
+from svn directly, using a command like this::
 
-* `lxml 1.1.2`_, released 2006-10-30 (`changes for 1.1.2`_)
+  svn co http://codespeak.net/svn/lxml/trunk lxml
 
-* `lxml 1.1.1`_, released 2006-09-21 (`changes for 1.1.1`_)
+You can also `browse it through the web`_.  Please read `how to build lxml
+from source`_ first.  The `latest CHANGES`_ of the developer version are also
+accessible.  You can check there if a bug you found has been fixed or a
+feature you want has been implemented in the latest trunk version.
 
-* `lxml 1.1`_, released 2006-09-13 (`changes for 1.1`_)
+.. _`how to build lxml from source`: build.html
+.. _`browse it through the web`: http://codespeak.net/svn/lxml
+.. _`latest CHANGES`: http://codespeak.net/svn/lxml/trunk/CHANGES.txt
 
-* `lxml 1.0.4`_, released 2006-09-09 (`changes for 1.0.4`_)
 
-* `lxml 1.0.3`_, released 2006-08-08 (`changes for 1.0.3`_)
+Documentation
+-------------
 
-* `lxml 1.0.2`_, released 2006-06-27 (`changes for 1.0.2`_)
+* ElementTree:
 
-* `lxml 1.0.1`_, released 2006-06-09 (`changes for 1.0.1`_)
+  * ElementTree_ API
 
-* `lxml 1.0`_, released 2006-06-01 (`changes for 1.0`_)
+  * compatibility_ and differences of lxml.etree
 
-* `lxml 0.9.2`_, released 2006-05-10 (`changes for 0.9.2`_)
+  * `benchmark results`_
 
-* `lxml 0.9.1`_, released 2006-03-30 (`changes for 0.9.1`_)
+* lxml.etree:
 
-* `lxml 0.9`_,   released 2006-03-20 (`changes for 0.9`_)
+  * `lxml.etree specific API`_ documentation
 
-* `lxml 0.8`_,   released 2005-11-03 (`changes for 0.8`_)
+  * Python `extension functions`_ for XPath and XSLT
 
-* `lxml 0.7`_,   released 2005-06-15 (`changes for 0.7`_)
+  * `custom element classes`_ for custom XML APIs
 
-* `lxml 0.6`_,   released 2005-05-14 (`changes for 0.6`_)
+  * a `SAX compliant API`_
 
-* `lxml 0.5.1`_, released 2005-04-09 (`changes for 0.5.1`_)
+  * the `C-level API`_ for interfacing with external C/Pyrex modules
 
-* `lxml 0.5`_,   released 2005-04-08
-
-.. _`lxml 1.2`: lxml-1.2.tgz
-.. _`lxml 1.1.2`: lxml-1.1.2.tgz
-.. _`lxml 1.1.1`: lxml-1.1.1.tgz
-.. _`lxml 1.1`: lxml-1.1.tgz
-.. _`lxml 1.0.4`: lxml-1.0.4.tgz
-.. _`lxml 1.0.3`: lxml-1.0.3.tgz
-.. _`lxml 1.0.2`: lxml-1.0.2.tgz
-.. _`lxml 1.0.1`: lxml-1.0.1.tgz
-.. _`lxml 1.0`: lxml-1.0.tgz
-.. _`lxml 0.9.2`: lxml-0.9.2.tgz
-.. _`lxml 0.9.1`: lxml-0.9.1.tgz
-.. _`lxml 0.9`: lxml-0.9.tgz
-.. _`lxml 0.8`: lxml-0.8.tgz
-.. _`lxml 0.7`: lxml-0.7.tgz
-.. _`lxml 0.6`: lxml-0.6.tgz
-.. _`lxml 0.5.1`: lxml-0.5.1.tgz
-.. _`lxml 0.5`: lxml-0.5.tgz
+* lxml.objectify:
 
-.. _`CHANGES for 1.2`: changes-1.2.html
-.. _`CHANGES for 1.1.2`: changes-1.1.2.html
-.. _`CHANGES for 1.1.1`: changes-1.1.1.html
-.. _`CHANGES for 1.1`: changes-1.1.html
-.. _`CHANGES for 1.0.4`: changes-1.0.4.html
-.. _`CHANGES for 1.0.3`: changes-1.0.3.html
-.. _`CHANGES for 1.0.2`: changes-1.0.2.html
-.. _`CHANGES for 1.0.1`: changes-1.0.1.html
-.. _`CHANGES for 1.0`: changes-1.0.html
-.. _`CHANGES for 0.9.2`: changes-0.9.2.html
-.. _`CHANGES for 0.9.1`: changes-0.9.1.html
-.. _`CHANGES for 0.9`: changes-0.9.html
-.. _`CHANGES for 0.8`: changes-0.8.html
-.. _`CHANGES for 0.7`: changes-0.7.html
-.. _`CHANGES for 0.6`: changes-0.6.html
-.. _`CHANGES for 0.5.1`: changes-0.5.1.html
+  * `lxml.objectify`_ API documentation
 
-It's also possible to check out the latest development version of lxml
-from svn directly, using a command like this::
-
-  svn co http://codespeak.net/svn/lxml/trunk lxml
-
-You can also `browse it through the web`_.  Please read `how to build lxml
-from source`_ first.  The `latest CHANGES`_ of the developer version are also
-accessible.  You can check there if a bug you found has been fixed or a
-feature you want has been implemented in the latest trunk version.
-
-.. _`how to build lxml from source`: build.html
-.. _`browse it through the web`: http://codespeak.net/svn/lxml
-.. _`latest CHANGES`: http://codespeak.net/svn/lxml/trunk/CHANGES.txt
-
-
-Documentation
--------------
+  * a brief comparison of `objectify and etree`_
 
 lxml.etree follows the ElementTree_ API as much as possible, building it on
-top of the native libxml2 tree.  See also the `ElementTree compatibility
-overview`_ and the `benchmark results`_ comparing lxml to the original
+top of the native libxml2 tree.  See also the ElementTree compatibility_
+overview and the `benchmark results`_ comparing lxml to the original
 ElementTree_ and cElementTree_ implementations.
 
 Right after the ElementTree_ documentation, the most important place to look
-is the `lxml.etree API documentation`_.  It describes how lxml extends the
+is the `lxml.etree specific API`_ documentation.  It describes how lxml extends the
 ElementTree API to expose libxml2 and libxslt specific functionality, such as
 XPath_, `Relax NG`_, `XML Schema`_, `XSLT`_, and `c14n`_.  Python code can be
 called from XPath expressions and XSLT stylesheets through the use of
@@ -143,8 +107,8 @@
 .. _cElementTree: http://effbot.org/zone/celementtree.htm
 
 .. _`benchmark results`: performance.html
-.. _`ElementTree compatibility overview`: compatibility.html
-.. _`lxml.etree API documentation`: api.html
+.. _`compatibility`: compatibility.html
+.. _`lxml.etree specific API`: api.html
 .. _`extension functions`: extensions.html
 .. _`custom element classes`: element_classes.html
 .. _`SAX compliant API`: sax.html
@@ -173,3 +137,72 @@
 The lxml library is shipped under a BSD license. libxml2 and libxslt2
 itself are shipped under the MIT license. There should therefore be no
 obstacle to using lxml in your codebase.
+
+
+Old Versions
+------------
+
+* `lxml 1.1.2`_, released 2006-10-30 (`changes for 1.1.2`_)
+
+* `lxml 1.1.1`_, released 2006-09-21 (`changes for 1.1.1`_)
+
+* `lxml 1.1`_, released 2006-09-13 (`changes for 1.1`_)
+
+* `lxml 1.0.4`_, released 2006-09-09 (`changes for 1.0.4`_)
+
+* `lxml 1.0.3`_, released 2006-08-08 (`changes for 1.0.3`_)
+
+* `lxml 1.0.2`_, released 2006-06-27 (`changes for 1.0.2`_)
+
+* `lxml 1.0.1`_, released 2006-06-09 (`changes for 1.0.1`_)
+
+* `lxml 1.0`_, released 2006-06-01 (`changes for 1.0`_)
+
+* `lxml 0.9.2`_, released 2006-05-10 (`changes for 0.9.2`_)
+
+* `lxml 0.9.1`_, released 2006-03-30 (`changes for 0.9.1`_)
+
+* `lxml 0.9`_,   released 2006-03-20 (`changes for 0.9`_)
+
+* `lxml 0.8`_,   released 2005-11-03 (`changes for 0.8`_)
+
+* `lxml 0.7`_,   released 2005-06-15 (`changes for 0.7`_)
+
+* `lxml 0.6`_,   released 2005-05-14 (`changes for 0.6`_)
+
+* `lxml 0.5.1`_, released 2005-04-09 (`changes for 0.5.1`_)
+
+* `lxml 0.5`_,   released 2005-04-08
+
+.. _`lxml 1.1.2`: lxml-1.1.2.tgz
+.. _`lxml 1.1.1`: lxml-1.1.1.tgz
+.. _`lxml 1.1`: lxml-1.1.tgz
+.. _`lxml 1.0.4`: lxml-1.0.4.tgz
+.. _`lxml 1.0.3`: lxml-1.0.3.tgz
+.. _`lxml 1.0.2`: lxml-1.0.2.tgz
+.. _`lxml 1.0.1`: lxml-1.0.1.tgz
+.. _`lxml 1.0`: lxml-1.0.tgz
+.. _`lxml 0.9.2`: lxml-0.9.2.tgz
+.. _`lxml 0.9.1`: lxml-0.9.1.tgz
+.. _`lxml 0.9`: lxml-0.9.tgz
+.. _`lxml 0.8`: lxml-0.8.tgz
+.. _`lxml 0.7`: lxml-0.7.tgz
+.. _`lxml 0.6`: lxml-0.6.tgz
+.. _`lxml 0.5.1`: lxml-0.5.1.tgz
+.. _`lxml 0.5`: lxml-0.5.tgz
+
+.. _`changes for 1.1.2`: changes-1.1.2.html
+.. _`changes for 1.1.1`: changes-1.1.1.html
+.. _`changes for 1.1`: changes-1.1.html
+.. _`changes for 1.0.4`: changes-1.0.4.html
+.. _`changes for 1.0.3`: changes-1.0.3.html
+.. _`changes for 1.0.2`: changes-1.0.2.html
+.. _`changes for 1.0.1`: changes-1.0.1.html
+.. _`changes for 1.0`: changes-1.0.html
+.. _`changes for 0.9.2`: changes-0.9.2.html
+.. _`changes for 0.9.1`: changes-0.9.1.html
+.. _`changes for 0.9`: changes-0.9.html
+.. _`changes for 0.8`: changes-0.8.html
+.. _`changes for 0.7`: changes-0.7.html
+.. _`changes for 0.6`: changes-0.6.html
+.. _`changes for 0.5.1`: changes-0.5.1.html

More information about the lxml-checkins mailing list