[Checkins] SVN: bluebream/website/docs/v1.0/reference/zcml.rst - Added i18n-resource

Baiju M baiju.m.mail at gmail.com
Wed Aug 11 13:12:12 EDT 2010


Log message for revision 115638:
  - Added i18n-resource
  - bit cleanup
  

Changed:
  U   bluebream/website/docs/v1.0/reference/zcml.rst

-=-
Modified: bluebream/website/docs/v1.0/reference/zcml.rst
===================================================================
--- bluebream/website/docs/v1.0/reference/zcml.rst	2010-08-11 17:03:04 UTC (rev 115637)
+++ bluebream/website/docs/v1.0/reference/zcml.rst	2010-08-11 17:12:12 UTC (rev 115638)
@@ -131,17 +131,9 @@
 
 **See Also**
 
-form/widget
------------
+Subdirective: widget
+~~~~~~~~~~~~~~~~~~~~
 
-:directive: ``form``
-:sub-directive: ``widget``
-:namespace: ``http://namespaces.zope.org/browser``
-:include: ``zope.app.form.browser``
-:distribution: ``zope.app.form``
-
-**Examples**
-
 editform
 --------
 
@@ -152,17 +144,9 @@
 
 **Examples**
 
-editform/widget
----------------
+Subdirective: widget
+~~~~~~~~~~~~~~~~~~~~
 
-:directive: ``editform``
-:sub-directive: ``widget``
-:namespace: ``http://namespaces.zope.org/browser``
-:include: ``zope.app.form.browser``
-:distribution: ``zope.app.form``
-
-**Examples**
-
 subeditform
 -----------
 
@@ -173,17 +157,9 @@
 
 **Examples**
 
-subeditform/widbrowserget
--------------------------
+Subdirective: widbrowserget
+~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
-:directive: ``subeditform``
-:sub-directive: ``widget``
-:namespace: ``http://namespaces.zope.org/browser``
-:include: ``zope.app.form.browser``
-:distribution: ``zope.app.form``
-
-**Examples**
-
 addform
 -------
 
@@ -194,18 +170,10 @@
 
 **Examples**
 
-addform/widget
---------------
+Subdirective: widget
+~~~~~~~~~~~~~~~~~~~~
 
-:directive: ``addform``
-:sub-directive: ``widget``
-:namespace: ``http://namespaces.zope.org/browser``
-:include: ``zope.app.form.browser``
-:distribution: ``zope.app.form``
 
-**Examples**
-
-
 schemadisplay
 -------------
 
@@ -216,17 +184,9 @@
 
 **Examples**
 
-schemadisplay/widget
---------------------
+Subdirective: widget
+~~~~~~~~~~~~~~~~~~~~
 
-:directive: ``schemadisplay``
-:sub-directive: ``widget``
-:namespace: ``http://namespaces.zope.org/browser``
-:include: ``zope.app.form.browser``
-:distribution: ``zope.app.form``
-
-**Examples**
-
 view
 ----
 
@@ -310,46 +270,18 @@
 
 **Examples**
 
-class/implements
-----------------
+Subdirective: implements
+~~~~~~~~~~~~~~~~~~~~~~~~
 
-:directive: ``class``
-:sub-directive: ``implements``
-:namespace: ``http://namespaces.zope.org/zope``
-:include: ``zope.security``
+Subdirective: require
+~~~~~~~~~~~~~~~~~~~~~
 
-**Examples**
+Subdirective: allow
+~~~~~~~~~~~~~~~~~~~
 
-class/require
--------------
+Subdirective: factory
+~~~~~~~~~~~~~~~~~~~~~
 
-:directive: ``class``
-:sub-directive: ``require``
-:namespace: ``http://namespaces.zope.org/zope``
-:include: ``zope.security``
-
-**Examples**
-
-class/allow
------------
-
-:directive: ``class``
-:sub-directive: ``allow``
-:namespace: ``http://namespaces.zope.org/zope``
-:include: ``zope.security``
-
-**Examples**
-
-class/factory
--------------
-
-:directive: ``class``
-:sub-directive: ``factory``
-:namespace: ``http://namespaces.zope.org/zope``
-:include: ``zope.security``
-
-**Examples**
-
 module
 ------
 
@@ -359,26 +291,12 @@
 
 **Examples**
 
-module/allow
-------------
+Subdirective: allow
+~~~~~~~~~~~~~~~~~~~
 
-:group-directive: ``module``
-:directive: ``allow``
-:namespace: ``http://namespaces.zope.org/zope``
-:include: ``zope.security``
+Subdirective: require
+~~~~~~~~~~~~~~~~~~~~~
 
