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 [19/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/roles.html
URL: http://svn.apache.org/viewvc/forrest/site/roles.html?view=diff&rev=527020&r1=527019&r2=527020
==============================================================================
--- forrest/site/roles.html (original)
+++ forrest/site/roles.html Mon Apr 9 21:44:00 2007
@@ -275,34 +275,43 @@
<h2 class="underlined_10">Overview</h2>
<div class="section">
<p>
- There are many tasks that need to be done to keep the project flowing. With the
- tasks being well-defined, the hope is that various people will be able to assist
- to carry out the role and so not rely on a couple of individuals to do all the
- work.
- </p>
-<p>There are no roles for "leadership" of technical areas. We don't have the
- concept of leadership at the ASF. Rather these are "functional roles".
- </p>
-<p>This is not intended to put pressure on people to force them to do work nor
- "pull their weight". If they do not manage to do a task, then someone else will
- be able to do it. Of course, shared load means a healthy project.
- </p>
-<p>Most roles have minimal tasks and are not too onerous. For example, for the
- "Documentation Coordinator", the only job might be to publish the documentation
- every Friday. Sure it can be done at other times and other people can do it too,
- but at least it gets done once per week.
- </p>
-<p>Having a person doing a role does not mean that everyone can leave it to them
- and rely on them. Anyone else can dive in and do the job (for example, publish
- the docs twice per week). The more people who are familiar with the role, the
- better. Perhaps the person who is primarily doing that role will notice that
- there can be improvements to how they are doing it.
- </p>
-<p>If a person is dissatisfied with the way a particular role is being done then
- find a way to offer constructive criticism, perhaps by assisting or by
- enhancing the role documentation.
+ There are many tasks that need to be done to keep the project flowing.
+ With the tasks being well-defined, the hope is that various people will
+ be able to assist to carry out the role and so not rely on a couple of
+ individuals to do all the work.
+ </p>
+<p>
+ There are no roles for "leadership" of technical areas. We don't have
+ the concept of leadership at the ASF. Rather these are "functional
+ roles".
+ </p>
+<p>
+ This is not intended to put pressure on people to force them to do work
+ nor "pull their weight". If they do not manage to do a task, then
+ someone else will be able to do it. Of course, shared load means a
+ healthy project.
+ </p>
+<p>
+ Most roles have minimal tasks and are not too onerous. For example, for
+ the "Documentation Coordinator", the only job might be to publish the
+ documentation every Friday. Sure it can be done at other times and other
+ people can do it too, but at least it gets done once per week.
+ </p>
+<p>
+ Having a person doing a role does not mean that everyone can leave it to
+ them and rely on them. Anyone else can dive in and do the job (for
+ example, publish the docs twice per week). The more people who are
+ familiar with the role, the better. Perhaps the person who is primarily
+ doing that role will notice that there can be improvements to how they
+ are doing it.
+ </p>
+<p>
+ If a person is dissatisfied with the way a particular role is being done
+ then find a way to offer constructive criticism, perhaps by assisting or
+ by enhancing the role documentation.
</p>
-<p>Most of the roles (except of course the Developer role) can only be
+<p>
+ Most of the roles (except of course the Developer role) can only be
carried out by PMC members because commit access is required.
</p>
</div>
@@ -310,106 +319,153 @@
<a name="N10029"></a><a name="roles"></a>
<h2 class="underlined_10">The roles</h2>
<div class="section">
-<p>These are the main roles, including the obvious ones. There are probably other
- roles that need to be defined also. Each role should have some continually
- enhanced documentation about it, so that any person can do the tasks.
+<p>
+ These are the main roles, including the obvious ones. There are probably
+ other roles that need to be defined also. Each role should have some
+ continually enhanced documentation about it, so that any person can do
+ the tasks.
</p>
<a name="N10032"></a><a name="pmc-member"></a>
<h3 class="underlined_5">PMC Member</h3>
-<p>This is well-defined in our <a href="guidelines.html">project guidelines</a>
- and in the top-level ASF docs.
+<p>
+ This is well-defined in our <a href="guidelines.html">project
+ guidelines</a> and in the top-level ASF docs.
</p>
<a name="N10040"></a><a name="pmc-chair"></a>
<h3 class="underlined_5">PMC Chair</h3>
-<p>This is well-defined in our <a href="guidelines.html">project guidelines</a>
- and in the top-level ASF docs.
+<p>
+ This is well-defined in our <a href="guidelines.html">project
+ guidelines</a> and in the top-level ASF docs.
</p>
<a name="N1004E"></a><a name="release-manager"></a>
<h3 class="underlined_5">Release Manager</h3>
-<p>Tasks are defined in
- <a href="procedures/release/How_to_release.html">How to Release Forrest</a>
+<p>
+ Tasks are defined in <a href="procedures/release/How_to_release.html">How to Release
+ Forrest</a>
</p>
-<p>Only one person can do this role, although other people can assist.
+<p>
+ Only one person can do this role, although other people can assist.
There is a lot of knowledge invested in this role. Document it as much
as possible.
</p>
<a name="N1005F"></a><a name="forrest-friday-coordinator"></a>
<h3 class="underlined_5">ForrestFriday Coordinator</h3>
-<p>The tasks are defined in
+<p>
+ The tasks are defined in
<a href="forrest-friday.html">ForrestFriday</a>.
</p>
-<p>Each month someone needs to co-ordinate the IRC session and be the main
- channel operator, maintain the logfile and commit it to the events SVN.
- </p>
-<p>Ensure that the session is summarised.
- </p>
-<p>This role can possibly be done by someone who is not a committer. However, a
- logfile and summary need to be committed to SVN.
+<p>
+ Each month someone needs to co-ordinate the IRC session and be the
+ main channel operator, maintain the logfile and commit it to the
+ events SVN.
+ </p>
+<p>
+ Ensure that the session is summarised.
+ </p>
+<p>
+ This role can possibly be done by someone who is not a committer.
+ However, a logfile and summary need to be committed to SVN.
</p>
<a name="N10076"></a><a name="issue-tracker-coordinator"></a>
<h3 class="underlined_5">Issue Tracker Coordinator</h3>
-<p>Add new Components, e.g. for each new plugin.</p>
-<p>Other general Admin tasks.</p>
-<p>Add new committers to the forrest-administrators group.</p>
-<p>Add/enhance <a href="issues.html">Filters</a>.</p>
-<p>Review issues to ensure that they are properly categorised. This is best
- done as soon as a new issue comes in.</p>
-<p>Review the list of unscheduled issues.</p>
-<p>Each month get the project to review the outstanding major issues
- that are scheduled for the upcoming release.</p>
+<p>
+ Add new Components, e.g. for each new plugin.
+ </p>
+<p>
+ Other general Admin tasks.
+ </p>
+<p>
+ Add new committers to the forrest-administrators group.
+ </p>
+<p>
+ Add/enhance <a href="issues.html">Filters</a>.
+ </p>
+<p>
+ Review issues to ensure that they are properly categorised. This is
+ best done as soon as a new issue comes in.
+ </p>
+<p>
+ Review the list of unscheduled issues.
+ </p>
+<p>
+ Each month get the project to review the outstanding major issues that
+ are scheduled for the upcoming release.
+ </p>
<a name="N10096"></a><a name="documentation-coordinator"></a>
<h3 class="underlined_5">Documentation Coordinator</h3>
-<p>Publish the documentation at least once per week.</p>
-<p>Various people make edits to the source files, but often the
+<p>
+ Publish the documentation at least once per week.
+ </p>
+<p>
+ Various people make edits to the source files, but often the
documentation is not generated and published. Also people add new
entries to site-author/status.xml but the changes.html needs to be
regularly generated from it.
</p>
-<p>This role is not actually about doing the documentation. That should
- be up to everyone.</p>
-<p>Generating and publishing the main docs is very easy using a local forrestbot:
- See
- <a href="procedures/How_to_publish_docs.html">How to publish Forrest documentation</a>.
+<p>
+ This role is not actually about doing the documentation. That should
+ be up to everyone.
+ </p>
+<p>
+ Generating and publishing the main docs is very easy using a local
+ forrestbot: See <a href="procedures/How_to_publish_docs.html">How to publish Forrest
+ documentation</a>.
</p>
<a name="N100AD"></a><a name="subversion-monitor"></a>
<h3 class="underlined_5">Subversion Monitor</h3>
-<p>Ensure that svn:eol-style settings are "native" for all text files.</p>
-<p>Ensure no line-endings issues.</p>
-<p>Regularly run xml-tidy. (Not yet ready.)</p>
-<p>Regularly run java-tidy. (Not yet ready.)</p>
-<p>There are already some Perl scripts and other tools in the
+<p>
+ Ensure that svn:eol-style settings are "native" for all text files.
+ </p>
+<p>
+ Ensure no line-endings issues.
+ </p>
+<p>
+ Regularly run xml-tidy. (Not yet ready.)
+ </p>
+<p>
+ Regularly run java-tidy. (Not yet ready.)
+ </p>
+<p>
+ There are already some Perl scripts and other tools in the
"<a href="https://svn.apache.org/repos/private/committers">committers</a>"
SVN in the "tools" directory.
</p>
<a name="N100C7"></a><a name="legal-monitor"></a>
<h3 class="underlined_5">Legal Monitor</h3>
-<p>Regularly run a script which verifies and inserts missing license
+<p>
+ Regularly run a script which verifies and inserts missing license
headers to source files.
</p>
-<p>Regularly ensure that there are appropriate matching licenses to
+<p>
+ Regularly ensure that there are appropriate matching licenses to
accompany each supporting product that we redistribute.
</p>
-<p>This should have continual oversight by the PMC as a whole, but the
- monitoring is something that needs to be done regularly, and definitely
- prior to each release.
+<p>
+ This should have continual oversight by the PMC as a whole, but the
+ monitoring is something that needs to be done regularly, and
+ definitely prior to each release.
</p>
-<p>There are already some Perl scripts and other tools in the
+<p>
+ There are already some Perl scripts and other tools in the
"<a href="https://svn.apache.org/repos/private/committers">committers</a>"
SVN in the "tools" and "relicense/src/perl" directories.
</p>
<a name="N100DE"></a><a name="developer"></a>
<h3 class="underlined_5">Developer</h3>
-<p>The above roles are only for PMC Members. How can the Developers be
+<p>
+ The above roles are only for PMC Members. How can the Developers be
involved? That is easy: do the Developer Role.
</p>
-<p>Help out with commenting on the Issue Tracker, fixing the issues,
+<p>
+ Help out with commenting on the Issue Tracker, fixing the issues,
contributing to discussion, contributing patches, turning discussion
into clear documentation.
</p>
-<p>This is incredibly valuable and will enable the project to grow.
- After time, you will probably be elected as Committer/PMC Member and
- when comfortable, can take on one of the Project Management Roles.
+<p>
+ This is incredibly valuable and will enable the project to grow. After
+ time, you will probably be elected as Committer/PMC Member and when
+ comfortable, can take on one of the Project Management Roles.
</p>
</div>
Modified: forrest/site/skins/skins.xml
URL: http://svn.apache.org/viewvc/forrest/site/skins/skins.xml?view=diff&rev=527020&r1=527019&r2=527020
==============================================================================
--- forrest/site/skins/skins.xml (original)
+++ forrest/site/skins/skins.xml Mon Apr 9 21:44:00 2007
@@ -26,16 +26,14 @@
website CDATA #IMPLIED>
<!ELEMENT description (#PCDATA)>
]>
-
<skins>
<skin name="testskin"
author="Nicola Ken Barozzi"
website="http://www.nicolaken.com"
url="http://www.apache.org/~nicolaken/whiteboard/forrestskins/">
<description>
- Based on the standard forrest-site skin.
- (Note: This is only a test skin, with trivial changes to demonstrate
- the concept.)
+ Based on the standard forrest-site skin. (Note: This is only a test skin,
+ with trivial changes to demonstrate the concept.)
</description>
</skin>
<skin name="testskin2"
@@ -43,9 +41,8 @@
website="http://www.nicolaken.com"
url="http://www.apache.org/~nicolaken/whiteboard/forrestskins/">
<description>
- Based on the standard forrest-site skin.
- (Note: This is only a test skin, with trivial changes to demonstrate
- the concept.)
+ Based on the standard forrest-site skin. (Note: This is only a test skin,
+ with trivial changes to demonstrate the concept.)
</description>
</skin>
-</skins>
+</skins>
Modified: forrest/site/subversion_bestpractices.html
URL: http://svn.apache.org/viewvc/forrest/site/subversion_bestpractices.html?view=diff&rev=527020&r1=527019&r2=527020
==============================================================================
--- forrest/site/subversion_bestpractices.html (original)
+++ forrest/site/subversion_bestpractices.html Mon Apr 9 21:44:00 2007
@@ -242,9 +242,11 @@
<div class="fixme">
<div class="label">Fixme ()</div>
<div class="content">
- This doc is under development. It should have general notes to assist
- all developers to use the latest code in Forrest SVN and tips for working with SVN. An extra section would have other tips specific for Forrest committers.
- Some tips should instead be added to the ASF-wide docs, where we can link to them.
+ This doc is under development. It should have general notes to assist all
+ developers to use the latest code in Forrest SVN and tips for working with
+ SVN. An extra section would have other tips specific for Forrest
+ committers. Some tips should instead be added to the ASF-wide docs, where
+ we can link to them.
</div>
</div>
@@ -252,9 +254,9 @@
<h2 class="underlined_10">Golden Rules</h2>
<div class="section">
<p>
- Using subversion seems so easy. But there are so many things you can do to mess up other peoples work. This
- document tries to name just a few:
- </p>
+ Using subversion seems so easy. But there are so many things you can do
+ to mess up other peoples work. This document tries to name just a few:
+ </p>
<ul>
<li>Be familiar with the <a href="svn.html">instructions</a> for using Forrest SVN.
@@ -268,14 +270,12 @@
<div class="fixme">
<div class="label">Fixme ()</div>
<div class="content">
- Move the notes from contrib.html to here.
- See other notes in
+ Move the notes from contrib.html to here. See other notes in
<a href="http://marc.theaimsgroup.com/?t=114834506800002">email</a>.
</div>
</div>
-
</li>
-
+
<li>When moving an existing file please use "svn move fromFile toFile". This ensures
that the history of the item is not lost.</li>
Modified: forrest/site/svn.html
URL: http://svn.apache.org/viewvc/forrest/site/svn.html?view=diff&rev=527020&r1=527019&r2=527020
==============================================================================
--- forrest/site/svn.html (original)
+++ forrest/site/svn.html Mon Apr 9 21:44:00 2007
@@ -231,40 +231,40 @@
<input value="+a" class="biggerfont" title="Enlarge text" onclick="ndeSetTextSize('incr'); return false;" type="button">
</div>
<h1>Version control</h1>
-
+
<p>
- The version control system Subversion is used by all ASF projects to manage their
- source code and other resources.
- </p>
-
-
-<p>
- The "trunk" is where the main development happens. From time-to-time "branches"
- are used for specific short-term development tasks and later merged to trunk.
- </p>
-
-
-<p>
- Developers can browse the trunk via
- <a href="http://svn.apache.org/repos/asf/forrest/">direct access</a> or
- via the <a href="http://svn.apache.org/viewvc/forrest/trunk">ViewVC web interface</a>.
- Similarly branches can be browsed (go up one level).
- </p>
-
-<p>
- For every change, a notification email is automatically sent to the
- <a href="mail-lists.html">svn@ mailing list</a>. Subscribe to that
- list or search the archives to keep up-to-date with changes.
- </p>
-
-<p>
- Developers can work with the most recent sources rather than a released version,
- follow the <a href="docs_0_80/howto/../build.html">instructions</a> to checkout your working copy.
- </p>
-
+ The version control system Subversion is used by all ASF projects to
+ manage their source code and other resources.
+ </p>
+
+<p>
+ The "trunk" is where the main development happens. From time-to-time
+ "branches" are used for specific short-term development tasks and later
+ merged to trunk.
+ </p>
+
+<p>
+ Developers can browse the trunk via
+ <a href="http://svn.apache.org/repos/asf/forrest/">direct access</a> or
+ via the <a href="http://svn.apache.org/viewvc/forrest/trunk">ViewVC web
+ interface</a>. Similarly branches can be browsed (go up one level).
+ </p>
+
+<p>
+ For every change, a notification email is automatically sent to the
+ <a href="mail-lists.html">svn@ mailing list</a>. Subscribe to that list or
+ search the archives to keep up-to-date with changes.
+ </p>
+
+<p>
+ Developers can work with the most recent sources rather than a released
+ version, follow the <a href="docs_0_80/howto/../build.html">instructions</a> to checkout your
+ working copy.
+ </p>
+
<p>
- See other <a href="subversion_bestpractices.html">best practice notes</a>.
- </p>
+ See other <a href="subversion_bestpractices.html">best practice notes</a>.
+ </p>
</div>
<!--+
Modified: forrest/site/thanks.html
URL: http://svn.apache.org/viewvc/forrest/site/thanks.html?view=diff&rev=527020&r1=527019&r2=527020
==============================================================================
--- forrest/site/thanks.html (original)
+++ forrest/site/thanks.html Mon Apr 9 21:44:00 2007
@@ -205,24 +205,24 @@
</li>
</ul>
</div>
-
+
<p>
- The Apache Forrest project gives thanks ...
- </p>
+ The Apache Forrest project gives thanks ...
+ </p>
<a name="N10010"></a><a name="general"></a>
<h2 class="underlined_10">General thanks</h2>
<div class="section">
<p>
-<a href="http://www.apache.org/foundation/">The Apache Software Foundation (ASF)</a>
- provides an excellent home for our community.
- See also the
- <a href="http://www.apache.org/foundation/thanks.html">ASF thanks</a>.
+<a href="http://www.apache.org/foundation/">The Apache Software
+ Foundation (ASF)</a> provides an excellent home for our community. See
+ also the <a href="http://www.apache.org/foundation/thanks.html">ASF
+ thanks</a>.
</p>
<p>
- The individual developers who participate via the
- dev <a href="mail-lists.html">mailing list</a>.
+ The individual developers who participate via the dev
+ <a href="mail-lists.html">mailing list</a>.
</p>
<p>
Our <a href="who.html">committers</a> and Project Management Committee.
@@ -232,7 +232,6 @@
<a href="live-sites.html">example sites</a>.
</p>
</div>
-
<a name="N1003B"></a><a name="packaged-attribution"></a>
<h2 class="underlined_10">Packaged software attribution</h2>
@@ -240,11 +239,10 @@
<p>
Various products are packaged with the Apache Forrest distribution.
These products use a license that is compatible with the Apache License.
- Most products do not require specific attribution, but some do request that.
- See the NOTICE.txt and LICENSE.txt files in the distribution.
+ Most products do not require specific attribution, but some do request
+ that. See the NOTICE.txt and LICENSE.txt files in the distribution.
</p>
</div>
-
<a name="N10045"></a><a name="supporting-attribution"></a>
<h2 class="underlined_10">Supporting software attribution</h2>
@@ -252,11 +250,10 @@
<p>
Developers use various tools to assist with their work, such as
<a href="docs_0_80/catalog.html">xml editors</a> and IDEs such as
- <a href="http://www.jetbrains.com/idea/opensource/">IntelliJ IDEA</a>
- or
- <a href="http://www.eclipse.org/">Eclipse</a>.
- Most tools do not require attribution, but some do
- (<a href="http://www.yourkit.com/">YourKit Java Profiler</a>).
+ <a href="http://www.jetbrains.com/idea/opensource/">IntelliJ IDEA</a> or
+ <a href="http://www.eclipse.org/">Eclipse</a>. Most tools do not require
+ attribution, but some do (<a href="http://www.yourkit.com/">YourKit Java
+ Profiler</a>).
</p>
</div>
Modified: forrest/site/tools/eclipse.html
URL: http://svn.apache.org/viewvc/forrest/site/tools/eclipse.html?view=diff&rev=527020&r1=527019&r2=527020
==============================================================================
--- forrest/site/tools/eclipse.html (original)
+++ forrest/site/tools/eclipse.html Mon Apr 9 21:44:00 2007
@@ -237,7 +237,7 @@
</li>
</ul>
</div>
-
+
<a name="N1000D"></a><a name="overview"></a>
<h2 class="underlined_10">
Eclipse Plugin
@@ -246,160 +246,195 @@
<div class="warning">
<div class="label">Warning</div>
<div class="content">
- The Forrest plugin for Eclipse is new and under development.
- </div>
+ The Forrest plugin for Eclipse is new and under development.
+ </div>
</div>
</div>
-
+
<a name="N10017"></a><a name="install"></a>
<h2 class="underlined_10">
Installation notes
</h2>
<div class="section">
<p>
- To get you started while the documentation is being developed, see this forrest-dev mail thread:
- <a href="http://marc.theaimsgroup.com/?t=112059632000001">
- [eclipse] How to install?
- </a>
- .
- </p>
+ To get you started while the documentation is being developed, see this
+ forrest-dev mail thread:
+ <a href="http://marc.theaimsgroup.com/?t=112059632000001"> [eclipse] How
+ to install? </a> .
+ </p>
</div>
-
-
+
<a name="N10025"></a><a name="Wizards"></a>
<h2 class="underlined_10">Wizards</h2>
<div class="section">
-<p>A number of wizards are provided for performing common tasks. This section briefly describes
- the available wizards.</p>
+<p>
+ A number of wizards are provided for performing common tasks. This
+ section briefly describes the available wizards.
+ </p>
<a name="N1002E"></a><a name="newProject"></a>
<h3 class="underlined_5">Creating a new Forrest Project</h3>
-<p>To create a new Forrest project select "New Project" from either the context menu in the package explorer or the
- "New" menu and select Forrest -> Seed New Project.</p>
<p>
+ To create a new Forrest project select "New Project" from either the
+ context menu in the package explorer or the "New" menu and select
+ Forrest -> Seed New Project.
+ </p>
+<p>
+
<strong>Project Name and Location</strong>
+
</p>
-<p>A wizard will ask you for the name of the project and the location in which the project files are to be created
- (by default the files will be in your current workspace). When you are done, click on Next</p>
<p>
+ A wizard will ask you for the name of the project and the location in
+ which the project files are to be created (by default the files will
+ be in your current workspace). When you are done, click on Next
+ </p>
+<p>
+
<strong>Site options</strong>
+
</p>
<p>
- Here you will see the Site Options page. This is where you can specify certain options for your new site.
- Currently the available options are:</p>
+ Here you will see the Site Options page. This is where you can specify
+ certain options for your new site. Currently the available options
+ are:
+ </p>
<ul>
-
+
<li>Group Name</li>
-
+
<li>Project Name</li>
-
+
<li>Vendor</li>
-
+
<li>Copyright link</li>
-
+
<li>Disable PDF link</li>
-
+
<li>Disable POD link</li>
-
+
<li>Disable Print link</li>
-
+
<li>Disable Text link</li>
-
+
<li>Disable XML link</li>
-
+
</ul>
-<p>There is also an option to save these sselections as your default settings. If this is done, the next time you create a project it will have the
- same seelections that you have specified here. When you are finished with this page, click on Next</p>
<p>
+ There is also an option to save these sselections as your default
+ settings. If this is done, the next time you create a project it will
+ have the same seelections that you have specified here. When you are
+ finished with this page, click on Next
+ </p>
+<p>
+
<strong>Activate Plugins</strong>
+
</p>
-<p>This page allows you to select the plugins that you would like your project to use. The list of available plugins is on the left
- and list of plugins that you have chosen for your project is on the right. Once you have selected those plugins click on Finish to create your new Site Project.</p>
-<a name="N1006E"></a><a name="newXDoc"></a>
+<p>
+ This page allows you to select the plugins that you would like your
+ project to use. The list of available plugins is on the left and list
+ of plugins that you have chosen for your project is on the right. Once
+ you have selected those plugins click on Finish to create your new
+ Site Project.
+ </p>
+<a name="N10074"></a><a name="newXDoc"></a>
<h3 class="underlined_5">Creating a new XDoc</h3>
-<p>To create a new XDoc within yout Forrest project select "New -> Other..." and then select
- "New XDoc" from the Forrest node.</p>
+<p>
+ To create a new XDoc within yout Forrest project select "New ->
+ Other..." and then select "New XDoc" from the Forrest node.
+ </p>
</div>
-
-
-<a name="N10079"></a><a name="editors"></a>
+
+<a name="N1007F"></a><a name="editors"></a>
<h2 class="underlined_10">Editors</h2>
<div class="section">
-<p>A number of editors are provided for Forrest configuration files. This section describes those editors.</p>
-<a name="N10082"></a><a name="siteXMLEditor"></a>
+<p>
+ A number of editors are provided for Forrest configuration files. This
+ section describes those editors.
+ </p>
+<a name="N10088"></a><a name="siteXMLEditor"></a>
<h3 class="underlined_5">
site.xml Editor
</h3>
<p>
- First, you need to activate the Site.xml view. This can be done by:
- <span class="codefrag">
- Window -> Show View -> Other... -> Forrest -> SiteXML -> OK
- </span>
- Now you will see the the view open up in Eclipse. To view a tree, click on the project you are working and you should see the structure of the site.xml as a tree in the view.
- </p>
+ First, you need to activate the Site.xml view. This can be done by:
+ <span class="codefrag"> Window -> Show View -> Other... -> Forrest -> SiteXML -> OK
+ </span> Now you will see the the view open up in Eclipse. To view a
+ tree, click on the project you are working and you should see the
+ structure of the site.xml as a tree in the view.
+ </p>
<p>
- There are two ways to add the note to the site.xml file.
- </p>
+ There are two ways to add the note to the site.xml file.
+ </p>
<ol>
-
+
<li>
Drag a file from the Package Explorer to the tree. This will create a new element
with references to that dropped file(s).
</li>
-
+
<li>
Right click on an element in the site.xml tree and select "Add Element". A wizard will come up which will allow you to enter the HREF, Description, Label and Element name for the new element that is being added.
</li>
-
+
</ol>
<p>
- To delete an element, right click on the element in the tree and click on "Delete Element".
- </p>
+ To delete an element, right click on the element in the tree and click
+ on "Delete Element".
+ </p>
<div class="warning">
<div class="label">Warning</div>
<div class="content">
- For the changes to show up when you run a test site for your project, you must save the changes. Right click on the tree and select
- "Save". In a later version of the plugin this step will not be necessary.
- </div>
+ For the changes to show up when you run a test site for your project,
+ you must save the changes. Right click on the tree and select "Save".
+ In a later version of the plugin this step will not be necessary.
+ </div>
</div>
<div class="fixme">
<div class="label">Fixme (Anil Ramnanan)</div>
<div class="content">
- Currently there is no easy way to edit an existing element. The element will be linked to the Properties View in Eclipse to allow for easy editing
- </div>
+ Currently there is no easy way to edit an existing element. The
+ element will be linked to the Properties View in Eclipse to allow for
+ easy editing
+ </div>
</div>
-<a name="N100A5"></a><a name="tabsXMLEditor"></a>
+<a name="N100AB"></a><a name="tabsXMLEditor"></a>
<h3 class="underlined_5">
tabs.xml Editor
</h3>
<p>
First, you need to activate the Tab.xml view. This can be done by:
- <span class="codefrag">
- Window -> Show View -> Other... -> Forrest -> TabXML -> OK
- </span>
- Now you will see the the view open up in Eclipse. To view a tree, click on the project you are working and you should see the structure of the tabs.xml as a tree in the view.
+ <span class="codefrag"> Window -> Show View -> Other... -> Forrest -> TabXML -> OK
+ </span> Now you will see the the view open up in Eclipse. To view a
+ tree, click on the project you are working and you should see the
+ structure of the tabs.xml as a tree in the view.
</p>
<p>
- To add a new element to the tabs.xml file right click on an element in the tabs.xml tree and select "Add Element".
- A wizard will come up which will allow you to enter the Id, Dir, Label and Index File for the new tab
- element that is being added.
+ To add a new element to the tabs.xml file right click on an element in
+ the tabs.xml tree and select "Add Element". A wizard will come up
+ which will allow you to enter the Id, Dir, Label and Index File for
+ the new tab element that is being added.
</p>
<p>
- To delete an element, right click on the element in the tree and click on Delete Element
+ To delete an element, right click on the element in the tree and click
+ on Delete Element
</p>
<div class="warning">
<div class="label">Warning</div>
<div class="content">
- For the changes to show up when you run a test site for your project, you must save the changes. Right
- click on the tree and select "Save". In a later version of the plugin this step will not be necessary.
+ For the changes to show up when you run a test site for your project,
+ you must save the changes. Right click on the tree and select "Save".
+ In a later version of the plugin this step will not be necessary.
</div>
</div>
<div class="fixme">
<div class="label">Fixme (Anil Ramnanan)</div>
<div class="content">
- Currently there is no easy way to edit an element. The element will be linked to the Properties View in Eclipse to allow for easy editing
+ Currently there is no easy way to edit an element. The element will be
+ linked to the Properties View in Eclipse to allow for easy editing
</div>
</div>
-<a name="N100BF"></a><a name="LocationmapEditor"></a>
+<a name="N100C5"></a><a name="LocationmapEditor"></a>
<h3 class="underlined_5">
Locationmap.xml Editor
</h3>
@@ -407,34 +442,38 @@
First, you need to activate the Locationmap view. This can be done by:
</p>
<p>
- Window -> Show View -> Other... -> Forrest -> Locationmap -> OK
+ Window -> Show View -> Other... -> Forrest -> Locationmap -> OK
</p>
<p>
- Now you will see the the view open up in Eclipse. To view a tree, click on the
- project you are working and you should see the structure of the Locationmap.xml
- as a tree in the view.
+ Now you will see the the view open up in Eclipse. To view a tree,
+ click on the project you are working and you should see the structure
+ of the Locationmap.xml as a tree in the view.
</p>
<p>
- To add a match, you must rich click on the locater element and click on
- "Add Match". A wizard will come up asking you to enter the Pattern or the Match.
+ To add a match, you must rich click on the locater element and click
+ on "Add Match". A wizard will come up asking you to enter the Pattern
+ or the Match.
</p>
<p>
- Right click on the match you just created and click on "Add Location". This will allow you to enter the Location Source.
+ Right click on the match you just created and click on "Add Location".
+ This will allow you to enter the Location Source.
</p>
<p>
- To delete an element, right click on the element in the tree and click on Delete Element
+ To delete an element, right click on the element in the tree and click
+ on Delete Element
</p>
<p>
- For the changes to show up when you run a test site for your project, you must save the changes. Right click on the tree and select
- "Save".
+ For the changes to show up when you run a test site for your project,
+ you must save the changes. Right click on the tree and select "Save".
</p>
<div class="fixme">
<div class="label">Fixme (Anil Ramnanan)</div>
<div class="content">
- Currently there is no easy way to edit an element. The element will be linked to the Properties View in Eclipse to allow for easy editing
+ Currently there is no easy way to edit an element. The element will be
+ linked to the Properties View in Eclipse to allow for easy editing
</div>
</div>
-<a name="N100DF"></a><a name="ForrestViews"></a>
+<a name="N100E5"></a><a name="ForrestViews"></a>
<h3 class="underlined_5">
Activate Forrest:Views for a project
</h3>
@@ -442,105 +481,114 @@
To activate views when seeding a new project:
</p>
<p>
- File -> New -> Project -> Forrest -> Seed New Project -> Next
+ File -> New -> Project -> Forrest -> Seed New Project -> Next
</p>
<p>
- Type in the name of the project and click on Next. To Activate views for the new project, check off
- "Activate Views" and click on Finish. When "Activate Views" is selected, the new project has
- project.skin=leather-dev uncommented and the relevant plugins for views are added to
- project.required.plugins
+ Type in the name of the project and click on Next. To Activate views
+ for the new project, check off "Activate Views" and click on Finish.
+ When "Activate Views" is selected, the new project has
+ project.skin=leather-dev uncommented and the relevant plugins for
+ views are added to project.required.plugins
</p>
<p>
- To add a new View doc (*.fv), click on New -> Other -> Forrest -> View Doc. Enter the file name of
- the view document and click on Finish.
+ To add a new View doc (*.fv), click on New -> Other -> Forrest -> View
+ Doc. Enter the file name of the view document and click on Finish.
</p>
-<a name="N100F2"></a><a name="RepositoryBrowser"></a>
+<a name="N100F8"></a><a name="RepositoryBrowser"></a>
<h3 class="underlined_5">
Browse a remote Repostory
</h3>
<p>
- The Repository Browser allows you to browse a a remote repository and include the documents in a Forrest Project.
- To show the Repository Browser view go to Window -> Show View - >Other. Expand the Forrest Tree and select Repository Browser.
-
+ The Repository Browser allows you to browse a a remote repository and
+ include the documents in a Forrest Project. To show the Repository
+ Browser view go to Window -> Show View - >Other. Expand the Forrest
+ Tree and select Repository Browser.
</p>
<div class="note">
<div class="label">Note</div>
<div class="content">
- Currently the repository Browser only has support for the Daisy repository
- but support for other repoisotries can be easily added. If you have specific
- need pleae join us on the dev list where we will be happy to assist.
+ Currently the repository Browser only has support for the Daisy
+ repository but support for other repoisotries can be easily added. If
+ you have specific need pleae join us on the dev list where we will be
+ happy to assist.
</div>
</div>
-<a name="N100FE"></a><a name="Daisy+Repository"></a>
+<a name="N10104"></a><a name="Daisy+Repository"></a>
<h4>Daisy Repository</h4>
<p>
- For the Repository Browser to work with the <a href="http://www.cocoondev.org/daisy">Daisy repository</a>, the settings for the daisy repository must be configured.
- </p>
+ For the Repository Browser to work with the
+ <a href="http://www.cocoondev.org/daisy">Daisy repository</a>, the
+ settings for the daisy repository must be configured.
+ </p>
<p>
- Go to Windows -> Preferences. Chose Daisy. Here you will see a number of options to set for the daisy repository.
- </p>
+ Go to Windows -> Preferences. Chose Daisy. Here you will see a
+ number of options to set for the daisy repository.
+ </p>
<ul>
-
+
<li>Repository Location - this is the http location of the repoistory browser. This can be a domain name or an IP address e.g. localhost or 127.0.0.1</li>
-
+
<li>Repository Port - This is the port that the repository runs on e.g. 9623</li>
-
+
<li>Repository Username - This is the username that is set for the repository</li>
-
+
<li>Repository Password - This is the password that is used to authenticate the user for the repository</li>
-
+
</ul>
<p>
- To include a document from a Repository in a Forrest Project, click on the document in the Document list of the
- repository browser and drag it to locator section in the Locationmap View.
- </p>
+ To include a document from a Repository in a Forrest Project, click on
+ the document in the Document list of the repository browser and drag
+ it to locator section in the Locationmap View.
+ </p>
</div>
-
-<a name="N10123"></a><a name="ModifyandBuild"></a>
+
+<a name="N10129"></a><a name="ModifyandBuild"></a>
<h2 class="underlined_10">
Modify and Build Forrest Sites
</h2>
<div class="section">
<p>
- Once a Forrest Project has been created the user can access the context menus to modify and build the site.
- </p>
-<a name="N1012C"></a><a name="ModifySettings"></a>
+ Once a Forrest Project has been created the user can access the context
+ menus to modify and build the site.
+ </p>
+<a name="N10132"></a><a name="ModifySettings"></a>
<h3 class="underlined_5">
Modify Settings
</h3>
<p>
- In order to modify the settings of a project, right click on the project in the Package Explorer. At the bottom of the menu you
- will find two meny items.
+ In order to modify the settings of a project, right click on the
+ project in the Package Explorer. At the bottom of the menu you will
+ find two meny items.
</p>
<ul>
-
+
<li>Modify Plugins Selection - This will let you add and remove Forrest plugins from your project</li>
-
+
<li>Modify Configurations - This allows you to modify the Site Option settings that were selected when the project was created.</li>
-
+
</ul>
-<a name="N1013F"></a><a name="BuildSettings"></a>
+<a name="N10145"></a><a name="BuildSettings"></a>
<h3 class="underlined_5">
Build Site Options
</h3>
<p>
- In order to build a project, right click on the project in the Package Explorer. At the bottom of the menu you
- will find the Site menu item. This menu item has a number of sub items.
+ In order to build a project, right click on the project in the Package
+ Explorer. At the bottom of the menu you will find the Site menu item.
+ This menu item has a number of sub items.
</p>
<ul>
-
+
<li>Start Test Server - This will start the project as a local webapp and open a browser window that will allow you to preview it.</li>
-
+
<li>Stop Test Server - This will stop the local webapp.</li>
-
+
<li>Build WAR File - This will build the site as a webapp in a war file located in the build folder of your project.</li>
-
+
<li>Build Site - This will build a static site from your project in the Build folder of your project.</li>
-
+
</ul>
</div>
-
-
+
</div>
<!--+
|end content
Modified: forrest/site/tools/forrestbar.html
URL: http://svn.apache.org/viewvc/forrest/site/tools/forrestbar.html?view=diff&rev=527020&r1=527019&r2=527020
==============================================================================
--- forrest/site/tools/forrestbar.html (original)
+++ forrest/site/tools/forrestbar.html Mon Apr 9 21:44:00 2007
@@ -170,30 +170,44 @@
<a name="N1000D"></a><a name="What%27s+the+ForrestBar%3F"></a>
<h2 class="underlined_10">What's the ForrestBar?</h2>
<div class="section">
-<p>The ForrestBar is a toolbar extension made for the
+<p>
+ The ForrestBar is a toolbar extension made for the
<a href="http://www.mozilla.org/products/mozilla1.x/">Mozilla</a>
and <a href="http://www.mozilla.org/products/firefox/">Firefox</a>
- browsers that eases the navigation of online Forrest resources (including local
- instances of Forrest running on jetty or as a webapp), Apache links
- and other Apache projects.</p>
-<p>Navigation and developer assistance for Apache Forrest-related documentation frameworks.</p>
+ browsers that eases the navigation of online Forrest resources
+ (including local instances of Forrest running on jetty or as a webapp),
+ Apache links and other Apache projects.
+ </p>
+<p>
+ Navigation and developer assistance for Apache Forrest-related
+ documentation frameworks.
+ </p>
</div>
<a name="N10022"></a><a name="Installing+the+ForrestBar"></a>
<h2 class="underlined_10">Installing the ForrestBar</h2>
<div class="section">
-<p>ForrestBar is currently compatible with Firefox 0.9 - 1.5+ and Mozilla
- 1.x browsers.</p>
-<p>Select this link to <a href="forrestbar.xpi">install</a> ForrestBar.</p>
-<p>If the extension does not automatically install for you when clicking
- on the link, download ForrestBar by right clicking on the link and select Save
- As... to save the file to your computer. To install, simply drag the
- downloaded .xpi file into your browser's window and drop it.</p>
-<p>To build ForrestBar locally rather than downloading, go to
+<p>
+ ForrestBar is currently compatible with Firefox 0.9 - 1.5+ and Mozilla
+ 1.x browsers.
+ </p>
+<p>
+ Select this link to <a href="forrestbar.xpi">install</a>
+ ForrestBar.
+ </p>
+<p>
+ If the extension does not automatically install for you when clicking on
+ the link, download ForrestBar by right clicking on the link and select
+ Save As... to save the file to your computer. To install, simply drag
+ the downloaded .xpi file into your browser's window and drop it.
+ </p>
+<p>
+ To build ForrestBar locally rather than downloading, go to
FORREST_HOME/tools/forrestbar and run the following command:
- <span class="codefrag">forrest -f build.xml</span> and the .xpi file will be built for you
- in the FORREST_HOME/tools/forrestbar/build directory. You can then install it by
- dragging and dropping as indicated above.</p>
+ <span class="codefrag">forrest -f build.xml</span> and the .xpi file will be built for
+ you in the FORREST_HOME/tools/forrestbar/build directory. You can then
+ install it by dragging and dropping as indicated above.
+ </p>
</div>
</div>
Modified: forrest/site/tools/forrestbot-web-interface.html
URL: http://svn.apache.org/viewvc/forrest/site/tools/forrestbot-web-interface.html?view=diff&rev=527020&r1=527019&r2=527020
==============================================================================
--- forrest/site/tools/forrestbot-web-interface.html (original)
+++ forrest/site/tools/forrestbot-web-interface.html Mon Apr 9 21:44:00 2007
@@ -185,20 +185,24 @@
</ul>
</div>
-<p>This webapp implements a website staging application for sites built with
- Apache Forrest. The webapp hosts HTML for a number of managed websites. The
- user can regenerate these sites at will. Once the user is satisfied with the
- site, they may 'deploy' the site, making it live.</p>
-
+<p>
+ This webapp implements a website staging application for sites built with
+ Apache Forrest. The webapp hosts HTML for a number of managed websites.
+ The user can regenerate these sites at will. Once the user is satisfied
+ with the site, they may 'deploy' the site, making it live.
+ </p>
<a name="N10010"></a><a name="Build"></a>
<h2 class="underlined_10">Build</h2>
<div class="section">
-<p>To build the webapp from source, you need <a href="http://maven.apache.org/">Apache Maven</a> installed. From a
- command prompt, go to the <span class="codefrag">forrest/tools/forrestbot/webapp</span>
- directory and execute "<span class="codefrag">maven war</span>".</p>
+<p>
+ To build the webapp from source, you need
+ <a href="http://maven.apache.org/">Apache Maven</a>
+ installed. From a command prompt, go to the
+ <span class="codefrag">forrest/tools/forrestbot/webapp</span> directory and execute
+ "<span class="codefrag">maven war</span>".
+ </p>
</div>
-
<a name="N10024"></a><a name="Requirements"></a>
<h2 class="underlined_10">Requirements</h2>
@@ -206,85 +210,75 @@
<ul>
<li>Forrest</li>
-
<li>A servlet container such as <a href="http://jakarta.apache.org/tomcat">Apache Tomcat</a>
</li>
-
<li>Directories for:</li>
-
<ul>
<li>forrestbot buildfiles</li>
-
<li>source and working files</li>
-
<li>log files</li>
-
<li>built websites (this is not their deployed location)</li>
</ul>
-
<li>A webserver to view the sites in the build directory</li>
</ul>
-<p>The server does not need local access to the sites' source nor final
- deployed location. The buildfiles configure the transfer of those
- files.</p>
+<p>
+ The server does not need local access to the sites' source nor final
+ deployed location. The buildfiles configure the transfer of those files.
+ </p>
</div>
-
<a name="N1004F"></a><a name="Installation"></a>
<h2 class="underlined_10">Installation</h2>
<div class="section">
<div class="note">
<div class="label">Note</div>
-<div class="content">Most of this configuration is related to the <a href="http://www.opensymphony.com/osuser/">OpenSymphony OSUser</a>
- authentication layer.</div>
+<div class="content">
+ Most of this configuration is related to the
+ <a href="http://www.opensymphony.com/osuser/">OpenSymphony
+ OSUser</a> authentication layer.
+ </div>
</div>
<ol>
<li>Extract the war to an empty directory</li>
-
<li>Modify welcome.local.html</li>
-
<li>Modify WEB-INF/classes/osuser.xml if you want to use an
authenticator other than XML files</li>
-
<li>Modify projects.xml, groups.xml, and users.xml (all in
WEB-INF/classes) according to your needs</li>
-
<li>Optionally modify logging via WEB-INF/classes/log4j.properties</li>
-
<li>Modify WEB-INF/classes/settings.properties according to the server's
specific setup</li>
-
<li>Deploy the webapp in Tomcat or some other servlet container (you may
want to repackage the war file)</li>
-
<li>Make sure tomcat has permissions to write in forrestbot's build,
work, and log directories.</li>
</ol>
-<p>Optional: set up "cron jobs" to execute forrestbot. This is completely
- independent of the forrestbot web interface, but is often useful. A
- suggested practice is to build the sites regularly and deploy them as
- desired through the web interface.</p>
+<p>
+ Optional: set up "cron jobs" to execute forrestbot. This is completely
+ independent of the forrestbot web interface, but is often useful. A
+ suggested practice is to build the sites regularly and deploy them as
+ desired through the web interface.
+ </p>
</div>
-
<a name="N1007B"></a><a name="FAQ"></a>
<h2 class="underlined_10">FAQ</h2>
@@ -293,25 +287,36 @@
<h3 class="underlined_5">The build and/or deploy commands don't seem to work</h3>
<div class="warning">
<div class="label">Warning</div>
-<div class="content">The only environment variable available is FORREST_HOME, which
- is set by forrest-home in the settings.properties file. Use a wrapper
- script (see below) if you need other environment variables.</div>
-</div>
-<p>Currently forrestbot only logs the forrest part of it's execution,
- not the whole thing. And the web interface starts a forrestbot process
- and doesn't watch it's progress directly.</p>
-<p>Set debug-exec=true in settings.properties and make sure
- log4j.properties logs at the DEBUG level. This will log all the thread
- output.</p>
-<p>Then look at the debugging output for the command executed and the
- working directory used. Log into the server as the use the Tomcat server
- uses and cd to the working directory and then execute the command. This
- will fairly accurately simulate what the web interface does.</p>
+<div class="content">
+ The only environment variable available is FORREST_HOME, which is set
+ by forrest-home in the settings.properties file. Use a wrapper script
+ (see below) if you need other environment variables.
+ </div>
+</div>
+<p>
+ Currently forrestbot only logs the forrest part of it's execution, not
+ the whole thing. And the web interface starts a forrestbot process and
+ doesn't watch it's progress directly.
+ </p>
+<p>
+ Set debug-exec=true in settings.properties and make sure
+ log4j.properties logs at the DEBUG level. This will log all the thread
+ output.
+ </p>
+<p>
+ Then look at the debugging output for the command executed and the
+ working directory used. Log into the server as the use the Tomcat
+ server uses and cd to the working directory and then execute the
+ command. This will fairly accurately simulate what the web interface
+ does.
+ </p>
<a name="N10094"></a><a name="Can+I+do+anything+with+this+besides+just+running+the%0A++++++++forrestbot%3F"></a>
<h3 class="underlined_5">Can I do anything with this besides just running the
forrestbot?</h3>
-<p>Sure. Create a wrapper script and specify it as forrest-exec in
- settings.properties. Here's an example:</p>
+<p>
+ Sure. Create a wrapper script and specify it as forrest-exec in
+ settings.properties. Here's an example:
+ </p>
<pre class="code">#!/bin/bash
# get env vars
@@ -340,7 +345,6 @@
# you can postprocess something here</pre>
</div>
-
<a name="N100A3"></a><a name="TODO+Wishlist"></a>
<h2 class="underlined_10">TODO Wishlist</h2>
@@ -348,16 +352,12 @@
<ul>
<li>seperate authorization of 'build' and 'deploy'</li>
-
<li>log everything, not just the build</li>
-
<li>view old log files</li>
-
<li>ability to reload all config files on the fly</li>
-
<li>put date at top of viewlog_body page</li>