[Zope3-checkins] CVS: Zope3/doc/zcml/namespaces.zope.org/browser -
addMenuItem.stx:1.2 addform.stx:1.4 addview.stx:1.4
addwizard.stx:1.2 containerViews.stx:1.2 defaultView.stx:1.5
editform.stx:1.4 editwizard.stx:1.2 i18n-resource.stx:1.3
icon.stx:1.3 menu.stx:1.3 menuItem.stx:1.3 menuItems.stx:1.4
page.stx:1.5 pages.stx:1.3 resource.stx:1.5
resourceDirectory.stx:1.2 schemadisplay.stx:1.2 skin.stx:1.5
subeditform.stx:1.3 view.stx:1.9
Stephan Richter
srichter at cosmos.phy.tufts.edu
Fri Jan 23 12:00:58 EST 2004
Update of /cvs-repository/Zope3/doc/zcml/namespaces.zope.org/browser
In directory cvs.zope.org:/tmp/cvs-serv24998/doc/zcml/namespaces.zope.org/browser
Modified Files:
addMenuItem.stx addform.stx addview.stx addwizard.stx
containerViews.stx defaultView.stx editform.stx editwizard.stx
i18n-resource.stx icon.stx menu.stx menuItem.stx menuItems.stx
page.stx pages.stx resource.stx resourceDirectory.stx
schemadisplay.stx skin.stx subeditform.stx view.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/browser/addMenuItem.stx 1.1 => 1.2 ===
--- Zope3/doc/zcml/namespaces.zope.org/browser/addMenuItem.stx:1.1 Thu Jan 22 18:57:06 2004
+++ Zope3/doc/zcml/namespaces.zope.org/browser/addMenuItem.stx Fri Jan 23 12:00:26 2004
@@ -41,7 +41,7 @@
A condition for displaying the menu item
The condition is given as a TALES expression. The expression has access
- the variables:
+ to the variables:
context -- The object the menu is being displayed for
@@ -50,7 +50,7 @@
nothing -- None
The menu item will not be displayed if there is a filter and the filter
- to a false value.
+ evaluates to a false value.
view -- TextLine (optional, default=None)
=== Zope3/doc/zcml/namespaces.zope.org/browser/addform.stx 1.3 => 1.4 ===
--- Zope3/doc/zcml/namespaces.zope.org/browser/addform.stx:1.3 Thu Jan 22 18:57:06 2004
+++ Zope3/doc/zcml/namespaces.zope.org/browser/addform.stx Fri Jan 23 12:00:26 2004
@@ -5,11 +5,12 @@
Define an automatically generated add form
The addform directive creates and registers a view for adding an object
- on a schema.
+ based on a schema.
Adding an object is a bit trickier than editing an object, because the
- the schema applies to isn't available when forms are being rendered. The
- directive provides an customization interface to overcome this difficulty.
+ object the schema applies to isn't available when forms are being rendered.
+ The addform directive provides an customization interface to overcome this
+ difficulty.
See zope.app.interfaces.browser.form.IAddFormCustomization.
@@ -20,10 +21,10 @@
The template usage top-level variable
See the usage documentation in the README.txt in the
- directory. If this view is associated with a menu item, this attribute
- not be supplied as the view will get its usage from the menu the menu
- is registered to. This attribute is available for views not associated
- a menu item.
+ zope/app/browser/skins directory. If this view is associated with a menu
+ item, this attribute should not be supplied as the view will get its
+ usage from the menu the menu item is registered to. This attribute is
+ available for views not associated with a menu item.
name -- TextLine (required)
@@ -44,9 +45,9 @@
The interface this page (view) applies to.
The view will be for all objects that implement this interface. The
- is used if the for attribute is not specified.
+ schema is used if the for attribute is not specified.
- If the for attribute is specified, then the objects views must
+ If the for attribute is specified, then the objects views must implement
or be adaptable to the schema.
permission -- Id (required)
@@ -72,10 +73,10 @@
Class
A class to provide custom widget definitions or methods to be used by a
- template.
+ custom template.
This class is used as a mix-in class. As a result, it needn't subclass
- special classes, such as BrowserView.
+ any special classes, such as BrowserView.
label -- MessageID (optional, default=None)
@@ -88,8 +89,8 @@
The browser menu to include the form in.
Many views are included in menus. It's convenient to name the menu in
- page directive, rather than having to give a separate menuItem
-
+ the page directive, rather than having to give a separate menuItem
+ directive.
title -- MessageID (optional, default=None)
@@ -102,8 +103,8 @@
Fields
The fields and the order in which to display them. If this is not
- all schema fields will be displayed in the order specified in the
- itself.
+ specified, all schema fields will be displayed in the order specified in
+ the schema itself.
content_factory -- GlobalObject (optional, default=None)
@@ -112,7 +113,7 @@
An object to call to create new content objects.
This attribute isn't used if a class is specified that implements
-
+ createAndAdd.
arguments -- Tokens (optional, default=None)
@@ -130,7 +131,7 @@
Set before add
- A list of fields to be assigned to the newly created object before it
+ A list of fields to be assigned to the newly created object before it is
added.
set_after_add -- Tokens (optional, default=None)
@@ -138,12 +139,12 @@
Set after add
A list of fields to be assigned to the newly created object after it is
-
+ added.
description -- Text (optional, default=None)
A longer description of the add form.
- A UI may display this with the item or display it when the user
+ A UI may display this with the item or display it when the user requests
more assistance.
=== Zope3/doc/zcml/namespaces.zope.org/browser/addview.stx 1.3 => 1.4 ===
--- Zope3/doc/zcml/namespaces.zope.org/browser/addview.stx:1.3 Thu Jan 22 18:57:06 2004
+++ Zope3/doc/zcml/namespaces.zope.org/browser/addview.stx Fri Jan 23 12:00:26 2004
@@ -5,7 +5,7 @@
The view directive defines a view that has subpages.
The pages provided by the defined view are accessed by first traversing to
- view name and then traversing to the page name.
+ the view name and then traversing to the page name.
Attributes
@@ -14,8 +14,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)
@@ -33,17 +33,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.
@@ -52,18 +52,18 @@
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.
usage -- TextLine (optional, default=u'')
The template usage top-level variable
See the usage documentation in the README.txt in the
- directory. If this view is associated with a menu item, this attribute
- not be supplied as the view will get its usage from the menu the menu
- is registered to. This attribute is available for views not associated
- a menu item.
+ zope/app/browser/skins directory. If this view is associated with a menu
+ item, this attribute should not be supplied as the view will get its
+ usage from the menu the menu item is registered to. This attribute is
+ available for views not associated with a menu item.
name -- TextLine (optional, default=u'')
@@ -76,8 +76,8 @@
The browser menu to include the page (view) in.
Many views are included in menus. It's convenient to name the menu in
- page directive, rather than having to give a separate menuItem
- </description>
+ the page directive, rather than having to give a separate menuItem
+ directive. </description>
title -- MessageID (optional, default=None)
@@ -85,12 +85,12 @@
This attribute must be supplied if a menu attribute is supplied.
- provides -- GlobalObject (optional, default=<InterfaceClass zope.interface.Interface at 4031b1ec>)
+ provides -- GlobalObject (optional, default=<InterfaceClass zope.interface.Interface at 4031b20c>)
The interface this view provides.
A view can provide an interface. This would be used for views that
- other views.
+ support other views.
Subdirectives
@@ -108,21 +108,21 @@
The name of a sub page of a view.
The name attribute is always required for the 'page' directive. It
- common to use an extension for the name, such as '.html'.
+ is common to use an extension for the name, such as '.html'.
attribute -- PythonIdentifier (optional, default=None)
The name of the view attribute implementing the page.
This refers to the attribute (method) on the view that is
- a specific sub page.
+ implementing a specific sub page.
template -- Path (optional, default=None)
The name of a template that implements the page.
Refers to a file containing a page template (must end in extension
-
+ '.pt').
@@ -139,6 +139,6 @@
The name of the page that is the default.
The named page will be used as the default if no name is specified
- in the path. If no defaultPage directive is supplied, the default
- will be the first page listed.
+ explicitly in the path. If no defaultPage directive is supplied, the
+ default page will be the first page listed.
=== Zope3/doc/zcml/namespaces.zope.org/browser/addwizard.stx 1.1 => 1.2 ===
--- Zope3/doc/zcml/namespaces.zope.org/browser/addwizard.stx:1.1 Thu Jan 22 18:57:06 2004
+++ Zope3/doc/zcml/namespaces.zope.org/browser/addwizard.stx Fri Jan 23 12:00:26 2004
@@ -5,11 +5,12 @@
Define an automatically generated add wizard (multi-page form)
The addwizard directive creates and registers a view for adding an object
- on a schema.
+ based on a schema.
Adding an object is a bit trickier than editing an object, because the
- the schema applies to isn't available when forms are being rendered. The
- directive provides an customization interface to overcome this difficulty.
+ object the schema applies to isn't available when forms are being rendered.
+ The addwizard directive provides an customization interface to overcome this
+ difficulty.
See zope.app.interfaces.browser.form.IAddFormCustomization.
@@ -20,10 +21,10 @@
The template usage top-level variable
See the usage documentation in the README.txt in the
- directory. If this view is associated with a menu item, this attribute
- not be supplied as the view will get its usage from the menu the menu
- is registered to. This attribute is available for views not associated
- a menu item.
+ zope/app/browser/skins directory. If this view is associated with a menu
+ item, this attribute should not be supplied as the view will get its
+ usage from the menu the menu item is registered to. This attribute is
+ available for views not associated with a menu item.
name -- TextLine (required)
@@ -44,9 +45,9 @@
The interface this page (view) applies to.
The view will be for all objects that implement this interface. The
- is used if the for attribute is not specified.
+ schema is used if the for attribute is not specified.
- If the for attribute is specified, then the objects views must
+ If the for attribute is specified, then the objects views must implement
or be adaptable to the schema.
permission -- Id (required)
@@ -72,18 +73,18 @@
Class
A class to provide custom widget definitions or methods to be used by a
- template.
+ custom template.
This class is used as a mix-in class. As a result, it needn't subclass
- special classes, such as BrowserView.
+ any special classes, such as BrowserView.
menu -- TextLine (optional, default=None)
The browser menu to include the form in.
Many views are included in menus. It's convenient to name the menu in
- page directive, rather than having to give a separate menuItem
-
+ the page directive, rather than having to give a separate menuItem
+ directive.
title -- MessageID (optional, default=None)
@@ -95,7 +96,7 @@
A longer description of the add form.
- A UI may display this with the item or display it when the user
+ A UI may display this with the item or display it when the user requests
more assistance.
use_session -- Bool (optional, default=None)
@@ -103,7 +104,8 @@
Use session
If 'no', hidden input controls are used to maintain state between panes
- the wizard. Only simple data types can be propagated with this method.
+ in the wizard. Only simple data types can be propagated with this
+ method.
Defaults to 'yes'.
@@ -114,7 +116,7 @@
An object to call to create new content objects.
This attribute isn't used if a class is specified that implements
-
+ createAndAdd.
arguments -- Tokens (optional, default=None)
@@ -132,7 +134,7 @@
Set before add
- A list of fields to be assigned to the newly created object before it
+ A list of fields to be assigned to the newly created object before it is
added.
set_after_add -- Tokens (optional, default=None)
@@ -140,7 +142,7 @@
Set after add
A list of fields to be assigned to the newly created object after it is
-
+ added.
Subdirectives
=== Zope3/doc/zcml/namespaces.zope.org/browser/containerViews.stx 1.1 => 1.2 ===
--- Zope3/doc/zcml/namespaces.zope.org/browser/containerViews.stx:1.1 Thu Jan 22 18:57:06 2004
+++ Zope3/doc/zcml/namespaces.zope.org/browser/containerViews.stx Fri Jan 23 12:00:26 2004
@@ -11,7 +11,7 @@
The interface this containerViews are for.
The containerViews will be for all objects that implement this
-
+ interface.
contents -- Id (optional, default=None)
=== Zope3/doc/zcml/namespaces.zope.org/browser/defaultView.stx 1.4 => 1.5 ===
--- Zope3/doc/zcml/namespaces.zope.org/browser/defaultView.stx:1.4 Thu Jan 22 18:57:06 2004
+++ Zope3/doc/zcml/namespaces.zope.org/browser/defaultView.stx Fri Jan 23 12:00:26 2004
@@ -4,7 +4,7 @@
The name of the view that should be the default.
- This name refers to view that should be the view used by default (if no
+ This name refers to view that should be the view used by default (if no view
name is supplied explicitly).
Attributes
@@ -14,12 +14,12 @@
The name of the view that should be the default.
This name refers to view that should be the view used by default (if no
- name is supplied explicitly).
+ view name is supplied explicitly).
for -- GlobalObject (optional, default=None)
The interface this view is the default for.
The view is the default view for the supplied interface. If this is not
- the view applies to all objects (XXX this ought to change).
+ supplied, the view applies to all objects (XXX this ought to change).
=== Zope3/doc/zcml/namespaces.zope.org/browser/editform.stx 1.3 => 1.4 ===
--- Zope3/doc/zcml/namespaces.zope.org/browser/editform.stx:1.3 Thu Jan 22 18:57:06 2004
+++ Zope3/doc/zcml/namespaces.zope.org/browser/editform.stx Fri Jan 23 12:00:26 2004
@@ -5,7 +5,7 @@
Define an automatically generated edit form
The editform directive creates and register's a view for editing an object
- on a schema.
+ based on a schema.
Attributes
@@ -14,10 +14,10 @@
The template usage top-level variable
See the usage documentation in the README.txt in the
- directory. If this view is associated with a menu item, this attribute
- not be supplied as the view will get its usage from the menu the menu
- is registered to. This attribute is available for views not associated
- a menu item.
+ zope/app/browser/skins directory. If this view is associated with a menu
+ item, this attribute should not be supplied as the view will get its
+ usage from the menu the menu item is registered to. This attribute is
+ available for views not associated with a menu item.
name -- TextLine (required)
@@ -38,9 +38,9 @@
The interface this page (view) applies to.
The view will be for all objects that implement this interface. The
- is used if the for attribute is not specified.
+ schema is used if the for attribute is not specified.
- If the for attribute is specified, then the objects views must
+ If the for attribute is specified, then the objects views must implement
or be adaptable to the schema.
permission -- Id (required)
@@ -66,10 +66,10 @@
Class
A class to provide custom widget definitions or methods to be used by a
- template.
+ custom template.
This class is used as a mix-in class. As a result, it needn't subclass
- special classes, such as BrowserView.
+ any special classes, such as BrowserView.
label -- MessageID (optional, default=None)
@@ -82,8 +82,8 @@
The browser menu to include the form in.
Many views are included in menus. It's convenient to name the menu in
- page directive, rather than having to give a separate menuItem
-
+ the page directive, rather than having to give a separate menuItem
+ directive.
title -- MessageID (optional, default=None)
@@ -96,6 +96,6 @@
Fields
The fields and the order in which to display them. If this is not
- all schema fields will be displayed in the order specified in the
- itself.
+ specified, all schema fields will be displayed in the order specified in
+ the schema itself.
=== Zope3/doc/zcml/namespaces.zope.org/browser/editwizard.stx 1.1 => 1.2 ===
--- Zope3/doc/zcml/namespaces.zope.org/browser/editwizard.stx:1.1 Thu Jan 22 18:57:06 2004
+++ Zope3/doc/zcml/namespaces.zope.org/browser/editwizard.stx Fri Jan 23 12:00:26 2004
@@ -4,7 +4,7 @@
Define an automatically generated edit wizard (multi-page form).
- The editwizard directive creates and register's a view for editing an
+ The editwizard directive creates and register's a view for editing an object
based on a schema.
Attributes
@@ -14,10 +14,10 @@
The template usage top-level variable
See the usage documentation in the README.txt in the
- directory. If this view is associated with a menu item, this attribute
- not be supplied as the view will get its usage from the menu the menu
- is registered to. This attribute is available for views not associated
- a menu item.
+ zope/app/browser/skins directory. If this view is associated with a menu
+ item, this attribute should not be supplied as the view will get its
+ usage from the menu the menu item is registered to. This attribute is
+ available for views not associated with a menu item.
name -- TextLine (required)
@@ -38,9 +38,9 @@
The interface this page (view) applies to.
The view will be for all objects that implement this interface. The
- is used if the for attribute is not specified.
+ schema is used if the for attribute is not specified.
- If the for attribute is specified, then the objects views must
+ If the for attribute is specified, then the objects views must implement
or be adaptable to the schema.
permission -- Id (required)
@@ -66,24 +66,24 @@
Class
A class to provide custom widget definitions or methods to be used by a
- template.
+ custom template.
This class is used as a mix-in class. As a result, it needn't subclass
- special classes, such as BrowserView.
+ any special classes, such as BrowserView.
menu -- TextLine (optional, default=None)
The browser menu to include the form in.
Many views are included in menus. It's convenient to name the menu in
- page directive, rather than having to give a separate menuItem
-
+ the page directive, rather than having to give a separate menuItem
+ directive.
description -- MessageID (optional, default=None)
A longer description of the add form.
- A UI may display this with the item or display it when the user
+ A UI may display this with the item or display it when the user requests
more assistance.
use_session -- Bool (optional, default=None)
@@ -91,7 +91,8 @@
Use session
If 'no', hidden input controls are used to maintain state between panes
- the wizard. Only simple data types can be propagated with this method.
+ in the wizard. Only simple data types can be propagated with this
+ method.
Defaults to 'yes'.
=== Zope3/doc/zcml/namespaces.zope.org/browser/i18n-resource.stx 1.2 => 1.3 ===
--- Zope3/doc/zcml/namespaces.zope.org/browser/i18n-resource.stx:1.2 Thu Jan 22 18:57:06 2004
+++ Zope3/doc/zcml/namespaces.zope.org/browser/i18n-resource.stx Fri Jan 23 12:00:26 2004
@@ -10,25 +10,25 @@
The layer the resource should be found in
- For information on layers, see the documentation for the skin
+ For information on layers, see the documentation for the skin directive.
Defaults to "default".
permission -- Id (optional, default=None)
The permission needed to access the resource.
- If a permission isn't specified, the resource will always be
-
+ If a permission isn't specified, the resource will always be accessible.
name -- TextLine (required)
The name of the resource
This is the name used in resource urls. Resource urls are of the form
- where site is the url of "site", a folder with a service manager.
+ site/@@/resourcename, where site is the url of "site", a folder with a
+ service manager.
We make resource urls site-relative (as opposed to content-relative) so
- not to defeat caches.
+ as not to defeat caches.
defaultLanguage -- TextLine (optional, default=None)
@@ -52,14 +52,14 @@
The layer the resource should be found in
For information on layers, see the documentation for the skin
- Defaults to "default".
+ directive. Defaults to "default".
permission -- Id (optional, default=None)
The permission needed to access the resource.
If a permission isn't specified, the resource will always be
-
+ accessible.
language -- TextLine (required)
@@ -78,5 +78,5 @@
Image
If the image attribute is used, then an image resource, rather than
- file resource will be created.
+ a file resource will be created.
=== Zope3/doc/zcml/namespaces.zope.org/browser/icon.stx 1.2 => 1.3 ===
--- Zope3/doc/zcml/namespaces.zope.org/browser/icon.stx:1.2 Thu Jan 22 18:57:06 2004
+++ Zope3/doc/zcml/namespaces.zope.org/browser/icon.stx Fri Jan 23 12:00:26 2004
@@ -40,6 +40,6 @@
The layer the icon should be found in
- For information on layers, see the documentation for the skin
+ For information on layers, see the documentation for the skin directive.
Defaults to "default".
=== Zope3/doc/zcml/namespaces.zope.org/browser/menu.stx 1.2 => 1.3 ===
--- Zope3/doc/zcml/namespaces.zope.org/browser/menu.stx:1.2 Thu Jan 22 18:57:06 2004
+++ Zope3/doc/zcml/namespaces.zope.org/browser/menu.stx Fri Jan 23 12:00:26 2004
@@ -11,10 +11,10 @@
The template usage top-level variable
See the usage documentation in the README.txt in the
- directory. If this view is associated with a menu item, this attribute
- not be supplied as the view will get its usage from the menu the menu
- is registered to. This attribute is available for views not associated
- a menu item.
+ zope/app/browser/skins directory. If this view is associated with a menu
+ item, this attribute should not be supplied as the view will get its
+ usage from the menu the menu item is registered to. This attribute is
+ available for views not associated with a menu item.
id -- TextLine (required)
=== Zope3/doc/zcml/namespaces.zope.org/browser/menuItem.stx 1.2 => 1.3 ===
--- Zope3/doc/zcml/namespaces.zope.org/browser/menuItem.stx:1.2 Thu Jan 22 18:57:06 2004
+++ Zope3/doc/zcml/namespaces.zope.org/browser/menuItem.stx Fri Jan 23 12:00:26 2004
@@ -34,7 +34,7 @@
A longer explanation of the menu item
- A UI may display this with the item or display it when the user
+ A UI may display this with the item or display it when the user requests
more assistance.
permission -- Id (optional, default=None)
@@ -42,16 +42,17 @@
The permission needed access the item
This can usually be inferred by the system, however, doing so may be
- When displaying a menu, the system tries to traverse to the URLs given
- each action to determine whether the url is accessible to the current
- This can be avoided if the permission is given explicitly.
+ expensive. When displaying a menu, the system tries to traverse to the
+ URLs given in each action to determine whether the url is accessible to
+ the current user. This can be avoided if the permission is given
+ explicitly.
filter -- TextLine (optional, default=None)
A condition for displaying the menu item
The condition is given as a TALES expression. The expression has access
- the variables:
+ to the variables:
context -- The object the menu is being displayed for
@@ -60,5 +61,5 @@
nothing -- None
The menu item will not be displayed if there is a filter and the filter
- to a false value.
+ evaluates to a false value.
=== Zope3/doc/zcml/namespaces.zope.org/browser/menuItems.stx 1.3 => 1.4 ===
--- Zope3/doc/zcml/namespaces.zope.org/browser/menuItems.stx:1.3 Thu Jan 22 18:57:06 2004
+++ Zope3/doc/zcml/namespaces.zope.org/browser/menuItems.stx Fri Jan 23 12:00:26 2004
@@ -5,7 +5,7 @@
Define a group of browser menu items
This directive is useful when many menu items are defined for the same
- and menu.
+ interface and menu.
Attributes
@@ -49,24 +49,24 @@
A longer explanation of the menu item
A UI may display this with the item or display it when the user
- more assistance.
+ requests more assistance.
permission -- Id (optional, default=None)
The permission needed access the item
- This can usually be inferred by the system, however, doing so may
+ This can usually be inferred by the system, however, doing so may be
expensive. When displaying a menu, the system tries to traverse to
- URLs given in each action to determine whether the url is
- to the current user. This can be avoided if the permission is given
-
+ the URLs given in each action to determine whether the url is
+ accessible to the current user. This can be avoided if the
+ permission is given explicitly.
filter -- TextLine (optional, default=None)
A condition for displaying the menu item
The condition is given as a TALES expression. The expression has
- to the variables:
+ access to the variables:
context -- The object the menu is being displayed for
@@ -75,5 +75,5 @@
nothing -- None
The menu item will not be displayed if there is a filter and the
- evaluates to a false value.
+ filter evaluates to a false value.
=== Zope3/doc/zcml/namespaces.zope.org/browser/page.stx 1.4 => 1.5 ===
--- Zope3/doc/zcml/namespaces.zope.org/browser/page.stx:1.4 Thu Jan 22 18:57:06 2004
+++ Zope3/doc/zcml/namespaces.zope.org/browser/page.stx Fri Jan 23 12:00:26 2004
@@ -3,10 +3,10 @@
File zope/app/publisher/browser/meta.zcml, lines 54 - 58.
The page directive is used to create views that provide a single url or
-
+ page.
The page directive creates a new view class from a given template and/or
- and registers it.
+ class and registers it.
Attributes
@@ -15,8 +15,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)
@@ -34,17 +34,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.
@@ -53,53 +53,53 @@
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.
usage -- TextLine (optional, default=u'')
The template usage top-level variable
See the usage documentation in the README.txt in the
- directory. If this view is associated with a menu item, this attribute
- not be supplied as the view will get its usage from the menu the menu
- is registered to. This attribute is available for views not associated
- a menu item.
+ zope/app/browser/skins directory. If this view is associated with a menu
+ item, this attribute should not be supplied as the view will get its
+ usage from the menu the menu item is registered to. This attribute is
+ available for views not associated with a menu item.
name -- TextLine (required)
The name of the page (view)
The name shows up in URLs/paths. For example 'foo' or 'foo.html'. This
- is required unless you use the subdirective 'page' to create sub views.
- you do not have sub pages, it is common to use an extension for the
- name such as '.html'. If you do have sub pages and you want to provide
- view name, you shouldn't use extensions.
+ attribute is required unless you use the subdirective 'page' to create
+ sub views. If you do not have sub pages, it is common to use an
+ extension for the view name such as '.html'. If you do have sub pages
+ and you want to provide a view name, you shouldn't use extensions.
template -- TextLine (optional, default=None)
The name of a page template.
Refers to a file containing a page template (must end in extension
-
+ '.pt').
attribute -- PythonIdentifier (optional, default=None)
The name of an attribute to publish.
This is used to publish an attribute provided by a class, instead of a
-
+ template.
This is the attribute, usually a method, to be published as the page
- The default is "__call__".
+ (view). The default is "__call__".
menu -- TextLine (optional, default=None)
The browser menu to include the page (view) in.
Many views are included in menus. It's convenient to name the menu in
- page directive, rather than having to give a separate menuItem
-
+ the page directive, rather than having to give a separate menuItem
+ directive.
title -- MessageID (optional, default=None)
=== Zope3/doc/zcml/namespaces.zope.org/browser/pages.stx 1.2 => 1.3 ===
--- Zope3/doc/zcml/namespaces.zope.org/browser/pages.stx:1.2 Thu Jan 22 18:57:06 2004
+++ Zope3/doc/zcml/namespaces.zope.org/browser/pages.stx Fri Jan 23 12:00:26 2004
@@ -5,8 +5,8 @@
Define multiple pages without repeating all of the parameters.
The pages directive allows multiple page views to be defined without
- the 'for', 'permission', 'class', 'layer', 'allowed_attributes', and
- attributes.
+ repeating the 'for', 'permission', 'class', 'layer', 'allowed_attributes',
+ and 'allowed_interface' attributes.
Attributes
@@ -15,8 +15,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)
@@ -34,17 +34,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.
@@ -53,18 +53,18 @@
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.
usage -- TextLine (optional, default=u'')
The template usage top-level variable
See the usage documentation in the README.txt in the
- directory. If this view is associated with a menu item, this attribute
- not be supplied as the view will get its usage from the menu the menu
- is registered to. This attribute is available for views not associated
- a menu item.
+ zope/app/browser/skins directory. If this view is associated with a menu
+ item, this attribute should not be supplied as the view will get its
+ usage from the menu the menu item is registered to. This attribute is
+ available for views not associated with a menu item.
Subdirectives
@@ -82,26 +82,27 @@
The name of the page (view)
The name shows up in URLs/paths. For example 'foo' or 'foo.html'.
- attribute is required unless you use the subdirective 'page' to
- sub views. If you do not have sub pages, it is common to use an
- for the view name such as '.html'. If you do have sub pages and you
- to provide a view name, you shouldn't use extensions.
+ This attribute is required unless you use the subdirective 'page' to
+ create sub views. If you do not have sub pages, it is common to use
+ an extension for the view name such as '.html'. If you do have sub
+ pages and you want to provide a view name, you shouldn't use
+ extensions.
template -- TextLine (optional, default=None)
The name of a page template.
Refers to a file containing a page template (must end in extension
-
+ '.pt').
attribute -- PythonIdentifier (optional, default=None)
The name of an attribute to publish.
- This is used to publish an attribute provided by a class, instead
+ This is used to publish an attribute provided by a class, instead of
a template.
- This is the attribute, usually a method, to be published as the
+ This is the attribute, usually a method, to be published as the page
(view). The default is "__call__".
menu -- TextLine (optional, default=None)
@@ -109,8 +110,8 @@
The browser menu to include the page (view) in.
Many views are included in menus. It's convenient to name the menu
- the page directive, rather than having to give a separate menuItem
-
+ in the page directive, rather than having to give a separate
+ menuItem directive.
title -- MessageID (optional, default=None)
=== Zope3/doc/zcml/namespaces.zope.org/browser/resource.stx 1.4 => 1.5 ===
--- Zope3/doc/zcml/namespaces.zope.org/browser/resource.stx:1.4 Thu Jan 22 18:57:06 2004
+++ Zope3/doc/zcml/namespaces.zope.org/browser/resource.stx Fri Jan 23 12:00:26 2004
@@ -10,25 +10,25 @@
The layer the resource should be found in
- For information on layers, see the documentation for the skin
+ For information on layers, see the documentation for the skin directive.
Defaults to "default".
permission -- Id (optional, default=None)
The permission needed to access the resource.
- If a permission isn't specified, the resource will always be
-
+ If a permission isn't specified, the resource will always be accessible.
name -- TextLine (required)
The name of the resource
This is the name used in resource urls. Resource urls are of the form
- where site is the url of "site", a folder with a service manager.
+ site/@@/resourcename, where site is the url of "site", a folder with a
+ service manager.
We make resource urls site-relative (as opposed to content-relative) so
- not to defeat caches.
+ as not to defeat caches.
file -- Path (optional, default=None)
@@ -41,12 +41,12 @@
Image
If the image attribute is used, then an image resource, rather than a
- resource will be created.
+ file resource will be created.
template -- Path (optional, default=None)
Template
If the image attribute is used, then a page template resource, rather
- a file resource will be created.
+ than a file resource will be created.
=== Zope3/doc/zcml/namespaces.zope.org/browser/resourceDirectory.stx 1.1 => 1.2 ===
--- Zope3/doc/zcml/namespaces.zope.org/browser/resourceDirectory.stx:1.1 Thu Jan 22 18:57:06 2004
+++ Zope3/doc/zcml/namespaces.zope.org/browser/resourceDirectory.stx Fri Jan 23 12:00:26 2004
@@ -10,25 +10,25 @@
The layer the resource should be found in
- For information on layers, see the documentation for the skin
+ For information on layers, see the documentation for the skin directive.
Defaults to "default".
permission -- Id (optional, default=None)
The permission needed to access the resource.
- If a permission isn't specified, the resource will always be
-
+ If a permission isn't specified, the resource will always be accessible.
name -- TextLine (required)
The name of the resource
This is the name used in resource urls. Resource urls are of the form
- where site is the url of "site", a folder with a service manager.
+ site/@@/resourcename, where site is the url of "site", a folder with a
+ service manager.
We make resource urls site-relative (as opposed to content-relative) so
- not to defeat caches.
+ as not to defeat caches.
directory -- Path (required)
=== Zope3/doc/zcml/namespaces.zope.org/browser/schemadisplay.stx 1.1 => 1.2 ===
--- Zope3/doc/zcml/namespaces.zope.org/browser/schemadisplay.stx:1.1 Thu Jan 22 18:57:06 2004
+++ Zope3/doc/zcml/namespaces.zope.org/browser/schemadisplay.stx Fri Jan 23 12:00:26 2004
@@ -5,7 +5,7 @@
Define an automatically generated display form.
The schemadisplay directive creates and register's a view for displaying an
- based on a schema.
+ object based on a schema.
Attributes
@@ -14,10 +14,10 @@
The template usage top-level variable
See the usage documentation in the README.txt in the
- directory. If this view is associated with a menu item, this attribute
- not be supplied as the view will get its usage from the menu the menu
- is registered to. This attribute is available for views not associated
- a menu item.
+ zope/app/browser/skins directory. If this view is associated with a menu
+ item, this attribute should not be supplied as the view will get its
+ usage from the menu the menu item is registered to. This attribute is
+ available for views not associated with a menu item.
name -- TextLine (required)
@@ -38,9 +38,9 @@
The interface this page (view) applies to.
The view will be for all objects that implement this interface. The
- is used if the for attribute is not specified.
+ schema is used if the for attribute is not specified.
- If the for attribute is specified, then the objects views must
+ If the for attribute is specified, then the objects views must implement
or be adaptable to the schema.
permission -- Id (required)
@@ -66,10 +66,10 @@
Class
A class to provide custom widget definitions or methods to be used by a
- template.
+ custom template.
This class is used as a mix-in class. As a result, it needn't subclass
- special classes, such as BrowserView.
+ any special classes, such as BrowserView.
label -- MessageID (optional, default=None)
@@ -82,16 +82,16 @@
The browser menu to include the form in.
Many views are included in menus. It's convenient to name the menu in
- page directive, rather than having to give a separate menuItem
-
+ the page directive, rather than having to give a separate menuItem
+ directive.
fields -- Tokens (optional, default=None)
Fields
The fields and the order in which to display them. If this is not
- all schema fields will be displayed in the order specified in the
- itself.
+ specified, all schema fields will be displayed in the order specified in
+ the schema itself.
title -- MessageID (optional, default=None)
=== Zope3/doc/zcml/namespaces.zope.org/browser/skin.stx 1.4 => 1.5 ===
--- Zope3/doc/zcml/namespaces.zope.org/browser/skin.stx:1.4 Thu Jan 22 18:57:06 2004
+++ Zope3/doc/zcml/namespaces.zope.org/browser/skin.stx Fri Jan 23 12:00:26 2004
@@ -17,6 +17,6 @@
A list of names of layers.
This should be in order of lookup. Usually one of the layers has the
- name as the skin, and the last skin should be 'default', unless you
- to completely override all views.
+ same name as the skin, and the last skin should be 'default', unless you
+ want to completely override all views.
=== Zope3/doc/zcml/namespaces.zope.org/browser/subeditform.stx 1.2 => 1.3 ===
--- Zope3/doc/zcml/namespaces.zope.org/browser/subeditform.stx:1.2 Thu Jan 22 18:57:06 2004
+++ Zope3/doc/zcml/namespaces.zope.org/browser/subeditform.stx Fri Jan 23 12:00:26 2004
@@ -11,10 +11,10 @@
The template usage top-level variable
See the usage documentation in the README.txt in the
- directory. If this view is associated with a menu item, this attribute
- not be supplied as the view will get its usage from the menu the menu
- is registered to. This attribute is available for views not associated
- a menu item.
+ zope/app/browser/skins directory. If this view is associated with a menu
+ item, this attribute should not be supplied as the view will get its
+ usage from the menu the menu item is registered to. This attribute is
+ available for views not associated with a menu item.
name -- TextLine (required)
@@ -35,9 +35,9 @@
The interface this page (view) applies to.
The view will be for all objects that implement this interface. The
- is used if the for attribute is not specified.
+ schema is used if the for attribute is not specified.
- If the for attribute is specified, then the objects views must
+ If the for attribute is specified, then the objects views must implement
or be adaptable to the schema.
permission -- Id (required)
@@ -63,10 +63,10 @@
Class
A class to provide custom widget definitions or methods to be used by a
- template.
+ custom template.
This class is used as a mix-in class. As a result, it needn't subclass
- special classes, such as BrowserView.
+ any special classes, such as BrowserView.
label -- TextLine (optional, default=None)
=== Zope3/doc/zcml/namespaces.zope.org/browser/view.stx 1.8 => 1.9 ===
--- Zope3/doc/zcml/namespaces.zope.org/browser/view.stx:1.8 Thu Jan 22 18:57:06 2004
+++ Zope3/doc/zcml/namespaces.zope.org/browser/view.stx Fri Jan 23 12:00:26 2004
@@ -5,7 +5,7 @@
The view directive defines a view that has subpages.
The pages provided by the defined view are accessed by first traversing to
- view name and then traversing to the page name.
+ the view name and then traversing to the page name.
Attributes
@@ -14,8 +14,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)
@@ -33,17 +33,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.
@@ -52,18 +52,18 @@
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.
usage -- TextLine (optional, default=u'')
The template usage top-level variable
See the usage documentation in the README.txt in the
- directory. If this view is associated with a menu item, this attribute
- not be supplied as the view will get its usage from the menu the menu
- is registered to. This attribute is available for views not associated
- a menu item.
+ zope/app/browser/skins directory. If this view is associated with a menu
+ item, this attribute should not be supplied as the view will get its
+ usage from the menu the menu item is registered to. This attribute is
+ available for views not associated with a menu item.
name -- TextLine (optional, default=u'')
@@ -76,8 +76,8 @@
The browser menu to include the page (view) in.
Many views are included in menus. It's convenient to name the menu in
- page directive, rather than having to give a separate menuItem
- </description>
+ the page directive, rather than having to give a separate menuItem
+ directive. </description>
title -- MessageID (optional, default=None)
@@ -85,12 +85,12 @@
This attribute must be supplied if a menu attribute is supplied.
- provides -- GlobalObject (optional, default=<InterfaceClass zope.interface.Interface at 4031b1ec>)
+ provides -- GlobalObject (optional, default=<InterfaceClass zope.interface.Interface at 4031b20c>)
The interface this view provides.
A view can provide an interface. This would be used for views that
- other views.
+ support other views.
Subdirectives
@@ -108,21 +108,21 @@
The name of a sub page of a view.
The name attribute is always required for the 'page' directive. It
- common to use an extension for the name, such as '.html'.
+ is common to use an extension for the name, such as '.html'.
attribute -- PythonIdentifier (optional, default=None)
The name of the view attribute implementing the page.
This refers to the attribute (method) on the view that is
- a specific sub page.
+ implementing a specific sub page.
template -- Path (optional, default=None)
The name of a template that implements the page.
Refers to a file containing a page template (must end in extension
-
+ '.pt').
@@ -139,6 +139,6 @@
The name of the page that is the default.
The named page will be used as the default if no name is specified
- in the path. If no defaultPage directive is supplied, the default
- will be the first page listed.
+ explicitly in the path. If no defaultPage directive is supplied, the
+ default page will be the first page listed.
More information about the Zope3-Checkins
mailing list