[Zope3-checkins] CVS: Zope/lib/python/ZConfig/doc - zconfig.tex:1.64

[Fred L. Drake, Jr.]

Update of /cvs-repository/Zope/lib/python/ZConfig/doc
In directory cvs.zope.org:/tmp/cvs-serv16796

Modified Files:
	zconfig.tex 
Log Message:
- documented the "prefix" stuff
- fixed datatype of the values for "handler" attributes
- removed/commented out all mentions of schema component extension;
  that's really not complete and should probably be thought through
  again
- moved docs for legacy API out; these should not be generally
  documented
- misc. small fixes


=== Zope/lib/python/ZConfig/doc/zconfig.tex 1.63 => 1.64 === (421/521 lines abridged)
--- Zope/lib/python/ZConfig/doc/zconfig.tex:1.63	Fri Mar 21 17:36:17 2003
+++ Zope/lib/python/ZConfig/doc/zconfig.tex	Mon Mar 24 13:29:30 2003
@@ -257,8 +257,6 @@
 
 \section{Writing Configuration Schema \label{writing-schema}}
 
-XXX to be written
-
 \module{ZConfig} schema are written as XML documents.
 
 Data types are searched in a special namespace defined by the data
@@ -287,7 +285,9 @@
   \begin{attributedesc}{datatype}{\datatype{basic-key}
                                   or \datatype{dotted-name}}
     The data type converter which will be applied to the value of this
-    section.
+    section.  If the value is a \datatype{dotted-name} that begins
+    with a period, the value of \attribute{prefix} will be pre-pended,
+    if set.
   \end{attributedesc}
 
   \begin{attributedesc}{handler}{\datatype{basic-key}}
@@ -298,10 +298,17 @@
     this section.  This can be used to constrain key values in
     different ways; two data types which may be especially useful are
     the \datatype{identifier} and \datatype{ipaddr-or-hostname}
-    types.  The default value is \datatype{basic-key}.
+    types.  If the value is a \datatype{dotted-name} that begins
+    with a period, the value of \attribute{prefix} will be pre-pended,
+    if set.  The default value is \datatype{basic-key}.
   \end{attributedesc}
 
   \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 with the \element{schema} element if it hasn't been
+    overridden by an inner element with a \attribute{prefix}
+    attribute.
   \end{attributedesc}
 \end{elementdesc}
 
@@ -348,7 +355,9 @@
   \begin{attributedesc}{datatype}{\datatype{basic-key}
                                   or \datatype{dotted-name}}
     The data type converter which will be applied to the value of this
-    section.
+    section.  If the value is a \datatype{dotted-name} that begins
+    with a period, the value of \attribute{prefix} will be pre-pended,
+    if set.
   \end{attributedesc}

[-=- -=- -=- 421 lines omitted -=- -=- -=-]

-\begin{methoddesc}[Configuration]{addNamedSection}{section}
-  Add a named section to this section's context.  This is only used to
-  add sections that are descendants but not children of the current
-  section.
-\end{methoddesc}
-
-\begin{methoddesc}[Configuration]{getChildSections}{\optional{type}}
-  Returns a sequence of all child sections, in the order in which they
-  were added.  If \var{type} is omitted or \code{None}, all sections
-  are returned; otherwise only sections of the specified type are
-  included.  The delegate is never consulted by this method.
-\end{methoddesc}
-
-\begin{methoddesc}[Configuration]{getSection}{type\optional{, name}}
-  Returns a single typed section.  The type of the retrieved section
-  is given by \var{type}.  If \var{name} is given and not \code{None},
-  the name of the section must match \var{name}.  If there is no
-  section matching in both name and type,
-  \exception{ConfigurationMissingSectionError} is
-  raised.  If \var{name} is not given or is \code{None}, there must be
-  exactly one child section of type \var{type}; that section is
-  returned.  If there is more than one section of type \var{type},
-  \exception{ConfigurationConflictingSectionError} is raised.  If
-  there is no matching section and a delegate is available, it's
-  \method{getSection()} method is called to provide the return value,
-  otherwise \code{None} is returned.
-\end{methoddesc}
-
-Delegation is supported by one additional method:
-
-\begin{methoddesc}[Configuration]{setDelegate}{section}
-  Set the delegate section to \var{section} if not already set.  If
-  already set, raises \exception{ConfigurationError}.
-\end{methoddesc}
-
-This method is called on each section when the configuration is
-completely loaded.  This is called for all sections contained within a
-section before it is called on the containing section.
-
-\begin{methoddesc}[Configuration]{finish}{}
-  Perform any initialization for the section object that needs to
-  occur after the content of the section is loaded and delegation
-  chains have been established.  (This method may not have been called
-  for delegates before being called on the delegating section.)  The
-  default implementation does nothing.
-\end{methoddesc}
-
+%\input{oldapi}
 
 \end{document}