[Zope3-checkins] CVS: Zope3/doc/zcml/namespaces.zope.org/help - register.stx:1.4

[Stephan Richter]

Update of /cvs-repository/Zope3/doc/zcml/namespaces.zope.org/help
In directory cvs.zope.org:/tmp/cvs-serv7874/help

Modified Files:
	register.stx 
Log Message:
Update ZCML directives documentation.


=== Zope3/doc/zcml/namespaces.zope.org/help/register.stx 1.3 => 1.4 ===
--- Zope3/doc/zcml/namespaces.zope.org/help/register.stx:1.3	Mon Jul 14 09:31:36 2003
+++ Zope3/doc/zcml/namespaces.zope.org/help/register.stx	Thu Jan 22 18:57:11 2004
@@ -1,44 +1,44 @@
-register (class zope.app.onlinehelp.metaconfigure)
+register
 
-  The register directive defines a help topic in the help system.
+  File zope/app/onlinehelp/meta.zcml, lines 5 - 9.
+
+  Register directive for onlien help topics.
 
   Attributes
 
-    parent -- (optional)
+    id -- BytesLine (required)
+
+      Topic Id
+
+      Id of the topic as it will appear in the URL.
+
+    title -- MessageID (required)
+
+      Title
 
-      Location of this topic's parent in the OnlineHelp tree.
+      Provides a title for the online Help Topic.
 
-    id -- (required)
+    parent -- BytesLine (optional, default='')
 
-      The id of the help topic.
+      Parent Topic
 
-    title -- (required)
+      Id of the parent topic.
 
-      Specifies title of the topic. This title will be used in
-      the tree as Identification.
+    for -- GlobalObject (optional, default=None)
 
-    doc_path --  (required)
+      Object Interface
 
-      Specifies where the file that contains the topic content is located on the
-      filesystem.
+      Interface for which this Help Topic is registered.
 
-    doc_type -- (optional)
+    view -- BytesLine (optional, default='')
 
-      Defines the type of document this topic will be.
-      Examples (not necessarily available) are: TXT, reST, HTML
+      View Name
 
-    for -- (optional)
+      The view name for which this Help Topic is registered.
 
-      The interface this help topic applies to.
+    doc_path -- Path (required)
 
-      The help topic will be for all objects that implement this interface.
-      If 'for' is not supplied, the help topic applies to all objects
-      (XXX this ought to change).
-      This can be optional, since not all topics must be bound to a particular
-      interface.
+      Path to File
 
-    view -- (optional)
+      Path to the file that contains the Help Topic content.
 
-      This attribute specifies the name of the view for which
-      this topic is registered. Note that this attribute is also
-      optional.
\ No newline at end of file