Products.MightyCal (version 1.21)
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.
* CalendarRegistry holds the defined Calendar objects for the current MightyCal instance.
* A Calendar object provides an administrative reference point for a variety of MightyCal objects.  In
  particular, Events are not allowed to be entered into the MightyCal instance unless they are assigned
  to one or another Calendar.  Each Calendar administrator then has the right to accept or reject the
  Event for inclusion into his calendar.  Also, Calendars hold references to the EventTypes that are
  valid for entry into the Calendar.  In addition, Calendars hold admin-defined Templates that are used
  to produce the various output documents, e.g. month-views and list-views in PDF or HTML, etc.  Finally,
  Calendars have an associated EventCollection, which consists of all Events which were created for
  that particular Calendar.  Calendars do *not* actually store Event objects... these are kept in the
  EventCatalog.
* 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 StyleCollection holds instances of Stylesheets for Calendars.  StyleCollection has a tree-based
  administrative interface for browsing and updating the Stylesheets and the StyleElements they contain.
* Stylesheets are collections of StyleElements.  Stylesheets can render themselves into standard CSS
  format stylesheets, as well as XML-formatted documents.  In CSS format, they are used directly by user
  agents to style the Calendars when they are displayed.  In XML format, they are integrated into XSL-FO
  documents as properties of the XSL-FO tags themselves.
* StyleElements hold the property/value pairs for each element in a Stylesheet.  They have an administrative
  interface that allows the properties to be changed or deleted, or for new properties to be added.  They
  also have the ability to export themselves as a complete CSS element or as an XML tree fragment.
* The Consoles subpackage implements the various administrative consoles (i.e. Calendar-specific and
  overall MightyCal instance consoles) that give the administrators single-screen overviews of the
  Calendar or MightyCal instance.

 
Package Contents
            
Calendar
CalendarRegistry
CalendarUser
Consoles (package)
Const
DataEntry (package)
EventCatalog (package)
EventType (package)
ImageCollection
MightyCal
Permissions
StyleCollection
StyleElement
Stylesheet
TagRegistry
Tags
Template (package)
UserRegistry
Utils
XMLRPC (package)
XMLSerialize
__init__
tests (package)

 
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.21 $'