A Topic is a single help page that you can view. Topics are able to contain other Topics and so on.
You can also associate a Topic with a particular view.
The Content is stored in a file and not the Topic itself. The file is only read when required.
Note that all the Sub-Topic management is done via the utility service. The topic itself is stored in the IContainer implementation after add the right parent topic of a child. This mechanism ensures that we don't have to take care on the registration order. The topic resources are stroed in the IContainer implementation of the topic too.
id
*
-
TextLine
(default =
u''
)
The Id of this Help Topic
path
*
-
TextLine
(default =
u'./README.TXT'
)
The Path to the Definition of a Help Topic
title
*
-
TextLine
(default =
u'Help Topic'
)
The Title of a Help Topic
view
*
-
TextLine
(default =
u''
)
The View Name for which this Help Topic is registered
interface
-
GlobalInterface
(default =
None
)
Interface for which this Help Topic is registered.
parentPath
-
TextLine
(default =
u''
)
The Path to the Parent of this Help Topic
* = required
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:
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.
__len__()
Return the number of items.
There are no specific adapters registered for this interface.
zope.viewlet.viewlet.SimpleViewletClass from /opt/zope/sr/apidoc/src/zope/app/boston/viewlets/addinginfo/viewlet.pt
(name: addinginfo)
zope.app.onlinehelp.onlinehelp.OnlineHelp
zope.app.onlinehelp.onlinehelptopic.RESTOnlineHelpTopic
zope.app.onlinehelp.onlinehelptopic.ZPTOnlineHelpTopic
zope.app.onlinehelp.onlinehelptopic.STXOnlineHelpTopic
zope.app.onlinehelp.onlinehelptopic.OnlineHelpTopic
zope.app.apidoc.bookmodule.book.BookModule
zope.app.onlinehelp.onlinehelp.OnlineHelp