[Zope3-checkins] CVS: Packages/ZConfig/doc - zconfig.tex:1.35.10.5

[Fred L. Drake, Jr.]

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

Modified Files:
      Tag: zconfig-schema-devel-branch
	zconfig.tex 
Log Message:
Update the documentation for the top-level convenience functions.


=== Packages/ZConfig/doc/zconfig.tex 1.35.10.4 => 1.35.10.5 ===
--- Packages/ZConfig/doc/zconfig.tex:1.35.10.4	Thu Dec 19 12:03:56 2002
+++ Packages/ZConfig/doc/zconfig.tex	Thu Dec 19 13:23:32 2002
@@ -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
@@ -223,20 +225,41 @@
 \declaremodule{}{ZConfig}
 \modulesynopsis{Configuration package.}
 
-The main \module{ZConfig} package exports two convenience functions:
+The main \module{ZConfig} package exports these convenience functions:
 
-\begin{funcdesc}{loadURL}{url}
+\begin{funcdesc}{loadConfig}{schema, url}
   Load and return a configuration from a URL or pathname given by
   \var{url}.  \var{url} may be a URL, absolute pathname, or relative
-  pathname.  Fragment identifiers are not supported.
+  pathname.  Fragment identifiers are not supported.  \var{schema} is
+  a referennce to a schema loaded by \function{loadSchema()} or
+  \function{loadSchemaFile()}.
 \end{funcdesc}
 
-\begin{funcdesc}{loadFile}{file\optional{, url}}
-  Load and return a configuration from an opened file object.
-  If \var{url} is omitted, one will be computed based on the
+\begin{funcdesc}{loadConfigFile}{schema, file\optional{, url}}
+  Load and return a configuration from an opened file object.  If
+  \var{url} is omitted, one will be computed based on the
   \member{name} attribute of \var{file}, if it exists.  If no URL can
-  be determined, all \keyword{\%include} statements in the configuration
-  must use absolute URLs.
+  be determined, all \keyword{\%include} statements in the
+  configuration must use absolute URLs.  \var{schema} is a referennce
+  to a schema loaded by \function{loadSchema()} or
+  \function{loadSchemaFile()}.
+\end{funcdesc}
+
+\begin{funcdesc}{loadSchema}{url}
+  Load a schema definition from the URL \var{url}.  The resulting
+  schema object can be passed to \function{loadConfig()} or
+  \function{loadConfigFile()}.  The schema object may be used as many
+  times as needed.
+\end{funcdesc}
+
+\begin{funcdesc}{loadSchemaFile}{file\optional{, url}}
+  Load a schema definition from the open file object \var{file}.  If
+  \var{url} is given and not \code{None}, it should be the URL of
+  resource represented by \var{file}.  If \var{url} is ommitted or
+  \code{None}, a URL may be computed from the \member{name} attrigbute
+  of \var{file}, if present.  The resulting schema object can
+  be passed to \function{loadConfig()} or \function{loadConfigFile()}.
+  The schema object may be used as many times as needed.
 \end{funcdesc}
 
 The following exceptions are defined by this package: