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 2007/04/10 05:48:57 UTC
svn commit: r527010 [1/26] - in /forrest/trunk/site-author/content: ./
skins/ xdocs/ xdocs/docs_0_70/ xdocs/docs_0_70/howto/
xdocs/docs_0_70/howto/bugzilla-patch/ xdocs/docs_0_70/howto/cvs-ssh/
xdocs/docs_0_70/howto/multi/ xdocs/docs_0_80/ xdocs/docs_0...
Author: crossley
Date: Mon Apr 9 20:48:52 2007
New Revision: 527010
URL: http://svn.apache.org/viewvc?view=rev&rev=527010
Log:
Whitespace changes only. Using xmlformat. Issue: FOR-644
Modified:
forrest/trunk/site-author/content/doap.xml
forrest/trunk/site-author/content/locationmap.xml
forrest/trunk/site-author/content/skins/skins.xml
forrest/trunk/site-author/content/xdocs/asf-infrastructure.xml
forrest/trunk/site-author/content/xdocs/committed.xml
forrest/trunk/site-author/content/xdocs/compliance.xml
forrest/trunk/site-author/content/xdocs/contrib.xml
forrest/trunk/site-author/content/xdocs/docs_0_70/body-index.fv
forrest/trunk/site-author/content/xdocs/docs_0_70/build.xml
forrest/trunk/site-author/content/xdocs/docs_0_70/cap.xml
forrest/trunk/site-author/content/xdocs/docs_0_70/catalog.xml
forrest/trunk/site-author/content/xdocs/docs_0_70/compliance.xml
forrest/trunk/site-author/content/xdocs/docs_0_70/dreams.xml
forrest/trunk/site-author/content/xdocs/docs_0_70/faq.xml
forrest/trunk/site-author/content/xdocs/docs_0_70/forrest-contract.xml
forrest/trunk/site-author/content/xdocs/docs_0_70/howto/bugzilla-patch/book.xml
forrest/trunk/site-author/content/xdocs/docs_0_70/howto/bugzilla-patch/howto-bugzilla-patch.xml
forrest/trunk/site-author/content/xdocs/docs_0_70/howto/cvs-ssh/book.xml
forrest/trunk/site-author/content/xdocs/docs_0_70/howto/cvs-ssh/howto-cvs-ssh.xml
forrest/trunk/site-author/content/xdocs/docs_0_70/howto/forrest.xmap.html
forrest/trunk/site-author/content/xdocs/docs_0_70/howto/howto-asf-mirror.xml
forrest/trunk/site-author/content/xdocs/docs_0_70/howto/howto-buildPlugin.xml
forrest/trunk/site-author/content/xdocs/docs_0_70/howto/howto-corner-images.xml
forrest/trunk/site-author/content/xdocs/docs_0_70/howto/howto-custom-html-source.xml
forrest/trunk/site-author/content/xdocs/docs_0_70/howto/howto-editcss.xml
forrest/trunk/site-author/content/xdocs/docs_0_70/howto/howto-forrest-from-maven.xml
forrest/trunk/site-author/content/xdocs/docs_0_70/howto/howto-forrestbot.xml
forrest/trunk/site-author/content/xdocs/docs_0_70/howto/howto-howto.xml
forrest/trunk/site-author/content/xdocs/docs_0_70/howto/howto-pdf-tab.xml
forrest/trunk/site-author/content/xdocs/docs_0_70/howto/howto-view-contracts.xml
forrest/trunk/site-author/content/xdocs/docs_0_70/howto/howto-view-dsl.xml
forrest/trunk/site-author/content/xdocs/docs_0_70/howto/howto-view-install.xml
forrest/trunk/site-author/content/xdocs/docs_0_70/howto/index.xml
forrest/trunk/site-author/content/xdocs/docs_0_70/howto/multi/howto-multi.xml
forrest/trunk/site-author/content/xdocs/docs_0_70/howto/multi/revision-howto-multi-2003-09-14.xml
forrest/trunk/site-author/content/xdocs/docs_0_70/howto/multi/revision-howto-multi-2003-09-15.xml
forrest/trunk/site-author/content/xdocs/docs_0_70/howto/multi/revision-step1-2003-09-16.xml
forrest/trunk/site-author/content/xdocs/docs_0_70/howto/multi/step1.xml
forrest/trunk/site-author/content/xdocs/docs_0_70/howto/multi/step2.xml
forrest/trunk/site-author/content/xdocs/docs_0_70/howto/multi/step3.xml
forrest/trunk/site-author/content/xdocs/docs_0_70/howto/project_sitemap.xmap.html
forrest/trunk/site-author/content/xdocs/docs_0_70/howto/sitemap.xmap.html
forrest/trunk/site-author/content/xdocs/docs_0_70/index.xml
forrest/trunk/site-author/content/xdocs/docs_0_70/libre-intro.xml
forrest/trunk/site-author/content/xdocs/docs_0_70/linking.xml
forrest/trunk/site-author/content/xdocs/docs_0_70/menu-index.fv
forrest/trunk/site-author/content/xdocs/docs_0_70/primer.xml
forrest/trunk/site-author/content/xdocs/docs_0_70/project-sitemap.xml
forrest/trunk/site-author/content/xdocs/docs_0_70/searching.xml
forrest/trunk/site-author/content/xdocs/docs_0_70/sitemap-ref.xml
forrest/trunk/site-author/content/xdocs/docs_0_70/skin-package.xml
forrest/trunk/site-author/content/xdocs/docs_0_70/skins.xml
forrest/trunk/site-author/content/xdocs/docs_0_70/tab-index.fv
forrest/trunk/site-author/content/xdocs/docs_0_70/upgrading_07.xml
forrest/trunk/site-author/content/xdocs/docs_0_70/validation.xml
forrest/trunk/site-author/content/xdocs/docs_0_70/views.xml
forrest/trunk/site-author/content/xdocs/docs_0_70/your-project.xml
forrest/trunk/site-author/content/xdocs/docs_0_80/body-index.fv
forrest/trunk/site-author/content/xdocs/docs_0_80/build.xml
forrest/trunk/site-author/content/xdocs/docs_0_80/cap.xml
forrest/trunk/site-author/content/xdocs/docs_0_80/catalog.xml
forrest/trunk/site-author/content/xdocs/docs_0_80/dreams.xml
forrest/trunk/site-author/content/xdocs/docs_0_80/faq.xml
forrest/trunk/site-author/content/xdocs/docs_0_80/glossary.xml
forrest/trunk/site-author/content/xdocs/docs_0_80/howto/bugzilla-patch/book.xml
forrest/trunk/site-author/content/xdocs/docs_0_80/howto/bugzilla-patch/howto-bugzilla-patch.xml
forrest/trunk/site-author/content/xdocs/docs_0_80/howto/cvs-ssh/book.xml
forrest/trunk/site-author/content/xdocs/docs_0_80/howto/cvs-ssh/howto-cvs-ssh.xml
forrest/trunk/site-author/content/xdocs/docs_0_80/howto/howto-asf-mirror.xml
forrest/trunk/site-author/content/xdocs/docs_0_80/howto/howto-buildPlugin.xml
forrest/trunk/site-author/content/xdocs/docs_0_80/howto/howto-collaborativeEditing.html
forrest/trunk/site-author/content/xdocs/docs_0_80/howto/howto-corner-images.xml
forrest/trunk/site-author/content/xdocs/docs_0_80/howto/howto-custom-html-source.xml
forrest/trunk/site-author/content/xdocs/docs_0_80/howto/howto-editcss.xml
forrest/trunk/site-author/content/xdocs/docs_0_80/howto/howto-forrest-from-maven.xml
forrest/trunk/site-author/content/xdocs/docs_0_80/howto/howto-forrestbot.xml
forrest/trunk/site-author/content/xdocs/docs_0_80/howto/howto-pdf-tab.xml
forrest/trunk/site-author/content/xdocs/docs_0_80/howto/index.xml
forrest/trunk/site-author/content/xdocs/docs_0_80/howto/multi/howto-multi.xml
forrest/trunk/site-author/content/xdocs/docs_0_80/howto/multi/revision-howto-multi-2003-09-14.xml
forrest/trunk/site-author/content/xdocs/docs_0_80/howto/multi/revision-howto-multi-2003-09-15.xml
forrest/trunk/site-author/content/xdocs/docs_0_80/howto/multi/revision-step1-2003-09-16.xml
forrest/trunk/site-author/content/xdocs/docs_0_80/howto/multi/step1.xml
forrest/trunk/site-author/content/xdocs/docs_0_80/howto/multi/step2.xml
forrest/trunk/site-author/content/xdocs/docs_0_80/howto/multi/step3.xml
forrest/trunk/site-author/content/xdocs/docs_0_80/index.xml
forrest/trunk/site-author/content/xdocs/docs_0_80/libre-intro.xml
forrest/trunk/site-author/content/xdocs/docs_0_80/linking.xml
forrest/trunk/site-author/content/xdocs/docs_0_80/locationmap.xml
forrest/trunk/site-author/content/xdocs/docs_0_80/menu-index.fv
forrest/trunk/site-author/content/xdocs/docs_0_80/primer.xml
forrest/trunk/site-author/content/xdocs/docs_0_80/project-sitemap.xml
forrest/trunk/site-author/content/xdocs/docs_0_80/searching.xml
forrest/trunk/site-author/content/xdocs/docs_0_80/sitemap-ref.xml
forrest/trunk/site-author/content/xdocs/docs_0_80/skin-package.xml
forrest/trunk/site-author/content/xdocs/docs_0_80/skins.xml
forrest/trunk/site-author/content/xdocs/docs_0_80/status-themes.xml
forrest/trunk/site-author/content/xdocs/docs_0_80/tab-index.fv
forrest/trunk/site-author/content/xdocs/docs_0_80/upgrading_08.xml
forrest/trunk/site-author/content/xdocs/docs_0_80/validation.xml
forrest/trunk/site-author/content/xdocs/docs_0_80/your-project.xml
forrest/trunk/site-author/content/xdocs/documentation_bestpractices.xml
forrest/trunk/site-author/content/xdocs/dtdx/document-v11.xml
forrest/trunk/site-author/content/xdocs/dtdx/document-v12.xml
forrest/trunk/site-author/content/xdocs/dtdx/document-v13.xml
forrest/trunk/site-author/content/xdocs/dtdx/document-v20.xml
forrest/trunk/site-author/content/xdocs/dtdx/dtd-docs.xml
forrest/trunk/site-author/content/xdocs/events.xml
forrest/trunk/site-author/content/xdocs/flyer.xml
forrest/trunk/site-author/content/xdocs/forrest-contract.xml
forrest/trunk/site-author/content/xdocs/forrest-friday.xml
forrest/trunk/site-author/content/xdocs/guidelines.xml
forrest/trunk/site-author/content/xdocs/gump.xml
forrest/trunk/site-author/content/xdocs/howto-dev.xml
forrest/trunk/site-author/content/xdocs/howto-howto.xml
forrest/trunk/site-author/content/xdocs/index.xml
forrest/trunk/site-author/content/xdocs/issues.xml
forrest/trunk/site-author/content/xdocs/license.xml
forrest/trunk/site-author/content/xdocs/live-sites.xml
forrest/trunk/site-author/content/xdocs/mail-lists.xml
forrest/trunk/site-author/content/xdocs/mirrors.html
forrest/trunk/site-author/content/xdocs/plan/index.xml
forrest/trunk/site-author/content/xdocs/plan/internal-xhtml.xml
forrest/trunk/site-author/content/xdocs/pluginDocs/plugins_0_70/pluginInfrastructure.xml
forrest/trunk/site-author/content/xdocs/pluginDocs/plugins_0_70/usingPlugins.xml
forrest/trunk/site-author/content/xdocs/pluginDocs/plugins_0_80/pluginInfrastructure.xml
forrest/trunk/site-author/content/xdocs/pluginDocs/plugins_0_80/usingPlugins.xml
forrest/trunk/site-author/content/xdocs/procedures/How_to_publish_docs.xml
forrest/trunk/site-author/content/xdocs/procedures/release/How_to_release.xml
forrest/trunk/site-author/content/xdocs/proposal-asf-forrestbot.xml
forrest/trunk/site-author/content/xdocs/roles.xml
forrest/trunk/site-author/content/xdocs/site.xml
forrest/trunk/site-author/content/xdocs/subversion_bestpractices.xml
forrest/trunk/site-author/content/xdocs/svn.xml
forrest/trunk/site-author/content/xdocs/tabs.xml
forrest/trunk/site-author/content/xdocs/thanks.xml
forrest/trunk/site-author/content/xdocs/tools/eclipse.xml
forrest/trunk/site-author/content/xdocs/tools/forrestbar.xml
forrest/trunk/site-author/content/xdocs/tools/forrestbot-web-interface.xml
forrest/trunk/site-author/content/xdocs/tools/forrestbot.xml
forrest/trunk/site-author/content/xdocs/tools/xxe.xml
forrest/trunk/site-author/content/xdocs/trash/docs_0_50/index.xml
forrest/trunk/site-author/content/xdocs/trash/docs_0_50/upgrading_05.xml
forrest/trunk/site-author/content/xdocs/uri-namespace.xml
forrest/trunk/site-author/content/xdocs/versions.xml
forrest/trunk/site-author/content/xdocs/who.xml
forrest/trunk/site-author/content/xdocs/zone.xml
Modified: forrest/trunk/site-author/content/doap.xml
URL: http://svn.apache.org/viewvc/forrest/trunk/site-author/content/doap.xml?view=diff&rev=527010&r1=527009&r2=527010
==============================================================================
--- forrest/trunk/site-author/content/doap.xml (original)
+++ forrest/trunk/site-author/content/doap.xml Mon Apr 9 20:48:52 2007
@@ -1,6 +1,5 @@
<?xml version="1.0" encoding="UTF-8"?>
<!-- DOAP file for Apache Forrest -->
-
<!--
Licensed to the Apache Software Foundation (ASF) under one or more
contributor license agreements. See the NOTICE file distributed with
@@ -24,38 +23,30 @@
xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#"
xmlns:asfext="http://projects.apache.org/ns/asfext#"
>
-
<title type="text">Apache Forrest</title>
<author>
<name>Apache Forrest</name>
<uri>http://forrest.apache.org</uri>
</author>
-
<updated>2005-08-09T23:06:00Z</updated>
- <id>tag:apache.org:forrest</id>
-
- <link
+ <id>tag:apache.org:forrest</id><link
rel="alternate"
type="text/html"
hreflang="en"
href="http://forrest.apache.org"/>
-
<entry>
<title>Apache Forrest 0.7</title>
<id>tag:apache.org:forrest:0.7</id>
<updated>2005-08-09T23:06:00Z</updated>
-
<content type="application/rdf+xml">
<doap:Project>
<doap:name>Apache Forrest</doap:name>
<doap:homepage rdf:resource="http://forrest.apache.org"/>
<asfext:pmc rdf:resource="http://forrest.apache.org" />
<doap:created>2005-06-23</doap:created>
-
<doap:shortdesc xml:lang="en">
Aggregated multi-channel documentation framework, separation of concerns.
</doap:shortdesc>
-
<doap:description xml:lang="en">
Apache Forrest is a publishing framework that transforms input from various
sources into a unified presentation in one or more output formats. The
@@ -64,7 +55,6 @@
generate static documents, or be used as a dynamic server, or be deployed by
its automated facility.
</doap:description>
-
<doap:programming-language xml:lang="en">Java</doap:programming-language>
<doap:category rdf:resource="http://projects.apache.org/category/build-management"/>
<doap:category rdf:resource="http://projects.apache.org/category/database"/>
@@ -74,25 +64,19 @@
<doap:category rdf:resource="http://projects.apache.org/category/network-server"/>
<doap:category rdf:resource="http://projects.apache.org/category/web-framework"/>
<doap:category rdf:resource="http://projects.apache.org/category/xml"/>
-
<doap:license rdf:resource="http://forrest.apache.org/license.html"/>
-
<doap:download-page
rdf:resource="http://forrest.apache.org/mirrors.cgi"/>
-
<doap:bug-database
rdf:resource="http://forrest.apache.org/issues.html"/>
-
<doap:mailing-list
rdf:resource="http://forrest.apache.org/mail-lists.html"/>
-
<doap:repository>
<doap:SVNRepository>
<doap:browse rdf:resource="http://svn.apache.org/viewvc/forrest/"/>
<doap:location rdf:resource="http://svn.apache.org/repos/asf/forrest/trunk/"/>
</doap:SVNRepository>
</doap:repository>
-
<doap:maintainer>
<foaf:Person>
<foaf:name>The Apache Forrest Project</foaf:name>
@@ -100,7 +84,6 @@
<foaf:mbox rdf:resource="mailto:dev@forrest.apache.org"/>
</foaf:Person>
</doap:maintainer>
-
<doap:release>
<doap:Version>
<doap:name>Latest stable release</doap:name>
@@ -110,5 +93,5 @@
</doap:release>
</doap:Project>
</content>
- </entry>
+ </entry>
</feed>
Modified: forrest/trunk/site-author/content/locationmap.xml
URL: http://svn.apache.org/viewvc/forrest/trunk/site-author/content/locationmap.xml?view=diff&rev=527010&r1=527009&r2=527010
==============================================================================
--- forrest/trunk/site-author/content/locationmap.xml (original)
+++ forrest/trunk/site-author/content/locationmap.xml Mon Apr 9 20:48:52 2007
@@ -15,11 +15,8 @@
See the License for the specific language governing permissions and
limitations under the License.
-->
-
<!-- Default Forrest locationmap for issues related files -->
-
<locationmap xmlns="http://apache.org/forrest/locationmap/1.0">
-
<components>
<matchers default="lm">
<matcher
@@ -27,16 +24,13 @@
src="org.apache.forrest.locationmap.WildcardLocationMapHintMatcher"/>
</matchers>
<selectors default="exists">
- <selector name="exists" logger="sitemap.selector.exists"
+ <selector name="exists" logger="sitemap.selector.exists"
src="org.apache.forrest.sourceexists.SourceExistsSelector" />
</selectors>
</components>
-
<locator>
-
<match pattern="forrest.issues-rss-url">
- <location src="{forrest:forrest.issues-rss-url}" />
+ <location src="{forrest:forrest.issues-rss-url}" />
</match>
-
</locator>
</locationmap>
Modified: forrest/trunk/site-author/content/skins/skins.xml
URL: http://svn.apache.org/viewvc/forrest/trunk/site-author/content/skins/skins.xml?view=diff&rev=527010&r1=527009&r2=527010
==============================================================================
--- forrest/trunk/site-author/content/skins/skins.xml (original)
+++ forrest/trunk/site-author/content/skins/skins.xml Mon Apr 9 20:48:52 2007
@@ -26,16 +26,14 @@
website CDATA #IMPLIED>
<!ELEMENT description (#PCDATA)>
]>
-
<skins>
<skin name="testskin"
author="Nicola Ken Barozzi"
website="http://www.nicolaken.com"
url="http://www.apache.org/~nicolaken/whiteboard/forrestskins/">
<description>
- Based on the standard forrest-site skin.
- (Note: This is only a test skin, with trivial changes to demonstrate
- the concept.)
+ Based on the standard forrest-site skin. (Note: This is only a test skin,
+ with trivial changes to demonstrate the concept.)
</description>
</skin>
<skin name="testskin2"
@@ -43,9 +41,8 @@
website="http://www.nicolaken.com"
url="http://www.apache.org/~nicolaken/whiteboard/forrestskins/">
<description>
- Based on the standard forrest-site skin.
- (Note: This is only a test skin, with trivial changes to demonstrate
- the concept.)
+ Based on the standard forrest-site skin. (Note: This is only a test skin,
+ with trivial changes to demonstrate the concept.)
</description>
</skin>
-</skins>
+</skins>
Modified: forrest/trunk/site-author/content/xdocs/asf-infrastructure.xml
URL: http://svn.apache.org/viewvc/forrest/trunk/site-author/content/xdocs/asf-infrastructure.xml?view=diff&rev=527010&r1=527009&r2=527010
==============================================================================
--- forrest/trunk/site-author/content/xdocs/asf-infrastructure.xml (original)
+++ forrest/trunk/site-author/content/xdocs/asf-infrastructure.xml Mon Apr 9 20:48:52 2007
@@ -26,10 +26,11 @@
<title>Overview</title>
<p>
The Apache Software Foundation (<a href="ext:asf">ASF</a>) provides an
- environment where various communities can operate. The ASF Infrastructure
- is a key component. See <a href="ext:asf/dev">ASF Development Infrastructure Information</a>.
- The information provided there is relevant to all developers, together
- with information that is only relevant for committers.
+ environment where various communities can operate. The ASF
+ Infrastructure is a key component. See <a href="ext:asf/dev">ASF
+ Development Infrastructure Information</a>. The information provided
+ there is relevant to all developers, together with information that is
+ only relevant for committers.
</p>
</section>
</body>
Modified: forrest/trunk/site-author/content/xdocs/committed.xml
URL: http://svn.apache.org/viewvc/forrest/trunk/site-author/content/xdocs/committed.xml?view=diff&rev=527010&r1=527009&r2=527010
==============================================================================
--- forrest/trunk/site-author/content/xdocs/committed.xml (original)
+++ forrest/trunk/site-author/content/xdocs/committed.xml Mon Apr 9 20:48:52 2007
@@ -19,126 +19,154 @@
"http://forrest.apache.org/dtd/document-v20.dtd">
<document>
<header>
- <title>Becoming an Apache Forrest committer</title>
- <abstract>This is a discussion of how users can
- become committers within the Apache Forrest project.</abstract>
+ <title>Becoming an Apache Forrest committer</title>
+ <abstract>
+ This is a discussion of how users can become committers within the Apache
+ Forrest project.
+ </abstract>
</header>
<body>
<section id="committers">
- <title>What is a committer?</title>
- <warning>
- This document is under development and does not yet represent
- the view of our community.
- </warning>
- <note>Content is being gleaned from various current and past
- discussions on the Forrest dev mailing list, in particular
- <a href="http://marc.theaimsgroup.com/?l=forrest-dev&m=112239074108858">this</a>.
- Further editing of this page is needed and would
- be greatly appreciated.</note>
- <p>Committer is an term used at the ASF to signify someone who is
- committed to a particular project and who is invited to be part of
- the core group within the project that ensures the project's vitality
- (represented by the PMC, Project Management Committee).</p>
- <p>One thing
- that is sometimes hard to understand when you are new to the
- open development<sup>1</sup> process used at the ASF,
- is that we value the community more than the code.
- A strong and healthy community will be respectful and be a fun
- and rewarding place. Strong code will evolve.
+ <title>What is a committer?</title>
+ <warning>
+ This document is under development and does not yet represent the view
+ of our community.
+ </warning>
+ <note>
+ Content is being gleaned from various current and past discussions on
+ the Forrest dev mailing list, in particular
+ <a href="http://marc.theaimsgroup.com/?l=forrest-dev&m=112239074108858">this</a>.
+ Further editing of this page is needed and would be greatly appreciated.
+ </note>
+ <p>
+ Committer is an term used at the ASF to signify someone who is committed
+ to a particular project and who is invited to be part of the core group
+ within the project that ensures the project's vitality (represented by
+ the PMC, Project Management Committee).
+ </p>
+ <p>
+ One thing that is sometimes hard to understand when you are new to the
+ open development<sup>1</sup> process used at the ASF, is that we value
+ the community more than the code. A strong and healthy community will be
+ respectful and be a fun and rewarding place. Strong code will evolve.
</p>
</section>
<section id="copdoc">
- <title>Contributing to the Project - CoPDoC</title>
- <p>The foundation of a project and how the community contributes
- to it is known by the acronym CoPDoC:</p>
- <ul>
- <li>(Co)mmunity - one must interact with others, and share vision
+ <title>Contributing to the Project - CoPDoC</title>
+ <p>
+ The foundation of a project and how the community contributes to it is
+ known by the acronym CoPDoC:
+ </p>
+ <ul>
+ <li>(Co)mmunity - one must interact with others, and share vision
and knowledge</li>
- <li>(P)roject - a clear vision and consensus are needed</li>
- <li>(Do)cumentation - without it, the stuff remains only in the
+ <li>(P)roject - a clear vision and consensus are needed</li>
+ <li>(Do)cumentation - without it, the stuff remains only in the
minds of the authors</li>
- <li>(C)ode - discussion goes nowhere without code</li>
- </ul>
+ <li>(C)ode - discussion goes nowhere without code</li>
+ </ul>
</section>
<section id="becoming">
- <title>Becoming a Committer</title>
- <p>There is nothing at The Apache Software Foundation that says you must write code
- in order to be a committer. Anyone who is supportive of the community
- and works in any of the CoPDoC areas is a likely candidate for
- committership.</p>
- <p>Apache is a meritocracy. That is, once someone has
- contributed sufficiently to any area of CoPDoC they can be voted in
- as a committer. Being a committer does not mean you commit code, it
- means you are committed to the project.</p>
- <p>One of the key contributions
- people can make to the community is through the support of a wide
- user base by assisting users on the user list, writing user oriented
- docs and ensuring the user viewpoint is understood by all developers. A
- main idea behind being a committer is the ability to be a mentor and
- to work cooperatively with your peers.</p>
- <p>The following diagram shows the progression of a user to a
- committer/mentor.</p>
- <p><img alt="committer path" src="committed-1.png"/></p>
- <p>Meritocracy progresses this way
- <code>------------> ------------------------></code></p>
- <p>Note that this is not a hierarchy, it is a progression from a
- broad user base from which those that wish to to contribute to the
- ongoing development of the project (again, through any aspect of
- CoPDoC, not just coding) can become involved as developers. From
- these developers are those who take on additional roles of mentoring
- and more fully commit themselves to the project.</p>
+ <title>Becoming a Committer</title>
+ <p>
+ There is nothing at The Apache Software Foundation that says you must
+ write code in order to be a committer. Anyone who is supportive of the
+ community and works in any of the CoPDoC areas is a likely candidate for
+ committership.
+ </p>
+ <p>
+ Apache is a meritocracy. That is, once someone has contributed
+ sufficiently to any area of CoPDoC they can be voted in as a committer.
+ Being a committer does not mean you commit code, it means you are
+ committed to the project.
+ </p>
+ <p>
+ One of the key contributions people can make to the community is through
+ the support of a wide user base by assisting users on the user list,
+ writing user oriented docs and ensuring the user viewpoint is understood
+ by all developers. A main idea behind being a committer is the ability
+ to be a mentor and to work cooperatively with your peers.
+ </p>
+ <p>
+ The following diagram shows the progression of a user to a
+ committer/mentor.
+ </p>
+ <p>
+ <img alt="committer path" src="committed-1.png"/>
+ </p>
+ <p>
+ Meritocracy progresses this way <code>------------>
+ ------------------------></code>
+ </p>
+ <p>
+ Note that this is not a hierarchy, it is a progression from a broad user
+ base from which those that wish to to contribute to the ongoing
+ development of the project (again, through any aspect of CoPDoC, not
+ just coding) can become involved as developers. From these developers
+ are those who take on additional roles of mentoring and more fully
+ commit themselves to the project.
+ </p>
</section>
<section id="responsibility">
- <title>Responsibilities</title>
- <p>The additional responsibilities of the PMC as a whole are outlined in the
- Apache Forrest project guidelines<sup>2</sup>. It should be noted though
- that Apache projects should be fun, not pressure. As a PMC member, just as a
- developer, you do as much work as you feel like doing. You do not need to
- participate in every discussion, just because it concerns the PMC. Neither
- do you need to participate in every vote or in every development issue.
- We like people to be involved and we reward contributions (meritocracy),
- but we do not punish a lack of contributions. People come and go as their
- needs change and we adapt to those changes.</p>
+ <title>Responsibilities</title>
+ <p>
+ The additional responsibilities of the PMC as a whole are outlined in
+ the Apache Forrest project guidelines<sup>2</sup>. It should be noted
+ though that Apache projects should be fun, not pressure. As a PMC
+ member, just as a developer, you do as much work as you feel like doing.
+ You do not need to participate in every discussion, just because it
+ concerns the PMC. Neither do you need to participate in every vote or in
+ every development issue. We like people to be involved and we reward
+ contributions (meritocracy), but we do not punish a lack of
+ contributions. People come and go as their needs change and we adapt to
+ those changes.
+ </p>
</section>
<section id="discussion">
- <title>Adding to the discussions and contributing code</title>
- <p>Discussion leads to a clearer community understanding of the
- project's goals and objectives and also of how the community works.</p>
- <p>
- Of course, there needs to be a balance between too much chat and not
- enough code. If something is easy to do in code and does not impact
- the overall product (such as a bug fix) then just go ahead and do it.
- However, if something is to introduce a new feature, then it is best to
- introduce your idea to the community via an email to the dev mail
- list first. In this introduction you should outline why you want to
- do something, how you propose to do it (pseudo code is a good way of
- expressing this) and ask for comments. Any comments received will
- help to fine tune the design and, in many cases, produce a quicker,
- more elegant solution (this is the benefit of many eyes on a
- solution).</p>
- <p>The absence of comments from others does not
- mean it is not a good idea, in fact the reverse is true, it means
- nobody has any objection or anything to add. It is only if people
- respond that you need to discuss further. Once the discussion reaches
- consensus then coding can accelerate. Once you have implicit or explicit
- approval for your contribution, just go ahead and do it. Be sure to
- document what you have done whilst you are at it. Without
- documentation (comments in code, mailing list discussion and user
- docs) your code is next to useless - nobody knows it is there and
- nobody knows how it works.</p>
- <p>Online discussion is important for community building.
- Offline discussion and one-to-one conversations deny the
- community the chance to become involved and lead to solutions
- that are not ideal. So please do as much discussion as possible
- on the dev or user mailing list.</p>
+ <title>Adding to the discussions and contributing code</title>
+ <p>
+ Discussion leads to a clearer community understanding of the project's
+ goals and objectives and also of how the community works.
+ </p>
+ <p>
+ Of course, there needs to be a balance between too much chat and not
+ enough code. If something is easy to do in code and does not impact the
+ overall product (such as a bug fix) then just go ahead and do it.
+ However, if something is to introduce a new feature, then it is best to
+ introduce your idea to the community via an email to the dev mail list
+ first. In this introduction you should outline why you want to do
+ something, how you propose to do it (pseudo code is a good way of
+ expressing this) and ask for comments. Any comments received will help
+ to fine tune the design and, in many cases, produce a quicker, more
+ elegant solution (this is the benefit of many eyes on a solution).
+ </p>
+ <p>
+ The absence of comments from others does not mean it is not a good idea,
+ in fact the reverse is true, it means nobody has any objection or
+ anything to add. It is only if people respond that you need to discuss
+ further. Once the discussion reaches consensus then coding can
+ accelerate. Once you have implicit or explicit approval for your
+ contribution, just go ahead and do it. Be sure to document what you have
+ done whilst you are at it. Without documentation (comments in code,
+ mailing list discussion and user docs) your code is next to useless -
+ nobody knows it is there and nobody knows how it works.
+ </p>
+ <p>
+ Online discussion is important for community building. Offline
+ discussion and one-to-one conversations deny the community the chance to
+ become involved and lead to solutions that are not ideal. So please do
+ as much discussion as possible on the dev or user mailing list.
+ </p>
</section>
<section id="references">
<title>References</title>
- <p><sup>1</sup> <a href="site:guidelines/way">Open development</a> at Apache Forrest.
+ <p>
+ <sup>1</sup> <a href="site:guidelines/way">Open development</a> at
+ Apache Forrest.
</p>
- <p><sup>2</sup>
- Apache Forrest
- <a href="site:guidelines">project guidelines</a>.
+ <p>
+ <sup>2</sup> Apache Forrest <a href="site:guidelines">project
+ guidelines</a>.
</p>
</section>
</body>
Modified: forrest/trunk/site-author/content/xdocs/compliance.xml
URL: http://svn.apache.org/viewvc/forrest/trunk/site-author/content/xdocs/compliance.xml?view=diff&rev=527010&r1=527009&r2=527010
==============================================================================
--- forrest/trunk/site-author/content/xdocs/compliance.xml (original)
+++ forrest/trunk/site-author/content/xdocs/compliance.xml Mon Apr 9 20:48:52 2007
@@ -16,69 +16,68 @@
limitations under the License.
-->
<!DOCTYPE document PUBLIC "-//APACHE//DTD Documentation V1.3//EN" "http://forrest.apache.org/dtd/document-v13.dtd">
-<document>
- <header>
- <title>Standards Compliance</title>
- </header>
- <body>
+<document>
+ <header>
+ <title>Standards Compliance</title>
+ </header>
+ <body>
<section>
<title>Introduction</title>
<p>
- Forrest is still quite young, so there are known issues.
- Standards compliance is a definite major goal. Please send patches
- for the Forrest stylesheets to ensure such compliance.
+ Forrest is still quite young, so there are known issues. Standards
+ compliance is a definite major goal. Please send patches for the Forrest
+ stylesheets to ensure such compliance.
</p>
<note>
For your testing, use the Forrestbot-generated website at our
- <link href="site:zone">Zone testbed</link> because that
- reflects the current SVN code.
+ <link href="site:zone">Zone testbed</link> because that reflects the
+ current SVN code.
</note>
- </section>
-
+ </section>
<section>
<title>HTML</title>
-
<p>
Tested using the W3C HTML Validation Service
(<link href="http://validator.w3.org/">validator.w3.org</link>).
</p>
<p>
- The "<code>pelt</code>" skin
- validates as HTML 4.0.1
+ The "<code>pelt</code>" skin validates as HTML 4.0.1
</p>
<p>
- The "<code>tigris</code>" skin
- validates as HTML 4.0.1
+ The "<code>tigris</code>" skin validates as HTML 4.0.1
</p>
- </section>
-
+ </section>
<section>
<title>WAI</title>
-<p>See
-<link href="http://www.w3.org/WAI/">Web Accessibility Initiative (WAI)</link>
-</p>
-<p>
-"W3C WCAG - AAA Compliance" using
-<link href="http://webxact.watchfire.com/">webxact.watchfire.com</link>
-</p>
-<p>Issues ...</p>
-<ol>
- <li>Priority 1: No errors, some warnings.</li>
- <li>Priority 2: Some errors, some warnings.</li>
- <li>Priority 3: Some errors, some warnings.</li>
-</ol>
- </section>
-
+ <p>
+ See <link href="http://www.w3.org/WAI/">Web Accessibility Initiative
+ (WAI)</link>
+ </p>
+ <p>
+ "W3C WCAG - AAA Compliance" using
+ <link href="http://webxact.watchfire.com/">webxact.watchfire.com</link>
+ </p>
+ <p>
+ Issues ...
+ </p>
+ <ol>
+ <li>Priority 1: No errors, some warnings.</li>
+ <li>Priority 2: Some errors, some warnings.</li>
+ <li>Priority 3: Some errors, some warnings.</li>
+ </ol>
+ </section>
<section>
<title>CSS</title>
-<p>
-Jigsaw:
-<link href="http://jigsaw.w3.org/css-validator/">jigsaw.w3.org</link>
-</p>
-<p>Issues ...</p>
-<ol>
- <li>CSS 2: No errors, some warnings.</li>
-</ol>
- </section>
+ <p>
+ Jigsaw:
+ <link href="http://jigsaw.w3.org/css-validator/">jigsaw.w3.org</link>
+ </p>
+ <p>
+ Issues ...
+ </p>
+ <ol>
+ <li>CSS 2: No errors, some warnings.</li>
+ </ol>
+ </section>
</body>
</document>
Modified: forrest/trunk/site-author/content/xdocs/contrib.xml
URL: http://svn.apache.org/viewvc/forrest/trunk/site-author/content/xdocs/contrib.xml?view=diff&rev=527010&r1=527009&r2=527010
==============================================================================
--- forrest/trunk/site-author/content/xdocs/contrib.xml (original)
+++ forrest/trunk/site-author/content/xdocs/contrib.xml Mon Apr 9 20:48:52 2007
@@ -23,33 +23,42 @@
<body>
<section id="introduction">
<title>Introduction</title>
- <p> The Forrest Project is an <link href="http://www.opensource.org/">Open Source</link> volunteer project released
- under a very liberal license. This means there are many ways to contribute to the
- project - either with direct participation (coding, documenting, answering
- questions, proposing ideas, reporting bugs, suggesting bug-fixes, etc..) or by
- resource donations (staff time, conference presentations, publicity, software)
- and even general hardware/money
- <link href="http://www.apache.org/foundation/thanks.html">donations</link>
- via the ASF.
- </p>
- <p> To begin with, we suggest you to subscribe to the
- <link href="site:mail-lists">Forrest mailing lists</link> (follow the link for
- information on how to subscribe and to access the mail list archives).
- Listen-in for a while, to hear how others make contributions. </p>
- <p>You can get your local working copy of the
- <link href="site:build">latest and
- greatest code</link> (which you find in the Forrest module in the Subversion code
- repository). Review the todo list and the issue tracker, choose a task. Perhaps you have noticed
- something that needs patching, or have a new feature to contribute. Make the changes, do the testing, generate a
- patch, and discuss on the dev mailing list. (Do not worry - the process is easy
- and explained below.) </p>
- <p> Document writers are usually the most wanted people so if you like to
- help but you're not familiar with the innermost technical details, don't worry:
- we have work for you! </p>
+ <p>
+ The Forrest Project is an <link href="http://www.opensource.org/">Open
+ Source</link> volunteer project released under a very liberal license.
+ This means there are many ways to contribute to the project - either
+ with direct participation (coding, documenting, answering questions,
+ proposing ideas, reporting bugs, suggesting bug-fixes, etc..) or by
+ resource donations (staff time, conference presentations, publicity,
+ software) and even general hardware/money
+ <link href="http://www.apache.org/foundation/thanks.html">donations</link>
+ via the ASF.
+ </p>
+ <p>
+ To begin with, we suggest you to subscribe to the
+ <link href="site:mail-lists">Forrest mailing lists</link> (follow the
+ link for information on how to subscribe and to access the mail list
+ archives). Listen-in for a while, to hear how others make contributions.
+ </p>
+ <p>
+ You can get your local working copy of the
+ <link href="site:build">latest and greatest code</link> (which you find
+ in the Forrest module in the Subversion code repository). Review the
+ todo list and the issue tracker, choose a task. Perhaps you have noticed
+ something that needs patching, or have a new feature to contribute. Make
+ the changes, do the testing, generate a patch, and discuss on the dev
+ mailing list. (Do not worry - the process is easy and explained below.)
+ </p>
+ <p>
+ Document writers are usually the most wanted people so if you like to
+ help but you're not familiar with the innermost technical details, don't
+ worry: we have work for you!
+ </p>
</section>
<section id="wanted">
- <title>Help Wanted Here</title>
- <p>We would be glad to have extra help in any of the following areas:
+ <title>Help Wanted Here</title>
+ <p>
+ We would be glad to have extra help in any of the following areas:
</p>
<ul>
<li>Assisting to improve documentation.</li>
@@ -63,173 +72,194 @@
below</link>).</li>
<li>Providing new use-cases and requirements. If you think that
Forrest does not quite meet your needs then tell us about it.</li>
- <li>Specifying/analysing/designing new features - and beyond. If you
+ <li>Specifying/analysing/designing new features - and beyond. If you
wish to get further involved with this, please join the <code>forrest-dev</code> mailing
list, install and try out Forrest and read some of the
<link href="site:mail-lists">mail archives</link>. You should have a reasonable
fluency in XML technologies, some Java and Ant skills, and a basic understanding of the Forrest
architecture - don't just say "it should have XYZ" without reading anything
first - because chances are, somebody has already thought of that feature!)</li>
- <li>Packaging easy-to-install packages (such as RPMs) for the myriad of
+ <li>Packaging easy-to-install packages (such as RPMs) for the myriad of
possible configurations out there. (The project does not maintain anything but
the basic <code>.zip</code> and <code>.tar.gz</code> packages, but anyone is
welcome to build their own specific packages and announce them on the
<code>forrest-dev</code> list)</li>
- <li>... and there is just one other thing - don't forget to tell everyone
+ <li>... and there is just one other thing - don't forget to tell everyone
who asks, how great Forrest is! The more people that know about and start
to use Forrest, the larger the pool of potential contributors will be.
</li>
</ul>
</section>
-
<section id="issues">
- <title>Procedure for reporting bugs and issues and enhancement suggestions</title>
+ <title>Procedure for reporting bugs and issues and enhancement suggestions</title>
<p>
If you think that you have found a bug or you have a suggestion for
- improvement, then please discuss it on
- one of the <link href="site:mail-lists">mailing lists</link>.
- However, please check our Issue Tracker first as it may be already reported.
+ improvement, then please discuss it on one of the
+ <link href="site:mail-lists">mailing lists</link>. However, please check
+ our Issue Tracker first as it may be already reported.
</p>
<p>
The <link href="site:bugs">Apache Forrest Issue Tracker</link> collates
our known issues. Obviously not every issue is listed there. Some issues
- have been discussed on the mailing list but do not yet have an issue recorded.
+ have been discussed on the mailing list but do not yet have an issue
+ recorded.
</p>
<p>
- The Roadmap is the best way to get an overview. The Unscheduled list also
- needs regular review, and committers will schedule some of those for the
- next release.
+ The Roadmap is the best way to get an overview. The Unscheduled list
+ also needs regular review, and committers will schedule some of those
+ for the next release.
</p>
<p>
- When creating a new issue, please provide a concise Summary Title and
- a short Description. Add further information as Comments and include
- links to the mail archives. The normal procedure is to discuss the
- issue on the mailing list and then add relevant notes to the issue tracker,
+ When creating a new issue, please provide a concise Summary Title and a
+ short Description. Add further information as Comments and include links
+ to the mail archives. The normal procedure is to discuss the issue on
+ the mailing list and then add relevant notes to the issue tracker,
otherwise it becomes cluttered.
</p>
</section>
-
<section id="cvshowto">
- <title>SVN Usage</title>
- <p>An overview of how to use Subversion (SVN) to participate in Forrest development.
- Do not be afraid - you cannot accidently destroy the actual code repository,
- because you are working with a local copy as an anonymous user. Therefore, you
- do not have the system permissions to change anything. You can only update your
- local repository and compare your revisions with the real repository.
- The <link href="site:v0.70//build">Building Forrest</link> document explains.
+ <title>SVN Usage</title>
+ <p>
+ An overview of how to use Subversion (SVN) to participate in Forrest
+ development. Do not be afraid - you cannot accidently destroy the actual
+ code repository, because you are working with a local copy as an
+ anonymous user. Therefore, you do not have the system permissions to
+ change anything. You can only update your local repository and compare
+ your revisions with the real repository. The
+ <link href="site:v0.70//build">Building Forrest</link> document
+ explains.
</p>
</section>
-
<section id="ssh">
- <title>SVN Committer with Secure Shell access</title>
- <p>After a developer has consistently provided contributions (code,
- documentation and discussion) and demonstrated committment, then the rest of the dev community may vote to
- grant this developer commit access to the Subversion repository.
- See the <link href="http://www.apache.org/dev/">ASF developers resources</link>
- especially the
- <link href="http://www.apache.org/dev/version-control.html">Source code repositories</link>.
- </p>
- <p>You will need secure access to the repository to be able to commit
- patches. Commits to the SVN repository must use the https: protocol.
- If you already have the codebase
- checked out via the http: protocol, then the following command will
- convert it.</p>
+ <title>SVN Committer with Secure Shell access</title>
+ <p>
+ After a developer has consistently provided contributions (code,
+ documentation and discussion) and demonstrated committment, then the
+ rest of the dev community may vote to grant this developer commit access
+ to the Subversion repository. See the
+ <link href="http://www.apache.org/dev/">ASF developers resources</link>
+ especially the
+ <link href="http://www.apache.org/dev/version-control.html">Source code
+ repositories</link>.
+ </p>
+ <p>
+ You will need secure access to the repository to be able to commit
+ patches. Commits to the SVN repository must use the https: protocol. If
+ you already have the codebase checked out via the http: protocol, then
+ the following command will convert it.
+ </p>
<source>svn sw https://svn.apache.org/repos/asf/forrest/trunk</source>
- <p id="svn-config">Line ending issues can be a problem when committing, since developers use
- both Linux and Windows. SVN can understand that files are text (as opposed to binary like images), but
- this must be specified for every new file added. Your SVN client
- can be
+ <p id="svn-config">
+ Line ending issues can be a problem when committing, since developers
+ use both Linux and Windows. SVN can understand that files are text (as
+ opposed to binary like images), but this must be specified for every new
+ file added. Your SVN client can be
<link href="http://www.apache.org/dev/version-control.html#https-svn">configured</link>
- to automatically do this for certain file extensions.
- To do it manually, make sure all line endings
- are in your current OS's native format (the dos2unix and unix2dos utilities
- may be useful) and then do a <code>svn propset svn:eol-style native myfilename.txt</code>
- and <code>svn commit -m "fix line endings" myfilename.txt</code>
+ to automatically do this for certain file extensions. To do it manually,
+ make sure all line endings are in your current OS's native format (the
+ dos2unix and unix2dos utilities may be useful) and then do a <code>svn
+ propset svn:eol-style native myfilename.txt</code> and <code>svn commit
+ -m "fix line endings" myfilename.txt</code>
</p>
</section>
-
<section id="procedure">
- <title>Procedure for Raising Development Issues</title>
- <p> There are two methods for discussing development and submitting
- patches. So that everyone can be productive, it is important to know which
- method is appropriate for a certain situation and how to go about it without
+ <title>Procedure for Raising Development Issues</title>
+ <p>
+ There are two methods for discussing development and submitting patches.
+ So that everyone can be productive, it is important to know which method
+ is appropriate for a certain situation and how to go about it without
confusion. This section explains when to use the developer
<link href="site:mail-lists">mailing list</link> and the
- <link href="site:bugs">issue tracker</link>. </p>
- <p> Research your topic thoroughly before beginning to discuss a new
- development issue. Search and browse through the email archives - your issue
- may have been discussed before. Prepare your post clearly and concisely. </p>
- <p> Most issues will be discovered, resolved, and then patched quickly
- via the developer mailing list. Larger issues, and ones that are
- not yet fully understood or are hard to solve, are destined for the issue tracker. </p>
- <p> Experienced developers use the issue tracker directly, as they are very sure
- when they have found a bug and when not. However, less experienced users should
- first discuss it on the user or developer mailing list (as appropriate).
- Impatient people always enter everything into the issue tracker without caring if it is
- a bug of Forrest or their own installation/configuration mistake - please do
- not do this. </p>
- <p> As a rule-of-thumb, discuss an issue on the developers
- mailing list first to work out any details. After it is confirmed to be
- worthwhile, and you are clear about it, then submit the bug description or
- patch via Bug Tracking. </p>
- <p> Perhaps you do not get any answer on your first reply, so just post
- it again until you get one. (But please not every hour - allow a few days for
- the list to deal with it.) Do not be impatient - remember that the whole world
- is busy, not just you. Bear in mind that other countries will have holidays at
- different times to your country and that they are in different time zones. You
- might also consider rewriting your initial posting - perhaps it was not clear
- enough and the readers eyes glazed over. </p>
+ <link href="site:bugs">issue tracker</link>.
+ </p>
+ <p>
+ Research your topic thoroughly before beginning to discuss a new
+ development issue. Search and browse through the email archives - your
+ issue may have been discussed before. Prepare your post clearly and
+ concisely.
+ </p>
+ <p>
+ Most issues will be discovered, resolved, and then patched quickly via
+ the developer mailing list. Larger issues, and ones that are not yet
+ fully understood or are hard to solve, are destined for the issue
+ tracker.
+ </p>
+ <p>
+ Experienced developers use the issue tracker directly, as they are very
+ sure when they have found a bug and when not. However, less experienced
+ users should first discuss it on the user or developer mailing list (as
+ appropriate). Impatient people always enter everything into the issue
+ tracker without caring if it is a bug of Forrest or their own
+ installation/configuration mistake - please do not do this.
+ </p>
+ <p>
+ As a rule-of-thumb, discuss an issue on the developers mailing list
+ first to work out any details. After it is confirmed to be worthwhile,
+ and you are clear about it, then submit the bug description or patch via
+ Bug Tracking.
+ </p>
+ <p>
+ Perhaps you do not get any answer on your first reply, so just post it
+ again until you get one. (But please not every hour - allow a few days
+ for the list to deal with it.) Do not be impatient - remember that the
+ whole world is busy, not just you. Bear in mind that other countries
+ will have holidays at different times to your country and that they are
+ in different time zones. You might also consider rewriting your initial
+ posting - perhaps it was not clear enough and the readers eyes glazed
+ over.
+ </p>
</section>
-
<section id="patch">
- <title>How to prepare and contribute patches</title>
- <p>If you use the current development version of Forrest via Subversion,
- then do
- '<code>svn update; svn status</code>' to see what files that you
- have changed.
- Do '<code>svn diff > mypatch.txt</code>' to make a patch which
- includes every change. To make a patch for a specific file, do
- <code>svn diff src/documentation/content/xdocs/faq.xml > faq.xml.diff</code>'.
- It is better to prepare the patch from the $FORREST_HOME directory
- so that it contains a definite path to the document. However, be careful
- that the patch does not contain other work-in-progress.
- </p>
- <p>
- For more information about working with SVN, see
- <link href="http://svnbook.red-bean.com/">Version Control with
- Subversion</link> - the opensource SVN book.
- </p>
- <p>
- If you use a downloaded released version of Forrest (or don't use SVN),
- then use the 'diff' command of your operating system:
- '<code>diff -u faq.xml.orig faq.xml > mypatch.txt</code>' (better
- to do that from $FORREST_HOME directory). If you want to use the most
- recent version of the documentation then grab its source file directly
- from the
- <link href="http://svn.apache.org/repos/asf/forrest/trunk/site-author/content/xdocs/">SVN server</link>
- (and tell us which Revision number you used).
+ <title>How to prepare and contribute patches</title>
+ <p>
+ If you use the current development version of Forrest via Subversion,
+ then do '<code>svn update; svn status</code>' to see what files that you
+ have changed. Do '<code>svn diff > mypatch.txt</code>' to make a patch
+ which includes every change. To make a patch for a specific file, do
+ <code>svn diff src/documentation/content/xdocs/faq.xml >
+ faq.xml.diff</code>'. It is better to prepare the patch from the
+ $FORREST_HOME directory so that it contains a definite path to the
+ document. However, be careful that the patch does not contain other
+ work-in-progress.
</p>
- <note>Please send all contributions via our
- <link href="site:bugs">issue tracker</link>.
- and specify the Forrest version or svn version of the source.
+ <p>
+ For more information about working with SVN, see
+ <link href="http://svnbook.red-bean.com/">Version Control with
+ Subversion</link> - the opensource SVN book.
+ </p>
+ <p>
+ If you use a downloaded released version of Forrest (or don't use SVN),
+ then use the 'diff' command of your operating system: '<code>diff -u
+ faq.xml.orig faq.xml > mypatch.txt</code>' (better to do that from
+ $FORREST_HOME directory). If you want to use the most recent version of
+ the documentation then grab its source file directly from the
+ <link href="http://svn.apache.org/repos/asf/forrest/trunk/site-author/content/xdocs/">SVN
+ server</link> (and tell us which Revision number you used).
+ </p>
+ <note>
+ Please send all contributions via our <link href="site:bugs">issue
+ tracker</link>. and specify the Forrest version or svn version of the
+ source.
</note>
<p>
It is always a good idea to check the Forrest
- <link href="site:bugs">issue tracker</link>
- before diving in.
+ <link href="site:bugs">issue tracker</link> before diving in.
</p>
</section>
-
<section id="revert">
<title>How to revert changes in SVN</title>
- <p>Check out <link href="http://svnbook.red-bean.com/en/1.0/ch04s04.html#svn-ch-4-sect-4.2">http://svnbook.red-bean.com/en/1.0/ch04s04.html#svn-ch-4-sect-4.2</link>
- for instructions on how to revert (roll back) changes to svn.</p>
+ <p>
+ Check out
+ <link href="http://svnbook.red-bean.com/en/1.0/ch04s04.html#svn-ch-4-sect-4.2">http://svnbook.red-bean.com/en/1.0/ch04s04.html#svn-ch-4-sect-4.2</link>
+ for instructions on how to revert (roll back) changes to svn.
+ </p>
</section>
-
<section id="tips">
- <title>Contribution Notes and Tips</title>
- <p> This is a collection of tips for contributing to the project in a
- manner that is productive for all parties. </p>
+ <title>Contribution Notes and Tips</title>
+ <p>
+ This is a collection of tips for contributing to the project in a manner
+ that is productive for all parties.
+ </p>
<ul>
<li>See general ASF
<link href="http://www.apache.org/dev/contrib-email-tips.html">Tips for email contributors</link></li>
@@ -256,34 +286,33 @@
with editor
<link href="site:v0.70//catalog">configuration</link>.
</li>
- <li> Remember that most people are participating in development on a
+ <li> Remember that most people are participating in development on a
volunteer basis and in their "spare time". These enthusiasts will attempt to
respond to issues. It may take a little while to get your answers. </li>
- <li> Research your topic thoroughly before beginning to discuss a new
+ <li> Research your topic thoroughly before beginning to discuss a new
development issue. Search and browse through the email archives - your issue
may have been discussed before. Do not just perceive a problem and then rush
out with a question - instead, delve. </li>
- <li> Try to at least offer a partial solution and not just a problem
+ <li> Try to at least offer a partial solution and not just a problem
statement. </li>
- <li> Take the time to clearly explain your issue and write a concise
+ <li> Take the time to clearly explain your issue and write a concise
email message. Less confusion facilitates fast and complete resolution. </li>
- <li> Do not bother to send an email reply that simply says "thanks". When
+ <li> Do not bother to send an email reply that simply says "thanks". When
the issue is resolved, that is the finish - end of thread. Reduce clutter.
</li>
- <li> You would usually do any development work against the trunk of
+ <li> You would usually do any development work against the trunk of
SVN. </li>
- <li> When sending a patch, you usually do not need to worry about which
+ <li> When sending a patch, you usually do not need to worry about which
SVN branch it should be applied to. The maintainers of the repository will
decide. </li>
- <li>Keep all project-related discussion on the mailing list. It is much
+ <li>Keep all project-related discussion on the mailing list. It is much
better to utilise the wider audience, rather than to break off into
private discussion groups. You never know who else will have the
answer to your issues, and anyway other people are interested in
the outcome.
</li>
- <li> Become familiar with the mailing lists. As you browse and search,
+ <li> Become familiar with the mailing lists. As you browse and search,
you will see the way other people do things. Follow the leading examples. </li>
-
</ul>
</section>
</body>
Modified: forrest/trunk/site-author/content/xdocs/docs_0_70/body-index.fv
URL: http://svn.apache.org/viewvc/forrest/trunk/site-author/content/xdocs/docs_0_70/body-index.fv?view=diff&rev=527010&r1=527009&r2=527010
==============================================================================
--- forrest/trunk/site-author/content/xdocs/docs_0_70/body-index.fv (original)
+++ forrest/trunk/site-author/content/xdocs/docs_0_70/body-index.fv Mon Apr 9 20:48:52 2007
@@ -17,7 +17,7 @@
-->
<forrest:views xmlns:forrest="http://apache.org/forrest/templates/1.0"
xmlns:jx="http://apache.org/cocoon/templates/jx/1.0">
- <!-- The following variables are used to contact data models and/or contracts. -->
+<!-- The following variables are used to contact data models and/or contracts. -->
<jx:set var="getRequest" value="#{$cocoon/parameters/getRequest}"/>
<forrest:view type="html" hooksXpath="/">
<forrest:contract name="genericMarkup">
@@ -27,4 +27,4 @@
</forrest:property>
</forrest:contract>
</forrest:view>
-</forrest:views>
\ No newline at end of file
+</forrest:views>
Modified: forrest/trunk/site-author/content/xdocs/docs_0_70/build.xml
URL: http://svn.apache.org/viewvc/forrest/trunk/site-author/content/xdocs/docs_0_70/build.xml?view=diff&rev=527010&r1=527009&r2=527010
==============================================================================
--- forrest/trunk/site-author/content/xdocs/docs_0_70/build.xml (original)
+++ forrest/trunk/site-author/content/xdocs/docs_0_70/build.xml Mon Apr 9 20:48:52 2007
@@ -25,9 +25,12 @@
<title>Getting the Forrest source</title>
<section>
<title>Step-by-step Subversion (SVN) instructions</title>
- <note>If you are behind a proxy, see
- <link href="http://subversion.tigris.org/project_faq.html#proxy">this FAQ</link>.</note>
- <ol>
+ <note>
+ If you are behind a proxy, see
+ <link href="http://subversion.tigris.org/project_faq.html#proxy">this
+ FAQ</link>.
+ </note>
+ <ol>
<li>Make sure you have a recent release of a
<link href="http://subversion.tigris.org/">Subversion</link>
client installed and properly configured.</li>
@@ -37,32 +40,38 @@
<li>At a command prompt, enter
'<code>svn co http://svn.apache.org/repos/asf/forrest/trunk forrest</code>'
(committers should replace <code>http</code> with <code>https</code>).</li>
- <li>This will create a directory called "<code>forrest</code>" where the Forrest source will be stored.</li>
- </ol>
- <p>Whenever you want to update your Forrest source tree to the current
- version, change to the top-level
-"<code>forrest</code>" directory and invoke '<code>svn update</code>'.</p>
- <p>To see what changes you've made, invoke '<code>svn status</code>'</p>
- <p>SVN is really powerful. See
- <link href="http://svnbook.red-bean.com/">Version Control with Subversion</link> - the opensource SVN book.
+ <li>This will create a directory called "<code>forrest</code>" where the Forrest source will be stored.</li>
+ </ol>
+ <p>
+ Whenever you want to update your Forrest source tree to the current
+ version, change to the top-level "<code>forrest</code>" directory and
+ invoke '<code>svn update</code>'.
</p>
- </section>
+ <p>
+ To see what changes you've made, invoke '<code>svn status</code>'
+ </p>
+ <p>
+ SVN is really powerful. See
+ <link href="http://svnbook.red-bean.com/">Version Control with
+ Subversion</link> - the opensource SVN book.
+ </p>
+ </section>
</section>
-
- <section id="building">
- <title>Building and installing Forrest</title>
-<note>
-This document applies to the current 0.7 release version.
-See other instructions for the current development
-<link href="http://forrest.apache.org/docs/dev/build.html">0.8-dev</link> version.
-</note>
- <p>
- To build Forrest, change directory to '<code>forrest/main</code>', and
- then type '<code>build</code>' on Windows or '<code>./build.sh</code>' on
- Unix. (Requires Java 1.4)
- If everything is successful, you should see a message similar to:
- </p>
- <source>
+ <section id="building">
+ <title>Building and installing Forrest</title>
+ <note>
+ This document applies to the current 0.7 release version. See other
+ instructions for the current development
+ <link href="http://forrest.apache.org/docs/dev/build.html">0.8-dev</link>
+ version.
+ </note>
+ <p>
+ To build Forrest, change directory to '<code>forrest/main</code>', and
+ then type '<code>build</code>' on Windows or '<code>./build.sh</code>'
+ on Unix. (Requires Java 1.4) If everything is successful, you should see
+ a message similar to:
+ </p>
+ <source>
*-----------------------------------------------------------------
| Installation notice
*-----------------------------------------------------------------
@@ -76,36 +85,35 @@
| More help at http://forrest.apache.org/
*-----------------------------------------------------------------
</source>
- <p>
- As the message says, you need to add the distribution's <code>bin/</code>
- ("binary") directory to your PATH variable, so the <code>'forrest'</code>
- command is available everywhere:
- </p>
- <source>
+ <p>
+ As the message says, you need to add the distribution's
+ <code>bin/</code> ("binary") directory to your PATH variable, so the
+ <code>'forrest'</code> command is available everywhere:
+ </p>
+ <source>
[~]$ cd /path/to/svn/forrest
[/svn/forrest]$ export FORREST_HOME=`pwd`
[/svn/forrest]$ export PATH=$PATH:$FORREST_HOME/bin
</source>
- <warning>
- After updating the Forrest source from SVN, if there have been certain types of
- updates (e.g. Java sources, supporting libraries, build system, etc.) you will
- need to clean and build forrest again. Do 'cd forrest/main; build clean; build".
- </warning>
+ <warning>
+ After updating the Forrest source from SVN, if there have been certain
+ types of updates (e.g. Java sources, supporting libraries, build system,
+ etc.) you will need to clean and build forrest again. Do 'cd
+ forrest/main; build clean; build".
+ </warning>
+ </section>
+ <section id="run">
+ <title>Run Forrest, run!</title>
+ <p>
+ Forrest is now ready to go. To view and edit the local copy of Forrest
+ core documentation, cd to site-author and do '<code>forrest run</code>'
+ to see the local webapp using the bundled Jetty server. Edit something
+ in content/xdocs/*.xml see the immediate effect.
+ </p>
+ <p>
+ The document <link href="site:v0.70//your-project">Using Forrest</link>
+ is your next step.
+ </p>
</section>
-
- <section id="run">
- <title>Run Forrest, run!</title>
- <p>
- Forrest is now ready to go. To view and edit the local copy of
- Forrest core documentation, cd to site-author and do
- '<code>forrest run</code>' to see
- the local webapp using the bundled Jetty server. Edit something in
- content/xdocs/*.xml see the immediate effect.
- </p>
- <p>
- The document <link href="site:v0.70//your-project">Using Forrest</link> is
- your next step.</p>
- </section>
-
-</body>
+ </body>
</document>
Modified: forrest/trunk/site-author/content/xdocs/docs_0_70/cap.xml
URL: http://svn.apache.org/viewvc/forrest/trunk/site-author/content/xdocs/docs_0_70/cap.xml?view=diff&rev=527010&r1=527009&r2=527010
==============================================================================
--- forrest/trunk/site-author/content/xdocs/docs_0_70/cap.xml (original)
+++ forrest/trunk/site-author/content/xdocs/docs_0_70/cap.xml Mon Apr 9 20:48:52 2007
@@ -17,33 +17,41 @@
-->
<!-- vi: set et sw=2 ts=2 tw=75: -->
<!DOCTYPE document PUBLIC "-//APACHE//DTD Documentation V1.3//EN" "http://forrest.apache.org/dtd/document-v13.dtd">
-<document>
- <header>
- <title>SourceTypeAction (content aware pipelines)</title>
- </header>
- <body>
- <section>
- <title>Introduction</title>
- <p>SourceTypeAction assigns a "type" (a string) to an XML file. This is
- done based on information occuring in the header of the XML file, up to the
- document (root) element. This type is then returned to the sitemap as a
- variable with the name 'sourcetype'. If no matching sourcetype could be be
- found, null is returned and thus the contents of the action element will not be
- executed.</p>
- <p>SourceTypeAction works by pull-parsing the document and collecting
- information such as the Public Id, the processing instructions, the document
- element local name and namespace, and the xsi:schemaLocation and
- xsi:noNamespaceSchemaLocation attributes. This information is then compared
- with the rules described in the configuration of the SourceTypeAction.</p>
- </section>
- <section>
- <title>Configuration</title>
- <p>The action should be declared and configured in the map:actions
- section of your sitemap. Example:</p>
- <source><![CDATA[<map:sitemap xmlns:map="http://apache.org/cocoon/sitemap/1.0">
+<document>
+ <header>
+ <title>SourceTypeAction (content aware pipelines)</title>
+ </header>
+ <body>
+ <section>
+ <title>Introduction</title>
+ <p>
+ SourceTypeAction assigns a "type" (a string) to an XML file. This is
+ done based on information occuring in the header of the XML file, up to
+ the document (root) element. This type is then returned to the sitemap
+ as a variable with the name 'sourcetype'. If no matching sourcetype
+ could be be found, null is returned and thus the contents of the action
+ element will not be executed.
+ </p>
+ <p>
+ SourceTypeAction works by pull-parsing the document and collecting
+ information such as the Public Id, the processing instructions, the
+ document element local name and namespace, and the xsi:schemaLocation
+ and xsi:noNamespaceSchemaLocation attributes. This information is then
+ compared with the rules described in the configuration of the
+ SourceTypeAction.
+ </p>
+ </section>
+ <section>
+ <title>Configuration</title>
+ <p>
+ The action should be declared and configured in the map:actions section
+ of your sitemap. Example:
+ </p>
+ <source>
+<![CDATA[<map:sitemap xmlns:map="http://apache.org/cocoon/sitemap/1.0">
<map:components>
- <...>]]>
- <strong><![CDATA[<map:actions>
+ <...>]]><strong>
+<![CDATA[<map:actions>
<map:action name="sourcetype"
src="org.apache.forrest.sourcetype.SourceTypeAction">
<sourcetype name="download-v1.0">
@@ -51,50 +59,63 @@
public-id="-//Acme//DTD Download Documentation V1.0//EN" />
</sourcetype>
</map:action>
- </map:actions>]]></strong><![CDATA[
+ </map:actions>]]></strong>
+<![CDATA[
</map:components>
<...>
-</map:sitemap>]]></source>
- <p>There are other examples in <code>main/webapp/forrest.xmap</code></p>
- <p>Each sourcetype-tag declares a source type. Inside the sourcetype-tag
- a number of rules can be defined, described below. The sourcetypes will be
- checked in the same order as they are defined in the configuration, the first
- sourcetype of which all rules match will be used.</p>
- <p>These are the available rules:</p>
- <dl>
- <dt>document-declaration</dt>
+</map:sitemap>]]>
+ </source>
+ <p>
+ There are other examples in <code>main/webapp/forrest.xmap</code>
+ </p>
+ <p>
+ Each sourcetype-tag declares a source type. Inside the sourcetype-tag a
+ number of rules can be defined, described below. The sourcetypes will be
+ checked in the same order as they are defined in the configuration, the
+ first sourcetype of which all rules match will be used.
+ </p>
+ <p>
+ These are the available rules:
+ </p>
+ <dl>
+ <dt>document-declaration</dt>
<dd>This rule checks the public ID. It takes one attribute
- <code>public-id</code>.</dd>
- <dt>document-element</dt>
+ <code>public-id</code>.</dd>
+ <dt>document-element</dt>
<dd>This rule checks the local name and/or namespace of the document
element. These are specified with the attributes <code>local-name</code> and
- <code>namespace</code>. At least one of these two is required.</dd>
- <dt>processing-instruction</dt>
+ <code>namespace</code>. At least one of these two is required.</dd>
+ <dt>processing-instruction</dt>
<dd>This rule checks a processing instruction. It can take two
attributes: <code>target</code> and <code>data</code>. The target attribute is
- always required, the data attribute is optional.</dd>
- <dt>w3c-xml-schema</dt>
+ always required, the data attribute is optional.</dd>
+ <dt>w3c-xml-schema</dt>
<dd>This rule checks the value of the xsi:schemaLocation and
xsi:noNamespaceSchemaLocation attributes on the document element. These are
specified with the attributes <code>schema-location</code> and
- <code>no-namespace-schema-location</code>.</dd>
- </dl>
+ <code>no-namespace-schema-location</code>.</dd>
+ </dl>
<p>
- Perhaps you need other methods. Please enhance the source at
- <code>main/java/org/apache/forrest/sourcetype</code>
+ Perhaps you need other methods. Please enhance the source at
+ <code>main/java/org/apache/forrest/sourcetype</code>
</p>
- </section>
- <section>
- <title>Usage</title>
- <p>The source of which the sourcetype must be defined must be specified
- using the 'src' attribute on the map:act element.</p>
- <source><![CDATA[<map:act type="sourcetype" src="{1}">
+ </section>
+ <section>
+ <title>Usage</title>
+ <p>
+ The source of which the sourcetype must be defined must be specified
+ using the 'src' attribute on the map:act element.
+ </p>
+ <source>
+<![CDATA[<map:act type="sourcetype" src="{1}">
...
-</map:act>]]></source>
- <p>See a real-life example in the advanced section of the
- <link href="your-project.html#adding_new_content_type_2">Using Forrest</link>
- document.
- </p>
- </section>
- </body>
-</document>
+</map:act>]]>
+ </source>
+ <p>
+ See a real-life example in the advanced section of the
+ <link href="your-project.html#adding_new_content_type_2">Using
+ Forrest</link> document.
+ </p>
+ </section>
+ </body>
+</document>
Modified: forrest/trunk/site-author/content/xdocs/docs_0_70/catalog.xml
URL: http://svn.apache.org/viewvc/forrest/trunk/site-author/content/xdocs/docs_0_70/catalog.xml?view=diff&rev=527010&r1=527009&r2=527010
==============================================================================
--- forrest/trunk/site-author/content/xdocs/docs_0_70/catalog.xml (original)
+++ forrest/trunk/site-author/content/xdocs/docs_0_70/catalog.xml Mon Apr 9 20:48:52 2007
@@ -25,31 +25,29 @@
<title>Overview</title>
<p>
This is a collection of notes for configuring the Catalog Entity
- Resolver with your favourite XML tools (validating parsers and
- editors).
+ Resolver with your favourite XML tools (validating parsers and editors).
</p>
<p>
All XML documents declare their ruleset - the Document Type Definition
(DTD). When Forrest processes the documents, it uses the Resolver to
- find Forrest's local copies of the DTDs, rather than trundling out
- onto the network.
+ find Forrest's local copies of the DTDs, rather than trundling out onto
+ the network.
</p>
<p>
- Many Java-based XML tools already have an entity resolver, probably
- the same one that Forrest uses. Many non-Java tools also have an
- entity resolver. To use these tools with documents based on the
- Forrest DTDs, you need to configure the tools.
+ Many Java-based XML tools already have an entity resolver, probably the
+ same one that Forrest uses. Many non-Java tools also have an entity
+ resolver. To use these tools with documents based on the Forrest DTDs,
+ you need to configure the tools.
</p>
<note>
- The information provided here is not intended to endorse any
- particular tool.
+ The information provided here is not intended to endorse any particular
+ tool.
</note>
<p>
If you have any other configuration tips for a particular tool, then
please send them to the forrest-dev mailing list.
</p>
</section>
-
<section id="config">
<title>General configuration notes</title>
<p>
@@ -61,50 +59,50 @@
supplied by Forrest at either:
<code>$FORREST_HOME/main/webapp/resources/schema/catalog.xcat</code>
(for XML Catalog) or
- <code>$FORREST_HOME/main/webapp/resources/schema/catalog</code>
- (for TR 9401 Catalog).
+ <code>$FORREST_HOME/main/webapp/resources/schema/catalog</code> (for TR
+ 9401 Catalog).
</p>
</section>
-
<section id="tools">
<title>Configuring specific tools</title>
-
<section id="system">
<title>Operating system catalog</title>
<p>
- Some operating systems already provide a system-wide catalog that
- is used by many tools. This is usually located at
+ Some operating systems already provide a system-wide catalog that is
+ used by many tools. This is usually located at
<code>/etc/xml/catalog</code> or at
<code>/usr/share/sgml/catalog</code> files.
</p>
<p>
For an XML Catalog, add this line:
</p>
- <source><![CDATA[
+ <source>
+<![CDATA[
<nextCatalog
catalog="/usr/local/svn/forrest/main/webapp/resources/schema/catalog.xcat"/>
- ]]></source>
+ ]]>
+ </source>
<p>
For a TR 9401 Catalog, add this line:
</p>
- <source><![CDATA[
+ <source>
+<![CDATA[
CATALOG \
"/usr/local/svn/forrest/main/webapp/resources/schema/catalog"
- ]]></source>
+ ]]>
+ </source>
<p>
- Actually you probably do not want to touch that system catalog,
- so rather create your own catalog file in your home directory
- which refers to both the Forrest catalog and your system catalog.
+ Actually you probably do not want to touch that system catalog, so
+ rather create your own catalog file in your home directory which
+ refers to both the Forrest catalog and your system catalog.
</p>
</section>
-
<section id="xmllint">
<title>xmllint validating parser</title>
<p>
- "xmllint" is part of the "libxml2" package.
- It is very fast and powerful, with are many facilities. It can
- validate whole directories of files at once.
- Set the SGML_CATALOG_FILES environment variable.
+ "xmllint" is part of the "libxml2" package. It is very fast and
+ powerful, with are many facilities. It can validate whole directories
+ of files at once. Set the SGML_CATALOG_FILES environment variable.
</p>
<source>
export SGML_CATALOG_FILES=$SGML_CATALOG_FILES:\
@@ -112,34 +110,30 @@
xmllint --valid --catalogs --noout mydoc.xml
</source>
</section>
-
<section id="vim">
<title>Vim</title>
- <p>
- The following .vimrc entries are useful:
- </p>
+ <p>
+ The following .vimrc entries are useful:
+ </p>
<source>
au FileType xml set efm=%A%f:%l:\ %.%#error:\ %m,%-Z%p^,%-C%.%#
au FileType xml set makeprg=xmllint\ --noout\ --valid\ --catalogs\ %
</source>
</section>
-
<section id="emacs">
<title>Emacs</title>
- <p>See
- <link href="http://www.thaiopensource.com/nxml-mode/">nXML mode</link>
- and
- <link href="http://www.dpawson.co.uk/relaxng/nxml/">FAQ</link>.
+ <p>
+ See <link href="http://www.thaiopensource.com/nxml-mode/">nXML
+ mode</link> and
+ <link href="http://www.dpawson.co.uk/relaxng/nxml/">FAQ</link>.
</p>
</section>
-
<section id="onsgmls">
<title>onsgmls validating parser</title>
<p>
- "onsgmls" is part of the "Open SP" package.
- You need to also tell it where to find an "SGML declaration".
- The easiest way is to create your own little "my-catalog" file,
- containing this:
+ "onsgmls" is part of the "Open SP" package. You need to also tell it
+ where to find an "SGML declaration". The easiest way is to create your
+ own little "my-catalog" file, containing this:
</p>
<source>
SGMLDECL "/usr/share/sgml/xml.dcl"
@@ -153,91 +147,96 @@
onsgmls -c path/to/my-catalog -wall -wxml -s mydoc.xml
</source>
</section>
-
<section id="jedit">
<title>jEdit - Open Source programmer's text editor</title>
- <source><![CDATA[
+ <source>
+<![CDATA[
Select the menu:
Utilities > Global Options > Plugins:XML > Catalogs
Select the "+" button, and use the "File System Browser"
to specify the TR9401 Catalog file:
"forrest/main/webapp/resources/schema/catalog"
- ]]></source>
- <source><![CDATA[
+ ]]>
+ </source>
+ <source>
+<![CDATA[
On version 4.2. Select the menu:
Plugins > Plugins Options > Plugins:XML > Catalogs
Select the "+" button, and use the "File System Browser"
to specify the TR9401 Catalog file:
"forrest/main/webapp/resources/schema/catalog"
- ]]></source>
+ ]]>
+ </source>
</section>
-
<section id="oxygenxml">
<title>oXygen XML Editor</title>
- <source><![CDATA[
+ <source>
+<![CDATA[
Select the menu:
Options > Preferences > XML Catalog
Specify the XML Catalog file:
"forrest/main/webapp/resources/schema/catalog.xcat"
- ]]></source>
+ ]]>
+ </source>
</section>
-
<section id="xmlspy">
<title>xmlspy</title>
- <source><![CDATA[
+ <source>
+<![CDATA[
Add the following entry to the file CustomCatalog.xml
(located in XMLSpy install directory):
<nextCatalog
catalog="file://localhost/C:/apache/forrest/main/webapp/
resources/schema/catalog.xcat"/>
- ]]></source>
+ ]]>
+ </source>
</section>
-
<section id="xxe">
<title>XMLmind XML Editor (XXE)</title>
<section>
<title>XXE v2.5p2 or older</title>
- <source><![CDATA[
+ <source>
+<![CDATA[
Select the menu:
Options > Options > Schema > Add File
Specify the XML Catalog file:
"forrest/main/webapp/resources/schema/catalog.xcat"
- ]]></source>
+ ]]>
+ </source>
</section>
- <section>
+ <section>
<title>XXE v2.5p3+</title>
- <p>XXE supports catalogs by automatic detection via configuration files.
- Download the <fork href="http://www.splike.com/howtos/xxe_forrest.html">XXE
- Forrest Config</fork> files from splike.com; this also add support for WYSIWYG
- editing of forrest documents.
- Note: This configuration suite has recently been added to the
- Forrest scratchpad.
- </p>
+ <p>
+ XXE supports catalogs by automatic detection via configuration
+ files. Download the
+ <fork href="http://www.splike.com/howtos/xxe_forrest.html">XXE
+ Forrest Config</fork> files from splike.com; this also add support
+ for WYSIWYG editing of forrest documents. Note: This configuration
+ suite has recently been added to the Forrest scratchpad.
+ </p>
</section>
</section>
</section>
-
<section id="info">
<title>Further information and resources</title>
<p>
Forrest and Cocoon use the
<link href="http://xml.apache.org/commons/components/resolver/">Catalog
- Entity Resolver</link>
- that is provided by the
+ Entity Resolver</link> that is provided by the
<link href="http://xml.apache.org/commons/">Apache XML Commons</link>
project. The resolver is packaged with the Forrest distribution at
<code>lib/core/xml-commons-resolver-x.y.jar</code>
</p>
<p>
- Other Forrest documentation has some notes about configuring the
- entity resolver for your own DTDs. See
- <link href="site:v0.70//validation">XML Validation</link>.
+ Other Forrest documentation has some notes about configuring the entity
+ resolver for your own DTDs. See <link href="site:v0.70//validation">XML
+ Validation</link>.
</p>
<p>
Cocoon has extensive documentation about the entity resolver. See
<link href="ext:cocoon/catalogs">Entity resolution with catalogs</link>.
</p>
</section>
-</body>
+ </body>
</document>