Table of Contents

Zope 2.2.1 Source Documentation  

Welcome to the Zope source release

This document provides some general information about the Zope source release and provides links to other documents.

Installation information can be found in doc/INSTALL.txt. Other documentation is also in the doc directory.

Zope information is available at http://www.zope.org/

Report problems with this release on the Zope mailing list (zope@zope.org) To subscribe to the list send mail to zope-request@zope.org with "subscribe" in the subject line.

Introduction

The source release is intended for tinkerers, those who want to use Zope components separately, Bobo hackers, people who want to use their own Python, and people who work on obscure platforms because they love to compile everything from source.

If you just want to use Zope easily and aren't a programmer the binary release will probably suit you better. All are available at http://www.zope.org/Download

License

The Zope License is included in LICENSE.txt Send your feedback about the license to zope-license@zope.org.

Important

This release requires Python 1.5.2.

Installing Zope

Follow the instructions in doc/INSTALL.txt to install Zope.

Using Zope Components Separately

Zope consists of many Python packages which can be profitably used by themselves. For example you will find all your old friends from Bobo here:

  • ZPublisher - A packagized version of the Bobo ORB you know and love.

  • DocumentTemplate - This package includes cDocumentTemplate which speeds things up considerably.

  • BoboPOS - This is NOT ZODB 3. It a version of BoboPOS2 which include c code to make things faster.

You can find most of these packages in the lib/python directory. If you poke around, you might find other goodies too, like StructuredText.

ZPublisher and DocumentTemplate are also available separately.

Notes

  • Zope requires Python 1.5.2.

  • Lots more documentation is coming.

  • Don't forget to check the Zope web site and mailing list.

  • Read the source, have fun!

Modules   

Zope-2.2.1-src/

w_pcgi

Try to do all of the installation steps.

wo_pcgi

Try to do all of the installation steps.

z2

Zope 2 ZServer start-up file

zpasswd

Zope password change system"""

Zope-2.2.1-src/ZServer/

DebugLogger
FCGIServer

ZServer/Medusa FastCGI server, by Robin Dunn.

FTPRequest

FTP Request class for FTP server.

FTPResponse

Response class for the FTP Server.

FTPServer

ZServer FTP Channel for use the medusa's ftp server.

HTTPServer

Medusa HTTP server for Zope

PCGIServer

Medusa PCGI server.

Producers

ZServer pipe utils. These producers basically function as callbacks.

ZService

ZServer as a NT service.

Zope-2.2.1-src/ZServer/PubCore/

ZEvent

Simple Event Manager Based on Pipes

ZRendezvous
ZServerPublisher

Zope-2.2.1-src/ZServer/medusa/

asynchat
asyncore
counter
default_handler
filesys
ftp_server
http_date
http_server
logger
m_syslog

socket interface to unix syslog.

max_sockets
medusa_gif
mime_type_table
monitor
monitor_client
monitor_client_win32
producers

A collection of producers.

resolver
select_trigger
status_handler

Zope-2.2.1-src/inst/

binary_install

Try to do all of the installation steps.

build_extensions

Build the Zope Extension Modules

build_pcgi

Build a PCGI

compilezpy
default_content
do

Shared routines used by the various scripts.

make_resource

Build a PCGI resource file.

make_start

Zope-2.2.1-src/lib/Components/ExtensionClass/

AqAlg
Xaq
test_MultiMapping
test_Sync
test_ThreadLock
test_acquisition
test_add
test_binding
test_explicit_acquisition
test_func_attr

Test function attributes

test_method_hook

Zope-2.2.1-src/lib/Components/cPickle/

copy_reg

Zope-2.2.1-src/lib/python/

ExportImportXML
Globals

Global definitions"""

LOG
Main

Provide a Main application for the Zope framework

Persistence

Provide access to Persistent and PersistentMapping

ThreadedAsync

Utility module to help manage the asyncore mainloop in a multi-threaded app

dcdb
__init__

The webdav package provides WebDAV capability for common Zope objects.

xmlrpclib
zLOG

General logging facility

zdaemon

zinit, slightly smarter server manager and ZServer startup script.

Zope-2.2.1-src/lib/python/AccessControl/

AuthEncoding
DTML

Add security system support to Document Templates

Owned
PermissionMapping

Permission Mapping

PermissionRole
Role

Access control support"""

SecurityManagement
SecurityManager
SimpleObjectPolicies
SpecialUsers
User

Access control package"""

ZopeSecurityPolicy

Zope-2.2.1-src/lib/python/App/

ApplicationManager
CacheManager
Common

