Products.MightyCal (version 1.31)
index
/home/zope/lib/python/Products/MightyCal/__init__.py

** See the bottom of this document for links to the classes/subpackages themselves **
 
MightyCal is a powerful calendar/schedule building program which combines the object-oriented
web development of Zope with the XML transformation capabilities of Cocoon.  There are two portions
to the application: the Zope backend, which is implemented as a Python Product for Zope, and the
Cocoon frontend, which is implemented as a Java Servlet Engine web application.
 
This API documentation covers only the Zope backend.  The subpackages and classes found in this API
document are used as follows:
 
* The MightyCal class is the root class of the entire Product, and is the class which is registered with
  the Zope Management Interface so that administrators can add an instance of MightyCal.
* The EventType subpackage implements a composite object called an EventType, which makes it possible
  for a Calendar administrator to define a Calendar Event, and add custom fields to it.  This package
  also contains the EventTypeRegistry, which is the MightyCal's global interface for managing and
  interacting with available EventTypes.
* The EventCatalog subpackage is responsible for managing Event objects.  It implements the Event object
  itself, and also the EventCatalog which holds and indexes the Events.  It also provides EventCollection,
  which is a dynamic collection of events meeting certain criteria.
* The Template subpackage implements an HTML-like language that administrators can use to design the
  general look of the various output formats for Calendars and Events.  This subpackage also implements
  TemplateCollection, a module used to associate a set of Templates with MightyCal objects.
* The DataEntry subpackage implements the DataEntryTransaction and related modules.  This package
  handles all event entry and updating intelligence, and is responsible for generating the editing
  widgets for event editing.
* The User subpackage holds the UserRegistry and CalendarUser objects.  They provide a means for storing
  user information and permission information.
* The Style subpackage contains classes for attaching stylesheet information to calendars.  These
  stylesheets are customizable by the administrator, and will render themselves for several different
  user-agent contexts (i.e. CSS and XSL-FO stylesheets).  In combination with Templates, this gives
  the administrator total control over the look-and-feel of the various output documents from the frontend.
* The XMLSerialize subpackage provides a set of objects for serializing MightyCal objects for feeding
  to the Cocoon frontend.  In particular, it handles sending EventType descriptors and Events as XML.
* The Consoles subpackage implements the administrative console that give the administrators a
  single-screen overview of the MightyCal instance.
* The Search subpackage:
* The Security subpackage implements the Zope security policies that get applied to the objects contained
  within a MightyCal.  It contains the Permissions module, which defines constants for Zope permissions
  assertions; the SecurityPolicy module, which defines the specific permissions to be applied to
  each object type within a MightyCal; and the PermissionsPropagation module, which implements a mixin
  class to make it easier for permissions to be propagated down a Zope object hierarchy.
* The SFolder class:
* The SItem class:

 
Package Contents
            
Calendar (package)
Consoles (package)
Const
DataEntry (package)
EventCatalog (package)
EventType (package)
MightyCal
SFolder
SItem
Search (package)
Security (package)
Style (package)
Template (package)
User (package)
Utils
XML (package)
__init__
tests (package)

 
Functions
            
initialize(registrar)
Upon Zope startup, this routine is run.  It registers the MightyCal class with the Zope Management Interface, so that an administrator can add an instance of MightyCal from the "Add Product" dropdown box.  A number of other classes are registered, generally so that we can get their icons to appear correctly in object listings.  These classes have their "visibility" attribute set to None.  EventType and Event have to be visible so that they can be cut and pasted.

 
Data
             ICONS_DIR = 'icons'

__file__ = '/home/zope/lib/python/Products/MightyCal/__init__.pyc'

__name__ = 'Products.MightyCal'

__path__ = ['/home/zope/lib/python/Products/MightyCal']

__version__ = '$Revision: 1.31 $'