diff --git a/src/documentation/content/components/resolver/CatalogManager.properties b/src/documentation/content/components/resolver/CatalogManager.properties new file mode 100644 index 0000000..dc6dace --- /dev/null +++ b/src/documentation/content/components/resolver/CatalogManager.properties @@ -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 diff --git a/src/documentation/content/xdocs/components/resolver/index.xml b/src/documentation/content/xdocs/components/resolver/index.xml index 3e52e6f..e43d6c7 100644 --- a/src/documentation/content/xdocs/components/resolver/index.xml +++ b/src/documentation/content/xdocs/components/resolver/index.xml @@ -3,9 +3,6 @@
Resolver overview - - -
@@ -24,6 +21,11 @@ API docs - the complete Javadocs explain the code. +
  • + Tips + - various things to help you get started, such as configuration + files and default catalogs. +
    • diff --git a/src/documentation/content/xdocs/components/resolver/tips.xml b/src/documentation/content/xdocs/components/resolver/tips.xml new file mode 100644 index 0000000..90b6129 --- /dev/null +++ b/src/documentation/content/xdocs/components/resolver/tips.xml @@ -0,0 +1,110 @@ + + + +
    + Resolver tips +
    + +
    + Introduction +

    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 + documentation. + These are some additional resources. +

    +
    + +
    + Annotated <code>CatalogManager.properties</code> +

    + See this example + CatalogManager.properties + file (shown below). Place it where your Java applications can find it. +

    + +
    + +
    + Other helpful resources +

    Apache Cocoon uses the entity resolver. See the doc + Entity resolution with catalogs. +

    +

    Apache Forrest uses Cocoon and the entity resolver. See the doc + XML Validation. +

    +

    Apache Avalon + Excalibur + has the + org.apache.excalibur.xml.DefaultEntityResolver + 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. +

    +
    + + +     diff --git a/src/documentation/content/xdocs/site.xml b/src/documentation/content/xdocs/site.xml index e96f342..52ed40f 100644 --- a/src/documentation/content/xdocs/site.xml +++ b/src/documentation/content/xdocs/site.xml @@ -15,6 +15,7 @@
    + diff --git a/status.xml b/status.xml index b6b0b02..9ecfb06 100644 --- a/status.xml +++ b/status.xml @@ -84,6 +84,12 @@ Added the brilliant xml-commons logo. + + Annotated example CatalogManager.properties for Resolver + (see discussion) + and new Tips page. +