Author: crossley
Date: Wed Feb 8 16:26:20 2006
New Revision: 376128
URL: http://svn.apache.org/viewcvs?rev=376128&view=rev
Log:
Automatic publish from forrestbot
Added:
forrest/site/committed.source.xml (with props)
forrest/site/contrib.source.xml (with props)
forrest/site/docs_0_60/build.source.xml (with props)
forrest/site/docs_0_60/cap.source.xml (with props)
forrest/site/docs_0_60/catalog.source.xml (with props)
forrest/site/docs_0_60/changes.source.xml (with props)
forrest/site/docs_0_60/compliance.source.xml (with props)
forrest/site/docs_0_60/faq.source.xml (with props)
forrest/site/docs_0_60/forrest-contract.source.xml (with props)
forrest/site/docs_0_60/howto/bugzilla-patch/howto-bugzilla-patch.source.xml
(with props)
forrest/site/docs_0_60/howto/howto-asf-mirror.source.xml (with props)
forrest/site/docs_0_60/howto/howto-howto.source.xml (with props)
forrest/site/docs_0_60/howto/howto-pdf-tab.source.xml (with props)
forrest/site/docs_0_60/howto/index.source.xml (with props)
forrest/site/docs_0_60/howto/multi/howto-multi.source.xml (with props)
forrest/site/docs_0_60/howto/multi/step1.source.xml (with props)
forrest/site/docs_0_60/howto/multi/step2.source.xml (with props)
forrest/site/docs_0_60/howto/multi/step3.source.xml (with props)
forrest/site/docs_0_60/index.source.xml (with props)
forrest/site/docs_0_60/linking.source.xml (with props)
forrest/site/docs_0_60/project-sitemap.source.xml (with props)
forrest/site/docs_0_60/searching.source.xml (with props)
forrest/site/docs_0_60/sitemap-ref.source.xml (with props)
forrest/site/docs_0_60/skin-package.source.xml (with props)
forrest/site/docs_0_60/skins.source.xml (with props)
forrest/site/docs_0_60/todo.source.xml (with props)
forrest/site/docs_0_60/upgrading_06.source.xml (with props)
forrest/site/docs_0_60/validation.source.xml (with props)
forrest/site/docs_0_60/your-project.source.xml (with props)
forrest/site/docs_0_70/build.source.xml (with props)
forrest/site/docs_0_70/cap.source.xml (with props)
forrest/site/docs_0_70/catalog.source.xml (with props)
forrest/site/docs_0_70/changes.source.xml (with props)
forrest/site/docs_0_70/compliance.source.xml (with props)
forrest/site/docs_0_70/dreams.source.xml (with props)
forrest/site/docs_0_70/faq.source.xml (with props)
forrest/site/docs_0_70/forrest-contract.source.xml (with props)
forrest/site/docs_0_70/howto/cvs-ssh/howto-cvs-ssh.source.xml (with props)
forrest/site/docs_0_70/howto/forrest.xmap.source.xml (with props)
forrest/site/docs_0_70/howto/howto-asf-mirror.source.xml (with props)
forrest/site/docs_0_70/howto/howto-buildPlugin.source.xml (with props)
forrest/site/docs_0_70/howto/howto-corner-images.source.xml (with props)
forrest/site/docs_0_70/howto/howto-custom-html-source.source.xml (with
props)
forrest/site/docs_0_70/howto/howto-editcss.source.xml (with props)
forrest/site/docs_0_70/howto/howto-forrest-from-maven.source.xml (with
props)
forrest/site/docs_0_70/howto/howto-howto.source.xml (with props)
forrest/site/docs_0_70/howto/howto-pdf-tab.source.xml (with props)
forrest/site/docs_0_70/howto/howto-view-contracts.source.xml (with props)
forrest/site/docs_0_70/howto/howto-view-dsl.source.xml (with props)
forrest/site/docs_0_70/howto/howto-view-install.source.xml (with props)
forrest/site/docs_0_70/howto/index.source.xml (with props)
forrest/site/docs_0_70/howto/multi/howto-multi.source.xml (with props)
forrest/site/docs_0_70/howto/multi/step1.source.xml (with props)
forrest/site/docs_0_70/howto/multi/step2.source.xml (with props)
forrest/site/docs_0_70/howto/multi/step3.source.xml (with props)
forrest/site/docs_0_70/howto/project_sitemap.xmap.source.xml (with props)
forrest/site/docs_0_70/howto/sitemap.xmap.source.xml (with props)
forrest/site/docs_0_70/index.source.xml (with props)
forrest/site/docs_0_70/libre-intro.source.xml (with props)
forrest/site/docs_0_70/linking.source.xml (with props)
forrest/site/docs_0_70/primer.source.xml (with props)
forrest/site/docs_0_70/project-sitemap.source.xml (with props)
forrest/site/docs_0_70/searching.source.xml (with props)
forrest/site/docs_0_70/sitemap-ref.source.xml (with props)
forrest/site/docs_0_70/skin-package.source.xml (with props)
forrest/site/docs_0_70/skins.source.xml (with props)
forrest/site/docs_0_70/todo.source.xml (with props)
forrest/site/docs_0_70/upgrading_07.source.xml (with props)
forrest/site/docs_0_70/validation.source.xml (with props)
forrest/site/docs_0_70/views.source.xml (with props)
forrest/site/docs_0_70/your-project.source.xml (with props)
forrest/site/docs_0_80/build.source.xml (with props)
forrest/site/docs_0_80/cap.source.xml (with props)
forrest/site/docs_0_80/catalog.source.xml (with props)
forrest/site/docs_0_80/changes.source.xml (with props)
forrest/site/docs_0_80/compliance.source.xml (with props)
forrest/site/docs_0_80/dispatcher.source.xml (with props)
forrest/site/docs_0_80/dreams.source.xml (with props)
forrest/site/docs_0_80/faq.source.xml (with props)
forrest/site/docs_0_80/forrest-contract.source.xml (with props)
forrest/site/docs_0_80/howto/cvs-ssh/howto-cvs-ssh.source.xml (with props)
forrest/site/docs_0_80/howto/forrest.xmap.source.xml (with props)
forrest/site/docs_0_80/howto/howto-asf-mirror.source.xml (with props)
forrest/site/docs_0_80/howto/howto-buildPlugin.source.xml (with props)
forrest/site/docs_0_80/howto/howto-corner-images.source.xml (with props)
forrest/site/docs_0_80/howto/howto-custom-html-source.source.xml (with
props)
forrest/site/docs_0_80/howto/howto-dev.source.xml (with props)
forrest/site/docs_0_80/howto/howto-dispatcher-quickstart.source.xml (with
props)
forrest/site/docs_0_80/howto/howto-editcss.source.xml (with props)
forrest/site/docs_0_80/howto/howto-forrest-from-maven.source.xml (with
props)
forrest/site/docs_0_80/howto/howto-howto.source.xml (with props)
forrest/site/docs_0_80/howto/howto-pdf-tab.source.xml (with props)
forrest/site/docs_0_80/howto/howto-structurer-contracts.source.xml (with
props)
forrest/site/docs_0_80/howto/howto-structurer-dsl.source.xml (with props)
forrest/site/docs_0_80/howto/howto-structurer-install.source.xml (with
props)
forrest/site/docs_0_80/howto/index.source.xml (with props)
forrest/site/docs_0_80/howto/multi/howto-multi.source.xml (with props)
forrest/site/docs_0_80/howto/multi/step1.source.xml (with props)
forrest/site/docs_0_80/howto/multi/step2.source.xml (with props)
forrest/site/docs_0_80/howto/multi/step3.source.xml (with props)
forrest/site/docs_0_80/howto/project_sitemap.xmap.source.xml (with props)
forrest/site/docs_0_80/howto/sitemap.xmap.source.xml (with props)
forrest/site/docs_0_80/index.source.xml (with props)
forrest/site/docs_0_80/libre-intro.source.xml (with props)
forrest/site/docs_0_80/linking.source.xml (with props)
forrest/site/docs_0_80/locationmap.source.xml (with props)
forrest/site/docs_0_80/primer.source.xml (with props)
forrest/site/docs_0_80/project-sitemap.source.xml (with props)
forrest/site/docs_0_80/searching.source.xml (with props)
forrest/site/docs_0_80/sitemap-ref.source.xml (with props)
forrest/site/docs_0_80/skin-package.source.xml (with props)
forrest/site/docs_0_80/skins.source.xml (with props)
forrest/site/docs_0_80/todo.source.xml (with props)
forrest/site/docs_0_80/upgrading_08.source.xml (with props)
forrest/site/docs_0_80/validation.source.xml (with props)
forrest/site/docs_0_80/your-project.source.xml (with props)
forrest/site/dtdx/document-v12.source.xml (with props)
forrest/site/dtdx/document-v13.dtdx.source.xml (with props)
forrest/site/dtdx/document-v13.source.xml (with props)
forrest/site/dtdx/document-v20.dtdx.source.xml (with props)
forrest/site/dtdx/document-v20.source.xml (with props)
forrest/site/dtdx/dtd-docs.source.xml (with props)
forrest/site/dtdx/faq-v13.dtdx.source.xml (with props)
forrest/site/dtdx/faq-v20.dtdx.source.xml (with props)
forrest/site/dtdx/howto-v13.dtdx.source.xml (with props)
forrest/site/dtdx/howto-v20.dtdx.source.xml (with props)
forrest/site/events.source.xml (with props)
forrest/site/flyer.source.xml (with props)
forrest/site/forrest-friday.source.xml (with props)
forrest/site/guidelines.source.xml (with props)
forrest/site/gump.source.xml (with props)
forrest/site/images/built-with-forrest-button.png (with props)
forrest/site/index.source.xml (with props)
forrest/site/issues.source.xml (with props)
forrest/site/license.source.xml (with props)
forrest/site/linkmap.source.xml (with props)
forrest/site/live-sites.source.xml (with props)
forrest/site/mail-lists.source.xml (with props)
forrest/site/mirrors.source.xml (with props)
forrest/site/plan/index.source.xml (with props)
forrest/site/plan/internal-xhtml.source.xml (with props)
forrest/site/pluginDocs/index.source.xml (with props)
forrest/site/pluginDocs/plugins_0_70/index.source.xml (with props)
forrest/site/pluginDocs/plugins_0_70/pluginInfrastructure.source.xml
(with props)
forrest/site/pluginDocs/plugins_0_70/usingPlugins.source.xml (with props)
forrest/site/pluginDocs/plugins_0_80/index.source.xml (with props)
forrest/site/pluginDocs/plugins_0_80/pluginInfrastructure.source.xml
(with props)
forrest/site/pluginDocs/plugins_0_80/usingPlugins.source.xml (with props)
forrest/site/proposal-asf-forrestbot.source.xml (with props)
forrest/site/themes/
forrest/site/themes/breadcrumbs.js (with props)
forrest/site/themes/common.css (with props)
forrest/site/themes/getBlank.js (with props)
forrest/site/themes/images/
forrest/site/themes/images/chapter.gif (with props)
forrest/site/themes/images/chapter_open.gif (with props)
forrest/site/themes/images/current.gif (with props)
forrest/site/themes/images/instruction_arrow.png (with props)
forrest/site/themes/images/page.gif (with props)
forrest/site/themes/images/pdfdoc.gif (with props)
forrest/site/themes/images/roundcorner-b-l-15-bgffffff-strokeE5E4D9-fgE5E4D9.png
(with props)
forrest/site/themes/images/roundcorner-b-l-5-bgffffff-strokeE5E4D9-fgE5E4D9.png
(with props)
forrest/site/themes/images/roundcorner-b-r-15-bgffffff-strokeE5E4D9-fgE5E4D9.png
(with props)
forrest/site/themes/images/roundcorner-b-r-5-bgffffff-strokeE5E4D9-fgE5E4D9.png
(with props)
forrest/site/themes/images/roundcorner-t-l-5-bgffffff-strokeE5E4D9-fgE5E4D9.png
(with props)
forrest/site/themes/images/roundcorner-t-l-5-bgffffff-strokeF5F4E9-fgF5F4E9.png
(with props)
forrest/site/themes/images/roundcorner-t-r-15-bgffffff-strokeE5E4D9-fgE5E4D9.png
(with props)
forrest/site/themes/images/roundcorner-t-r-5-bgffffff-strokeE5E4D9-fgE5E4D9.png
(with props)
forrest/site/themes/images/roundcorner-t-r-5-bgffffff-strokeF5F4E9-fgF5F4E9.png
(with props)
forrest/site/themes/images/spacer.gif (with props)
forrest/site/themes/images/xmldoc.gif (with props)
forrest/site/themes/leather-dev.css (with props)
forrest/site/themes/menu.js (with props)
forrest/site/themes/pelt.basic.css (with props)
forrest/site/themes/pelt.print.css (with props)
forrest/site/themes/pelt.screen.css (with props)
forrest/site/tools/eclipse.source.xml (with props)
forrest/site/tools/forrestbar.source.xml (with props)
forrest/site/tools/forrestbot-web-interface.source.xml (with props)
forrest/site/tools/forrestbot.source.xml (with props)
forrest/site/tools/index.source.xml (with props)
forrest/site/tools/xxe.source.xml (with props)
forrest/site/versions/index.source.xml (with props)
forrest/site/who.source.xml (with props)
forrest/site/zone.source.xml (with props)
Modified:
forrest/site/abs-linkmap
forrest/site/abs-menulinks
forrest/site/docs_0_80/faq.html
forrest/site/docs_0_80/faq.pdf
forrest/site/docs_0_80/faq.xml
forrest/site/mail-lists.html
forrest/site/mail-lists.pdf
Modified: forrest/site/abs-linkmap
URL:
http://svn.apache.org/viewcvs/forrest/site/abs-linkmap?rev=376128&r1=376127&r2=376128&view=diff
==============================================================================
--- forrest/site/abs-linkmap (original)
+++ forrest/site/abs-linkmap Wed Feb 8 16:26:20 2006
@@ -191,6 +191,7 @@
<docbook href="docs_0_80/faq.html#docbook"/>
<edit-content href="docs_0_80/faq.html#edit-content"/>
<ignoring_javadocs href="docs_0_80/faq.html#ignoring_javadocs"/>
+ <jobs href="docs_0_80/faq.html#jobs"/>
<link_raw href="docs_0_80/faq.html#link_raw"/>
<logs href="docs_0_80/faq.html#logs"/>
<pdf_images href="docs_0_80/faq.html#pdf_images"/>
Modified: forrest/site/abs-menulinks
URL:
http://svn.apache.org/viewcvs/forrest/site/abs-menulinks?rev=376128&r1=376127&r2=376128&view=diff
==============================================================================
--- forrest/site/abs-menulinks (original)
+++ forrest/site/abs-menulinks Wed Feb 8 16:26:20 2006
@@ -191,6 +191,7 @@
<docbook tab="v0_80" href="docs_0_80/faq.html#docbook"/>
<edit-content tab="v0_80" href="docs_0_80/faq.html#edit-content"/>
<ignoring_javadocs tab="v0_80"
href="docs_0_80/faq.html#ignoring_javadocs"/>
+ <jobs tab="v0_80" href="docs_0_80/faq.html#jobs"/>
<link_raw tab="v0_80" href="docs_0_80/faq.html#link_raw"/>
<logs tab="v0_80" href="docs_0_80/faq.html#logs"/>
<pdf_images tab="v0_80" href="docs_0_80/faq.html#pdf_images"/>
Added: forrest/site/committed.source.xml
URL:
http://svn.apache.org/viewcvs/forrest/site/committed.source.xml?rev=376128&view=auto
==============================================================================
--- forrest/site/committed.source.xml (added)
+++ forrest/site/committed.source.xml Wed Feb 8 16:26:20 2006
@@ -0,0 +1,142 @@
+<?xml version="1.0" encoding="ISO-8859-1"?><!--
+ Copyright 2002-2005 The Apache Software Foundation or its licensors,
+ as applicable.
+
+ Licensed under the Apache License, Version 2.0 (the "License");
+ you may not use this file except in compliance with the License.
+ You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+--><document>
+ <header>
+ <title>Becoming an Apache Forrest committer</title>
+ <abstract>This is a discussion of how users can progress to
+ 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
+ <link
href="http://marc.theaimsgroup.com/?l=forrest-dev&m=112239074108858";>this</link>.
+ Further editing of this page is needed and would
+ be greatly appreciated.</note>
+ <p>Committer is an Apache term used 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
+ Apache Way<sup>1</sup>
+ is that we don't really care about code, it is the
+ community we care about. This is because a strong and healthy
+ community will usually generate strong and healthy code. As a result
+ of the Apache focus on community it is more important for people here
+ to discuss and explore within the community.</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
+ 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
+ minds of the authors</li>
+ <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>
+ </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>
+ </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>
+ </section>
+ <section id="references">
+ <title>References</title>
+ <p><sup>1</sup> See more information about "the Apache Way" in the
+ <link href="http://www.apache.org/foundation/how-it-works.html";>ASF How
it works</link>.</p>
+ <p><sup>2</sup>
+ Apache Forrest
+ <link href="site:guidelines">project guidelines</link>.
+ </p>
+ </section>
+ </body>
+</document>
\ No newline at end of file
Propchange: forrest/site/committed.source.xml
------------------------------------------------------------------------------
svn:eol-style = native
Added: forrest/site/contrib.source.xml
URL:
http://svn.apache.org/viewcvs/forrest/site/contrib.source.xml?rev=376128&view=auto
==============================================================================
--- forrest/site/contrib.source.xml (added)
+++ forrest/site/contrib.source.xml Wed Feb 8 16:26:20 2006
@@ -0,0 +1,283 @@
+<?xml version="1.0" encoding="ISO-8859-1"?><!--
+ Copyright 2002-2005 The Apache Software Foundation or its licensors,
+ as applicable.
+
+ Licensed under the Apache License, Version 2.0 (the "License");
+ you may not use this file except in compliance with the License.
+ You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+--><!DOCTYPE document PUBLIC "-//APACHE//DTD Documentation V1.2//EN"
"http://forrest.apache.org/dtd/document-v12.dtd";>
+<document>
+ <header>
+ <title>Contributing to Apache Forrest</title>
+ </header>
+ <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 (money, time, publicity, hardware, software,
conference
+ presentations, speeches, etc...). </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:SVN">latest and
+ greatest code</link> (which you find in the Forrest module in the SVN
code
+ repository. Review the todo list, choose a task (or perhaps you have
noticed
+ something that needs patching). Make the changes, do the testing,
generate a
+ patch, and post to 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:
+ </p>
+ <ul>
+ <li>Assisting to improve documentation.</li>
+ <li>Testing Forrest (especially its less-frequently-used features) on
+ various configurations and reporting back.</li>
+ <li>Debugging - producing reproduceable test cases and/or finding
+ causes of bugs. Some known bugs are informally listed on To Do, and
some are
+ recorded as issues (see <link href="#procedure">explanation
+ 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
+ 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
+ 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
+ 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>
+ <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.
+ </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.
+ </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.
+ </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,
+ 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.
+ </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>
+ <source xml:space="preserve">svn sw
https://svn.apache.org/repos/asf/forrest/trunk</source>
+ <p>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>
+ </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
+ confusion. This section explains when to use the developer
+ <link href="site:mail-lists">mailing list</link> and the
+ <link href="site:forrest-issues">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).
+ </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.
+ </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>
+ </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>
+ <ul>
+ <li>See general ASF
+ <link href="http://www.apache.org/dev/contrib-email-tips.html";>Tips
for email contributors</link></li>
+ <li> Every contribution is worthwhile. Even if the ensuing discussion
+ proves it to be off-beam, then it may jog ideas for other people.
</li>
+ <li> Use sensible and concise email subject headings. Search engines,
+ and humans trying to browse a voluminous list, will respond
favourably to a
+ descriptive title. </li>
+ <li>Start new threads with new Subject for new topics, rather than
+ reusing the previous Subject line. </li>
+ <li>Keep each topic focused. If some new topic arises then start a new
+ discussion. This leaves the original topic to continue uncluttered.
</li>
+ <li>Whenever you decide to start a new topic, then start with a fresh
+ new email message window. Do not use the "Reply to" button, because
+ threaded mail-readers get confused (they utilise the
<code>In-reply-to</code>
+ header). If so, then your new topic will get lost in the previous
thread and go
+ unanswered. </li>
+ <li> Prepend your email subject line with a marker when that is
+ appropriate, e.g. <code>[Proposal]</code>,
+ <code>[RT]</code> (Random Thought which quickly blossom into
research topics
+ :-), <code>[STATUS]</code> (development status of a certain
facility). </li>
+ <li> When making changes to XML documentation, or any XML document for
+ that matter, use a validating XML editor. Here is some assistance
+ with editor
+ <link href="site:v0.70//catalog">configuration</link>.
+ </li>
+ <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
+ 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
+ statement. </li>
+ <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
+ 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
+ SVN. </li>
+ <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
+ 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,
+ you will see the way other people do things. Follow the leading
examples. </li>
+
+ </ul>
+ </section>
+ </body>
+</document>
\ No newline at end of file
Propchange: forrest/site/contrib.source.xml
------------------------------------------------------------------------------
svn:eol-style = native
Added: forrest/site/docs_0_60/build.source.xml
URL:
http://svn.apache.org/viewcvs/forrest/site/docs_0_60/build.source.xml?rev=376128&view=auto
==============================================================================
--- forrest/site/docs_0_60/build.source.xml (added)
+++ forrest/site/docs_0_60/build.source.xml Wed Feb 8 16:26:20 2006
@@ -0,0 +1,105 @@
+<?xml version="1.0" encoding="ISO-8859-1"?><!--
+ Copyright 2002-2004 The Apache Software Foundation or its licensors,
+ as applicable.
+
+ Licensed under the Apache License, Version 2.0 (the "License");
+ you may not use this file except in compliance with the License.
+ You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+--><!DOCTYPE document PUBLIC "-//APACHE//DTD Documentation V1.2//EN"
"http://forrest.apache.org/dtd/document-v12.dtd";>
+<document>
+ <header>
+ <title>Building Forrest</title>
+ </header>
+ <body>
+ <section id="getting_from_source">
+ <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>
+ <li>Make sure you have a recent release of a
+ <link href="http://subversion.tigris.org/";>Subversion</link>
+ client installed and properly configured.</li>
+ <li>Read the ASF notes about source repositories and
+ <link href="http://www.apache.org/dev/version-control.html";>version
control</link>.
+ </li>
+ <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.
+ </p>
+ </section>
+
+ <section id="snapshot">
+ <title>Using source snapshots</title>
+ <p>It is preferable to use SVN, but if you cannot for some reason, then
+ <link href="site:download">source snapshots</link> are available
+ (automatically packed every six hours).
+ </p>
+ </section>
+ </section>
+
+ <section id="building">
+ <title>Building and Installing Forrest</title>
+<note>
+This document applies to the past 0.6 release version.
+</note>
+ <p>
+ To build Forrest, type '<code>build</code>' on Windows, or
'<code>./build.sh</code>' on
+ Unix. If everything is successful, you should see a message like this:
+ </p>
+ <source xml:space="preserve">
+ *-----------------------------------------------------------------
+ | installation notice
+ *-----------------------------------------------------------------
+ | You have built the distribution of Forrest.
+ | Please set the environment variable FORREST_HOME point to src/core
+ | It is recommended to add
+ | unix: $FORREST_HOME/bin: to your $PATH
+ | win: %FORREST_HOME%\bin; to your %PATH%
+ | Then do 'forrest -projecthelp' to list options for the 'forrest' command
+ | 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 xml:space="preserve">
+~/apache/forrest$ export FORREST_HOME=`pwd`/src/core
+~/apache/forrest$ export PATH=$PATH:$FORREST_HOME/bin
+ </source>
+ <p>
+ After updating the Forrest source from SVN if there have been certain
types of
+ updates (to the Java source for xml-forrest.jar), you will have to
build forrest again.
+ </p>
+ </section>
+
+ <section id="run">
+ <title>Run Forrest, run!</title>
+ <p>Forrest is now ready to go. Type '<code>forrest run</code>' to see
+ the local webapp using the bundled Jetty server. Edit some of Forrest's
+ core documentation and see the effect.
+ The document <link href="site:v0.60//your-project">Using Forrest</link> is
+ your next step.</p>
+ </section>
+
+</body>
+</document>
\ No newline at end of file
Propchange: forrest/site/docs_0_60/build.source.xml
------------------------------------------------------------------------------
svn:eol-style = native
Added: forrest/site/docs_0_60/cap.source.xml
URL:
http://svn.apache.org/viewcvs/forrest/site/docs_0_60/cap.source.xml?rev=376128&view=auto
==============================================================================
--- forrest/site/docs_0_60/cap.source.xml (added)
+++ forrest/site/docs_0_60/cap.source.xml Wed Feb 8 16:26:20 2006
@@ -0,0 +1,81 @@
+<?xml version="1.0" encoding="ISO-8859-1"?><!--
+ Copyright 2002-2005 The Apache Software Foundation or its licensors,
+ as applicable.
+
+ Licensed under the Apache License, Version 2.0 (the "License");
+ you may not use this file except in compliance with the License.
+ You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+--><!-- 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 the sitemap. Example:</p>
+ <source xml:space="preserve"><![CDATA[<map:action name="sourcetype"
src="org.apache.cocoon.acting.sourcetype.SourceTypeAction">
+ <sourcetype name="documentv13">
+ <document-declaration public-id="-//APACHE//DTD Documentation V1.3//EN"/>
+ </sourcetype>
+ <sourcetype name="foo">
+ <document-element local-name="foo">
+ </sourcetype>
+</map:action>]]></source>
+ <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>
+ <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>
+ <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>
+ <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>
+ </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 xml:space="preserve"><![CDATA[<map:act type="sourcetype"
src="{1}">
+...
+</map:act>]]></source>
+ </section>
+ </body>
+</document>
\ No newline at end of file
Propchange: forrest/site/docs_0_60/cap.source.xml
------------------------------------------------------------------------------
svn:eol-style = native
Added: forrest/site/docs_0_60/catalog.source.xml
URL:
http://svn.apache.org/viewcvs/forrest/site/docs_0_60/catalog.source.xml?rev=376128&view=auto
==============================================================================
--- forrest/site/docs_0_60/catalog.source.xml (added)
+++ forrest/site/docs_0_60/catalog.source.xml Wed Feb 8 16:26:20 2006
@@ -0,0 +1,234 @@
+<?xml version="1.0" encoding="ISO-8859-1"?><!--
+ Copyright 2002-2005 The Apache Software Foundation or its licensors,
+ as applicable.
+
+ Licensed under the Apache License, Version 2.0 (the "License");
+ you may not use this file except in compliance with the License.
+ You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+--><!DOCTYPE document PUBLIC "-//APACHE//DTD Documentation V1.2//EN"
"http://forrest.apache.org/dtd/document-v12.dtd";>
+<document>
+ <header>
+ <title>Using Catalog Entity Resolver for local DTDs</title>
+ </header>
+ <body>
+ <section id="overview">
+ <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).
+ </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.
+ </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.
+ </p>
+ <note>
+ 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>
+ The Forrest DTDs and supporting resources are in the Forrest
+ distribution at <code>src/core/context/resources/schema/</code>
+ </p>
+ <p>
+ Usually all that is required is to direct your tool to the "catalog"
+ supplied by Forrest at either:
+ <code>$FORREST/src/core/context/resources/schema/catalog.xcat</code>
+ (for XML Catalog) or
+ <code>$FORREST/src/core/context/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
+ <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 xml:space="preserve"><![CDATA[
+<nextCatalog
+catalog="/usr/local/svn/forrest/src/core/context/resources/schema/catalog.xcat"/>
+ ]]></source>
+ <p>
+ For a TR 9401 Catalog, add this line:
+ </p>
+ <source xml:space="preserve"><![CDATA[
+CATALOG \
+"/usr/local/svn/forrest/src/core/context/resources/schema/catalog"
+ ]]></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.
+ </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.
+ </p>
+ <source xml:space="preserve">
+export SGML_CATALOG_FILES=$SGML_CATALOG_FILES:\
+$FORREST/src/core/context/resources/schema/catalog
+xmllint --valid --catalogs --noout mydoc.xml
+ </source>
+ </section>
+
+ <section id="vim">
+ <title>Vim</title>
+ <p>
+ The following .vimrc entries are useful:
+ </p>
+ <source xml:space="preserve">
+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>
+ </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:
+ </p>
+ <source xml:space="preserve">
+SGMLDECL "/usr/share/sgml/xml.dcl"
+CATALOG \
+"/usr/local/svn/forrest/src/core/context/resources/schema/catalog"
+ </source>
+ <p>
+ Then point the parser at it:
+ </p>
+ <source xml:space="preserve">
+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 xml:space="preserve"><![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/src/core/context/resources/schema/catalog"
+ ]]></source>
+ </section>
+
+ <section id="oxygenxml">
+ <title>oXygen XML Editor</title>
+ <source xml:space="preserve"><![CDATA[
+Select the menu:
+External Tools > Preferences > XML Catalog
+Specify the XML Catalog file:
+"forrest/src/core/context/resources/schema/catalog.xcat"
+ ]]></source>
+ </section>
+
+ <section id="xmlspy">
+ <title>xmlspy</title>
+ <source xml:space="preserve"><![CDATA[
+Add the following entry to the file CustomCatalog.xml
+(located in XMLSpy install directory):
+
+<nextCatalog
+catalog="file://localhost/C:/apache/forrest/src/core/
+context/resources/schema/catalog.xcat"/>
+ ]]></source>
+ </section>
+
+ <section id="xxe">
+ <title>XMLmind XML Editor (XXE)</title>
+ <section>
+ <title>XXE v2.5p2 or older</title>
+ <source xml:space="preserve"><![CDATA[
+Select the menu:
+Options > Options > Schema > Add File
+Specify the XML Catalog file:
+"forrest/src/core/context/resources/schema/catalog.xcat"
+ ]]></source>
+ </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>
+ </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
+ <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.60//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>
+</document>
\ No newline at end of file
Propchange: forrest/site/docs_0_60/catalog.source.xml
------------------------------------------------------------------------------
svn:eol-style = native