Commonly used utility functions."""

Dialogs

Common HTML dialog boxes

Extensions
Factory
FactoryDispatcher
FindHomes

Commonly used utility functions."""

ImageFile

Image object that is stored in a file"""

Management

Standard management interface support

Permission
PersistentExtra
Product

Product objects

ProductContext

Objects providing context for product initialization

ProductRegistry
Undo
class_init
special_dtml
tar
version_txt

Zope-2.2.1-src/lib/python/DateTime/

DateTimeZone

Zope-2.2.1-src/lib/python/DocumentTemplate/

DT_HTML

HTML formated DocumentTemplates

DT_If
DT_In
DT_InSV
DT_Let

The Let tag was contributed to Zope by and is copyright, 1999

DT_Raise

Raising exceptions

DT_Return
DT_String

$Id: DT_String.py,v 1.35.18.2 2000/08/17 13:46:48 brian Exp $"

DT_Try
DT_UI
DT_Util

$Id: DT_Util.py,v 1.66.10.3 2000/07/05 15:54:20 shane Exp $'''

DT_Var
DT_With

Nested namespace access

DTtest

Document Template Tests

DTtestExpr
DTtest_basicIn
DocumentTemplate

Document templates with fill-in fields

VSEval

Very Safe Python Expressions

gparse

$Id: gparse.py,v 1.10 1999/03/18 15:07:03 brian Exp $"

gparse_test

$Id: gparse_test.py,v 1.3 1999/03/10 00:15:08 klm Exp $"

pDocumentTemplate
ts_regex

Provide a thread-safe interface to regex

Zope-2.2.1-src/lib/python/HelpSys/

APIHelpTopic

API documentation help topics

HelpSys
HelpTopic
HelpUtil

Help system support module"""

ObjectRef

Object Reference implementation"""

Zope-2.2.1-src/lib/python/OFS/

Application
CopySupport
DefaultObservable
Document

Deprecated - use DTMLMethod"""

FTPInterface

FTP Support for Zope classes.

FindSupport
History

Object Histories"""

Moniker

Object monikers

SimpleItem

This module implements a simple item mix-in for objects that have a

Traversable

This module implements a mix-in for traversable objects.

Uninstalled

Objects for packages that have been uninstalled.

XMLExportImport
ZDOM

DOM implementation in ZOPE : Read-Only methods

content_types

A utility module for content-type handling."""

misc_
ndiff

ndiff [-q] file1 file2

rPickle

Restricted unpickler"""

Zope-2.2.1-src/lib/python/Products/ExternalMethod/help/

ExternalMethod

Zope-2.2.1-src/lib/python/Products/MIMETools/

MIMETag

Zope-2.2.1-src/lib/python/Products/MailHost/

SendMailTag

Zope-2.2.1-src/lib/python/Products/MailHost/help/

MailHost

Zope-2.2.1-src/lib/python/Products/OFSP/

Draft
Session

Backward compatability!

Version

Version object"""

Zope-2.2.1-src/lib/python/Products/OFSP/help/

AuthenticatedUser
DTMLDocument
DTMLMethod
DateTime
File
Folder
Image
ObjectManagerItem
PropertyManager
PropertySheet
PropertySheets

Zope-2.2.1-src/lib/python/Products/ZCatalog/

Catalog
CatalogAwareness

ZCatalog Findable class"""

CatalogAwarenessInterface
Lazy

Zope-2.2.1-src/lib/python/Products/ZCatalog/help/

Vocabulary
ZCatalog

Zope-2.2.1-src/lib/python/Products/ZGadflyDA/

DABase
db

$Id: db.py,v 1.11 1999/09/16 15:12:45 jim Exp $'''

Zope-2.2.1-src/lib/python/Products/ZGadflyDA/gadfly/

DLispShort
DumbLispGen
SQLTESTG
gadfly

main entry point for gadfly sql."""

gfclient

client access to gadfly server. (gfserve.py)

gfinstall

Gadfly installation script.

gfintrospect

View based introspection and extension views

gfserve

gadfly server mode

gfsocket

socket interactions for gadfly client and server"""

idl
kjParseBuild
kjParser
kjSet
kjpylint

python lint using kwParsing

pygram
relalg

Simple relational algebra interpreter.

remotetest

Demonstration of the Remote View protocol for adding

sqlbind

rule bindings for sql grammar."""

sqlgen

grammar generation stuff for sql.

sqlgram
sqlgtest

test parses for sql grammar"

sqlmod

