API Documentation

Classes

IDocument , IMutableDocument

Document content type interfaces.

$Id: Document.py 37023 2005-05-26 15:27:36Z yuppie $

class IDocument

Textual content, in one of several formats.

• Allowed formats include: structured text, HTML, plain text.

Methods

EditableBody():

Get the "raw" (as edited) form of the text.

CookedBody():

Get the "cooked" (ready for presentation) form of the text.

class IMutableDocument

Updatable form of IDocument.

Methods

edit(text_format, text, file=, safety_belt=):

Update the document.

• safety_belt, if passed, must match the value issued when the edit began.