Commit 095370ef authored by Fred Drake's avatar Fred Drake

Update information on schema components, at least partly.

parent b56fc3f0
...@@ -242,23 +242,21 @@ key $name ...@@ -242,23 +242,21 @@ key $name
XXX to be written XXX to be written
\section{Libraries of Schema Components \label{schema-library}} \section{Schema Components \label{schema-components}}
XXX need more explanation XXX need more explanation
\module{ZConfig} supports a library of extensible schema components \module{ZConfig} supports extensible schema components that can be
that can be provided by disparate components, and allows them to be provided by disparate components, and allows them to be knit together
knit together into concrete schema for applications. Neither into concrete schema for applications. Neither components nor
components nor extensions can add additional keys or sections in the extensions can add additional keys or sections in the application
application schema. schema.
A schema \dfn{component} is allowed to define new abstract and A schema \dfn{component} is allowed to define new abstract and
section types. It is not allowed to extend application types or section types. It is not allowed to extend application types or
include additional types in application-provided abstract types. include additional types in application-provided abstract types.
Components are identified using a dotted-name, similar to a Python Components are identified using a dotted-name, similar to a Python
module name. For example, one component may be \code{zodb.storage}. module name. For example, one component may be \code{zodb.storage}.
There is no relationship between the schema component namespace and
the Python module namespace.
A schema component \dfn{extension} is allowed to define new abstract A schema component \dfn{extension} is allowed to define new abstract
and section types, extend types provided by the component it extends, and section types, extend types provided by the component it extends,
...@@ -980,14 +978,11 @@ non-default data type registry. ...@@ -980,14 +978,11 @@ non-default data type registry.
for the instance to be used via the public API. for the instance to be used via the public API.
\end{classdesc} \end{classdesc}
\begin{classdesc}{ConfigLoader}{schema\optional{, library}} \begin{classdesc}{ConfigLoader}{schema}
Loader for configuration files. Each configuration file must Loader for configuration files. Each configuration file must
conform to the schema \var{schema}. The \method{load*()} methods conform to the schema \var{schema}. The \method{load*()} methods
return a tuple consisting of the configuration object and a return a tuple consisting of the configuration object and a
composite handler. composite handler.
The schema component directory is stored in the directory identified
by \var{library}, which defaults to \constant{LIBRARY_DIR} if
omitted or \code{None}.
\end{classdesc} \end{classdesc}
\begin{classdesc}{SchemaLoader}{\optional{registry}} \begin{classdesc}{SchemaLoader}{\optional{registry}}
...@@ -998,10 +993,6 @@ non-default data type registry. ...@@ -998,10 +993,6 @@ non-default data type registry.
used. used.
\end{classdesc} \end{classdesc}
\begin{datadesc}{LIBRARY_DIR}
Default directory for the schema component library.
\end{datadesc}
\subsection{Loader Objects} \subsection{Loader Objects}
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment