Here is a list of current official Zope documentation.
This document was last updated 10/26/2000.
Project |
Status |
Contact |
Zope Book The book
teaches you how to use Zope. It is a replacement for the Content
Manager's Guide, the SQL Methods Guide and the DTML User's Guide. It
will be published by O'Reilly. It will be available under an open
content license as soon as it's published. Until then you can still
read it on Zope.org. |
In Progress Rough draft completed 10/27/2000. Next the book
will go to technical review. After review, it should be published early
2001. After publication it will be made available
under an open content license on Zope.org. At that point it should
be available in many formats including HTML and PDF.
|
The book is written by Michel Pelletier and Amos Latteier. Write to
[email protected] with comments
and questions. |
Zope Guides The guide have
been the chief source of Zope documentation.
|
Soon to be Deprecated Content Manager's Guide, ZSQL Methods
Guide and DTML User's Guide are all being replaced by the Zope Book. When
the book is published the guides will be deprecated. They are currently
out of date. The Developer's Guide and the Admistrator's Guide are both
very incomplete. We are currently working on a plan to revive these
efforts. |
Write to [email protected]. with questions and comments.
|
Online Help Zope comes with online help that documents the Zope
management screens. The online help offers some more information and
background that helps you understand the purpose and use of Zope
management screens.
|
Up to Date All management screens have
help. If you find problems in the online help submit bugs to the
collector. We are in the process of putting procedures
in place to ensure the online help stays up to date.
|
Write to [email protected] with questions and comments.
|
API Reference The API reference documents Zope classes
and methods available from DTML. It gives you the information you
need to script Zope. It is available in the online help.
|
In Progress Many APIs have been documented, but there's still
plenty that could be done. The Interfaces
Wiki is where most of the API discussion takes place. We need a test
suite or some way to verify that all the APIs are accurate. We are in the
process of putting procedures
in place to ensure the online help stays up to date. |
Write to [email protected] with questions and comments. Also see
the Interfaces Wiki for API discussions.
|
DTML Reference The DTML reference documents all the DTML
tags. It is part of the online help system.
|
Up to Date in CVS The DTML reference is in CVS. It will
make its first public appearance in the next Zope release.
|
Write to [email protected] with questions
and comments.
|
Zope Tutorial The tutorial ships with Zope. You can
install it from the Product add list. It gives hands on examples
showing how to build some simple Zope apps.
|
Up to Date The tutorial is accurate and up to date, but rather
limited; a few more lessons might be nice. It might be possible to
coordinate it with examples from the Zope book. The tutorial could also
replace the currently out of date QuickStart. |
Write to [email protected] with questions
and comments.
|