[Zope3-checkins] SVN: Zope3/branches/ZopeX3-3.0/doc/zcml/ Convert
some text files to ReST.
Fred L. Drake, Jr.
fred at zope.com
Tue Jul 6 15:40:37 EDT 2004
Log message for revision 26132:
Convert some text files to ReST.
-=-
Deleted: Zope3/branches/ZopeX3-3.0/doc/zcml/attribute_conventions.stx
===================================================================
--- Zope3/branches/ZopeX3-3.0/doc/zcml/attribute_conventions.stx 2004-07-06 19:17:27 UTC (rev 26131)
+++ Zope3/branches/ZopeX3-3.0/doc/zcml/attribute_conventions.stx 2004-07-06 19:40:37 UTC (rev 26132)
@@ -1,45 +0,0 @@
-Terms used
-
- Dotted name
-
- XXX: explain resolution of ".Foo.Bar." and ".Foo.Bar+"
-
-
-The attributes used in zcml usually follow this convention
-
- component
-
- A dotted name that resolves to an object
-
- class
-
- A dotted name that resolves to a class
-
- permission
-
- The id of a permission
-
- principal
-
- The id of a principal
-
- role
-
- The id of a role
-
- factory
-
- A dotted name that resolves to a callable that acts as a factory.
- The argument list passed to the callable will depend on the
- type of object whose creation is controlled by the particular
- directive.
-
- Some directives support the specification of a 'composite
- factory'. This consists of several callables chained together
- to build the actual factory, and is specified by listing the
- names of two or more callables separated by one or more blanks.
- The first callable listed must accept the normal calling sequence
- for the type of object being constructed. The remaining callables
- must be Adapters. In other words, if the value of the factory
- attribute is '"a b c"', then the composite factory is built by
- doing 'c(b(a(<factory-argument-list>)))'.
Copied: Zope3/branches/ZopeX3-3.0/doc/zcml/attribute_conventions.txt (from rev 26131, Zope3/branches/ZopeX3-3.0/doc/zcml/attribute_conventions.stx)
===================================================================
--- Zope3/branches/ZopeX3-3.0/doc/zcml/attribute_conventions.stx 2004-07-06 19:17:27 UTC (rev 26131)
+++ Zope3/branches/ZopeX3-3.0/doc/zcml/attribute_conventions.txt 2004-07-06 19:40:37 UTC (rev 26132)
@@ -0,0 +1,49 @@
+=====================
+Attribute Conventions
+=====================
+
+The attributes used in zcml usually follow the conventions described
+here.
+
+
+Terms used in this document
+---------------------------
+
+Dotted name
+ XXX: explain resolution of ".Foo.Bar." and ".Foo.Bar+"
+
+
+Specific Conventions
+--------------------
+
+The following attribute names are used when applicable to an element.
+
+component
+ A dotted name that resolves to an object.
+
+class
+ A dotted name that resolves to a class.
+
+permission
+ The id of a permission.
+
+principal
+ The id of a principal.
+
+role
+ The id of a role.
+
+factory
+ A dotted name that resolves to a callable that acts as a factory.
+ The argument list passed to the callable will depend on the type of
+ object whose creation is controlled by the particular directive.
+
+ Some directives support the specification of a *composite factory*.
+ This consists of several callables chained together to build the
+ actual factory, and is specified by listing the names of two or more
+ callables separated by one or more blanks. The first callable
+ listed must accept the normal calling sequence for the type of
+ object being constructed. The remaining callables must be Adapters.
+ In other words, if the value of the factory attribute is ``"a b c"``,
+ then the composite factory is built by doing
+ ``c(b(a(<factory-argument-list>)))``.
Deleted: Zope3/branches/ZopeX3-3.0/doc/zcml/meta.stx
===================================================================
--- Zope3/branches/ZopeX3-3.0/doc/zcml/meta.stx 2004-07-06 19:17:27 UTC (rev 26131)
+++ Zope3/branches/ZopeX3-3.0/doc/zcml/meta.stx 2004-07-06 19:40:37 UTC (rev 26132)
@@ -1,12 +0,0 @@
-The Meta Configuration System
-
- Meta configuration is the configuration of the configuration
- system. In the case of zcml, this means using the "metaconfiguration"
- zcml configuration directives to define the configuration directives
- that will actually be used to configure the system.
-
- An overview of the meta-configuration system can be found in
- src/zope/configuration/README.txt.
-
- Instructions for creating simple configuration directives can be
- found in src/zope/configuration/tests/test_simple.py.
Copied: Zope3/branches/ZopeX3-3.0/doc/zcml/meta.txt (from rev 26131, Zope3/branches/ZopeX3-3.0/doc/zcml/meta.stx)
===================================================================
--- Zope3/branches/ZopeX3-3.0/doc/zcml/meta.stx 2004-07-06 19:17:27 UTC (rev 26131)
+++ Zope3/branches/ZopeX3-3.0/doc/zcml/meta.txt 2004-07-06 19:40:37 UTC (rev 26132)
@@ -0,0 +1,13 @@
+The Meta Configuration System
+-----------------------------
+
+Meta configuration is the configuration of the configuration system.
+In the case of zcml, this means using the "metaconfiguration" zcml
+configuration directives to define the configuration directives that
+will actually be used to configure the system.
+
+An overview of the meta-configuration system can be found in
+src/zope/configuration/README.txt.
+
+Instructions for creating simple configuration directives can be found
+in src/zope/configuration/tests/test_simple.py.
Modified: Zope3/branches/ZopeX3-3.0/doc/zcml/zcmlrng.txt
===================================================================
--- Zope3/branches/ZopeX3-3.0/doc/zcml/zcmlrng.txt 2004-07-06 19:17:27 UTC (rev 26131)
+++ Zope3/branches/ZopeX3-3.0/doc/zcml/zcmlrng.txt 2004-07-06 19:40:37 UTC (rev 26132)
@@ -1,3 +1,9 @@
+================
+ZCML in Relax NG
+================
+
+:author: Martijn Faassen
+
zcml.rng is a Relax NG schema that can validate (at the time of
writing) all the .zcml files in the Zope 3 core source tree. The only
exception to this is in zope/app/configure. There are tests there
@@ -13,10 +19,10 @@
different namespaces into separate files.
You should be able to validate a ZCML file against the schema by using
-any Relax NG processor. I've used libxml2's implementation through
-xmlllint, using the following command:
+any Relax NG processor. I've used libxml2's implementation through
+xmlllint, using the following command::
-xmllint --noout --relaxng zcml.rng somefile.zcml
+ xmllint --noout --relaxng zcml.rng somefile.zcml
At the time of writing the most recent release of libxml (2.5.10)
contains a bug which causes a segfault under certain circumstances. A
More information about the Zope3-Checkins
mailing list