Author: crossley
Date: Wed Feb 1 01:09:03 2012
New Revision: 1238894
URL: http://svn.apache.org/viewvc?rev=1238894&view=rev
Log:
Improved documentation about configuring project entities file, and general
tips for upgrading.
Issue: FOR-1233
Modified:
forrest/trunk/main/fresh-site/src/documentation/content/xdocs/samples-b/xml-entities.xml
forrest/trunk/main/fresh-site/src/documentation/content/xdocs/site.xml
forrest/trunk/site-author/content/xdocs/docs_0_100/upgrading_010.xml
forrest/trunk/site-author/content/xdocs/docs_0_90/upgrading_09.xml
forrest/trunk/site-author/content/xdocs/site.xml
forrest/trunk/site-author/status.xml
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=1238894&r1=1238893&r2=1238894&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
Wed Feb 1 01:09:03 2012
@@ -55,6 +55,8 @@
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.
+ See <a href="ext:forrest/validation/catalog">notes</a>
+ about configuring your project Catalog Entity Resolver.
</p>
<p>
For example, use "<code>&myp-t;</code>" to represent the project name
Modified: forrest/trunk/main/fresh-site/src/documentation/content/xdocs/site.xml
URL:
http://svn.apache.org/viewvc/forrest/trunk/main/fresh-site/src/documentation/content/xdocs/site.xml?rev=1238894&r1=1238893&r2=1238894&view=diff
==============================================================================
--- forrest/trunk/main/fresh-site/src/documentation/content/xdocs/site.xml
(original)
+++ forrest/trunk/main/fresh-site/src/documentation/content/xdocs/site.xml Wed
Feb 1 01:09:03 2012
@@ -116,7 +116,10 @@ See http://forrest.apache.org/docs/linki
<external-refs>
<forrest href="http://forrest.apache.org/";>
<linking href="docs/linking.html"/>
- <validation href="docs/validation.html"/>
+ <validation href="docs/validation.html">
+ <catalog href="#catalog"/>
+ <debug-catalog href="#debug-catalog"/>
+ </validation>
<webapp href="docs/your-project.html#webapp"/>
<cap href="docs/cap.html"/>
<dtd-docs href="docs/dtd-docs.html"/>
Modified: forrest/trunk/site-author/content/xdocs/docs_0_100/upgrading_010.xml
URL:
http://svn.apache.org/viewvc/forrest/trunk/site-author/content/xdocs/docs_0_100/upgrading_010.xml?rev=1238894&r1=1238893&r2=1238894&view=diff
==============================================================================
--- forrest/trunk/site-author/content/xdocs/docs_0_100/upgrading_010.xml
(original)
+++ forrest/trunk/site-author/content/xdocs/docs_0_100/upgrading_010.xml Wed
Feb 1 01:09:03 2012
@@ -86,14 +86,25 @@
<section id="tips">
<title>General upgrade tips</title>
<p>
- Synchronise your project's skinconf.xml and forrest.properties files:
+ Compare your configuration with that of a fresh seed site.
+ </p>
+ <p>
+ For example, synchronise your project's skinconf.xml and
forrest.properties files:
</p>
<p>
Take advantage of the separation of concerns. In a new workspace,
create
a fresh '<code>forrest seed</code>' site, then tweak its
forrest.properties and skinconf.xml until it reflects your old site.
When it is ready, replace your project's skinconf.xml and
- forrest.properties files. Any remaining issues would concern other
+ forrest.properties files.
+ </p>
+ <p>
+ Other configuration should also be synchronised. For example, a project
+ Catalog Entity Resolver or symbols entities (see
+ <a href="ext:forrest-zone/seed/xml-entities">notes</a>).
+ </p>
+ <p>
+ Any remaining issues should concern other
aspects of your configuration, such as site.xml and your actual
content.
</p>
</section>
Modified: forrest/trunk/site-author/content/xdocs/docs_0_90/upgrading_09.xml
URL:
http://svn.apache.org/viewvc/forrest/trunk/site-author/content/xdocs/docs_0_90/upgrading_09.xml?rev=1238894&r1=1238893&r2=1238894&view=diff
==============================================================================
--- forrest/trunk/site-author/content/xdocs/docs_0_90/upgrading_09.xml
(original)
+++ forrest/trunk/site-author/content/xdocs/docs_0_90/upgrading_09.xml Wed Feb
1 01:09:03 2012
@@ -224,14 +224,25 @@
<section id="tips">
<title>General upgrade tips</title>
<p>
- Synchronise your project's skinconf.xml and forrest.properties files:
+ Compare your configuration with that of a fresh seed site.
+ </p>
+ <p>
+ For example, synchronise your project's skinconf.xml and
forrest.properties files:
</p>
<p>
Take advantage of the separation of concerns. In a new workspace,
create
a fresh '<code>forrest seed</code>' site, then tweak its
forrest.properties and skinconf.xml until it reflects your old site.
When it is ready, replace your project's skinconf.xml and
- forrest.properties files. Any remaining issues would concern other
+ forrest.properties files.
+ </p>
+ <p>
+ Other configuration should also be synchronised. For example, a project
+ Catalog Entity Resolver or symbols entities (see
+ <a href="ext:forrest-zone/seed/xml-entities">notes</a>).
+ </p>
+ <p>
+ Any remaining issues should concern other
aspects of your configuration, such as site.xml and your actual
content.
</p>
</section>
Modified: forrest/trunk/site-author/content/xdocs/site.xml
URL:
http://svn.apache.org/viewvc/forrest/trunk/site-author/content/xdocs/site.xml?rev=1238894&r1=1238893&r2=1238894&view=diff
==============================================================================
--- forrest/trunk/site-author/content/xdocs/site.xml (original)
+++ forrest/trunk/site-author/content/xdocs/site.xml Wed Feb 1 01:09:03 2012
@@ -183,7 +183,11 @@
</versions>
</docs>
</forrest>
- <forrest-zone href="http://forrest.zones.apache.org/";></forrest-zone>
+ <forrest-zone href="http://forrest.zones.apache.org/";>
+ <seed href="ft/build/forrest-seed/">
+ <xml-entities href="samples-b/xml-entities.html"/>
+ </seed>
+ </forrest-zone>
<java href="http://java.sun.com/";>
<j2ee href="j2ee/">
<patterns href="patterns/">
Modified: forrest/trunk/site-author/status.xml
URL:
http://svn.apache.org/viewvc/forrest/trunk/site-author/status.xml?rev=1238894&r1=1238893&r2=1238894&view=diff
==============================================================================
--- forrest/trunk/site-author/status.xml (original)
+++ forrest/trunk/site-author/status.xml Wed Feb 1 01:09:03 2012
@@ -154,6 +154,10 @@
<link href="site:upgrading_010">upgrading to v0.10-dev</link>
</action>
<!-- 2012-01 -->
+ <action context="docs" type="update" dev="DC" fixes-bug="FOR-1233">
+ Improved documentation about configuring project entities file,
+ and general tips for upgrading.
+ </action>
<action context="code" type="update" dev="DC" importance="high"
due-to="Karl Wright" fixes-bug="FOR-1231">
Use JAVA_TOOL_OPTIONS to ensure UTF-8 everywhere.
</action>
