# [Zodb-checkins] CVS: Packages/ZConfig/doc - zconfig.tex:1.35.10.1

Fred L. Drake, Jr. fred@zope.com
Tue, 10 Dec 2002 11:02:37 -0500

Update of /cvs-repository/Packages/ZConfig/doc
In directory cvs.zope.org:/tmp/cvs-serv32431

Modified Files:
Tag: zconfig-schema-devel-branch
zconfig.tex
Log Message:
Excise %import.

=== Packages/ZConfig/doc/zconfig.tex 1.35 => 1.35.10.1 ===
--- Packages/ZConfig/doc/zconfig.tex:1.35	Thu Dec  5 00:53:44 2002
+++ Packages/ZConfig/doc/zconfig.tex	Tue Dec 10 11:02:36 2002
@@ -48,9 +48,9 @@
format, this format supports key-value pairs arranged in sections.
Unlike the \module{ConfigParser} format, sections are typed and can be
organized hierarchically, and support delegation of value lookup to
-other sections.  Additional files may be imported or included at the
-top level if needed.  Though both formats are substantially
-line-oriented, this format is more flexible.
+other sections.  Additional files may be included if needed.  Though
+both formats are substantially line-oriented, this format is more
+flexible.

The intent of supporting nested section is to allow setting up the
configurations for loosely-associated components in a container.  For
@@ -59,7 +59,7 @@
section may use the delegation syntax to share a base configuration
with other components of the same type.

-The top level of a configuration file consists of a series of imports,
+The top level of a configuration file consists of a series of
inclusions, key-value pairs, and sections.

Comments can be added on lines by themselves.  A comment has a
@@ -70,21 +70,15 @@
# This is a comment
\end{verbatim}

-An import is expressed like this:
-
-\begin{verbatim}
-%import defaults.conf
-\end{verbatim}
-
-while an inclusion is expressed like this:
+An inclusion is expressed like this:

\begin{verbatim}
%include defaults.conf
\end{verbatim}

-The resource to be imported or included can be a relative or absolute
-URL, resolved relative to the URL of the resource the import is
-located in.
+The resource to be included can be specified by a relative or absolute
+URL, resolved relative to the URL of the resource the
+\keyword{\%include} directive is located in.

A key-value pair is expressed like this:
@@ -203,7 +197,7 @@
Names must be defined before they are used, and may not be
re-defined.  All names are associated with the source text in which
they are defined, so distinct sources which are referenced using
-\keyword{\%import} or \keyword{\%include} are not affected by
+\keyword{\%include} are not affected by
definitions created by the resource being parsed.

References to defined names from configuration values use the syntax
@@ -332,21 +326,6 @@
The following methods are defined to be individually overridable by
subclasses; this should suffice for most context specialization.

-\begin{methoddesc}{createImportedSection}{parent, url}
-  Create a new section that represents a section loaded using
-  \keyword{\%import}.  The returned section should be conform to the
-  interface of the \class{ImportingConfiguration} class (see the
-  \refmodule{ZConfig.Config} module's documentation for more
-  information on this interface).  \var{parent} is the section that
-  contains the \keyword{\%import} statement, and \var{url} is the
-  resource that will be loaded into the new section.  This method
-  should not cause the \method{addImport()} of \var{parent} to be
-  called, nor should it cause the resource to actually be loaded.
-  Since the new section represents the top level of an external
-  resource, it's \member{type} and \member{name} attributes should be
-  \code{None}.
-\end{methoddesc}
-
\begin{methoddesc}{createNestedSection}{parent, type, name, delegatename}
Create a new section that represents a child of the section given by
\var{parent}.  \var{type} is the type that should be given to the
@@ -394,12 +373,8 @@
\end{methoddesc}

The following methods are provided to make it easy for parsers to
-support common semantics for the \keyword{\%import} and
-\keyword{\%include} statements, if those are defined for the syntax
-implemented by the alternate parser.
-
-\begin{methoddesc}{importConfiguration}{parent, url}
-\end{methoddesc}
+support common semantics for the \keyword{\%include} statement, if
+taht is defined for the syntax implemented by the alternate parser.

\begin{methoddesc}{includeConfiguration}{parent, url}
\end{methoddesc}
@@ -414,11 +389,8 @@
\modulesynopsis{Standard section objects.}

-The \module{ZConfig.Config} module provides implementations of the
-standard key-value section.  There are two implementations: the basic
-implementation used for internal'' sections, and a subclass that
-provides additional support for the \keyword{\%import} statement (used
-for the top level of a configuration and for imported resources).
+The \module{ZConfig.Config} module provides an implementation of the
+standard key-value section.

\begin{classdesc}{Configuration}{type, name, url}
A typed section with an optional name.  The type is given by the
@@ -428,13 +400,6 @@
no name, \var{name} should be \code{None}.
\end{classdesc}

-\begin{classdesc}{ImportingConfiguration}{type, name, url}
-  A subclass of \class{Configuration} which supports the context
-  needed to support the \keyword{\%import} directive.  This class
-  differs from the base class in that it offers an additional method
-  and changes the lookup semantics of the \method{get()} method.
-\end{classdesc}
-
\class{Configuration} objects provide the following attributes and
methods to retrieve information from the section:

@@ -580,16 +545,6 @@
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}
-
-The \class{ImportingConfiguration} subclass offers an additional
-method, normally not needed by applications, but possibly useful for
-alternate configuration parsers.  Objects returned by the
-context object's \method{createToplevelSection()} method need to
-support this interface.
-