[Zope3-checkins] CVS: Zope3/doc/zcml/namespaces.zope.org/zope -
adapter.stx:1.5 allow.stx:1.4 class.stx:1.2 content.stx:1.7
defaultView.stx:1.4 directive.stx:1.2 resource.stx:1.4
subdirective.stx:1.2 view.stx:1.4 vocabulary.stx:1.2
Stephan Richter
srichter at cosmos.phy.tufts.edu
Fri Jan 23 12:01:03 EST 2004
Update of /cvs-repository/Zope3/doc/zcml/namespaces.zope.org/zope
In directory cvs.zope.org:/tmp/cvs-serv24998/doc/zcml/namespaces.zope.org/zope
Modified Files:
adapter.stx allow.stx class.stx content.stx defaultView.stx
directive.stx resource.stx subdirective.stx view.stx
vocabulary.stx
Log Message:
I had a little bug in my text wrapper. I added a doc test for it now and
updated the generated ZCML reference.
=== Zope3/doc/zcml/namespaces.zope.org/zope/adapter.stx 1.4 => 1.5 ===
--- Zope3/doc/zcml/namespaces.zope.org/zope/adapter.stx:1.4 Thu Jan 22 18:57:17 2004
+++ Zope3/doc/zcml/namespaces.zope.org/zope/adapter.stx Fri Jan 23 12:00:30 2004
@@ -10,15 +10,13 @@
Adapter factory/factories
- A list of factories (usually just one) that create the adapter
-
+ A list of factories (usually just one) that create the adapter instance.
provides -- GlobalObject (required)
Interface the component provides
- This attribute specifes the interface the adapter instance must
-
+ This attribute specifes the interface the adapter instance must provide.
for -- GlobalObject (required)
@@ -37,5 +35,5 @@
Name
Adapters can have names. This attribute allows you to specify the name
- this adapter.
+ for this adapter.
=== Zope3/doc/zcml/namespaces.zope.org/zope/allow.stx 1.3 => 1.4 ===
--- Zope3/doc/zcml/namespaces.zope.org/zope/allow.stx:1.3 Thu Jan 22 18:57:17 2004
+++ Zope3/doc/zcml/namespaces.zope.org/zope/allow.stx Fri Jan 23 12:00:30 2004
@@ -17,6 +17,6 @@
Interface
Interfaces whos names to provide access to. Access will be provided to
- of the names defined by the interface(s). Multiple interfaces can be
-
+ all of the names defined by the interface(s). Multiple interfaces can be
+ supplied.
=== Zope3/doc/zcml/namespaces.zope.org/zope/class.stx 1.1 => 1.2 ===
--- Zope3/doc/zcml/namespaces.zope.org/zope/class.stx:1.1 Thu Jan 22 18:57:17 2004
+++ Zope3/doc/zcml/namespaces.zope.org/zope/class.stx Fri Jan 23 12:00:30 2004
@@ -20,7 +20,7 @@
File zope/app/component/meta.zcml, lines 85 - 88.
Declare that the class given by the content directive's class attribute
- a given interface
+ implements a given interface
Attributes
@@ -37,7 +37,7 @@
File zope/app/component/meta.zcml, lines 90 - 93.
Indicate that the a specified list of names or the names in a given
- require a given permission for access.
+ Interface require a given permission for access.
Attributes
@@ -46,7 +46,7 @@
Permission
Specifies the permission by id that will be required to access or
- the attributes and methods specified.
+ mutate the attributes and methods specified.
attributes -- Tokens (optional, default=None)
@@ -77,8 +77,8 @@
Configure like this class
This argument says that this content class should be configured in
- same way the specified class' security is. If this argument is
- no other argument can be used.
+ the same way the specified class' security is. If this argument is
+ specifed, no other argument can be used.
@@ -87,8 +87,8 @@
File zope/app/component/meta.zcml, lines 95 - 98.
Declare a part of the class to be publicly viewable (that is, requires
- zope.Public permission). Only one of the following two attributes may
- used.
+ the zope.Public permission). Only one of the following two attributes
+ may be used.
Attributes
@@ -119,22 +119,22 @@
ID
the identifier for this factory in the ZMI factory identification
- If not given, defaults to the literal string given as the content
- 'class' attribute.
+ scheme. If not given, defaults to the literal string given as the
+ content directive's 'class' attribute.
permission -- Id (optional, default=None)
Permission
permission id required to use this factory. Although optional, this
- should normally be specified.
+ attribute should normally be specified.
title -- MessageID (optional, default=None)
Title
text suitable for use in the 'add content' menu of a management
-
+ interface
description -- MessageID (optional, default=None)
=== Zope3/doc/zcml/namespaces.zope.org/zope/content.stx 1.6 => 1.7 ===
--- Zope3/doc/zcml/namespaces.zope.org/zope/content.stx:1.6 Thu Jan 22 18:57:17 2004
+++ Zope3/doc/zcml/namespaces.zope.org/zope/content.stx Fri Jan 23 12:00:30 2004
@@ -20,7 +20,7 @@
File zope/app/component/meta.zcml, lines 113 - 116.
Declare that the class given by the content directive's class attribute
- a given interface
+ implements a given interface
Attributes
@@ -37,7 +37,7 @@
File zope/app/component/meta.zcml, lines 118 - 121.
Indicate that the a specified list of names or the names in a given
- require a given permission for access.
+ Interface require a given permission for access.
Attributes
@@ -46,7 +46,7 @@
Permission
Specifies the permission by id that will be required to access or
- the attributes and methods specified.
+ mutate the attributes and methods specified.
attributes -- Tokens (optional, default=None)
@@ -77,8 +77,8 @@
Configure like this class
This argument says that this content class should be configured in
- same way the specified class' security is. If this argument is
- no other argument can be used.
+ the same way the specified class' security is. If this argument is
+ specifed, no other argument can be used.
@@ -87,8 +87,8 @@
File zope/app/component/meta.zcml, lines 123 - 126.
Declare a part of the class to be publicly viewable (that is, requires
- zope.Public permission). Only one of the following two attributes may
- used.
+ the zope.Public permission). Only one of the following two attributes
+ may be used.
Attributes
@@ -119,22 +119,22 @@
ID
the identifier for this factory in the ZMI factory identification
- If not given, defaults to the literal string given as the content
- 'class' attribute.
+ scheme. If not given, defaults to the literal string given as the
+ content directive's 'class' attribute.
permission -- Id (optional, default=None)
Permission
permission id required to use this factory. Although optional, this
- should normally be specified.
+ attribute should normally be specified.
title -- MessageID (optional, default=None)
Title
text suitable for use in the 'add content' menu of a management
-
+ interface
description -- MessageID (optional, default=None)
=== Zope3/doc/zcml/namespaces.zope.org/zope/defaultView.stx 1.3 => 1.4 ===
--- Zope3/doc/zcml/namespaces.zope.org/zope/defaultView.stx:1.3 Thu Jan 22 18:57:17 2004
+++ Zope3/doc/zcml/namespaces.zope.org/zope/defaultView.stx Fri Jan 23 12:00:30 2004
@@ -11,8 +11,8 @@
The interface this view applies to.
The view will be for all objects that implement this interface. If this
- not supplied, the view applies to all objects (XXX this ought to
-
+ is not supplied, the view applies to all objects (XXX this ought to
+ change).
permission -- Id (optional, default=None)
@@ -30,17 +30,17 @@
The layer the view is in.
- A skin is composed of layers. It is common to put skin specific views
+ A skin is composed of layers. It is common to put skin specific views in
a layer named after the skin. If the 'layer' attribute is not supplied,
- defaults to 'default'.
+ it defaults to 'default'.
allowed_interface -- Tokens (optional, default=None)
Interface that is also allowed if user has permission.
By default, 'permission' only applies to viewing the view and any
- sub views. By specifying this attribute, you can make the permission
- apply to everything described in the supplied interface.
+ possible sub views. By specifying this attribute, you can make the
+ permission also apply to everything described in the supplied interface.
Multiple interfaces can be provided, separated by whitespace.
@@ -49,8 +49,8 @@
View attributes that are also allowed if user has permission.
By default, 'permission' only applies to viewing the view and any
- sub views. By specifying 'allowed_attributes', you can make the
- also apply to the extra attributes on the view object.
+ possible sub views. By specifying 'allowed_attributes', you can make the
+ permission also apply to the extra attributes on the view object.
name -- TextLine (required)
@@ -58,12 +58,12 @@
The name shows up in URLs/paths. For example 'foo'.
- provides -- GlobalObject (optional, default=<InterfaceClass zope.interface.Interface at 4031b1ec>)
+ provides -- GlobalObject (optional, default=<InterfaceClass zope.interface.Interface at 4031b20c>)
The interface this component provides.
A view can provide an interface. This would be used for views that
- other views.
+ support other views.
type -- GlobalObject (required)
=== Zope3/doc/zcml/namespaces.zope.org/zope/directive.stx 1.1 => 1.2 ===
--- Zope3/doc/zcml/namespaces.zope.org/zope/directive.stx:1.1 Thu Jan 22 18:57:17 2004
+++ Zope3/doc/zcml/namespaces.zope.org/zope/directive.stx Fri Jan 23 12:00:30 2004
@@ -21,7 +21,7 @@
Attribute names
This is a space-speratated list of attribute names. This is used to
- a mimimal specification the attributes used.
+ provide a mimimal specification the attributes used.
handler -- GlobalObject (required)
=== Zope3/doc/zcml/namespaces.zope.org/zope/resource.stx 1.3 => 1.4 ===
--- Zope3/doc/zcml/namespaces.zope.org/zope/resource.stx:1.3 Thu Jan 22 18:57:17 2004
+++ Zope3/doc/zcml/namespaces.zope.org/zope/resource.stx Fri Jan 23 12:00:30 2004
@@ -30,12 +30,12 @@
The name shows up in URLs/paths. For example 'foo'.
- provides -- GlobalObject (optional, default=<InterfaceClass zope.interface.Interface at 4031b1ec>)
+ provides -- GlobalObject (optional, default=<InterfaceClass zope.interface.Interface at 4031b20c>)
The interface this component provides.
A view can provide an interface. This would be used for views that
- other views.
+ support other views.
type -- GlobalObject (required)
=== Zope3/doc/zcml/namespaces.zope.org/zope/subdirective.stx 1.1 => 1.2 ===
--- Zope3/doc/zcml/namespaces.zope.org/zope/subdirective.stx:1.1 Thu Jan 22 18:57:17 2004
+++ Zope3/doc/zcml/namespaces.zope.org/zope/subdirective.stx Fri Jan 23 12:00:30 2004
@@ -21,5 +21,5 @@
Attribute names
This is a space-speratated list of attribute names. This is used to
- a mimimal specification the attributes used.
+ provide a mimimal specification the attributes used.
=== Zope3/doc/zcml/namespaces.zope.org/zope/view.stx 1.3 => 1.4 ===
--- Zope3/doc/zcml/namespaces.zope.org/zope/view.stx:1.3 Thu Jan 22 18:57:17 2004
+++ Zope3/doc/zcml/namespaces.zope.org/zope/view.stx Fri Jan 23 12:00:30 2004
@@ -11,8 +11,8 @@
The interface this view applies to.
The view will be for all objects that implement this interface. If this
- not supplied, the view applies to all objects (XXX this ought to
-
+ is not supplied, the view applies to all objects (XXX this ought to
+ change).
permission -- Id (optional, default=None)
@@ -30,17 +30,17 @@
The layer the view is in.
- A skin is composed of layers. It is common to put skin specific views
+ A skin is composed of layers. It is common to put skin specific views in
a layer named after the skin. If the 'layer' attribute is not supplied,
- defaults to 'default'.
+ it defaults to 'default'.
allowed_interface -- Tokens (optional, default=None)
Interface that is also allowed if user has permission.
By default, 'permission' only applies to viewing the view and any
- sub views. By specifying this attribute, you can make the permission
- apply to everything described in the supplied interface.
+ possible sub views. By specifying this attribute, you can make the
+ permission also apply to everything described in the supplied interface.
Multiple interfaces can be provided, separated by whitespace.
@@ -49,8 +49,8 @@
View attributes that are also allowed if user has permission.
By default, 'permission' only applies to viewing the view and any
- sub views. By specifying 'allowed_attributes', you can make the
- also apply to the extra attributes on the view object.
+ possible sub views. By specifying 'allowed_attributes', you can make the
+ permission also apply to the extra attributes on the view object.
name -- TextLine (required)
@@ -58,12 +58,12 @@
The name shows up in URLs/paths. For example 'foo'.
- provides -- GlobalObject (optional, default=<InterfaceClass zope.interface.Interface at 4031b1ec>)
+ provides -- GlobalObject (optional, default=<InterfaceClass zope.interface.Interface at 4031b20c>)
The interface this component provides.
A view can provide an interface. This would be used for views that
- other views.
+ support other views.
type -- GlobalObject (required)
=== Zope3/doc/zcml/namespaces.zope.org/zope/vocabulary.stx 1.1 => 1.2 ===
--- Zope3/doc/zcml/namespaces.zope.org/zope/vocabulary.stx:1.1 Thu Jan 22 18:57:17 2004
+++ Zope3/doc/zcml/namespaces.zope.org/zope/vocabulary.stx Fri Jan 23 12:00:30 2004
@@ -5,16 +5,16 @@
Define a named vocabulary.
This associates a vocabulary name in the global vocabulary service with a
- Each name may only be defined once.
+ factory. Each name may only be defined once.
Additional keyword arguments may be passed to the factory by adding
- attributes beyond those listed here. This can be useful when using
- which implement various kinds of filtering.
+ additional attributes beyond those listed here. This can be useful when
+ using vocabularies which implement various kinds of filtering.
Example::
<vocabulary name="garys-favorite-path-references"
- />
+ factory="zope.app.gary.paths.Favorites" />
Attributes
@@ -22,16 +22,16 @@
Name
- Provides a title for the source type.", The name of the vocabulary;
+ Provides a title for the source type.", The name of the vocabulary; this
can be used as the value for the "vocabulary" argument to the
- and VocabularyMultiField constructors to cause this vocabulary to be
-
+ VocabularyField and VocabularyMultiField constructors to cause this
+ vocabulary to be used.
factory -- GlobalObject (required)
Factory
Factory that returns an instance of the named vocabulary when called
- the context object as the only argument. This should be a dotted-name
- refers to a Python object.
+ with the context object as the only argument. This should be a
+ dotted-name that refers to a Python object.
More information about the Zope3-Checkins
mailing list