Zope 3 apidoc

getTopicPath()

Return the presumed path to the topic, even the topic is not traversable from the onlinehelp.
__delitem__(name)

Delete the named object from the container.

Raises a KeyError if the object is not found.

If the deleted object's __parent__ and __name__ match the container and given name, then an IObjectRemovedEvent is generated and the attributes are set to None. If the object can be adapted to IObjectMovedEvent, then the adapter's moveNotify method is called with the event.

Unless the object's __parent__ and __name__ attributes were initially None, generate an IContainerModifiedEvent for the container.

If the object's __parent__ and __name__ were already set to None, then no events are generated. This allows advanced clients to take over event generation.
__getitem__(key)

Get a value for a key

A KeyError is raised if there is no value for the key.
getSubTopics()

Returns IOnlineHelpTopic provided childs.
get(key, default=None)

Get a value for a key

The default is returned if there is no value for the key.
keys()

Return the keys of the mapping object.
items()

Return the items of the mapping object.
__contains__(key)

Tell if a key exists in the mapping.
__iter__()

Return an iterator for the keys of the mapping object.
addResources(resources)

Add resources to this Help Topic.

The resources must be located in the same directory as the Help Topic itself.
__setitem__(name, object)
Add the given object to the container under the given name.

Raises a TypeError if the key is not a unicode or ascii string. Raises a ValueError if key is empty.

The container might choose to add a different object than the one passed to this method.

If the object doesn't implement IContained, then one of two things must be done:
1. If the object implements ILocation, then the IContained interface must be declared for the object.
2. Otherwise, a ContainedProxy is created for the object and stored.
The object's __parent__ and __name__ attributes are set to the container and the given name.

If the old parent was None, then an IObjectAddedEvent is generated, otherwise, an IObjectMovedEvent is generated. An IContainerModifiedEvent is generated for the container.

If the object replaces another object, then the old object is deleted before the new object is added, unless the container vetos the replacement by raising an exception.

If the object's __parent__ and __name__ were already set to the container and the name, then no events are generated and no hooks. This allows advanced clients to take over event generation.
values()

Return the values of the mapping object.
registerHelpTopic(parent_path, id, title, doc_path, interface=None, view=None, resources=None)

This method registers a topic at the correct place.

parent_path -- Location of this topic's parent in the OnlineHelp tree. Need not to exist at time of creation.

id -- Specifies the id of the topic

title -- Specifies title of the topic. This title will be used in the tree as Identification.

doc_path -- Specifies where the file that contains the topic content is located.

interface -- Name of the interface for which the help topic is being registered. This can be optional, since not all topics must be bound to a particular interface.

view -- This attribute specifies the name of the view for which this topic is registered. Note that this attribute is also optional.

resources -- Specifies a list of resources for the topic, for example images that are included by the rendered topic content. Optional.
__len__()

Return the number of items.

Adapters for objects providing this interface:

Specific Adapters

There are no specific adapters registered for this interface.

Extended Adapters

zope.app.container.contained.NameChooser

registered: Zope3/zope.app.container-3.6.0-py2.4-linux-x86_64.egg/zope/app/container/configure.zcml (line 40)

requires: zope.app.container.interfaces.IWriteContainer

provides: zope.app.container.interfaces.INameChooser
zope.app.container.size.ContainerSized

registered: Zope3/zope.app.container-3.6.0-py2.4-linux-x86_64.egg/zope/app/container/configure.zcml (line 34)

requires: zope.app.container.interfaces.IReadContainer

provides: zope.size.interfaces.ISized
zope.app.apidoc.codemodule.browser.introspector.mappingItemsNamespace (name: items)

registered: Zope3/zope.app.apidoc-3.4.3-py2.4.egg/zope/app/apidoc/codemodule/browser/introspector.zcml (line 35)

requires: zope.interface.common.mapping.IItemMapping , zope.interface.Interface

