Annotated example CatalogManager.properties
Submitted by: Mark R. Diggory mdiggory<AT>latte.harvard.edu and started new "Resolver tips" page. git-svn-id: https://svn.apache.org/repos/asf/xml/commons/trunk@226103 13f79535-47bb-0310-9956-ffa450edef68
This commit is contained in:
crossley committed
1 parent
9652c2c3aa
commit
07876e866c
5 files changed
+183
-3
No files matched your search
@@ -0,0 +1,61 @@
|
||||
########################################################################
|
||||
# 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
|
||||
@@ -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"/>
|
||||
@@ -24,6 +21,11 @@
|
||||
<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>
|
||||
|
||||
|
||||
@@ -0,0 +1,110 @@
|
||||
<?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>
|
||||
@@ -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"/>
|
||||
|
||||
@@ -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">
|
||||
|
||||
Reference in new issue
Block a user