Author: crossley
Date: Sun Mar 2 03:22:23 2008
New Revision: 632740
URL: http://svn.apache.org/viewvc?rev=632740&view=rev
Log:
Enable configuration of some Cocoon sitemap components, e.g. output html
encoding and document type declaration for html and xhtml serializers, JTidy
properties file location for html generator.
Issue: FOR-1071
Added:
forrest/trunk/main/webapp/resources/schema/entity/symbols-project-v10.ent
- copied unchanged from r632666,
forrest/trunk/main/fresh-site/src/documentation/resources/schema/symbols-project-v10.ent
Modified:
forrest/trunk/main/fresh-site/src/documentation/content/xdocs/samples-b/xml-entities.xml
forrest/trunk/main/webapp/resources/schema/catalog.forrest.xcat
forrest/trunk/main/webapp/resources/schema/entity/symbols-core-v10.ent
forrest/trunk/main/webapp/sitemap.xmap
forrest/trunk/site-author/content/xdocs/docs_0_90/faq.xml
forrest/trunk/site-author/status.xml
forrest/trunk/whiteboard/plugins/org.apache.forrest.plugin.internal.dispatcher/internal.xmap
Modified:
forrest/trunk/main/fresh-site/src/documentation/content/xdocs/samples-b/xml-entities.xml
URL:
http://svn.apache.org/viewvc/forrest/trunk/main/fresh-site/src/documentation/content/xdocs/samples-b/xml-entities.xml?rev=632740&r1=632739&r2=632740&view=diff
==============================================================================
---
forrest/trunk/main/fresh-site/src/documentation/content/xdocs/samples-b/xml-entities.xml
(original)
+++
forrest/trunk/main/fresh-site/src/documentation/content/xdocs/samples-b/xml-entities.xml
Sun Mar 2 03:22:23 2008
@@ -50,8 +50,11 @@
</p>
<p>
You can supply lists of symbols for your own project too. Create a fresh
- site with 'forrest seed' and see the set
- <code>src/documentation/resources/schema/symbols-project-v10.ent</code>
+ site with 'forrest seed' and see the set at the
+ <code>src/documentation/resources/schema/symbols-project-v10.ent</code>
file.
+ Copy that file to your own projects at the same location. Also add the
+ entry to your project xml catalog as shown in the seed site at
+ <code>src/documentation/resources/schema/catalog.xcat</code> file.
</p>
<p>
For example, use "<code>&myp-t;</code>" to represent the project name
Modified: forrest/trunk/main/webapp/resources/schema/catalog.forrest.xcat
URL:
http://svn.apache.org/viewvc/forrest/trunk/main/webapp/resources/schema/catalog.forrest.xcat?rev=632740&r1=632739&r2=632740&view=diff
==============================================================================
--- forrest/trunk/main/webapp/resources/schema/catalog.forrest.xcat (original)
+++ forrest/trunk/main/webapp/resources/schema/catalog.forrest.xcat Sun Mar 2
03:22:23 2008
@@ -52,6 +52,8 @@
<!-- Sets of symbols. e.g. for string replacements -->
<public publicId="-//Apache Forrest//ENTITIES Symbols Core v1.0//EN"
uri="entity/symbols-core-v10.ent"/>
+ <public publicId="-//Apache Forrest//ENTITIES Symbols Project v1.0//EN"
+ uri="entity/symbols-project-v10.ent"/>
<!-- Various other resources -->
<public publicId="-//Apache Forrest//ENTITIES Skin Configuration common
plugins V0.7-1//EN"
uri="entity/skinconf-common-plugins-07-1.xml"/>
Modified: forrest/trunk/main/webapp/resources/schema/entity/symbols-core-v10.ent
URL:
http://svn.apache.org/viewvc/forrest/trunk/main/webapp/resources/schema/entity/symbols-core-v10.ent?rev=632740&r1=632739&r2=632740&view=diff
==============================================================================
--- forrest/trunk/main/webapp/resources/schema/entity/symbols-core-v10.ent
(original)
+++ forrest/trunk/main/webapp/resources/schema/entity/symbols-core-v10.ent Sun
Mar 2 03:22:23 2008
@@ -20,5 +20,16 @@
"symbols-core-v10.ent">
%symbols-core;
-->
+
<!ENTITY for "Apache Forrest">
<!ENTITY for-s "<strong>Apache Forrest</strong>">
+
+<!-- Configure some sitemap components -->
+<!ENTITY generator-html-jtidy-properties "WEB-INF/jtidy.properties">
+<!ENTITY serializer-html-encoding "UTF-8">
+<!ENTITY serializer-html-doctype-public "-//W3C//DTD HTML 4.01
Transitional//EN">
+<!ENTITY serializer-html-doctype-system "http://www.w3.org/TR/html4/loose.dtd";>
+
+<!ENTITY serializer-xhtml-encoding "UTF-8">
+<!ENTITY serializer-xhtml-doctype-public "-//W3C//DTD XHTML 1.0 Strict//EN">
+<!ENTITY serializer-xhtml-doctype-system
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd";>
Modified: forrest/trunk/main/webapp/sitemap.xmap
URL:
http://svn.apache.org/viewvc/forrest/trunk/main/webapp/sitemap.xmap?rev=632740&r1=632739&r2=632740&view=diff
==============================================================================
--- forrest/trunk/main/webapp/sitemap.xmap (original)
+++ forrest/trunk/main/webapp/sitemap.xmap Sun Mar 2 03:22:23 2008
@@ -22,12 +22,22 @@
$Revision: 1.12 $
==================================================== -->
+<!DOCTYPE map:sitemap [
+<!ENTITY % symbols-project
+ PUBLIC "-//Apache Forrest//ENTITIES Symbols Project v1.0//EN"
+ "symbols-project-v10.ent">
+ %symbols-project;
+<!ENTITY % symbols-core
+ PUBLIC "-//Apache Forrest//ENTITIES Symbols Core v1.0//EN"
+ "symbols-core-v10.ent">
+ %symbols-core;
+]>
<map:sitemap xmlns:map="http://apache.org/cocoon/sitemap/1.0";>
<map:components>
<map:generators default="file">
<map:generator name="file"
src="org.apache.cocoon.generation.FileGenerator" />
<map:generator name="html"
src="org.apache.cocoon.generation.HTMLGenerator">
- <jtidy-config>WEB-INF/jtidy.properties</jtidy-config>
+ <jtidy-config>&generator-html-jtidy-properties;</jtidy-config>
</map:generator>
<map:generator name="exception"
src="org.apache.cocoon.generation.ExceptionGenerator"/>
@@ -156,9 +166,9 @@
</map:readers>
<map:serializers default="html">
<map:serializer name="html" mime-type="text/html"
src="org.apache.cocoon.serialization.HTMLSerializer">
- <doctype-public>-//W3C//DTD HTML 4.01 Transitional//EN</doctype-public>
- <doctype-system>http://www.w3.org/TR/html4/loose.dtd</doctype-system>
- <encoding>UTF-8</encoding>
+ <doctype-public>&serializer-html-doctype-public;</doctype-public>
+ <doctype-system>&serializer-html-doctype-system;</doctype-system>
+ <encoding>&serializer-html-encoding;</encoding>
</map:serializer>
<map:serializer name="xml" mime-type="text/xml"
src="org.apache.cocoon.serialization.XMLSerializer"/>
<map:serializer name="xml-document" mime-type="text/xml"
src="org.apache.cocoon.serialization.XMLSerializer">
Modified: forrest/trunk/site-author/content/xdocs/docs_0_90/faq.xml
URL:
http://svn.apache.org/viewvc/forrest/trunk/site-author/content/xdocs/docs_0_90/faq.xml?rev=632740&r1=632739&r2=632740&view=diff
==============================================================================
--- forrest/trunk/site-author/content/xdocs/docs_0_90/faq.xml (original)
+++ forrest/trunk/site-author/content/xdocs/docs_0_90/faq.xml Sun Mar 2
03:22:23 2008
@@ -680,7 +680,9 @@
<answer>
<p>
A set of symbols is available. See the demonstration in a fresh
- 'forrest seed' site (at samples/xml-entities.html). For example, use
+ 'forrest seed' site (at
+ <link
href="http://forrest.zones.apache.org/ft/build/forrest-seed/samples-b/xml-entities.html";>samples-b/xml-entities.html</link>).
+ For example, use
"<code>&myp-t;</code>" to represent the project name together
with
trademark symbol "My Project Name™". Avoid lengthy typing and
potential spelling errors.
@@ -1243,6 +1245,32 @@
file. Projects can supply their own (see FAQ:
<link href="#cli-xconf">Cocoon cli.xconf</link>) or use the default
installation-wide cli.xconf file.
+ </p>
+ </answer>
+ </faq>
+ <faq id="sitemap-entities">
+ <question>How to configure some Cocoon sitemap components, e.g. output
html encoding or doctype?</question>
+ <answer>
+ <p>
+ The core Cocoon components are defined in the
+ <code>main/webapp/sitemap.xmap</code> file. Normally the default
+ settings are suitable. There are some things that you might like to
+ change per project. For example, change the html encoding for output
+ html files from the default UTF-8 or configure a different document
+ type declaration for the Dispatcher.
+ </p>
+ <p>
+ Create a fresh site with 'forrest seed' and see the set of symbols
at the
+
<code>src/documentation/resources/schema/symbols-project-v10.ent</code> file.
+ Copy that file to your own projects at the same location. Also add
the
+ entry to your project xml catalog as shown in the seed site at
+ <code>src/documentation/resources/schema/catalog.xcat</code> file.
+ </p>
+ <p>
+ Now copy the particular entity that you wish to re-define from
+ <code>main/webapp/resources/schema/entity/symbols-core-v10.ent</code>
+ file into your project symbols file and edit the entity declaration.
+ Re-start Forrest.
</p>
</answer>
</faq>
Modified: forrest/trunk/site-author/status.xml
URL:
http://svn.apache.org/viewvc/forrest/trunk/site-author/status.xml?rev=632740&r1=632739&r2=632740&view=diff
==============================================================================
--- forrest/trunk/site-author/status.xml (original)
+++ forrest/trunk/site-author/status.xml Sun Mar 2 03:22:23 2008
@@ -151,6 +151,13 @@
Added document to facilitate
<link href="site:upgrading_09">upgrading to v0.9</link>
</action>
+<!-- 2008-03 -->
+ <action context="code" type="add" dev="DC" fixes-bug="FOR-1071"
+ importance="high">
+ Enable configuration of some Cocoon sitemap components, e.g.
+ output html encoding and document type declaration for html and xhtml
serializers,
+ JTidy properties file location for html generator.
+ </action>
<!-- 2008-02 -->
<action context="code" type="update" dev="TS" fixes-bug="FOR-635"
importance="high"> Images had not been reliably reproduced in PDFs
(fop version
Modified:
forrest/trunk/whiteboard/plugins/org.apache.forrest.plugin.internal.dispatcher/internal.xmap
URL:
http://svn.apache.org/viewvc/forrest/trunk/whiteboard/plugins/org.apache.forrest.plugin.internal.dispatcher/internal.xmap?rev=632740&r1=632739&r2=632740&view=diff
==============================================================================
---
forrest/trunk/whiteboard/plugins/org.apache.forrest.plugin.internal.dispatcher/internal.xmap
(original)
+++
forrest/trunk/whiteboard/plugins/org.apache.forrest.plugin.internal.dispatcher/internal.xmap
Sun Mar 2 03:22:23 2008
@@ -29,6 +29,16 @@
structure the content from multiple input sources. Far more actually
because it provides as well logical conditions for presentation formatting
logic
-->
+<!DOCTYPE map:sitemap [
+<!ENTITY % symbols-project
+ PUBLIC "-//Apache Forrest//ENTITIES Symbols Project v1.0//EN"
+ "symbols-project-v10.ent">
+ %symbols-project;
+<!ENTITY % symbols-core
+ PUBLIC "-//Apache Forrest//ENTITIES Symbols Core v1.0//EN"
+ "symbols-core-v10.ent">
+ %symbols-core;
+]>
<map:sitemap xmlns:map="http://apache.org/cocoon/sitemap/1.0";>
<map:components>
<map:generators default="file">
@@ -67,10 +77,9 @@
<map:serializer logger="sitemap.serializer.xhtml" mime-type="text/html"
name="xhtml" pool-grow="2" pool-max="64" pool-min="2"
src="org.apache.cocoon.serialization.XMLSerializer">
- <doctype-public> -//W3C//DTD XHTML 1.0 Strict//EN </doctype-public>
- <doctype-system> http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd
- </doctype-system>
- <encoding>UTF-8</encoding>
+ <doctype-public>&serializer-xhtml-doctype-public;</doctype-public>
+ <doctype-system>&serializer-xhtml-doctype-system;</doctype-system>
+ <encoding>&serializer-xhtml-encoding;</encoding>
<indent>yes</indent>
<omit-xml-declaration>yes</omit-xml-declaration>
</map:serializer>
