[Zope-Checkins] CVS: Zope/lib/python/ZConfig/doc - zconfig.tex:1.5.4.7

[Chris McDonough]

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

Modified Files:
      Tag: chrism-install-branch
	zconfig.tex 
Log Message:
Merge zconfig-schema-devel-branch into chrism-install-branch.  Why not? ;-)


=== Zope/lib/python/ZConfig/doc/zconfig.tex 1.5.4.6 => 1.5.4.7 === (746/846 lines abridged)
--- Zope/lib/python/ZConfig/doc/zconfig.tex:1.5.4.6	Tue Nov 26 18:52:34 2002
+++ Zope/lib/python/ZConfig/doc/zconfig.tex	Fri Jan  3 10:51:58 2003
@@ -19,7 +19,9 @@
 \begin{abstract}
 \noindent
 This document describes the syntax and API used in configuration files
-for components of a Zope installation written by Zope Corporation.
+for components of a Zope installation written by Zope Corporation.  This
+configuration mechanism is itself configured using a schema specification
+written in XML.
 \end{abstract}
 
 \tableofcontents
@@ -48,9 +50,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 +61,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 +72,15 @@
 # This is a comment
 \end{verbatim}
 
-An import is expressed like this:
+An inclusion is expressed like this:
 
 \begin{verbatim}
-import defaults.conf
+%include defaults.conf
 \end{verbatim}
 
-while an inclusion is expressed like this:
-
-\begin{verbatim}

[-=- -=- -=- 746 lines omitted -=- -=- -=-]

+  text, otherwise returns \code{False}.
 \end{funcdesc}
 
-The following exceptions are defined:
-
-\begin{excdesc}{SubstitutionError}
-  Base class for errors raised by the \module{ZConfig.Substitution}
-  module.  Instances provide the attributes \member{message} and
-  \member{context}.  \member{message} contains a description of the
-  error.  \member{context} is either \code{None} or a list of names
-  that have been looked up in the case of nested substitution.
-\end{excdesc}
-
-\begin{excdesc}{SubstitutionSyntaxError}
-  Raised when the source text contains syntactical errors.
-\end{excdesc}
-
-\begin{excdesc}{SubstitutionRecursionError}
-  Raised when a nested substitution is recursive.  The
-  \member{context} attribute will always be a list for this
-  exception.  An additional attribute, \member{name}, gives the name
-  for which an recursive reference was detected.
-\end{excdesc}
-
 
 \subsection{Examples}
 
-These examples show how \function{get()} and \function{substitute()}
-differ.
-
 \begin{verbatim}
->>> from ZConfig.Substitution import get, substitute
+>>> from ZConfig.substitution import substitute
 >>> d = {'name': 'value',
 ...      'top': '$middle',
 ...      'middle' : 'bottom'}
@@ -660,13 +953,6 @@
 'value'
 >>> substitute('$top', d)
 '$middle'
->>>
->>> get(d, 'name')
-'value'
->>> get(d, 'top')
-'bottom'
->>> get(d, 'missing', '$top')
-'$top'
 \end{verbatim}