You are viewing a plain text version of this content. The canonical link for it is here.
Posted to site-svn@forrest.apache.org by cr...@apache.org on 2007/04/10 06:44:05 UTC
svn commit: r527020 [3/20] - in /forrest/site: ./ docs_0_80/
docs_0_80/howto/ docs_0_80/howto/cvs-ssh/ docs_0_80/howto/multi/ dtdx/
plan/ pluginDocs/plugins_0_70/ pluginDocs/plugins_0_80/ procedures/
procedures/release/ skins/ tools/
Modified: forrest/site/contrib.html
URL: http://svn.apache.org/viewvc/forrest/site/contrib.html?view=diff&rev=527020&r1=527019&r2=527020
==============================================================================
--- forrest/site/contrib.html (original)
+++ forrest/site/contrib.html Mon Apr 9 21:44:00 2007
@@ -266,35 +266,44 @@
<a name="N1000D"></a><a name="introduction"></a>
<h2 class="underlined_10">Introduction</h2>
<div class="section">
-<p> The Forrest Project is an <a href="http://www.opensource.org/">Open Source</a> 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
- <a href="http://www.apache.org/foundation/thanks.html">donations</a>
- via the ASF.
- </p>
-<p> To begin with, we suggest you to subscribe to the
- <a href="mail-lists.html">Forrest mailing lists</a> (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
- <a href="docs_0_80/howto/../build.html">latest and
- greatest code</a> (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 <a href="http://www.opensource.org/">Open
+ Source</a> 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
+ <a href="http://www.apache.org/foundation/thanks.html">donations</a>
+ via the ASF.
+ </p>
+<p>
+ To begin with, we suggest you to subscribe to the
+ <a href="mail-lists.html">Forrest mailing lists</a> (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
+ <a href="docs_0_80/howto/../build.html">latest and greatest code</a> (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>
</div>
<a name="N10030"></a><a name="wanted"></a>
<h2 class="underlined_10">Help Wanted Here</h2>
<div class="section">
-<p>We would be glad to have extra help in any of the following areas:
+<p>
+ We would be glad to have extra help in any of the following areas:
</p>
<ul>
@@ -313,7 +322,7 @@
<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 <span class="codefrag">forrest-dev</span> mailing
list, install and try out Forrest and read some of the
@@ -321,13 +330,13 @@
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 <span class="codefrag">.zip</span> and <span class="codefrag">.tar.gz</span> packages, but anyone is
welcome to build their own specific packages and announce them on the
<span class="codefrag">forrest-dev</span> 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.
@@ -335,174 +344,195 @@
</ul>
</div>
-
<a name="N10069"></a><a name="issues"></a>
<h2 class="underlined_10">Procedure for reporting bugs and issues and enhancement suggestions</h2>
<div class="section">
<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 <a href="mail-lists.html">mailing lists</a>.
- However, please check our Issue Tracker first as it may be already reported.
+ improvement, then please discuss it on one of the
+ <a href="mail-lists.html">mailing lists</a>. However, please check
+ our Issue Tracker first as it may be already reported.
</p>
<p>
The <a href="issues.html">Apache Forrest Issue Tracker</a> 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>
</div>
-
<a name="N10084"></a><a name="cvshowto"></a>
<h2 class="underlined_10">SVN Usage</h2>
<div class="section">
-<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 <a href="docs_0_70/build.html">Building Forrest</a> document explains.
+<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
+ <a href="docs_0_70/build.html">Building Forrest</a> document
+ explains.
</p>
</div>
-
<a name="N10092"></a><a name="ssh"></a>
<h2 class="underlined_10">SVN Committer with Secure Shell access</h2>
<div class="section">
-<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 <a href="http://www.apache.org/dev/">ASF developers resources</a>
- especially the
- <a href="http://www.apache.org/dev/version-control.html">Source code repositories</a>.
- </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>
+<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
+ <a href="http://www.apache.org/dev/">ASF developers resources</a>
+ especially the
+ <a href="http://www.apache.org/dev/version-control.html">Source code
+ repositories</a>.
+ </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>
<pre class="code">svn sw https://svn.apache.org/repos/asf/forrest/trunk</pre>
<a name="svn-config"></a>
-<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
<a href="http://www.apache.org/dev/version-control.html#https-svn">configured</a>
- 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 <span class="codefrag">svn propset svn:eol-style native myfilename.txt</span>
- and <span class="codefrag">svn commit -m "fix line endings" myfilename.txt</span>
+ 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 <span class="codefrag">svn
+ propset svn:eol-style native myfilename.txt</span> and <span class="codefrag">svn commit
+ -m "fix line endings" myfilename.txt</span>
</p>
</div>
-
<a name="N100B9"></a><a name="procedure"></a>
<h2 class="underlined_10">Procedure for Raising Development Issues</h2>
<div class="section">
-<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
+<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
<a href="mail-lists.html">mailing list</a> and the
- <a href="issues.html">issue tracker</a>. </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>
+ <a href="issues.html">issue tracker</a>.
+ </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>
</div>
-
<a name="N100DA"></a><a name="patch"></a>
<h2 class="underlined_10">How to prepare and contribute patches</h2>
<div class="section">
-<p>If you use the current development version of Forrest via Subversion,
- then do
- '<span class="codefrag">svn update; svn status</span>' to see what files that you
- have changed.
- Do '<span class="codefrag">svn diff > mypatch.txt</span>' to make a patch which
- includes every change. To make a patch for a specific file, do
- <span class="codefrag">svn diff src/documentation/content/xdocs/faq.xml > faq.xml.diff</span>'.
- 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
- <a href="http://svnbook.red-bean.com/">Version Control with
- Subversion</a> - 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:
- '<span class="codefrag">diff -u faq.xml.orig faq.xml > mypatch.txt</span>' (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
- <a href="http://svn.apache.org/repos/asf/forrest/trunk/site-author/content/xdocs/">SVN server</a>
- (and tell us which Revision number you used).
+<p>
+ If you use the current development version of Forrest via Subversion,
+ then do '<span class="codefrag">svn update; svn status</span>' to see what files that you
+ have changed. Do '<span class="codefrag">svn diff > mypatch.txt</span>' to make a patch
+ which includes every change. To make a patch for a specific file, do
+ <span class="codefrag">svn diff src/documentation/content/xdocs/faq.xml >
+ faq.xml.diff</span>'. 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
+ <a href="http://svnbook.red-bean.com/">Version Control with
+ Subversion</a> - 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: '<span class="codefrag">diff -u
+ faq.xml.orig faq.xml > mypatch.txt</span>' (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
+ <a href="http://svn.apache.org/repos/asf/forrest/trunk/site-author/content/xdocs/">SVN
+ server</a> (and tell us which Revision number you used).
</p>
<div class="note">
<div class="label">Note</div>
-<div class="content">Please send all contributions via our
- <a href="issues.html">issue tracker</a>.
- and specify the Forrest version or svn version of the source.
+<div class="content">
+ Please send all contributions via our <a href="issues.html">issue
+ tracker</a>. and specify the Forrest version or svn version of the
+ source.
</div>
</div>
<p>
It is always a good idea to check the Forrest
- <a href="issues.html">issue tracker</a>
- before diving in.
+ <a href="issues.html">issue tracker</a> before diving in.
</p>
</div>
-
<a name="N1010C"></a><a name="revert"></a>
<h2 class="underlined_10">How to revert changes in SVN</h2>
<div class="section">
-<p>Check out <a 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</a>
- for instructions on how to revert (roll back) changes to svn.</p>
+<p>
+ Check out
+ <a 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</a>
+ for instructions on how to revert (roll back) changes to svn.
+ </p>
</div>
-
<a name="N1011A"></a><a name="tips"></a>
<h2 class="underlined_10">Contribution Notes and Tips</h2>
<div class="section">
-<p> This is a collection of tips for contributing to the project in a
- manner that is productive for all parties. </p>
+<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
@@ -538,43 +568,42 @@
with editor
<a href="docs_0_70/catalog.html">configuration</a>.
</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>
</div>
Modified: forrest/site/doap.xml
URL: http://svn.apache.org/viewvc/forrest/site/doap.xml?view=diff&rev=527020&r1=527019&r2=527020
==============================================================================
--- forrest/site/doap.xml (original)
+++ forrest/site/doap.xml Mon Apr 9 21:44:00 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/site/docs_0_80/body-index.html
URL: http://svn.apache.org/viewvc/forrest/site/docs_0_80/body-index.html?view=diff&rev=527020&r1=527019&r2=527020
==============================================================================
--- forrest/site/docs_0_80/body-index.html (original)
+++ forrest/site/docs_0_80/body-index.html Mon Apr 9 21:44:00 2007
@@ -24,29 +24,32 @@
<div id="disable-font-script"></div>
<h1>Apache Forrest documentation</h1>
<div id="skinconf-toc-page"></div>
-
+
<p>
- A good place to get started in our docs is the <a href="your-project.html">Using Forrest</a>
- guide.
- </p>
-
-<p>In the <a href="howto/index.html">How-To</a> section you will find various
- practical guides on how to achieve common objectives in Forrest.</p>
-
-<p>We also have a <a href="faq.html">FAQ</a> list that you should consult before posting questions to
- our user list.</p>
-
+ A good place to get started in our docs is the
+ <a href="your-project.html">Using Forrest</a> guide.
+ </p>
+
<p>
- The documentation <a href="../linkmap.html">Table of Contents</a> provides a
- useful overview of the main documentation. <a href="../docs_0_80/faq.html#docs">This FAQ</a>
- explains that there is other documentation at the example forrest seed
- site and that each plugin has its own documentation.
- </p>
-
+ In the <a href="howto/index.html">How-To</a> section you will find various
+ practical guides on how to achieve common objectives in Forrest.
+ </p>
+
<p>
- There are docs for
- <a href="../versions/index.html">other versions</a>
- too.
- </p>
+ We also have a <a href="faq.html">FAQ</a> list that you should consult
+ before posting questions to our user list.
+ </p>
+
+<p>
+ The documentation <a href="../linkmap.html">Table of Contents</a> provides a
+ useful overview of the main documentation. <a href="../docs_0_80/faq.html#docs">This
+ FAQ</a> explains that there is other documentation at the example forrest
+ seed site and that each plugin has its own documentation.
+ </p>
+
+<p>
+ There are docs for <a href="../versions/index.html">other versions</a>
+ too.
+ </p>
</div>
Modified: forrest/site/docs_0_80/build.html
URL: http://svn.apache.org/viewvc/forrest/site/docs_0_80/build.html?view=diff&rev=527020&r1=527019&r2=527020
==============================================================================
--- forrest/site/docs_0_80/build.html (original)
+++ forrest/site/docs_0_80/build.html Mon Apr 9 21:44:00 2007
@@ -346,10 +346,13 @@
<h3 class="underlined_5">Step-by-step Subversion (SVN) instructions</h3>
<div class="note">
<div class="label">Note</div>
-<div class="content">If you are behind a proxy, see
- <a href="http://subversion.tigris.org/project_faq.html#proxy">this FAQ</a>.</div>
+<div class="content">
+ If you are behind a proxy, see
+ <a href="http://subversion.tigris.org/project_faq.html#proxy">this
+ FAQ</a>.
+ </div>
</div>
-<ol>
+<ol>
<li>Make sure you have a recent release of a
<a href="http://subversion.tigris.org/">Subversion</a>
@@ -363,36 +366,42 @@
'<span class="codefrag">svn co http://svn.apache.org/repos/asf/forrest/trunk forrest</span>'
(committers should replace <span class="codefrag">http</span> with <span class="codefrag">https</span>).</li>
-<li>This will create a directory called "<span class="codefrag">forrest</span>" where the Forrest source will be stored.</li>
+<li>This will create a directory called "<span class="codefrag">forrest</span>" 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
-"<span class="codefrag">forrest</span>" directory and invoke '<span class="codefrag">svn update</span>'.</p>
-<p>To see what changes you've made, invoke '<span class="codefrag">svn status</span>'</p>
-<p>SVN is really powerful. See
- <a href="http://svnbook.red-bean.com/">Version Control with Subversion</a> - the opensource SVN book.
+<p>
+ Whenever you want to update your Forrest source tree to the current
+ version, change to the top-level "<span class="codefrag">forrest</span>" directory and
+ invoke '<span class="codefrag">svn update</span>'.
+ </p>
+<p>
+ To see what changes you've made, invoke '<span class="codefrag">svn status</span>'
+ </p>
+<p>
+ SVN is really powerful. See
+ <a href="http://svnbook.red-bean.com/">Version Control with
+ Subversion</a> - the opensource SVN book.
</p>
</div>
-
-
+
<a name="N1005B"></a><a name="building"></a>
<h2 class="underlined_10">Building and installing Forrest</h2>
<div class="section">
<div class="note">
<div class="label">Note</div>
<div class="content">
-This document applies to the current 0.7 release version.
-See other instructions for the current development
-<a href="http://forrest.apache.org/docs/dev/build.html">0.8-dev</a> version.
-</div>
+ This document applies to the current 0.7 release version. See other
+ instructions for the current development
+ <a href="http://forrest.apache.org/docs/dev/build.html">0.8-dev</a>
+ version.
+ </div>
</div>
<p>
- To build Forrest, change directory to '<span class="codefrag">forrest/main</span>', and
- then type '<span class="codefrag">build</span>' on Windows or '<span class="codefrag">./build.sh</span>' on
- Unix. (Requires Java 1.4)
- If everything is successful, you should see a message similar to:
- </p>
+ To build Forrest, change directory to '<span class="codefrag">forrest/main</span>', and
+ then type '<span class="codefrag">build</span>' on Windows or '<span class="codefrag">./build.sh</span>'
+ on Unix. (Requires Java 1.4) If everything is successful, you should see
+ a message similar to:
+ </p>
<pre class="code">
*-----------------------------------------------------------------
| Installation notice
@@ -408,10 +417,10 @@
*-----------------------------------------------------------------
</pre>
<p>
- As the message says, you need to add the distribution's <span class="codefrag">bin/</span>
- ("binary") directory to your PATH variable, so the <span class="codefrag">'forrest'</span>
- command is available everywhere:
- </p>
+ As the message says, you need to add the distribution's
+ <span class="codefrag">bin/</span> ("binary") directory to your PATH variable, so the
+ <span class="codefrag">'forrest'</span> command is available everywhere:
+ </p>
<pre class="code">
[~]$ cd /path/to/svn/forrest
[/svn/forrest]$ export FORREST_HOME=`pwd`
@@ -420,30 +429,29 @@
<div class="warning">
<div class="label">Warning</div>
<div class="content">
- 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".
- </div>
+ 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".
+ </div>
</div>
</div>
-
-
+
<a name="N10089"></a><a name="run"></a>
<h2 class="underlined_10">Run Forrest, run!</h2>
<div class="section">
<p>
- Forrest is now ready to go. To view and edit the local copy of
- Forrest core documentation, cd to site-author and do
- '<span class="codefrag">forrest run</span>' to see
- the local webapp using the bundled Jetty server. Edit something in
- content/xdocs/*.xml see the immediate effect.
- </p>
+ Forrest is now ready to go. To view and edit the local copy of Forrest
+ core documentation, cd to site-author and do '<span class="codefrag">forrest run</span>'
+ to see the local webapp using the bundled Jetty server. Edit something
+ in content/xdocs/*.xml see the immediate effect.
+ </p>
<p>
- The document <a href="../docs_0_80/your-project.html">Using Forrest</a> is
- your next step.</p>
+ The document <a href="../docs_0_80/your-project.html">Using Forrest</a> is your
+ next step.
+ </p>
</div>
-
-
+
</div>
<!--+
|end content
Modified: forrest/site/docs_0_80/cap.html
URL: http://svn.apache.org/viewvc/forrest/site/docs_0_80/cap.html?view=diff&rev=527020&r1=527019&r2=527020
==============================================================================
--- forrest/site/docs_0_80/cap.html (original)
+++ forrest/site/docs_0_80/cap.html Mon Apr 9 21:44:00 2007
@@ -332,33 +332,41 @@
<a href="#Usage">Usage</a>
</li>
</ul>
-</div>
+</div>
<a name="N1000E"></a><a name="Introduction"></a>
<h2 class="underlined_10">Introduction</h2>
<div class="section">
-<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>
-</div>
+<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>
+</div>
<a name="N1001B"></a><a name="Configuration"></a>
<h2 class="underlined_10">Configuration</h2>
<div class="section">
-<p>The action should be declared and configured in the map:actions
- section of your sitemap. Example:</p>
-<pre class="code"><map:sitemap xmlns:map="http://apache.org/cocoon/sitemap/1.0">
+<p>
+ The action should be declared and configured in the map:actions section
+ of your sitemap. Example:
+ </p>
+<pre class="code">
+<map:sitemap xmlns:map="http://apache.org/cocoon/sitemap/1.0">
<map:components>
- <...>
- <strong><map:actions>
+ <...><strong>
+<map:actions>
<map:action name="sourcetype"
src="org.apache.forrest.sourcetype.SourceTypeAction">
<sourcetype name="download-v1.0">
@@ -367,63 +375,76 @@
</sourcetype>
</map:action>
</map:actions></strong>
+
</map:components>
<...>
-</map:sitemap></pre>
-<p>There are other examples in <span class="codefrag">main/webapp/forrest.xmap</span>
+</map:sitemap>
+ </pre>
+<p>
+ There are other examples in <span class="codefrag">main/webapp/forrest.xmap</span>
+
</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>
+<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>
+<dt>document-declaration</dt>
<dd>This rule checks the public ID. It takes one attribute
- <span class="codefrag">public-id</span>.</dd>
+ <span class="codefrag">public-id</span>.</dd>
-<dt>document-element</dt>
+<dt>document-element</dt>
<dd>This rule checks the local name and/or namespace of the document
element. These are specified with the attributes <span class="codefrag">local-name</span> and
- <span class="codefrag">namespace</span>. At least one of these two is required.</dd>
+ <span class="codefrag">namespace</span>. At least one of these two is required.</dd>
-<dt>processing-instruction</dt>
+<dt>processing-instruction</dt>
<dd>This rule checks a processing instruction. It can take two
attributes: <span class="codefrag">target</span> and <span class="codefrag">data</span>. The target attribute is
- always required, the data attribute is optional.</dd>
+ always required, the data attribute is optional.</dd>
-<dt>w3c-xml-schema</dt>
+<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 <span class="codefrag">schema-location</span> and
- <span class="codefrag">no-namespace-schema-location</span>.</dd>
+ <span class="codefrag">no-namespace-schema-location</span>.</dd>
</dl>
<p>
- Perhaps you need other methods. Please enhance the source at
- <span class="codefrag">main/java/org/apache/forrest/sourcetype</span>
+ Perhaps you need other methods. Please enhance the source at
+ <span class="codefrag">main/java/org/apache/forrest/sourcetype</span>
</p>
-</div>
+</div>
-<a name="N1006D"></a><a name="Usage"></a>
+<a name="N1006E"></a><a name="Usage"></a>
<h2 class="underlined_10">Usage</h2>
<div class="section">
-<p>The source of which the sourcetype must be defined must be specified
- using the 'src' attribute on the map:act element.</p>
-<pre class="code"><map:act type="sourcetype" src="{1}">
+<p>
+ The source of which the sourcetype must be defined must be specified
+ using the 'src' attribute on the map:act element.
+ </p>
+<pre class="code">
+<map:act type="sourcetype" src="{1}">
...
-</map:act></pre>
-<p>See a real-life example in the advanced section of the
- <a href="your-project.html#adding_new_content_type_2">Using Forrest</a>
- document.
+</map:act>
+ </pre>
+<p>
+ See a real-life example in the advanced section of the
+ <a href="your-project.html#adding_new_content_type_2">Using
+ Forrest</a> document.
</p>
-</div>
+</div>
</div>
<!--+
Modified: forrest/site/docs_0_80/cap.pdf
URL: http://svn.apache.org/viewvc/forrest/site/docs_0_80/cap.pdf?view=diff&rev=527020&r1=527019&r2=527020
==============================================================================
Binary files - no diff available.
Modified: forrest/site/docs_0_80/catalog.html
URL: http://svn.apache.org/viewvc/forrest/site/docs_0_80/catalog.html?view=diff&rev=527020&r1=527019&r2=527020
==============================================================================
--- forrest/site/docs_0_80/catalog.html (original)
+++ forrest/site/docs_0_80/catalog.html Mon Apr 9 21:44:00 2007
@@ -379,26 +379,25 @@
<div class="section">
<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>
<div class="note">
<div class="label">Note</div>
<div class="content">
- The information provided here is not intended to endorse any
- particular tool.
+ The information provided here is not intended to endorse any particular
+ tool.
</div>
</div>
<p>
@@ -406,7 +405,6 @@
please send them to the forrest-dev mailing list.
</p>
</div>
-
<a name="N10023"></a><a name="config"></a>
<h2 class="underlined_10">General configuration notes</h2>
@@ -421,11 +419,10 @@
supplied by Forrest at either:
<span class="codefrag">$FORREST_HOME/main/webapp/resources/schema/catalog.xcat</span>
(for XML Catalog) or
- <span class="codefrag">$FORREST_HOME/main/webapp/resources/schema/catalog</span>
- (for TR 9401 Catalog).
+ <span class="codefrag">$FORREST_HOME/main/webapp/resources/schema/catalog</span> (for TR
+ 9401 Catalog).
</p>
</div>
-
<a name="N10039"></a><a name="tools"></a>
<h2 class="underlined_10">Configuring specific tools</h2>
@@ -433,8 +430,8 @@
<a name="N1003F"></a><a name="system"></a>
<h3 class="underlined_5">Operating system catalog</h3>
<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
<span class="codefrag">/etc/xml/catalog</span> or at
<span class="codefrag">/usr/share/sgml/catalog</span> files.
</p>
@@ -442,28 +439,31 @@
For an XML Catalog, add this line:
</p>
<pre class="code">
+
<nextCatalog
catalog="/usr/local/svn/forrest/main/webapp/resources/schema/catalog.xcat"/>
+
</pre>
<p>
For a TR 9401 Catalog, add this line:
</p>
<pre class="code">
+
CATALOG \
"/usr/local/svn/forrest/main/webapp/resources/schema/catalog"
+
</pre>
<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>
<a name="N10060"></a><a name="xmllint"></a>
<h3 class="underlined_5">xmllint validating parser</h3>
<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>
<pre class="code">
export SGML_CATALOG_FILES=$SGML_CATALOG_FILES:\
@@ -473,30 +473,30 @@
<a name="N1006E"></a><a name="vim"></a>
<h3 class="underlined_5">Vim</h3>
<p>
- The following .vimrc entries are useful:
- </p>
+ The following .vimrc entries are useful:
+ </p>
<pre class="code">
au FileType xml set efm=%A%f:%l:\ %.%#error:\ %m,%-Z%p^,%-C%.%#
au FileType xml set makeprg=xmllint\ --noout\ --valid\ --catalogs\ %
</pre>
<p>
- See other notes about using
- <a href="http://www.pinkjuice.com/howto/vimxml/">Vim as XML editor</a>.
+ See other notes about using
+ <a href="http://www.pinkjuice.com/howto/vimxml/">Vim as XML
+ editor</a>.
</p>
<a name="N10083"></a><a name="emacs"></a>
<h3 class="underlined_5">Emacs</h3>
-<p>See
- <a href="http://www.thaiopensource.com/nxml-mode/">nXML mode</a>
- and
- <a href="http://www.dpawson.co.uk/relaxng/nxml/">FAQ</a>.
+<p>
+ See <a href="http://www.thaiopensource.com/nxml-mode/">nXML
+ mode</a> and
+ <a href="http://www.dpawson.co.uk/relaxng/nxml/">FAQ</a>.
</p>
<a name="N10095"></a><a name="onsgmls"></a>
<h3 class="underlined_5">onsgmls validating parser</h3>
<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>
<pre class="code">
SGMLDECL "/usr/share/sgml/xml.dcl"
@@ -512,58 +512,68 @@
<a name="N100AA"></a><a name="jedit"></a>
<h3 class="underlined_5">jEdit - Open Source programmer's text editor</h3>
<pre class="code">
+
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"
+
</pre>
<pre class="code">
+
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"
+
</pre>
<a name="N100B9"></a><a name="oxygenxml"></a>
<h3 class="underlined_5">oXygen XML Editor</h3>
<pre class="code">
+
Select the menu:
Options > Preferences > XML Catalog
Specify the XML Catalog file:
"forrest/main/webapp/resources/schema/catalog.xcat"
+
</pre>
<a name="N100C4"></a><a name="xmlspy"></a>
<h3 class="underlined_5">xmlspy</h3>
<pre class="code">
+
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"/>
+
</pre>
<a name="N100CF"></a><a name="xxe"></a>
<h3 class="underlined_5">XMLmind XML Editor (XXE)</h3>
<a name="N100D5"></a><a name="XXE+v2.5p2+or+older"></a>
<h4>XXE v2.5p2 or older</h4>
<pre class="code">
+
Select the menu:
Options > Options > Schema > Add File
Specify the XML Catalog file:
"forrest/main/webapp/resources/schema/catalog.xcat"
- </pre>
+
+ </pre>
<a name="N100E0"></a><a name="XXE+v2.5p3%2B"></a>
<h4>XXE v2.5p3+</h4>
-<p>XXE supports catalogs by automatic detection via configuration files.
- Download the <a target="_blank" href="http://www.splike.com/howtos/xxe_forrest.html">XXE
- Forrest Config</a> 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
+ <a target="_blank" href="http://www.splike.com/howtos/xxe_forrest.html">XXE
+ Forrest Config</a> 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>
</div>
-
<a name="N100F0"></a><a name="info"></a>
<h2 class="underlined_10">Further information and resources</h2>
@@ -571,24 +581,23 @@
<p>
Forrest and Cocoon use the
<a href="http://xml.apache.org/commons/components/resolver/">Catalog
- Entity Resolver</a>
- that is provided by the
+ Entity Resolver</a> that is provided by the
<a href="http://xml.apache.org/commons/">Apache XML Commons</a>
project. The resolver is packaged with the Forrest distribution at
<span class="codefrag">lib/core/xml-commons-resolver-x.y.jar</span>
</p>
<p>
- Other Forrest documentation has some notes about configuring the
- entity resolver for your own DTDs. See
- <a href="../docs_0_80/validation.html">XML Validation</a>.
+ Other Forrest documentation has some notes about configuring the entity
+ resolver for your own DTDs. See <a href="../docs_0_80/validation.html">XML
+ Validation</a>.
</p>
<p>
Cocoon has extensive documentation about the entity resolver. See
<a href="http://cocoon.apache.org/2.1/userdocs/concepts/catalog.html">Entity resolution with catalogs</a>.
</p>
</div>
-
+
</div>
<!--+
|end content
Modified: forrest/site/docs_0_80/catalog.pdf
URL: http://svn.apache.org/viewvc/forrest/site/docs_0_80/catalog.pdf?view=diff&rev=527020&r1=527019&r2=527020
==============================================================================
Binary files - no diff available.
Modified: forrest/site/docs_0_80/dreams.html
URL: http://svn.apache.org/viewvc/forrest/site/docs_0_80/dreams.html?view=diff&rev=527020&r1=527019&r2=527020
==============================================================================
--- forrest/site/docs_0_80/dreams.html (original)
+++ forrest/site/docs_0_80/dreams.html Mon Apr 9 21:44:00 2007
@@ -331,90 +331,90 @@
</li>
</ul>
</div>
-
+
<a name="N10010"></a><a name="Introduction"></a>
<h2 class="underlined_10">Introduction</h2>
<div class="section">
-<p>This is the initial attempt to give focus to the Forrest project.
- This summary is a loose collection of items from the forrest-dev
- mailing list. Please add and re-arrange so that it can evolve into a
- focus document. The <a href="../docs_0_80/primer.html">Forrest Primer</a>
- provides an overview.
- </p>
-<p>These are the email threads and documents that are currently being
- summarised. Please see those documents for further detail.
- </p>
+<p>
+ This is the initial attempt to give focus to the Forrest project. This
+ summary is a loose collection of items from the forrest-dev mailing
+ list. Please add and re-arrange so that it can evolve into a focus
+ document. The <a href="../docs_0_80/primer.html">Forrest Primer</a> provides an
+ overview.
+ </p>
+<p>
+ These are the email threads and documents that are currently being
+ summarised. Please see those documents for further detail.
+ </p>
<ul>
-
+
<li>
[RT] my Forrest dream-list
Date: Wed, 20 Feb 2002
<a href="http://marc.theaimsgroup.com/?l=forrest-dev&m=101431895118349">http://marc.theaimsgroup.com/?l=forrest-dev&m=101431895118349</a>
[done]
</li>
-
+
<li>
README
[FIXME: not yet started summarising]
</li>
-
+
<li>
[phases] Forrest
Date: Fri, 22 Feb 2002
<a href="http://marc.theaimsgroup.com/?l=forrest-dev&m=101445744931104">http://marc.theaimsgroup.com/?l=forrest-dev&m=101445744931104</a>
[FIXME: not yet started summarising]
</li>
-
+
<li>
adding to the dream list
Date: Fri, 15 Mar 2002
<a href="http://marc.theaimsgroup.com/?l=forrest-dev&m=101620970016263">http://marc.theaimsgroup.com/?l=forrest-dev&m=101620970016263</a>
[FIXME: not yet started summarising]
</li>
-
+
<li>
analysis paralysis :-)
Date: Mon, 25 Feb 2002
<a href="http://marc.theaimsgroup.com/?l=forrest-dev&m=101465344708301">http://marc.theaimsgroup.com/?l=forrest-dev&m=101465344708301</a>
[FIXME: not yet started summarising]
</li>
-
+
<li>
documentation architecture?
Date: Thu, 25 Apr 2002
<a href="http://marc.theaimsgroup.com/?l=forrest-dev&m=101973705501466">http://marc.theaimsgroup.com/?l=forrest-dev&m=101973705501466</a>
[FIXME: not yet started summarising]
</li>
-
+
<li>
Topic Maps for Forrest ?
Date: Mon, 18 Mar 2002
<a href="http://marc.theaimsgroup.com/?l=forrest-dev&m=101647290524645">http://marc.theaimsgroup.com/?l=forrest-dev&m=101647290524645</a>
[FIXME: not yet started summarising]
</li>
-
+
</ul>
</div>
-
-
+
<a name="N10051"></a><a name="Draft+dream+list"></a>
<h2 class="underlined_10">Draft dream list</h2>
<div class="section">
<ul>
-
+
<li>
Forrest provides a robust technological infrastructure for open software development for the Apache Software Foundation based on ASF software, ASF practices and experience, and modern software design principles.
</li>
-
+
<li>
a publishing system for documentation
</li>
-
+
<li>
analysis of logs and publishing of results
</li>
-
-
+
<li>
Ok, first of all: "it hurts my spirit" (I should TM this) to see the
apache web sites with such a *poor* information infrastructure. Just
@@ -422,33 +422,28 @@
lots of tools and information that we currently don't have (or have
hidden someplace).
</li>
-
-
+
<li>
I want Forrest to be the development infrastructure of your dreams,
something that you'll be proud of showing your boss and say "if only we
had this in place, we would save big bucks" so...
</li>
-
-
+
<li>
Dream #1: Forrest should make Sourceforge look obsolete.
</li>
-
-
+
<li>
So, in order for this to happen, it must be dynamic.
Assumption #1: Forrest is a dynamic site.
The staticity of apache web sites was mostly due to the quest for heavy
mirroring, Forrest should allow mirroring, so
</li>
-
-
+
<li>
Dream #2: Forrest should reduce xml.apache.org bandwidth use dramatically
</li>
-
-
+
<li>
Dream #3: Forrest should automate mirroring in a simple and easy way.
@@ -457,79 +452,66 @@
rsync or other mean. Anyway, the goal is to make sure mirroring is as
easy as possible. No, easier than that.
</li>
-
-
+
<li>
coherence: all the site should look coherent, same graphics, same
look-and-feel, same information in the same locations, coherent and nice URI
space (build to last! so that broken links are reduced!)
</li>
-
-
+
<li>
structure: the site should look professional, the structure should be
flexible enough to fit every need but solid enough to guide users
browsing and developers adding resources
</li>
-
-
+
<li>
scalability
</li>
-
-
+
<li>
functionality: everything you ever wanted to have in your project web site
</li>
-
-
+
<li>
logs and community rating: I want to have numbers to judge the value
of a community/effort
</li>
-
-
+
<li>
Downloads, number of committers, numbers of people subscribed on the users/dev
list, numbers of mail messages / week on these lists, CVS activity...
These are the kind of parameters I use to "judge" an Apache project that I
have not been looking into before.
</li>
-
-
+
<li>
Graphs of various statistics.
</li>
-
-
+
<li>
Having good site metrics will be a valuable aid to those involved in
maintenance and future re-design phases.
See some discussion in
<a href="http://marc.theaimsgroup.com/?l=forrest-dev&m=102238816218885">http://marc.theaimsgroup.com/?l=forrest-dev&m=102238816218885</a>
-
</li>
-
-
+
<li>
Built-in search engine: users much have a simple way to find things.
Lucene.
</li>
-
-
+
<li>
User-writable pages: people should have a way to add things to the pages.
See the thread for more detail on this.
FIXME: get MARC ref
</li>
-
-
+
<li>
short bios for the project committers, with pictures: gives a better
sense of community. Having a weblog there would be great.
</li>
-
-
+
<li>
news, announcements, events and project calendaring: the news and
the announcements will generate a RSS feed, events will be aggregated
@@ -537,43 +519,35 @@
will also be overwritten on the logs, to indicate how logs were
influenced by the events (say, a release or a new committer added)
</li>
-
-
+
<li>
book-like PDF versions of documentation: easy to print out docs.
</li>
-
-
+
<li>
integration with GUMP: dependencies, runs, committer that broke the run
</li>
-
-
+
<li>
javadocs seemlessly integrated with the documentation and with the
search engine.
<a href="http://marc.theaimsgroup.com/?l=forrest-dev&m=101620970016263">http://marc.theaimsgroup.com/?l=forrest-dev&m=101620970016263</a>
-
</li>
-
-
+
<li>
mail archive seemlessly integrated with the search engine (one should
look for something and get results from either docs, javadocs or emails
messages)
</li>
-
-
+
<li>
coherent-looking CVS view
</li>
-
-
+
<li>
document translation using Google translation services
</li>
-
-
+
<li>
Integrated project management, task management, bug tracking, feature requests, process management.
The idea is to integrate Scarab for bug tracking/patches and
@@ -581,18 +555,15 @@
(As far as team management, this is a serious political issue and I do not
want to tackle that one yet, not even on the dreamlist.)
</li>
-
-
+
<li>
overview doco for all projects ... CVS Usage precis, overview of opensource
and links to relevant doco
</li>
-
-
+
</ul>
</div>
-
-
+
</div>
<!--+
|end content