crossley 01/11/16 00:44:48
Modified: documentation/xdocs/plan catalog.xml
Log:
Added overview of how the entity resolver is currently implemented.
Revision Changes Path
1.2 +59 -0 xml-cocoon2/documentation/xdocs/plan/catalog.xml
Index: catalog.xml
===================================================================
RCS file: /home/cvs/xml-cocoon2/documentation/xdocs/plan/catalog.xml,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- catalog.xml 2001/11/13 04:50:10 1.1
+++ catalog.xml 2001/11/16 08:44:48 1.2
@@ -32,6 +32,57 @@
</p>
</s1>
+ <s1 title="Current implementation with Cocoon">
+
+ <s2 title="Configuration">
+ <ul>
+ <li><code>cocoon.roles</code> defines role for Resolver</li>
+ <li><code>cocoon.xconf</code> set parameters for Resolver</li>
+ <li><code>CatalogManager.properties</code> additional config method</li>
+ </ul>
+ </s2>
+
+ <s2 title="Components">
+ <ul>
+ <li><code>src/org/apache/cocoon/components/resolver/ResolverImpl.java</code>
+ implements the Sun "XML Entity and URI Resolvers"
+ <ul>
+ <li>Gets a new CatalogResolver() which reads the default
+ <code>CatalogManager.properties</code> to set some properties for
+ local site config</li>
+ <li>Loads the Cocoon system catalog (which resolves all the DTDs
+ and entity sets that are used by Cocoon)</li>
+ <li>Applies any parameters that may have been specified in cocoon.xconf
+ (e.g. local catalogs, verbosity)</li>
+ <li>Allows the application to resolve external entities via
resolveEntity().</li>
+ </ul>
+ </li>
+ <li><code>setEntityResolver()</code> for any parser that is used ... JaxpParser,
XercesParser, PoolJaxpParser, XSLTProcessorImpl, (are there others?)</li>
+ <li></li>
+ </ul>
+ </s2>
+
+ <s2 title="Default Entities and Catalogs">
+ <ul>
+ <li><code>webapp/resources/entities/</code> holds all of the DTDs and
+ character entity sets currently used by Cocoon. These would also form a
+ base for any userland application (they can configure their own additional
+ entities).
+ </li>
+ <li>There are historical copies of all entities at
+ <code>documentation/xdocs/dtd/</code> (this is the default location
+ declared as <code>systemId</code> in each XML document). An open issue is
+ whether to leave them there as a belt-and-braces mechanism, or to rely
+ completely on the entity resolver.</li>
+ <li>The Cocoon system catalog is an OASIS plain-text catalog declaring
+ all of the necessary entities
+ <code>webapp/resources/entities/catalog</code>
+ </li>
+ </ul>
+
+ </s2>
+ </s1>
+
<s1 title="Moving to Avalon">
<note>TODO: describe overview of issues.</note>
@@ -44,6 +95,14 @@
and a CocoonResolver that both extend the same interface.
In fact, it would be reasonable for the CocoonResolver to
extend the ExcaliburResolver.
+ </p>
+
+ <p>The term "resolver" is used in many different ways by Cocoon.
+ So perhaps a better name would be CocoonEntityResolver or CocoonCatalogResolver.
+ </p>
+
+ <p>Which other Apache projects are using the DTDs that are in Cocoon CVS?
+ Some will need to move to Excalibur, Cocoon-specific ones will remain.
</p>
</s1>
----------------------------------------------------------------------
In case of troubles, e-mail: [EMAIL PROTECTED]
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]
