[Zodb-checkins] CVS: ZODB3/ZConfig/doc - zconfig.tex:1.70.16.2
zconfig.pdf:1.7.26.2 schema.dtd:1.6.26.2
Jeremy Hylton
jeremy at zope.com
Mon Sep 15 14:15:31 EDT 2003
Update of /cvs-repository/ZODB3/ZConfig/doc
In directory cvs.zope.org:/tmp/cvs-serv16492/ZConfig/doc
Modified Files:
Tag: Zope-2_7-branch
zconfig.tex zconfig.pdf schema.dtd
Log Message:
Merge the last batch of changes from the ZODB3-3_2-branch.
=== ZODB3/ZConfig/doc/zconfig.tex 1.70.16.1 => 1.70.16.2 ===
--- ZODB3/ZConfig/doc/zconfig.tex:1.70.16.1 Mon Jul 21 12:36:55 2003
+++ ZODB3/ZConfig/doc/zconfig.tex Mon Sep 15 14:14:54 2003
@@ -402,18 +402,11 @@
Import a schema component.
Exactly one of the two possible attributes must be specified.
- \begin{attributedesc}{file}{file name without directory information}
- Name of the component file within a package; if not specified,
- \file{component.xml} is used. This may only be given when
- \attribute{package} is used.
- \end{attributedesc}
-
\begin{attributedesc}{package}{\datatype{dotted-name}}
Python-package style name that identifies a directory found on
\code{sys.path} containing a schema component in a file named
- \file{component.xml} (unless the file name is overridden using
- \attribute{file}). Dots in the value are converted to directory
- separators.
+ \file{component.xml}. Dots in the value are converted to
+ directory separators.
\end{attributedesc}
\begin{attributedesc}{src}{\datatype{url-reference}}
@@ -637,12 +630,22 @@
Components are identified using a dotted-name, similar to a Python
module name. For example, one component may be \code{zodb.storage}.
+%A schema component \dfn{extension} is allowed to define new abstract
+%and section types, extend types provided by the component it extends,
+%and include new section types in abstract types provided by the
+%component. The expected usage is that extensions will provide one or
+%more concrete types that implement abstract types defined by the
+%component.
+
Schema components are stored alongside application code since they
directly reference datatype code. Schema components are provided by
Python packages; packages which contain a file named
\file{component.xml} can be ``imported''. The \file{component.xml}
file defines the types provided by that component; it must have a
\element{component} element as the document element.
+%Extensions to a component are stored in immediate subdirectories; a
+%file \file{extension.xml} provides the extension types. Extensions
+%must have an \element{extension} element as the document element.
The following element is used as the document element for schema
components. Note that schema components do not allow keys and
@@ -660,6 +663,18 @@
attribute.
\end{attributedesc}
\end{elementdesc}
+
+%\begin{elementdesc}{extension}{description?, (abstracttype | sectiontype)*}
+% The top-level element for schema component extensions.
+
+% \begin{attributedesc}{prefix}{\datatype{dotted-name}}
+% Prefix to be pre-pended in front of partial dotted-names that
+% start with a period. The value of this attribute is used in all
+% contexts within the \element{extension} element if it hasn't been
+% overridden by an inner element with a \attribute{prefix}
+% attribute.
+% \end{attributedesc}
+%\end{elementdesc}
\section{Standard \module{ZConfig} Datatypes\label{standard-datatypes}}
=== ZODB3/ZConfig/doc/zconfig.pdf 1.7.26.1 => 1.7.26.2 ===
<Binary-ish file>
=== ZODB3/ZConfig/doc/schema.dtd 1.6.26.1 => 1.6.26.2 ===
--- ZODB3/ZConfig/doc/schema.dtd:1.6.26.1 Mon Jul 21 12:36:55 2003
+++ ZODB3/ZConfig/doc/schema.dtd Mon Sep 15 14:14:54 2003
@@ -34,7 +34,6 @@
<!ELEMENT import EMPTY>
<!ATTLIST import
- file CDATA #IMPLIED
package NMTOKEN #IMPLIED
src CDATA #IMPLIED>
@@ -62,7 +61,7 @@
<!ELEMENT key (description?, metadefault?, example?)>
<!ATTLIST key
- name CDATA #REQUIRED
+ name PCDATA #REQUIRED
attribute NMTOKEN #IMPLIED
datatype NMTOKEN #IMPLIED
handler NMTOKEN #IMPLIED
@@ -71,7 +70,7 @@
<!ELEMENT multikey (description?, metadefault?, example?, default*)>
<!ATTLIST multikey
- name CDATA #REQUIRED
+ name PCDATA #REQUIRED
attribute NMTOKEN #IMPLIED
datatype NMTOKEN #IMPLIED
handler NMTOKEN #IMPLIED
@@ -79,7 +78,7 @@
<!ELEMENT section (description?)>
<!ATTLIST section
- name CDATA #REQUIRED
+ name PCDATA #REQUIRED
attribute NMTOKEN #IMPLIED
type NMTOKEN #REQUIRED
handler NMTOKEN #IMPLIED
@@ -88,7 +87,7 @@
<!ELEMENT multisection (description?)>
<!ATTLIST multisection
- name CDATA #REQUIRED
+ name PCDATA #REQUIRED
attribute NMTOKEN #IMPLIED
type NMTOKEN #REQUIRED
handler NMTOKEN #IMPLIED
More information about the Zodb-checkins
mailing list