-**Examples**
-
-module/require
---------------
-
-:group-directive: ``module``
-:directive: ``require``
-:namespace: ``http://namespaces.zope.org/zope``
-:include: ``zope.security``
-
-**Examples**
-
 register
 --------
 
@@ -397,16 +315,9 @@
 
 **Examples**
 
-resourceLibrary/directory
--------------------------
+Subdirective: directory
+~~~~~~~~~~~~~~~~~~~~~~~
 
-:directive: ``resourceLibrary``
-:sub-directive: ``directory``
-:namespace: ``http://namespaces.zope.org/zope``
-:include: ``zc.resourcelibrary``
-
-**Examples**
-
 menu
 ----
 
@@ -425,26 +336,12 @@
 
 **Examples**
 
-menuItems/menuItem
-------------------
+Subdirective: menuItem
+~~~~~~~~~~~~~~~~~~~~~~
 
-:directive: ``menuItems``
-:sub-directive: ``menuItem``
-:namespace: ``http://namespaces.zope.org/zope``
-:include: ``zope.browsermenu``
+Subdirective: subMenuItem
+~~~~~~~~~~~~~~~~~~~~~~~~~
 
-**Examples**
-
-menuItems/subMenuItem
----------------------
-
-:directive: ``menuItems``
-:sub-directive: ``subMenuItem``
-:namespace: ``http://namespaces.zope.org/zope``
-:include: ``zope.browsermenu``
-
-**Examples**
-
 menuItem
 --------
 
@@ -607,16 +504,9 @@
 
 **Examples**
 
-pages/page
-----------
+Subdirective: page
+~~~~~~~~~~~~~~~~~~
 
-:directive: ``pages``
-:sub-directive: ``page``
-:namespace: ``http://namespaces.zope.org/browser``
-:include: ``zope.browserpage``
-
-**Examples**
-
 view
 ----
 
@@ -626,16 +516,9 @@
 
 **Examples**
 
-view/page
----------
+Subdirective: page
+~~~~~~~~~~~~~~~~~~
 
-:directive: ``view``
-:sub-directive: ``page``
-:namespace: ``http://namespaces.zope.org/browser``
-:include: ``zope.browserpage``
-
-**Examples**
-
 defaultPage
 -----------
 
@@ -700,16 +583,9 @@
 
 **Examples**
 
-codec/charset
--------------
+Subdirective: charset
+~~~~~~~~~~~~~~~~~~~~~
 
-:directive: ``codec``
-:sub-directive: ``charset``
-:namespace: ``http://namespaces.zope.org/zope``
-:include: ``zope.mimetype``
-
-**Examples**
-
 mimeTypes
 ---------
 
@@ -1002,18 +878,65 @@
 :namespace: ``http://namespaces.zope.org/browser``
 :include: ``zope.browserresource``
 
-**Examples**
+**Attributes**
 
-i18n-resource/translation
--------------------------
+- ``name`` - This is the name used in resource urls. Resource urls are of
+  the form site/@@/resourcename, where site is the url of "site", a folder
+  with a site manager.
 
-:directive: ``i18n-resource``
-:sub-directive: ``translation``
-:namespace: ``http://namespaces.zope.org/browser``
-:include: ``zope.browserresource``
+  We make resource urls site-relative (as opposed to content-relative) so as
+  not to defeat caches.
 
-**Examples**
+- ``defaultLanguage`` - Defines the default language
 
+- ``layer`` - The layer the resource should be found in
+
+  For information on layers, see the documentation for the skin
+  directive.  Defaults to *default*.
+
+- ``permission`` - The permission needed to access the resource.
+
+  If a permission isn't specified, the resource will always be
+  accessible.
+
+Subdirective: translation
+~~~~~~~~~~~~~~~~~~~~~~~~~
+
+**Attributes**
+
+- ``language`` - TextLine (default = None)
+
+  Language
+
+  Language of this translation of the resource
+
+- ``file`` - Path (default = None)
+
+  File
+
+  The file containing the resource data.
+
+- ``image`` - Path (default = None)
+
+  Image
+
+  If the image attribute is used, then an image resource, rather than a file
+  resource will be created.
+
+- ``layer`` - LayerField (default = None)
+
+  The layer the resource should be found in
+
+  For information on layers, see the documentation for the skin
+  directive. Defaults to "default".
+
+- ``permission`` - Permission (default = None)
+
+  The permission needed to access the resource.
+
+  If a permission isn't specified, the resource will always be accessible.
+
+
 icon
 ----
 
@@ -1044,4 +967,3 @@
 This directive and ``zope.rdb`` is not actively used by the community.  If
 you want relational database connectivily, look at `z3c.sqlalchemy
 <http://pypi.python.org/pypi/z3c.sqlalchemy>`_.
-



More information about the checkins mailing list