[Zope-dev] Alpha release of ZODB programming guide

[Andrew Kuchling]

For what seems like half an eternity, I've been working on a ZODB
programming guide, written for Python programmers who want to use the
ZODB to store data.  The document is placed under the GNU Free
Documentation License.  It's still far from being finished, but while
on vacation I filled it out enough to make it alpha-worthy, though
note that there are still empty sections.  Please take a look at:

http://www.amk.ca/zodb/guide/

What I'd like right now:
     * Suggestions for topics that should be covered.  This would be
the most helpful.

     * Comments on the organization (ordering of chapters, topics, &c.)

     * Reporting errors and inaccuracies would also be helpful, but
are less important at the moment.  Getting the outline correct
is my primary concern at the moment.

--amk

Table of contents:
     * 1 Introduction
          + 1.1 What is ZODB?
          + 1.2 OODBs vs. Relational DBs
          + 1.3 What is ZEO?
          + 1.4 About this guide
     * 2 ZODB Programming
          + 2.1 Installing ZODB
               o 2.1.1 Requirements
               o 2.1.2 Installing the Packages
          + 2.2 How ZODB Works
          + 2.3 Opening a ZODB
          + 2.4 Writing a Persistent Class
          + 2.5 Rules for Writing Persistent Classes
               o 2.5.1 Modifying Mutable Objects
               o 2.5.2 Some Special Methods Don't Work
               o 2.5.3 Fixing isinstance and issubclass
               o 2.5.4 __getattr__, __delattr__, and __setattr__
          + 2.6 Writing Persistent Classes
               o 2.6.1 Changing Class Attributes
     * 3 ZEO
          + 3.1 How ZEO Works
          + 3.2 Installing ZEO
               o 3.2.1 Requirements
               o 3.2.2 Installation
          + 3.3 Configuring and Running a ZEO Server
          + 3.4 Testing the ZEO Installation
          + 3.5 Sample Application: chatter.py
     * 4 Transactions and Versioning
          + 4.1 Subtransactions
          + 4.2 Undoing Changes
          + 4.3 Versions
          + 4.4 Multithreaded ZODB Programs
     * 5 Storages
          + 5.1 FileStorage
          + 5.2 BerkeleyStorage
          + 5.3 OracleStorage
     * 6 Related Modules
          + 6.1 ZODB.PersistentMapping
          + 6.2 ZODB.PersistentList
          + 6.3 B-tree Modules
     * A. Resources
     * B. GNU Free Documentation License