You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commons-cvs@xml.apache.org by cr...@apache.org on 2003/09/06 05:43:46 UTC
cvs commit: xml-commons/src/documentation/content/xdocs/components/resolver tips.xml index.xml
crossley 2003/09/05 20:43:46
Modified: . status.xml
src/documentation/content/xdocs site.xml
src/documentation/content/xdocs/components/resolver
index.xml
Added: src/documentation/content/components/resolver
CatalogManager.properties
src/documentation/content/xdocs/components/resolver tips.xml
Log:
Annotated example CatalogManager.properties
Submitted by: Mark R. Diggory mdiggory<AT>latte.harvard.edu
and started new "Resolver tips" page.
Revision Changes Path
1.10 +6 -0 xml-commons/status.xml
Index: status.xml
===================================================================
RCS file: /home/cvs/xml-commons/status.xml,v
retrieving revision 1.9
retrieving revision 1.10
diff -u -r1.9 -r1.10
--- status.xml 6 Sep 2003 03:02:00 -0000 1.9
+++ status.xml 6 Sep 2003 03:43:45 -0000 1.10
@@ -84,6 +84,12 @@
Added the brilliant
<link href="http://nagoya.apache.org/eyebrowse/BrowseList?listName=commons-dev@xml.apache.org&by=thread&from=320776">xml-commons logo</link>.
</action>
+ <action type="add" context="docs" dev="crossley"
+ due-to="Mark Diggory" due-to-email="mdiggory@latte.harvard.edu">
+ Annotated example CatalogManager.properties for Resolver
+ (see <link href="http://marc.theaimsgroup.com/?l=xml-commons-dev&m=106273408211244">discussion</link>)
+ and new <link href="components/resolver/tips.html">Tips</link> page.
+ </action>
</release>
<release version="0.5" date="2003-09-05">
<action type="add" context="docs" dev="curcuru">
1.1 xml-commons/src/documentation/content/components/resolver/CatalogManager.properties
Index: CatalogManager.properties
===================================================================
########################################################################
# CatalogManager provides an interface to the catalog properties.
# Properties can come from two places: from system properties or
# from a CatalogManager.properties file. This class provides a
# transparent interface to both, with system properties preferred
# over property file values.
#######################################################################
# Catalog Files:
# The semicolon-delimited list of catalog files.
# Example: catalogs=./xcatalog;/share/doctypes/catalog
catalogs=../conf/xml-catalog.xml
#######################################################################
# Relative Catalogs:
# If false, relative catalog URIs are made absolute with respect to the
# base URI of the CatalogManager.properties file. This setting only
# applies to catalog URIs obtained from the catalogs property in the
# CatalogManager.properties file
# Example: relative-catalogs = [yes|no]
relative-catalogs=yes
#######################################################################
# Verbosity:
# If non-zero, the Catalog classes will print informative and debugging
# messages. The higher the number, the more messages.
# Example: verbosity = [0..99]
verbosity=99
#######################################################################
# Prefer:
# Which identifier is preferred, "public" or "system"?
# Example: xml.catalog.prefer = [public|system]
prefer=system
#######################################################################
# Static-catalog:
# Should a single catalog be constructed for all parsing, or should a
# different catalog be created for each parser?
# Example: static-catalog = [yes|no]
static-catalog=yes
#######################################################################
# Allow-oasis-xml-catalog-pi
# If the source document contains "oasis-xml-catalog" processing
# instructions, should they be used?
# Example: allow-oasis-xml-catalog-pi = [yes|no]
allow-oasis-xml-catalog-pi=yes
#######################################################################
# catalog-class-name
# If you're using the convenience classes
# org.apache.xml.resolver.tools.*, this setting allows you to specify
# an alternate class name to use for the underlying catalog.
# Example: catalog-class-name=org.apache.xml.resolver.Resolver
1.6 +1 -0 xml-commons/src/documentation/content/xdocs/site.xml
Index: site.xml
===================================================================
RCS file: /home/cvs/xml-commons/src/documentation/content/xdocs/site.xml,v
retrieving revision 1.5
retrieving revision 1.6
diff -u -r1.5 -r1.6
--- site.xml 4 Sep 2003 23:54:12 -0000 1.5
+++ site.xml 6 Sep 2003 03:43:45 -0000 1.6
@@ -15,6 +15,7 @@
<article label="Article" href="resolver-article.html"/>
<release-notes label="Release Notes" href="resolver-release-notes.html"/>
<apidocs label="API docs" href="../apidocs/resolver/index.html"/>
+ <tips label="Tips" href="tips.html"/>
</resolver>
<which label="Which" href="which/">
<overview label="Overview" href="index.html"/>
1.3 +5 -3 xml-commons/src/documentation/content/xdocs/components/resolver/index.xml
Index: index.xml
===================================================================
RCS file: /home/cvs/xml-commons/src/documentation/content/xdocs/components/resolver/index.xml,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- index.xml 5 Sep 2003 06:20:34 -0000 1.2
+++ index.xml 6 Sep 2003 03:43:45 -0000 1.3
@@ -3,9 +3,6 @@
<document>
<header>
<title>Resolver overview</title>
- <authors>
- <person name="Norman Walsh" email="ndw@apache.org"/>
- </authors>
</header>
<body>
<anchor id="overview"/>
@@ -23,6 +20,11 @@
<li>
<link href="../apidocs/resolver/index.html">API docs</link>
- the complete Javadocs explain the code.
+ </li>
+ <li>
+ <link href="tips.html">Tips</link>
+ - various things to help you get started, such as configuration
+ files and default catalogs.
</li>
</ul>
</section>
1.1 xml-commons/src/documentation/content/xdocs/components/resolver/tips.xml
Index: tips.xml
===================================================================
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE document PUBLIC "-//APACHE//DTD Documentation V1.1//EN" "document-v11.dtd">
<document>
<header>
<title>Resolver tips</title>
</header>
<body>
<section id="intro">
<title>Introduction</title>
<p>This is a collection of various things to help you get started,
such as configuration files and default catalogs. Of course there is
lots of explanation in the main
<link href="resolver-article.html">documentation</link>.
These are some additional resources.
</p>
</section>
<section id="properties">
<title>Annotated <code>CatalogManager.properties</code></title>
<p>
See this example
<link href="CatalogManager.properties"><code>CatalogManager.properties</code></link>
file (shown below). Place it where your Java applications can find it.
</p>
<source><![CDATA[
########################################################################
# CatalogManager provides an interface to the catalog properties.
# Properties can come from two places: from system properties or
# from a CatalogManager.properties file. This class provides a
# transparent interface to both, with system properties preferred
# over property file values.
#######################################################################
# Catalog Files:
# The semicolon-delimited list of catalog files.
# Example: catalogs=./xcatalog;/share/doctypes/catalog
catalogs=../conf/xml-catalog.xml
#######################################################################
# Relative Catalogs:
# If false, relative catalog URIs are made absolute with respect to the
# base URI of the CatalogManager.properties file. This setting only
# applies to catalog URIs obtained from the catalogs property in the
# CatalogManager.properties file
# Example: relative-catalogs = [yes|no]
relative-catalogs=yes
#######################################################################
# Verbosity:
# If non-zero, the Catalog classes will print informative and debugging
# messages. The higher the number, the more messages.
# Example: verbosity = [0..99]
verbosity=99
#######################################################################
# Prefer:
# Which identifier is preferred, "public" or "system"?
# Example: xml.catalog.prefer = [public|system]
prefer=system
#######################################################################
# Static-catalog:
# Should a single catalog be constructed for all parsing, or should a
# different catalog be created for each parser?
# Example: static-catalog = [yes|no]
static-catalog=yes
#######################################################################
# Allow-oasis-xml-catalog-pi
# If the source document contains "oasis-xml-catalog" processing
# instructions, should they be used?
# Example: allow-oasis-xml-catalog-pi = [yes|no]
allow-oasis-xml-catalog-pi=yes
#######################################################################
# catalog-class-name
# If you're using the convenience classes
# org.apache.xml.resolver.tools.*, this setting allows you to specify
# an alternate class name to use for the underlying catalog.
# Example: catalog-class-name=org.apache.xml.resolver.Resolver
]]></source>
</section>
<section id="resources">
<title>Other helpful resources</title>
<p>Apache Cocoon uses the entity resolver. See the doc
<link href="http://cocoon.apache.org/2.1/userdocs/concepts/catalog.html">Entity resolution with catalogs</link>.
</p>
<p>Apache Forrest uses Cocoon and the entity resolver. See the doc
<link href="http://xml.apache.org/forrest/validation.html">XML Validation</link>.
</p>
<p>Apache Avalon
<link href="http://avalon.apache.org/excalibur/">Excalibur</link>
has the
<code>org.apache.excalibur.xml.DefaultEntityResolver</code>
which was developed in Cocoon then moved to Avalon so that it would
be more widely available.
This hooks the resolver into the xml framework. It is available in
the excalibur-xmlutil package.
</p>
</section>
</body>
</document>