You are viewing a plain text version of this content. The canonical link for it is here.
Posted to svn@forrest.apache.org by cr...@apache.org on 2004/06/17 05:17:04 UTC
svn commit: rev 21372 - in forrest/trunk/src: core core/context core/context/WEB-INF core/context/WEB-INF/classes core/fresh-site core/fresh-site/src/documentation/classes documentation/content/xdocs/docs
Author: crossley
Date: Wed Jun 16 20:17:03 2004
New Revision: 21372
Added:
forrest/trunk/src/core/fresh-site/src/documentation/classes/
forrest/trunk/src/core/fresh-site/src/documentation/classes/CatalogManager.properties (contents, props changed)
Removed:
forrest/trunk/src/core/context/WEB-INF/classes/CatalogManager.properties
Modified:
forrest/trunk/src/core/context/WEB-INF/cocoon.xconf
forrest/trunk/src/core/context/default-forrest.properties
forrest/trunk/src/core/forrest.build.xml
forrest/trunk/src/core/fresh-site/forrest.properties
forrest/trunk/src/documentation/content/xdocs/docs/validation.xml
Log:
Enable a user project to define a local OASIS Catalog
to resolve their own DTDs to local copies.
The CatalogManager.properties defines their catalog.xcat and needs to be
avaliable to the classpath when Cocoon starts.
http://marc.theaimsgroup.com/?t=108730305500007
Modified: forrest/trunk/src/core/context/WEB-INF/cocoon.xconf
==============================================================================
--- forrest/trunk/src/core/context/WEB-INF/cocoon.xconf (original)
+++ forrest/trunk/src/core/context/WEB-INF/cocoon.xconf Wed Jun 16 20:17:03 2004
@@ -191,10 +191,10 @@
| and declare your own local catalogs, which are loaded in addition to
| the system catalog.
|
- | There are various ways to do local configuration (see "Entity Catalogs"
- | documentation). One way is via the CatalogManager.properties file.
- | As an additional method, you can specify the "local-catalog"
- | parameter here.
+ | There are various ways to do local configuration.
+ | See the Apache Forrest documentation:
+ | http://forrest.apache.org/docs/your-project.html
+ | http://forrest.apache.org/docs/validation.html
|
| local-catalog:
| The full filesystem pathname to a single local catalog file.
@@ -210,14 +210,9 @@
| 3 = 2+, Catalog does not exist, resolvePublic, resolveSystem
| 10 = 3+, List all catalog entries when loading a catalog
| (Cocoon also logs the "Resolved public" messages.)
- |
- | <parameter name="verbosity" value="2"/>
+-->
<entity-resolver logger="core.resolver">
<parameter name="catalog" value="resources/schema/catalog.xcat"/>
- <!-- TODO disabled for now, as filtering no longer works -->
- <!--<parameter name="local-catalog" value="@local-catalog@"/>-->
- <!-- TODO fixed to 1 for now, as filtering no longer works -->
<parameter name="verbosity" value="1"/>
</entity-resolver>
Modified: forrest/trunk/src/core/context/default-forrest.properties
==============================================================================
--- forrest/trunk/src/core/context/default-forrest.properties (original)
+++ forrest/trunk/src/core/context/default-forrest.properties Wed Jun 16 20:17:03 2004
@@ -68,9 +68,6 @@
# A local OASIS catalog file to supplement the default Forrest catalog
project.catalog=${project.schema-dir}/catalog.xcat
-# The verbosity level for the entity resolver (1..10)
-forrest.catalog.verbosity=1
-
##############
# validation properties
Modified: forrest/trunk/src/core/forrest.build.xml
==============================================================================
--- forrest/trunk/src/core/forrest.build.xml (original)
+++ forrest/trunk/src/core/forrest.build.xml Wed Jun 16 20:17:03 2004
@@ -214,6 +214,7 @@
<pathelement path="${env.CLASSPATH}" />
<pathelement location="${forrest.home}/context/WEB-INF/classes"/>
<pathelement location="${forrest.build.lib-dir}/xml-forrest.jar"/>
+ <pathelement location="${project.classes-dir}"/>
<fileset dir="${forrest.jetty.lib-dir}">
<include name="*.jar"/>
<include name="*.JAR"/>
Modified: forrest/trunk/src/core/fresh-site/forrest.properties
==============================================================================
--- forrest/trunk/src/core/fresh-site/forrest.properties (original)
+++ forrest/trunk/src/core/fresh-site/forrest.properties Wed Jun 16 20:17:03 2004
@@ -66,10 +66,6 @@
# A local OASIS catalog file to supplement the default Forrest catalog
#project.catalog=${project.schema-dir}/catalog.xcat
-# The verbosity level for the entity resolver (1..10)
-#forrest.catalog.verbosity=1
-
-
##############
# validation properties
Added: forrest/trunk/src/core/fresh-site/src/documentation/classes/CatalogManager.properties
==============================================================================
--- (empty file)
+++ forrest/trunk/src/core/fresh-site/src/documentation/classes/CatalogManager.properties Wed Jun 16 20:17:03 2004
@@ -0,0 +1,35 @@
+# Copyright 2002-2004 The Apache Software Foundation
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+#=======================================================================
+# CatalogManager.properties
+#
+# This is the default properties file for Apache Forrest.
+# This facilitates local configuration of application-specific catalogs.
+#
+# See the Apache Forrest documentation:
+# http://forrest.apache.org/docs/your-project.html
+# http://forrest.apache.org/docs/validation.html
+
+# verbosity ... level of messages for status/debug
+# See forrest/src/core/context/WEB-INF/cocoon.xconf
+
+# catalogs ... list of additional catalogs to load
+# Note that Apache Forrest will automatically load its own default catalog
+# from src/resources/schema/catalog.xcat
+# use full pathnames
+# pathname separator is always semi-colon (;) regardless of operating system
+# directory separator is always slash (/) regardless of operating system
+#
+#catalogs=/home/me/forrest/my-site/src/documentation/resources/schema/catalog.xcat
Modified: forrest/trunk/src/documentation/content/xdocs/docs/validation.xml
==============================================================================
--- forrest/trunk/src/documentation/content/xdocs/docs/validation.xml (original)
+++ forrest/trunk/src/documentation/content/xdocs/docs/validation.xml Wed Jun 16 20:17:03 2004
@@ -191,9 +191,9 @@
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
-
+
http://www.apache.org/licenses/LICENSE-2.0
-
+
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
@@ -282,13 +282,13 @@
is:
</p>
<source><!DOCTYPE document PUBLIC "-//Acme//DTD Download Documentation V1.0//EN"
- "download-v11.dtd">
+ "download-v10.dtd">
</source>
<p>
We only care about the quoted section after <code>PUBLIC</code>, called
the "public identifier", which globally identifies our document type.
We cannot rely on the subsequent "system identifier" part
- ("download-v11.dtd"), because as a relative reference it is liable to
+ ("download-v10.dtd"), because as a relative reference it is liable to
break. The solution Forrest uses is to ignore the system id, and rely
on a mapping from the public ID to a stable DTD location, via a
Catalog file.</p>
@@ -305,8 +305,7 @@
own catalog file located in
<code>${project.schema-dir}/catalog.xcat</code>.
Use the "project.catalog" property in <code>forrest.properties</code>
- if you need a different pathname. Remember to raise the "verbosity"
- level if you suspect problems with your catalog.
+ if you need a different pathname.
</p>
<p>
Forrest uses the XML Catalog syntax by default, although the SGML
@@ -317,7 +316,7 @@
<!-- OASIS XML Catalog for Forrest -->
<catalog xmlns="urn:oasis:names:tc:entity:xmlns:xml:catalog">
<public publicId="-//Acme//DTD Download Documentation V1.0//EN"
- uri="dtd/download.dtd"/>
+ uri="dtd/download-v10.dtd"/>
</catalog>]]></source>
<p>
The format is described in <link href="ext:catalog_spec">the
@@ -326,12 +325,20 @@
a public identifier to a DTD (relative to the catalog file).
</p>
<p>
- We now have a custom DTD and a catalog mapping which lets Forrest
+ Next specify the full path to your <code>catalog.xcat</code> in the
+ <code>src/documentation/classes/CatalogManager.properties</code> file.
+ Cocoon needs this file when it starts to run. A template file is
+ provided in the "fresh-site" when you do the
+ '<code>forrest seed</code>' to commence a new project.
+ </p>
+ <p>
+ We now have a custom DTD and a catalog mapping which lets both
+ Forrest and Cocoon
locate the DTD. Now if we were to run <code>'forrest validate'</code>
our download file would validate along with all the others. If
something goes wrong, try running <code>'forrest -v validate'</code> to
see the error in more detail. Remember to raise the "verbosity"
- level in <code>forrest.properties</code> if you suspect problems
+ level in <code>cocoon.xconf</code> if you suspect problems
with your catalog.
</p>
</section>