Database modification statement semantics"""

sqlsem

sql semantics

sqlwhere

this module indicates where the sql datastructures are marshalled

Zope-2.2.1-src/lib/python/Products/ZSQLMethods/

SQL

Zope-2.2.1-src/lib/python/Products/ZSQLMethods/help/

ZSQLMethod

Zope-2.2.1-src/lib/python/Products/ZopeTutorial/

TutorialTopic

Zope-2.2.1-src/lib/python/SearchIndex/

GlobbingLexicon
Index

Simple column indices"""

Lexicon
ResultList
TextIndex

Text Index

UnIndex

Simple column indices"""

UnKeywordIndex
UnTextIndex

Text Index

Zope-2.2.1-src/lib/python/Shared/DC/ZRDB/

Aqueduct
DA
RDB
Results
Search
THUNK
TM

Provide support for linking an external transaction manager with Zope's

dbi_db
sqlgroup

Inserting optional tests with sqlgroup

sqltest

Inserting optional tests with sqlgroup

sqlvar

Inserting values with the sqlvar tag

Zope-2.2.1-src/lib/python/Shared/DC/xml/

ppml

Provide conversion between Python pickles and XML

xmllib
xyap

Yet another XML parser

Zope-2.2.1-src/lib/python/Shared/DC/xml/pyexpat/

_checkversion

This file (which is sourced, not imported) checks the version of the

pyexpattest

Zope-2.2.1-src/lib/python/StructuredText/

MML

$Id: MML.py,v 1.3 1999/03/10 00:15:46 klm Exp $'''

StructuredText

Structured Text Manipulation

Zope-2.2.1-src/lib/python/TreeDisplay/

TreeTag

Rendering object hierarchies as Trees

Zope-2.2.1-src/lib/python/ZClasses/

Basic

Basic Item class and class manager

Method

Basic Item class and class manager

ObjectManager

Object-manager mix-in for ZClasses

Property

Provide management of common instance property sheets

ZClass

Zope Classes

ZClassOwner

Zope Classes

Zope-2.2.1-src/lib/python/ZLogger/

FileLogger
ZLogger
stupidFileLogger
syslog

socket interface to unix syslog.

syslogLogger
test_logger

Zope-2.2.1-src/lib/python/ZODB/

BaseStorage

Handy standard storage machinery

Connection

Database connection support

DB

Database objects

DemoStorage

Demo ZODB storage

ExportImport

Support for database export and import.

FileStorage
MappingStorage

Very Simple Mapping ZODB storage

Mount

Mounted database support

POSException

BoboPOS-defined exceptions

PersistentMapping
TmpStore
Transaction

Transaction management

UndoLogCompatible

Provide backward compatability with storages that have undoLog, but not undoInfo."""

ZApplication

Implement an bobo_application object that is BoboPOS3 aware

bpthread

Thread abstraction module

conversionhack
dbmStorage

Very Simple dbm-based ZODB storage

fsrecover

Simple script for repairing damaged FileStorage files.

lock_file

Try windows-specific code:

referencesf

Provide a function that can find object references in pickles

utils

Zope-2.2.1-src/lib/python/ZPublisher/

BaseRequest
BaseResponse

CGI Response Output formatter

BeforeTraverse

BeforeTraverse interface and helper classes"""

Client

:"

Converters
HTTPRequest
HTTPResponse

CGI Response Output formatter

Publish
Request
Response
Test

:"

cgi

Support module for CGI (Common Gateway Interface) scripts.

mapply

Provide an apply-like facility that works with any mapping object

maybe_lock
xmlrpc

XML-RPC support module

Zope-2.2.1-src/lib/python/Zope/

ClassFactory

Zope Framework Class Finder

Zope-2.2.1-src/lib/python/webdav/

Collection

WebDAV support - collection objects."""

NullResource

WebDAV support - null resource objects."""

Resource

WebDAV support - resource objects."""

client

HTTP 1.1 / WebDAV client library."""

common

Commonly used functions for WebDAV support modules."""

davcmds

WebDAV xml request objects."""

xmltools

WebDAV XML parsing tools. Note that this module does just

Zope-2.2.1-src/pcgi/

pcgi_publisher

Zope-2.2.1-src/pcgi/Example/

pcgitime

Zope-2.2.1-src/pcgi/MrCreosote/

creosote

Zope-2.2.1-src/pcgi/Util/

killpcgi
pcgifile

Zope-2.2.1-src/utilities/

FS
bbb

Read and (re-)format BoboPOS 2 database files

fixbbbts
load_site

Load a Zope site from a collection of files or directories


Table of Contents

This document was automatically generated on Mon Sep 4 07:33:06 2000 by HappyDoc version r0_6