provides: zope.traversing.interfaces.ITraversable
zope.app.apidoc.codemodule.browser.introspector.mappingItemsNamespace (name: items)

registered: Zope3/zope.app.apidoc-3.4.3-py2.4.egg/zope/app/apidoc/codemodule/browser/introspector.zcml (line 35)

requires: zope.interface.common.mapping.IItemMapping , zope.interface.Interface

provides: zope.traversing.interfaces.ITraversable
zope.app.container.find.FindAdapter

registered: Zope3/zope.app.container-3.6.0-py2.4-linux-x86_64.egg/zope/app/container/configure.zcml (line 8)

requires: zope.app.container.interfaces.IReadContainer

provides: zope.app.container.interfaces.IFind
zope.app.container.directory.noop

registered: Zope3/zope.app.container-3.6.0-py2.4-linux-x86_64.egg/zope/app/container/configure.zcml (line 21)

requires: zope.app.container.interfaces.IWriteContainer

provides: zope.filerepresentation.interfaces.IWriteDirectory
zope.copypastemove.ContainerItemRenamer

registered: Zope3/zope.copypastemove-3.4.0-py2.4.egg/zope/copypastemove/configure.zcml (line 19)

requires: zope.app.container.interfaces.IContainer

provides: zope.copypastemove.interfaces.IContainerItemRenamer
zope.app.container.contained.ContainerSublocations

registered: Zope3/zope.app.container-3.6.0-py2.4-linux-x86_64.egg/zope/app/container/configure.zcml (line 60)

requires: zope.app.container.interfaces.IReadContainer

provides: zope.location.interfaces.ISublocations
zope.app.container.traversal.ContainerTraversable

registered: Zope3/zope.app.container-3.6.0-py2.4-linux-x86_64.egg/zope/app/container/configure.zcml (line 27)

requires: zope.app.container.interfaces.IReadContainer

provides: zope.traversing.interfaces.ITraversable
zope.app.tree.adapters.ContainerChildObjects

registered: Zope3/zope.app.tree-3.4.0-py2.4.egg/zope/app/tree/configure.zcml (line 37)

requires: zope.app.container.interfaces.IReadContainer

provides: zope.app.tree.interfaces.IChildObjects
zope.app.apidoc.codemodule.browser.introspector.mappingItemsNamespace (name: items)

registered: Zope3/zope.app.apidoc-3.4.3-py2.4.egg/zope/app/apidoc/codemodule/browser/introspector.zcml (line 42)

requires: zope.interface.common.mapping.IItemMapping

provides: zope.traversing.interfaces.ITraversable
zope.app.container.directory.noop

registered: Zope3/zope.app.container-3.6.0-py2.4-linux-x86_64.egg/zope/app/container/configure.zcml (line 15)

requires: zope.app.container.interfaces.IReadContainer

provides: zope.filerepresentation.interfaces.IReadDirectory

Interface
zope.app.onlinehelp.interfaces.IOnlineHelp

Base interfaces

Attributes/Fields

Methods

Adapters

Adapters for objects providing this interface:

Specific Adapters

Extended Adapters

Generic Adapters

Views

Browser

Specific views

Extended views

Generic views

XML-RPC

Specific views

Extended views

Generic views

HTTP

Specific views

Extended views

Generic views

FTP

Specific views

Extended views

Generic views

Other

Specific views

Extended views

Generic views

Other Information

Utilities

Classes

Interface zope.app.onlinehelp.interfaces.IOnlineHelp

Base interfaces

Attributes/Fields

Methods

Adapters

Adapters for objects providing this interface:

Specific Adapters

Extended Adapters

Generic Adapters

Views

Browser

Specific views

Extended views

Generic views

XML-RPC

Specific views

Extended views

Generic views

HTTP

Specific views

Extended views

Generic views

FTP

Specific views

Extended views

Generic views

Other

Specific views

Extended views

Generic views

Other Information

Utilities

Classes

Interface
zope.app.onlinehelp.interfaces.IOnlineHelp