You are viewing a plain text version of this content. The canonical link for it is here.
Posted to svn@forrest.apache.org by cr...@apache.org on 2007/04/10 05:48:57 UTC
svn commit: r527010 [21/26] - in /forrest/trunk/site-author/content: ./
skins/ xdocs/ xdocs/docs_0_70/ xdocs/docs_0_70/howto/
xdocs/docs_0_70/howto/bugzilla-patch/ xdocs/docs_0_70/howto/cvs-ssh/
xdocs/docs_0_70/howto/multi/ xdocs/docs_0_80/ xdocs/docs_...
Modified: forrest/trunk/site-author/content/xdocs/live-sites.xml
URL: http://svn.apache.org/viewvc/forrest/trunk/site-author/content/xdocs/live-sites.xml?view=diff&rev=527010&r1=527009&r2=527010
==============================================================================
--- forrest/trunk/site-author/content/xdocs/live-sites.xml (original)
+++ forrest/trunk/site-author/content/xdocs/live-sites.xml Mon Apr 9 20:48:52 2007
@@ -16,164 +16,168 @@
limitations under the License.
-->
<!DOCTYPE document PUBLIC "-//APACHE//DTD Documentation V1.2//EN" "http://forrest.apache.org/dtd/document-v12.dtd">
-<document>
- <header>
- <title>Examples Built-With-Forrest</title>
- </header>
- <body>
- <p>These are some of the sites that were created using Apache Forrest
- technology.</p>
-
+<document>
+ <header>
+ <title>Examples Built-With-Forrest</title>
+ </header>
+ <body>
<p>
- If you want your site added to the list, then please send a request to
- the <link href="site:mail-lists">mailing lists</link> or to the
+ These are some of the sites that were created using Apache Forrest
+ technology.
+ </p>
+ <p>
+ If you want your site added to the list, then please send a request to the
+ <link href="site:mail-lists">mailing lists</link> or to the
<link href="site:bugs">Issue tracker</link>. Tell us the URL, Name, and
catch-phrase.
</p>
-
- <section id="skinned">
- <title>Skinned Sites</title>
- <p>These sites use the skinning system that was part of all releases up
- to and including 0.7 release. This system is expected to be deprecated soon
- in favour of a more flexible system called Dispatcher. See the
- next section for some examples of such sites.</p>
- <ul>
- <li><link href="ext:xml.apache.org">Apache XML Project (xml.apache.org)</link></li>
- <li><link href="ext:forrest">Apache Forrest</link></li>
- <li><link href="site:references/cocoon">Apache Cocoon</link></li>
- <li><link href="site:references/lenya">Apache Lenya</link> </li>
- <li><link href="http://aft.sourceforge.net/">Anteater</link> - Ant-based functional testing</li>
- <li><link href="http://chaperon.sourceforge.net">Chaperon</link> - text parser</li>
- <li><link href="http://www.iasandcb.pe.kr/3g/">IAS&CB</link></li>
- <li>Some <link href="http://www.apache.org/~coar/people.html">Apache
+ <section id="skinned">
+ <title>Skinned Sites</title>
+ <p>
+ These sites use the skinning system that was part of all releases up to
+ and including 0.7 release. This system is expected to be deprecated soon
+ in favour of a more flexible system called Dispatcher. See the next
+ section for some examples of such sites.
+ </p>
+ <ul>
+ <li><link href="ext:xml.apache.org">Apache XML Project (xml.apache.org)</link></li>
+ <li><link href="ext:forrest">Apache Forrest</link></li>
+ <li><link href="site:references/cocoon">Apache Cocoon</link></li>
+ <li><link href="site:references/lenya">Apache Lenya</link></li>
+ <li><link href="http://aft.sourceforge.net/">Anteater</link> - Ant-based functional testing</li>
+ <li><link href="http://chaperon.sourceforge.net">Chaperon</link> - text parser</li>
+ <li><link href="http://www.iasandcb.pe.kr/3g/">IAS&CB</link></li>
+ <li>Some <link href="http://www.apache.org/~coar/people.html">Apache
Committer</link> personal pages</li>
- <li><link href="ext:fop">Apache FOP</link>
+ <li><link href="ext:fop">Apache FOP</link>
(Formatting Objects Processor)</li>
- <li><link href="http://www.dream-models.com/">Dream Models</link>
+ <li><link href="http://www.dream-models.com/">Dream Models</link>
- gather information about electric radio controlled helicopters</li>
- <li><link href="http://people.apache.org/~vgritsenko/stats/">Apache Stats (Vadim's Home Page)</link> - some web statistics</li>
- <li><link href="http://www.indexgeo.net/zalarm/">Z-alarm - Ensure
+ <li><link href="http://people.apache.org/~vgritsenko/stats/">Apache Stats (Vadim's Home Page)</link> - some web statistics</li>
+ <li><link href="http://www.indexgeo.net/zalarm/">Z-alarm - Ensure
information server integrity</link></li>
- <li><link href="http://jakarta.apache.org/poi/">Apache Jakarta POI</link></li>
- <li><link href="http://terra-intl.com/">Terra-International, Inc. (Japanese)</link></li>
- <li><link href="http://jakarta.terra-intl.com/poi/">Apache Jakarta POI (Japanese Translation)</link></li>
- <li><link href="http://xfp.sourceforge.net/">XFP</link> - eXtensible Filtering Pipelines</li>
- <li><link href="http://www.atlassian.com/software/jira/docs/latest">JIRA bugtracker documentation</link></li>
- <li><link href="http://www.phpopentracker.de/">phpOpenTracker</link> - A framework solution for the analysis of website traffic and visitor analysis</li>
- <li><link href="http://ws.apache.org/">Apache Web Services Project</link></li>
- <li><link href="http://ws.apache.org/wsif/">Apache WSIF Project</link> - Web Services Invocation Framework</li>
- <li><link href="http://xml.apache.org/xmlbeans/">Apache XMLBeans</link> - An XML-Java binding tool</li>
- <li><link href="http://druid.sourceforge.net/">Druid: The Database Manager</link> - GUI tool to create databases (GPL)</li>
- <li><link href="http://ws.apache.org/axis/">Apache Axis</link> - an implementation of the SOAP ("Simple Object Access Protocol")</li>
- <li><link href="http://ws.apache.org/soap/">Apache SOAP</link> - an implementation of the SOAP submission</li>
- <li><link href="http://www.kanaputs.org/">Kanaputs</link> - an interpreter for Java</li>
- <li><link href="http://cese.sourceforge.net/">Cell Electrophysiology Simulation Environment (CESE)</link>
+ <li><link href="http://jakarta.apache.org/poi/">Apache Jakarta POI</link></li>
+ <li><link href="http://terra-intl.com/">Terra-International, Inc. (Japanese)</link></li>
+ <li><link href="http://jakarta.terra-intl.com/poi/">Apache Jakarta POI (Japanese Translation)</link></li>
+ <li><link href="http://xfp.sourceforge.net/">XFP</link> - eXtensible Filtering Pipelines</li>
+ <li><link href="http://www.atlassian.com/software/jira/docs/latest">JIRA bugtracker documentation</link></li>
+ <li><link href="http://www.phpopentracker.de/">phpOpenTracker</link> - A framework solution for the analysis of website traffic and visitor analysis</li>
+ <li><link href="http://ws.apache.org/">Apache Web Services Project</link></li>
+ <li><link href="http://ws.apache.org/wsif/">Apache WSIF Project</link> - Web Services Invocation Framework</li>
+ <li><link href="http://xml.apache.org/xmlbeans/">Apache XMLBeans</link> - An XML-Java binding tool</li>
+ <li><link href="http://druid.sourceforge.net/">Druid: The Database Manager</link> - GUI tool to create databases (GPL)</li>
+ <li><link href="http://ws.apache.org/axis/">Apache Axis</link> - an implementation of the SOAP ("Simple Object Access Protocol")</li>
+ <li><link href="http://ws.apache.org/soap/">Apache SOAP</link> - an implementation of the SOAP submission</li>
+ <li><link href="http://www.kanaputs.org/">Kanaputs</link> - an interpreter for Java</li>
+ <li><link href="http://cese.sourceforge.net/">Cell Electrophysiology Simulation Environment (CESE)</link>
- a framework for computational electrophysiological simulations</li>
- <li><link href="ext:gump">Apache Gump</link></li>
- <li><link href="http://www.agssa.net/">AG Software</link></li>
- <li><link href="http://jdbc.postgresql.org/">PostgreSQL JDBC Driver</link></li>
- <li><link href="http://www.sbbi.net/">SuperBonBon Industries</link></li>
- <li><link href="http://learnlinux.tsf.org.za/">Learn Linux</link> - developing Free/Open Source GNU/Linux Training Materials</li>
- <li><link href="http://computerdictionary.tsf.org.za">Computer Dictionary Project</link> - develop a DocBook XML computer nomenclature glossary database</li>
- <li><link href="http://www.softoutfit.com/">Cañones Software Outfitter</link></li>
- <li><link href="http://www.cirquedigital.com/">Cirque|Digital, LLC</link></li>
- <li><link href="http://db.apache.org/derby/">Apache Derby</link>
+ <li><link href="ext:gump">Apache Gump</link></li>
+ <li><link href="http://www.agssa.net/">AG Software</link></li>
+ <li><link href="http://jdbc.postgresql.org/">PostgreSQL JDBC Driver</link></li>
+ <li><link href="http://www.sbbi.net/">SuperBonBon Industries</link></li>
+ <li><link href="http://learnlinux.tsf.org.za/">Learn Linux</link> - developing Free/Open Source GNU/Linux Training Materials</li>
+ <li><link href="http://computerdictionary.tsf.org.za">Computer Dictionary Project</link> - develop a DocBook XML computer nomenclature glossary database</li>
+ <li><link href="http://www.softoutfit.com/">Cañones Software Outfitter</link></li>
+ <li><link href="http://www.cirquedigital.com/">Cirque|Digital, LLC</link></li>
+ <li><link href="http://db.apache.org/derby/">Apache Derby</link>
- a zero admin, embeddable java rdbms</li>
- <li><link href="http://www.atbymjm.com/">ATbyMJM</link>
+ <li><link href="http://www.atbymjm.com/">ATbyMJM</link>
- Assistive Technology, using augmentive communication devices, by Martha Jane McLellan</li>
- <li><link href="http://www.cccp-project.org/">CCCP Common Clan Portal</link>
+ <li><link href="http://www.cccp-project.org/">CCCP Common Clan Portal</link>
- Primarily a J2EE website application for game clans</li>
- <li><link href="http://www.verit.de/">verit Informationssysteme GmbH</link></li>
- <li><link href="http://www.sello-propio.com/">Sello Propio</link> - Feng Shui in Columbia</li>
- <li><link href="http://www.divvun.no/">Sámi proofing tools development project</link></li>
- <li><link href="http://www.risten.no/">Sámi terminology portal</link>
+ <li><link href="http://www.verit.de/">verit Informationssysteme GmbH</link></li>
+ <li><link href="http://www.sello-propio.com/">Sello Propio</link> - Feng Shui in Columbia</li>
+ <li><link href="http://www.divvun.no/">Sámi proofing tools development project</link></li>
+ <li><link href="http://www.risten.no/">Sámi terminology portal</link>
- (background documentation uses Forrest, the main page uses eXist+Cocoon)</li>
- <li><link href="http://www.discountdracula.com/">DisCountDracula</link>
+ <li><link href="http://www.discountdracula.com/">DisCountDracula</link>
- bargains/deals on various products and services</li>
- <li><link href="http://www.cfas.org/">Central Florida Astronomical
+ <li><link href="http://www.cfas.org/">Central Florida Astronomical
Society</link>
- The Central Florida Astronomical Society, Inc.
(CFAS) is a 501(c)(3) organization operating in the Greater Orlando Metropolitan
area and surrounding communities.</li>
- <li><link href="http://uml2svg.sourceforge.net/">uml2svg</link>
+ <li><link href="http://uml2svg.sourceforge.net/">uml2svg</link>
- an
XSLT-based tool for converting XMI-compliant UML Diagrams into
SVG</li>
- <li><link href="http://www.technicat.com/">technicat</link>
+ <li><link href="http://www.technicat.com/">technicat</link>
- consulting
and development expertise to the Internet, educational software,
computer graphics and video game industries</li>
- <li><link href="http://icdl.tsf.org.za/">OpenICDL</link>
+ <li><link href="http://icdl.tsf.org.za/">OpenICDL</link>
- training materials for International Computer Driving License certification</li>
- <li><link href="http://www.thesummitjournal.com/">The Summit Journal</link> -
+ <li><link href="http://www.thesummitjournal.com/">The Summit Journal</link> -
A global, free, translated and syndicated Adventure and Exploration publication. </li>
- <li><link href="http://www.xprime.com.au/">X'Prime</link>
+ <li><link href="http://www.xprime.com.au/">X'Prime</link>
- Software company specialising in optimisation techniques
using evolutionary algorithms
</li>
- <li><link href="http://www.art-painter.com/">Snjezana Vidovic - Art Painter</link>
+ <li><link href="http://www.art-painter.com/">Snjezana Vidovic - Art Painter</link>
- Virtual Gallery
</li>
- <li><link href="http://www.j2world.net/">j2world</link>
+ <li><link href="http://www.j2world.net/">j2world</link>
- smart solutions for a mobile world</li>
- <li><link href="http://j2ee.by.ru/">J2EE Quick Start</link></li>
- <li><link href="http://javaworkshop.sourceforge.net ">Java Workshop</link> online web book - show cases some of the tools that every java developer should have in his / her toolbox </li>
- <li><link href="http://www.krabbelkaefer.de">Die Krabbelkäfer</link> -
+ <li><link href="http://j2ee.by.ru/">J2EE Quick Start</link></li>
+ <li><link href="http://javaworkshop.sourceforge.net ">Java Workshop</link> online web book - show cases some of the tools that every java developer should have in his / her toolbox </li>
+ <li><link href="http://www.krabbelkaefer.de">Die Krabbelkäfer</link> -
homepage of the association for the promotion of child care in Usingen
(Germany).</li>
- <li><link href="http://www.solvkroken.no/ekat/produkter/HK_00/">Produktkatalog for Sølvkroken</link>
+ <li><link href="http://www.solvkroken.no/ekat/produkter/HK_00/">Produktkatalog for Sølvkroken</link>
- biggest supplier of sports fishing equipment in Norway, with export all over the world.
</li>
- <li><link href="http://www.apwebco.com">Design Patterns</link> - GoF Design Patterns Tutorial</li>
- <li><link href="http://www.usefuldomains.co.uk">Generic Domain
+ <li><link href="http://www.apwebco.com">Design Patterns</link> - GoF Design Patterns Tutorial</li>
+ <li><link href="http://www.usefuldomains.co.uk">Generic Domain
Names</link> - Domain sales site specialising in industrial, business
and home themed generic domains.</li>
- <li><link href="http://www.travelvisas.eu/">travel visas</link>
+ <li><link href="http://www.travelvisas.eu/">travel visas</link>
- travel information for backpackers and other travellers in Europe and
beyond
</li>
- <li><link href="http://www.xmlmath.org">XMLMath</link> - XML-Based Mathematical Expression Evaluator</li>
- <li><link href="http://g11ntoolkit.sourceforge.net/">Globalization Tool Kit</link>
+ <li><link href="http://www.xmlmath.org">XMLMath</link> - XML-Based Mathematical Expression Evaluator</li>
+ <li><link href="http://g11ntoolkit.sourceforge.net/">Globalization Tool Kit</link>
- Introduction to the G11NToolKit.</li>
- <li><link href="http://barcode4j.krysalis.org/">Barcode4J</link>
+ <li><link href="http://barcode4j.krysalis.org/">Barcode4J</link>
- a flexible generator for barcodes written in Java.</li>
- <li><link href="http://maemo.org/">Maemo</link> -
+ <li><link href="http://maemo.org/">Maemo</link> -
open development platform to create applications
for Nokia 770 Internet Tablet and other maemo compliant
- handheld devices in the future.</li>
- <li><link href="http://www.primordion.com/Xholon/">Xholon</link>
+ handheld devices in the future.</li>
+ <li><link href="http://www.primordion.com/Xholon/">Xholon</link>
- A Java framework for developing UML 2.0 and other event-driven systems.
</li>
- <li><link href="http://www.primordion.com/Cellontro/">Cellontro</link>
+ <li><link href="http://www.primordion.com/Cellontro/">Cellontro</link>
- Modeling and simulation of cells, other biological entities, and
biochemical networks, using Xholon.
</li>
- <li><link href="http://www.erbox.org/">ER/Box Site</link> An all Java, open source ERP system built on Compiere and Apache Derby. Some customisations have been <link href="http://www.erbox.org/documentation/Other/ForrestNotes/forrestNotesOverview.html">documented</link>.</li>
- <li><link href="http://apfw.sourceforge.net/">Apparatus Framework</link> -
+ <li><link href="http://www.erbox.org/">ER/Box Site</link> An all Java, open source ERP system built on Compiere and Apache Derby. Some customisations have been <link href="http://www.erbox.org/documentation/Other/ForrestNotes/forrestNotesOverview.html">documented</link>.</li>
+ <li><link href="http://apfw.sourceforge.net/">Apparatus Framework</link> -
An object-oriented software framework written in C++ for
embedded applications.</li>
- <li><link href="http://www.skiclub-troisdorf.de/">Skiclub
+ <li><link href="http://www.skiclub-troisdorf.de/">Skiclub
Troisdorf-Sieglar e.V.</link> The skiclub aims to provide ski related
activities and social events for our members in and around Troisdorf area
- (near Cologne and Bonn).</li>
- <li><link href="http://scriptella.javaforge.com">Scriptella ETL</link> Open source ETL (Extract-Transform-Load) and script execution tool. </li>
- <li><link href="http://open.controltier.com/">open.controltier.com</link> Open Source tools for automating the build and deployment of complex applications.</li>
- <li><link href="http://antdepo.org/">antdepo.org</link> Open Source automation harness built on top of Apache Ant</li>
- <!-- <li><link href=""></link></li> -->
- </ul>
+ (near Cologne and Bonn).</li>
+ <li><link href="http://scriptella.javaforge.com">Scriptella ETL</link> Open source ETL (Extract-Transform-Load) and script execution tool. </li>
+ <li><link href="http://open.controltier.com/">open.controltier.com</link> Open Source tools for automating the build and deployment of complex applications.</li>
+ <li><link href="http://antdepo.org/">antdepo.org</link> Open Source automation harness built on top of Apache Ant</li>
+<!-- <li><link href=""></link></li> -->
+ </ul>
</section>
-
<section id="dispatcher">
<title>Sites using upcoming Dispatcher</title>
- <p>The skinning system in versions of Forrest up to and including 0.7 was great,
- however, it proved to be too inflexible. Soon we will have
- brand new system called Dispatcher. The following sites are examples.
+ <p>
+ The skinning system in versions of Forrest up to and including 0.7 was
+ great, however, it proved to be too inflexible. Soon we will have brand
+ new system called Dispatcher. The following sites are examples.
</p>
- <note>The Dispatcher is still in development (as of 0.8-dev cycle), please
- only use them if you know what you are doing. We expect to include them in
- an upcoming release at which point we will be encouraging their use.</note>
+ <note>
+ The Dispatcher is still in development (as of 0.8-dev cycle), please
+ only use them if you know what you are doing. We expect to include them
+ in an upcoming release at which point we will be encouraging their use.
+ </note>
<ul>
- <li><link href="http://floatingsun.net/">Floating Sun</link> - Diwaker Gupta :: Web/Blog/Gallery</li>
+ <li><link href="http://floatingsun.net/">Floating Sun</link> - Diwaker Gupta :: Web/Blog/Gallery</li>
<li><link href="http://www.ourlittlestars.org/">Our Little Stars</link> - A non-profit toy library site.
This site is interesting because it pulls content from many locations including a Daisy CMS system and
the Amazon ECS service.</li>
@@ -186,7 +190,7 @@
<li><link href="http://www.criaturitas.org/">CDK - club deportivo kriaturitas</link>.
Website of the basketball club CDK located in Sevilla, España.</li>
<li><link href="http://www.varietee.com.au/">varietee™ adjustable golf practice platforms</link></li>
- <!-- <li><link href=""></link></li> -->
+<!-- <li><link href=""></link></li> -->
</ul>
</section>
</body>
Modified: forrest/trunk/site-author/content/xdocs/mail-lists.xml
URL: http://svn.apache.org/viewvc/forrest/trunk/site-author/content/xdocs/mail-lists.xml?view=diff&rev=527010&r1=527009&r2=527010
==============================================================================
--- forrest/trunk/site-author/content/xdocs/mail-lists.xml (original)
+++ forrest/trunk/site-author/content/xdocs/mail-lists.xml Mon Apr 9 20:48:52 2007
@@ -16,160 +16,169 @@
limitations under the License.
-->
<!DOCTYPE document PUBLIC "-//APACHE//DTD Documentation V1.2//EN" "http://forrest.apache.org/dtd/document-v12.dtd">
-<document>
- <header>
- <title>Mailing Lists</title>
- </header>
+<document>
+ <header>
+ <title>Mailing Lists</title>
+ </header>
<body>
<section>
<title>Important Notices</title>
- <p>Before posting a question or problem to any mailing list, please first
- look at the following resources:</p>
- <ul>
- <li><link href="site:documentation/faq">Forrest FAQs</link></li>
- <li><link href="site:index">Forrest documentation</link></li>
+ <p>
+ Before posting a question or problem to any mailing list, please first
+ look at the following resources:
+ </p>
+ <ul>
+ <li><link href="site:documentation/faq">Forrest FAQs</link></li>
+ <li><link href="site:index">Forrest documentation</link></li>
<li><link href="http://cocoon.apache.org/link/">Cocoon Links</link>
(section: Related Topics)
for pointers to general XML and XSL and Java related resources.
- Please do not ask such questions here unless they are related to Forrest.</li>
+ Please do not ask such questions here unless they are related to Forrest.</li>
<li>Mailing list <link href="#Lists">archives</link>
- - a veritable goldmine of Forrest-specific information.</li>
+ - a veritable goldmine of Forrest-specific information.</li>
<li>Contribution <link href="contrib.html#tips">notes and tips</link>
(e.g. a clear subject heading; being patient).</li>
- </ul>
- <p>If you are posting about a problem that you are having, it will aid in
+ </ul>
+ <p>
+ If you are posting about a problem that you are having, it will aid in
finding a speedy resolution if you provide full configuration details,
- including the version number of Forrest, your operating system, JDK version, and
- servlet engine, and full details of any errors encountered including
- full error messages and stack traces.</p>
+ including the version number of Forrest, your operating system, JDK
+ version, and servlet engine, and full details of any errors encountered
+ including full error messages and stack traces.
+ </p>
<note>
- Please use our Jira <link href="site:bugs">issue tracker</link>
- to submit attachments, rather than the mailing list. Create a new
- issue, if necessary.
+ Please use our Jira <link href="site:bugs">issue tracker</link> to
+ submit attachments, rather than the mailing list. Create a new issue, if
+ necessary.
</note>
<p>
Please do not send emails directly to individual developers asking for
- free support. We are non-paid volunteers who help out with the project and we do not
- necessarily have the time or energy to help people on an individual basis.
- Instead, we have these mailing lists which contain many
- individuals who will help to answer. There are numerous benefits of
+ free support. We are non-paid volunteers who help out with the project
+ and we do not necessarily have the time or energy to help people on an
+ individual basis. Instead, we have these mailing lists which contain
+ many individuals who will help to answer. There are numerous benefits of
using mailing lists over private communication. It is a shared resource
- where others can also learn from common mistakes and as a community we all grow
- together. This discussion also builds a searchable knowledge-base.
- Doing off-list discussion is not efficient: only one person hears the
- answers and it will cause the volunteers to become burnt out.
- See FAQ about <link href="site:faq/jobs">job offers</link>.
+ where others can also learn from common mistakes and as a community we
+ all grow together. This discussion also builds a searchable
+ knowledge-base. Doing off-list discussion is not efficient: only one
+ person hears the answers and it will cause the volunteers to become
+ burnt out. See FAQ about <link href="site:faq/jobs">job offers</link>.
</p>
- </section>
-
+ </section>
<section>
- <title>Lists</title>
- <table>
- <tr>
- <th>Name</th>
- <th>Archives</th>
- <th>Purpose</th>
- <th>Notes</th>
- <th>Subscription Management</th>
- </tr>
- <tr>
- <td><anchor id="forrest-user"/><strong>user@forrest</strong></td>
- <td><link href="http://mail-archives.apache.org/mod_mbox/forrest-user">mod_mbox
+ <title>Lists</title>
+ <table>
+ <tr>
+ <th>Name</th>
+ <th>Archives</th>
+ <th>Purpose</th>
+ <th>Notes</th>
+ <th>Subscription Management</th>
+ </tr>
+ <tr>
+ <td>
+ <anchor id="forrest-user"/><strong>user@forrest</strong>
+ </td>
+ <td><link href="http://mail-archives.apache.org/mod_mbox/forrest-user">mod_mbox
at mail-archives.apache.org</link>
- <br/><br/>
- <link href="http://www.mail-archive.com/user@forrest.apache.org/">mail-archive.com</link>
- <br/><br/>
- <link href="http://dir.gmane.org/gmane.text.xml.forrest.user">Gmane</link>
- </td>
- <td>Any general issue related to the day-to-day use of Forrest.</td>
- <td>This is a subscriber-only list (in an effort to stop spam), so you must join before you can post.</td>
- <td>
+ <br/>
+ <br/><link href="http://www.mail-archive.com/user@forrest.apache.org/">mail-archive.com</link>
+ <br/>
+ <br/><link href="http://dir.gmane.org/gmane.text.xml.forrest.user">Gmane</link>
+ </td>
+ <td>Any general issue related to the day-to-day use of Forrest.</td>
+ <td>This is a subscriber-only list (in an effort to stop spam), so you must join before you can post.</td>
+ <td>
user-subscribe<at>forrest.apache.org<br/>
user-unsubscribe<at>forrest.apache.org<br/>
user-help<at>forrest.apache.org
</td>
- </tr>
- <tr>
- <td><anchor id="forrest-dev"/><strong>dev@forrest</strong></td>
- <td>
- <link href="http://marc.theaimsgroup.com/?l=forrest-dev"> MARC: Mailing list ARChives at AIMS</link>
- <br/><br/>
- <link href="http://mail-archives.apache.org/mod_mbox/forrest-dev">mod_mbox
+ </tr>
+ <tr>
+ <td>
+ <anchor id="forrest-dev"/><strong>dev@forrest</strong>
+ </td>
+ <td><link href="http://marc.theaimsgroup.com/?l=forrest-dev"> MARC: Mailing list ARChives at AIMS</link>
+ <br/>
+ <br/><link href="http://mail-archives.apache.org/mod_mbox/forrest-dev">mod_mbox
at mail-archives.apache.org</link>
- <br/><br/>
- <link href="http://www.mail-archive.com/dev@forrest.apache.org/">mail-archive.com</link>
- <br/><br/>
- <link href="http://dir.gmane.org/gmane.text.xml.forrest.devel">Gmane</link>
- </td>
- <td>Any issue related to development and enhancement.</td>
- <td>Postings from non-subscribers are moderated.
+ <br/>
+ <br/><link href="http://www.mail-archive.com/dev@forrest.apache.org/">mail-archive.com</link>
+ <br/>
+ <br/><link href="http://dir.gmane.org/gmane.text.xml.forrest.devel">Gmane</link>
+ </td>
+ <td>Any issue related to development and enhancement.</td>
+ <td>Postings from non-subscribers are moderated.
<br/>Read-only NNTP access to forrest-dev is available through the
<link href="news://news.gmane.org:119/gmane.text.xml.forrest.devel">gmane.text.xml.forrest.devel newsgroup</link>
- </td>
- <td>
+ </td>
+ <td>
dev-subscribe<at>forrest.apache.org<br/>
dev-unsubscribe<at>forrest.apache.org<br/>
dev-help<at>forrest.apache.org
</td>
- </tr>
- <tr>
- <td><anchor id="forrest-svn"/><strong>svn@forrest</strong></td>
- <td><link href="http://mail-archives.apache.org/mod_mbox/forrest-svn">mod_mbox
+ </tr>
+ <tr>
+ <td>
+ <anchor id="forrest-svn"/><strong>svn@forrest</strong>
+ </td>
+ <td><link href="http://mail-archives.apache.org/mod_mbox/forrest-svn">mod_mbox
at mail-archives.apache.org</link>
- <br/><br/>
- <link href="http://www.mail-archive.com/svn@forrest.apache.org/">mail-archive.com</link>
- <br/><br/>
- <link href="http://dir.gmane.org/gmane.text.xml.forrest.cvs">Gmane</link>
- </td>
- <td>Receive notifications on changes in the Forrest codebase in the SVN repository.</td>
- <td>Replies go to dev@forrest</td>
- <td>
+ <br/>
+ <br/><link href="http://www.mail-archive.com/svn@forrest.apache.org/">mail-archive.com</link>
+ <br/>
+ <br/><link href="http://dir.gmane.org/gmane.text.xml.forrest.cvs">Gmane</link>
+ </td>
+ <td>Receive notifications on changes in the Forrest codebase in the SVN repository.</td>
+ <td>Replies go to dev@forrest</td>
+ <td>
svn-subscribe<at>forrest.apache.org<br/>
svn-unsubscribe<at>forrest.apache.org<br/>
svn-help<at>forrest.apache.org
</td>
- </tr>
- <tr>
- <td><anchor id="forrest-site-svn"/><strong>site-svn@forrest</strong></td>
- <td><link href="http://mail-archives.apache.org/mod_mbox/forrest-site-svn">mod_mbox
+ </tr>
+ <tr>
+ <td>
+ <anchor id="forrest-site-svn"/><strong>site-svn@forrest</strong>
+ </td>
+ <td><link href="http://mail-archives.apache.org/mod_mbox/forrest-site-svn">mod_mbox
at mail-archives.apache.org</link>
- <br/><br/>
- <link href="http://www.mail-archive.com/site-svn@forrest.apache.org/">mail-archive.com</link>
- </td>
- <td>Receive notifications on changes to the generated Forrest site SVN.</td>
- <td>Replies go to dev@forrest</td>
- <td>
+ <br/>
+ <br/><link href="http://www.mail-archive.com/site-svn@forrest.apache.org/">mail-archive.com</link>
+ </td>
+ <td>Receive notifications on changes to the generated Forrest site SVN.</td>
+ <td>Replies go to dev@forrest</td>
+ <td>
site-svn-subscribe<at>forrest.apache.org<br/>
site-svn-unsubscribe<at>forrest.apache.org<br/>
site-svn-help<at>forrest.apache.org
</td>
- </tr>
- </table>
+ </tr>
+ </table>
</section>
<section>
<title>Mailing list in mbox-format</title>
<p>
- These are Gzipped monthly archives which you can import into your
- local mail client.
+ These are Gzipped monthly archives which you can import into your local
+ mail client.
</p>
<ul>
- <li><link href="http://forrest.apache.org/mail/user/">user</link> - Since May 2004</li>
- <li><link href="http://forrest.apache.org/mail/dev/">dev</link> - Since February 2002</li>
- <li><link href="http://forrest.apache.org/mail/svn/">svn</link> - Since June 2004</li>
+ <li><link href="http://forrest.apache.org/mail/user/">user</link> - Since May 2004</li>
+ <li><link href="http://forrest.apache.org/mail/dev/">dev</link> - Since February 2002</li>
+ <li><link href="http://forrest.apache.org/mail/svn/">svn</link> - Since June 2004</li>
</ul>
</section>
<section>
<title>Related Mailing Lists</title>
- <ul>
-<li><link href="http://xml.apache.org/mail.html">XML Apache Projects</link>
+ <ul>
+ <li><link href="http://xml.apache.org/mail.html">XML Apache Projects</link>
- list of mailing lists for all xml.apache.org projects
-</li>
-<li>Especially
-<link href="http://cocoon.apache.org/mail-lists.html">Apache Cocoon</link>
-</li>
-<li>All Apache Software Foundation <link href="http://www.apache.org/foundation/mailinglists.html">lists</link>.
-</li>
- </ul>
- </section>
+</li>
+ <li>Especially
+<link href="http://cocoon.apache.org/mail-lists.html">Apache Cocoon</link></li>
+ <li>All Apache Software Foundation <link href="http://www.apache.org/foundation/mailinglists.html">lists</link>.
+</li>
+ </ul>
+ </section>
</body>
</document>
Modified: forrest/trunk/site-author/content/xdocs/mirrors.html
URL: http://svn.apache.org/viewvc/forrest/trunk/site-author/content/xdocs/mirrors.html?view=diff&rev=527010&r1=527009&r2=527010
==============================================================================
--- forrest/trunk/site-author/content/xdocs/mirrors.html (original)
+++ forrest/trunk/site-author/content/xdocs/mirrors.html Mon Apr 9 20:48:52 2007
@@ -22,103 +22,102 @@
<title>Obtain the Apache Forrest distribution</title>
</head>
<body>
-<h1><a name="how" />How to download</h1>
-<p class="note">
-Please realise that Forrest is still pre-1.0 release version.
-It is certainly usable for those who are prepared to move with it.
-See more notes about <a href="index.html#status">status</a>.
-</p>
-<p>Use the links below to download a distribution of Apache Forrest from
-one of our mirrors. It is good practice to
-<a href="[location]#verify">verify the integrity</a>
-of the distribution files.</p>
-
-<p>Apache Forrest is distributed as a <code>zip</code> archive (for Windows) and
-as a <code>tar.gz</code> archive (for UNIX). The contents are the same,
-the only difference is the line-endings of all text files.
-</p>
-<p>The distribution contains all of the source code, documentation,
-and resources, together with the pre-built ready-to-run forrest binary.
-It also includes pre-packaged copies of relevant portions of Apache Cocoon
-and Apache Ant, and supporting products.
-</p>
-<p>
-After unpacking the distribution, follow the README.txt
-to see the Requirements (just Java 1.4+), Installation Instructions and
-Documentation, Licensing and legal issues and credits.
-</p>
-
-<h1><a name="closest" />Current official release (closest mirror site selected automatically)</h1>
-
-<p>You are currently using <b>[preferred]</b>. If you encounter a
-problem with this mirror, then please select another. If all
-mirrors are failing, there are backup mirrors at the end of the list.
-See <a href="http://www.apache.org/mirrors/">status</a> of mirrors.
-</p>
-
-<form action="[location]" method="get" id="SelectMirror">
+ <h1><a name="how" />How to download</h1>
+ <p class="note">
+ Please realise that Forrest is still pre-1.0 release version. It is
+ certainly usable for those who are prepared to move with it. See more
+ notes about <a href="index.html#status">status</a>.
+ </p>
+ <p>
+ Use the links below to download a distribution of Apache Forrest from one
+ of our mirrors. It is good practice to <a href="[location]#verify">verify
+ the integrity</a> of the distribution files.
+ </p>
+ <p>
+ Apache Forrest is distributed as a <code>zip</code> archive (for Windows)
+ and as a <code>tar.gz</code> archive (for UNIX). The contents are the
+ same, the only difference is the line-endings of all text files.
+ </p>
+ <p>
+ The distribution contains all of the source code, documentation, and
+ resources, together with the pre-built ready-to-run forrest binary. It
+ also includes pre-packaged copies of relevant portions of Apache Cocoon
+ and Apache Ant, and supporting products.
+ </p>
+ <p>
+ After unpacking the distribution, follow the README.txt to see the
+ Requirements (just Java 1.4+), Installation Instructions and
+ Documentation, Licensing and legal issues and credits.
+ </p>
+ <h1><a name="closest" />Current official release (closest mirror site selected automatically)</h1>
+ <p>
+ You are currently using
+ <b>[preferred]</b>
+ . If you encounter a problem with this mirror, then please select another.
+ If all mirrors are failing, there are backup mirrors at the end of the
+ list. See <a href="http://www.apache.org/mirrors/">status</a> of mirrors.
+ </p>
+ <form action="[location]" method="get" id="SelectMirror">
Other mirrors: <select name="Preferred">
<!--[if-any http] [for http]-->
-<option value="[http]">[http]</option>
+ <option value="[http]">[http]</option>
<!--[end] [end]-->
<!--[if-any ftp] [for ftp]-->
-<option value="[ftp]">[ftp]</option>
+ <option value="[ftp]">[ftp]</option>
<!--[end] [end]-->
<!--[if-any backup] [for backup]-->
-<option value="[backup]">[backup] (backup)</option>
+ <option value="[backup]">[backup] (backup)</option>
<!--[end] [end]-->
-</select>
-<input type="submit" value="Change" />
-</form>
-
-<p>The current release is Apache Forrest 0.7 (see the
-<a href="[preferred]/forrest/RELEASE-NOTES-0.7.txt">release notes</a>).</p>
-
-<ul>
-<li>For UNIX operating systems:
+ </select>
+ <input type="submit" value="Change" />
+ </form>
+ <p>
+ The current release is Apache Forrest 0.7 (see the
+ <a href="[preferred]/forrest/RELEASE-NOTES-0.7.txt">release notes</a>).
+ </p>
+ <ul>
+ <li>For UNIX operating systems:
<a href="[preferred]/forrest/apache-forrest-0.7.tar.gz">apache-forrest-0.7.tar.gz</a>
[<a href="http://www.apache.org/dist/forrest/apache-forrest-0.7.tar.gz.asc">PGP</a>]
[<a href="http://www.apache.org/dist/forrest/apache-forrest-0.7.tar.gz.md5">MD5</a>]</li>
-
-<li>For Windows operating systems:
+ <li>For Windows operating systems:
<a href="[preferred]/forrest/apache-forrest-0.7.zip">apache-forrest-0.7.zip</a>
[<a href="http://www.apache.org/dist/forrest/apache-forrest-0.7.zip.asc">PGP</a>]
[<a href="http://www.apache.org/dist/forrest/apache-forrest-0.7.zip.md5">MD5</a>]</li>
-</ul>
-
-<h1><a name="svn" />Current development and head SVN repository</h1>
-
-<p>Developers can use the latest Apache Forrest features, the source code is under
-version control with Subversion (read how to
-<a href="site:documentation/developers/build">obtain</a> your working copy).
-</p>
-
-<h1><a name="archive" />Archive of old releases</h1>
-
-<p>Older releases are available in the <a
-href="http://archive.apache.org/dist/forrest/">archive</a>. Those
-releases are only provided as historical artefacts. We strongly
-recommend to not use those releases, but upgrade to the most recent release.
-</p>
-
-<h1><a name="verify" />Verify releases</h1>
-
-<p>It is essential that you verify the integrity of the downloaded
-files using the PGP and MD5 signatures. MD5 verification ensures the
-file was not corrupted or tampered with. PGP verification
-ensures that the file came from a certain person.</p>
-
-<p>The PGP signatures can be verified using
-<a href="http://www.pgpi.org/">PGP</a> or
-<a href="http://www.gnupg.org/">GPG</a>.
-First download the Apache Forrest
-<a href="http://www.apache.org/dist/forrest/KEYS">KEYS</a>
-as well as the <code>*.asc</code> signature file for the particular
-distribution. It is important that you get these files from the ultimate
-trusted source - the main ASF distribution site, rather than from a mirror.
-Then verify the signatures using ...</p>
-
-<pre>
+ </ul>
+ <h1><a name="svn" />Current development and head SVN repository</h1>
+ <p>
+ Developers can use the latest Apache Forrest features, the source code is
+ under version control with Subversion (read how to
+ <a href="site:documentation/developers/build">obtain</a> your working
+ copy).
+ </p>
+ <h1><a name="archive" />Archive of old releases</h1>
+ <p>
+ Older releases are available in the
+ <a
+href="http://archive.apache.org/dist/forrest/">archive</a>. Those
+ releases are only provided as historical artefacts. We strongly recommend
+ to not use those releases, but upgrade to the most recent release.
+ </p>
+ <h1><a name="verify" />Verify releases</h1>
+ <p>
+ It is essential that you verify the integrity of the downloaded files
+ using the PGP and MD5 signatures. MD5 verification ensures the file was
+ not corrupted or tampered with. PGP verification ensures that the file
+ came from a certain person.
+ </p>
+ <p>
+ The PGP signatures can be verified using
+ <a href="http://www.pgpi.org/">PGP</a> or
+ <a href="http://www.gnupg.org/">GPG</a>. First download the Apache Forrest
+ <a href="http://www.apache.org/dist/forrest/KEYS">KEYS</a> as well as the
+ <code>*.asc</code> signature file for the particular distribution. It is
+ important that you get these files from the ultimate trusted source - the
+ main ASF distribution site, rather than from a mirror. Then verify the
+ signatures using ...
+ </p>
+ <pre>
% pgpk -a KEYS
% pgpv apache-forrest-X.Y.tar.gz.asc
@@ -132,23 +131,26 @@
% gpg --import KEYS
% gpg --verify apache-forrest-X.Y.tar.gz.asc
</pre>
-
-<p>To verify the MD5 signature on the files, you need to use a program
-called <code>md5</code> or <code>md5sum</code>, which is
-included in many unix distributions. It is also available as part of
-<a href="http://www.gnu.org/software/textutils/textutils.html">GNU
-Textutils</a>. Windows users can get binary md5 programs from <a
-href="http://www.fourmilab.ch/md5/">here</a>, <a
+ <p>
+ To verify the MD5 signature on the files, you need to use a program called
+ <code>md5</code> or <code>md5sum</code>, which is included in many unix
+ distributions. It is also available as part of
+ <a href="http://www.gnu.org/software/textutils/textutils.html">GNU
+ Textutils</a>. Windows users can get binary md5 programs from
+ <a
+href="http://www.fourmilab.ch/md5/">here</a>,
+ <a
href="http://www.pc-tools.net/win32/freeware/console/">here</a>, or
-<a href="http://www.slavasoft.com/fsum/">here</a> or an openssl client
-from <a href="http://www.slproweb.com/products/Win32OpenSSL.html">here</a>.</p>
-
-<pre>
+ <a href="http://www.slavasoft.com/fsum/">here</a> or an openssl client
+ from
+ <a href="http://www.slproweb.com/products/Win32OpenSSL.html">here</a>.
+ </p>
+ <pre>
% md5sum apache-forrest-X.Y.tar.gz
... output should match the string in apache-forrest-X.Y.tar.gz.md5
</pre>
-
-<p>We strongly recommend you verify your downloads with both PGP and MD5.</p>
-
-</body>
+ <p>
+ We strongly recommend you verify your downloads with both PGP and MD5.
+ </p>
+ </body>
</html>
Modified: forrest/trunk/site-author/content/xdocs/plan/index.xml
URL: http://svn.apache.org/viewvc/forrest/trunk/site-author/content/xdocs/plan/index.xml?view=diff&rev=527010&r1=527009&r2=527010
==============================================================================
--- forrest/trunk/site-author/content/xdocs/plan/index.xml (original)
+++ forrest/trunk/site-author/content/xdocs/plan/index.xml Mon Apr 9 20:48:52 2007
@@ -26,23 +26,23 @@
<title>Overview</title>
<p>
This is a collection of notes to assist with certain project planning
- and to co-ordinate development.
- When the development work is complete, then these docs can be removed
- because all of the content will have moved into the documentation proper.
+ and to co-ordinate development. When the development work is complete,
+ then these docs can be removed because all of the content will have
+ moved into the documentation proper.
</p>
<p>
Refer to the <a href="site:bugs">Issue Tracker</a> for further specific
- information. Try to keep these notes, and the issues, as concise as possible.
+ information. Try to keep these notes, and the issues, as concise as
+ possible.
</p>
</section>
-
<section id="topics">
<title>Ongoing major development topics</title>
- <p>Some current topics in no particular order.</p>
+ <p>
+ Some current topics in no particular order.
+ </p>
<ul>
- <li>
- <a href="internal-xhtml.html">Internal structure is XHTML2</a>
- </li>
+ <li><a href="internal-xhtml.html">Internal structure is XHTML2</a></li>
<li>
Integrate the "views" facility with the core and rename its components.
</li>
Modified: forrest/trunk/site-author/content/xdocs/plan/internal-xhtml.xml
URL: http://svn.apache.org/viewvc/forrest/trunk/site-author/content/xdocs/plan/internal-xhtml.xml?view=diff&rev=527010&r1=527009&r2=527010
==============================================================================
--- forrest/trunk/site-author/content/xdocs/plan/internal-xhtml.xml (original)
+++ forrest/trunk/site-author/content/xdocs/plan/internal-xhtml.xml Mon Apr 9 20:48:52 2007
@@ -25,22 +25,22 @@
<section id="overview">
<title>Overview</title>
<p>
- The internal document structure currently uses document-v13
- and this is due to become XHTML2.
+ The internal document structure currently uses document-v13 and this is
+ due to become XHTML2.
</p>
<p>
See the parent issue:
- <a href="http://issues.apache.org/jira/browse/FOR-184">FOR-184</a>
- which also has links to some of the various email discussion threads.
+ <a href="http://issues.apache.org/jira/browse/FOR-184">FOR-184</a> which
+ also has links to some of the various email discussion threads.
</p>
</section>
-
<section id="tasks">
<title>Tasks</title>
<p>
The first job is to define what needs to happen. See the email
discussion:
- <a href="http://marc.theaimsgroup.com/?l=forrest-dev&m=112512727827172">Re: Planning the move to XHTML2</a>. Ross has started to add those as
+ <a href="http://marc.theaimsgroup.com/?l=forrest-dev&m=112512727827172">Re:
+ Planning the move to XHTML2</a>. Ross has started to add those as
subtasks for issue FOR-184.
</p>
</section>
Modified: forrest/trunk/site-author/content/xdocs/pluginDocs/plugins_0_70/pluginInfrastructure.xml
URL: http://svn.apache.org/viewvc/forrest/trunk/site-author/content/xdocs/pluginDocs/plugins_0_70/pluginInfrastructure.xml?view=diff&rev=527010&r1=527009&r2=527010
==============================================================================
--- forrest/trunk/site-author/content/xdocs/pluginDocs/plugins_0_70/pluginInfrastructure.xml (original)
+++ forrest/trunk/site-author/content/xdocs/pluginDocs/plugins_0_70/pluginInfrastructure.xml Mon Apr 9 20:48:52 2007
@@ -16,41 +16,42 @@
limitations under the License.
-->
<!DOCTYPE document PUBLIC "-//APACHE//DTD Documentation V2.0//EN" "http://forrest.apache.org/dtd/document-v20.dtd">
-
<document>
<header>
<title>Plugin Infrastructure</title>
</header>
-
<body>
<section id="overview">
<title>Overview</title>
- <p>Forrest can be extended with the addition of plugins. This document
- describes what a plugin is and outlines the plugin infrastructure so
- that you can start building your own Forrest extensions.</p>
+ <p>
+ Forrest can be extended with the addition of plugins. This document
+ describes what a plugin is and outlines the plugin infrastructure so
+ that you can start building your own Forrest extensions.
+ </p>
</section>
-
<section>
<title>What is a Forrest Plugin?</title>
-
- <p>A Forrest plugin is a set of resources and configuration files that
- extend the functionality of Forrest. They will typically consist of a
- sitemap, zero or more stylesheets and zero or more schemas.</p>
-
- <p>The plugins sitemap is mounted by Forrest's sitemap after the project
- specific sitemap but before the Forrest default matchers. This allows
- a plugin to override/extend default Forrest behaviour. By adopting a
- plugin model we can keep the core of Forrest tightly
- focused on the basic functionality, whilst still facilitating extensions
- to suit individual projects needs.</p>
-
+ <p>
+ A Forrest plugin is a set of resources and configuration files that
+ extend the functionality of Forrest. They will typically consist of a
+ sitemap, zero or more stylesheets and zero or more schemas.
+ </p>
+ <p>
+ The plugins sitemap is mounted by Forrest's sitemap after the project
+ specific sitemap but before the Forrest default matchers. This allows a
+ plugin to override/extend default Forrest behaviour. By adopting a
+ plugin model we can keep the core of Forrest tightly focused on the
+ basic functionality, whilst still facilitating extensions to suit
+ individual projects needs.
+ </p>
<section id="pluginTypes">
<title>Types of Plugin</title>
- <p>There are three types of plugin, <code>input</code>,
- <code>output</code> and <code>internal</code>. Each plugin has a
- specific role to play and extends a different part of Forrest:</p>
-
-<source>
+ <p>
+ There are three types of plugin, <code>input</code>,
+ <code>output</code> and <code>internal</code>. Each plugin has a
+ specific role to play and extends a different part of Forrest:
+ </p>
+ <source>
internal plugins
(site.xml, abs-linkmap etc.)
|
@@ -63,123 +64,132 @@
input plugin output plugin
(**.xml) (**.html, **.pdf etc.)
</source>
-
-
- <p>The name of the sitemap will reflect the type of plugin in use.
- That is, an internal plugin will have a sitemap called <code>internal.xmap</code>,
- an output plugin has <code>output.xmap</code> and an input plugin has
- <code>input.xmap</code>. In addition, an input plugin can optionally provide a
- <code>resources.xmap</code>.</p>
-
+ <p>
+ The name of the sitemap will reflect the type of plugin in use. That
+ is, an internal plugin will have a sitemap called
+ <code>internal.xmap</code>, an output plugin has
+ <code>output.xmap</code> and an input plugin has
+ <code>input.xmap</code>. In addition, an input plugin can optionally
+ provide a <code>resources.xmap</code>.
+ </p>
<section id="inputPlugins">
<title>Input Plugins</title>
- <p>Input plugins provide a new source format. For example, the
- OpenOffice.org plugin extends Forrest to allow the use of
- OpenOffice.org Application file formats.</p>
-
- <p>An input plugin provides an <code>input.xmap</code> file.
- This provides the source matchers (i.e. **.xml), it is
- mounted in forrest.xmap before the default forrest **.xml behaviour
- and therefore can override that default behaviour but it will not
- interfere with any internal Forrest infrastructure matches, or any
- other plugins infrastructure matches.</p>
-
- <p>An input plugin may also provide a <code>resources.xmap</code>
- file. This can be used to match additional resources that are not
- stored in XML files, for example, javascript files.</p>
+ <p>
+ Input plugins provide a new source format. For example, the
+ OpenOffice.org plugin extends Forrest to allow the use of
+ OpenOffice.org Application file formats.
+ </p>
+ <p>
+ An input plugin provides an <code>input.xmap</code> file. This
+ provides the source matchers (i.e. **.xml), it is mounted in
+ forrest.xmap before the default forrest **.xml behaviour and
+ therefore can override that default behaviour but it will not
+ interfere with any internal Forrest infrastructure matches, or any
+ other plugins infrastructure matches.
+ </p>
+ <p>
+ An input plugin may also provide a <code>resources.xmap</code> file.
+ This can be used to match additional resources that are not stored
+ in XML files, for example, javascript files.
+ </p>
</section>
-
<section id="outputPlugins">
<title>Output Plugins</title>
-
- <p>Output plugins provide a new output format. For example, the
- s5 plugin extends Forrest to produce HTML slides from Forrest
- documents.</p>
-
- <p>An output plugin provides an <code>output.xmap</code> file.
- This provides the relevant output matchers (i.e.
- **.html, **.pdf, **.slides), it is mounted before any of the default
- matchers for Forrest and so can override this default behaviour.</p>
+ <p>
+ Output plugins provide a new output format. For example, the s5
+ plugin extends Forrest to produce HTML slides from Forrest
+ documents.
+ </p>
+ <p>
+ An output plugin provides an <code>output.xmap</code> file. This
+ provides the relevant output matchers (i.e. **.html, **.pdf,
+ **.slides), it is mounted before any of the default matchers for
+ Forrest and so can override this default behaviour.
+ </p>
</section>
-
<section id="internalPlugins">
<title>Internal Plugins</title>
-
- <p>Internal plugins are for advanced use only. They provide ways
- of extending or overriding Forrest's
- internal operations. For example, the IMSManifest plugin
- allows Forrest projects to use an IMS Manifest file instead of
- a site.xml and tabs.xml configuration files.</p>
-
- <p>Internal plugins provide an <code>internal.xmap</code> file.
- This provides the infrastructure matchers (i.e.
- site.xml, faq.xml, issues.xml), and will be mounted before
- *any* of the Forrest matches. This sitemap can override any behaviour
- within Forrest and so developers of these plugins must be especially
- careful with the construction of their matchers, since they will be
- processed before any other matchers and consequently can easily break
- existing functionality. You must only do a <map:generate ...>
- if you are certain you are going to process the full result. </p>
+ <p>
+ Internal plugins are for advanced use only. They provide ways of
+ extending or overriding Forrest's internal operations. For example,
+ the IMSManifest plugin allows Forrest projects to use an IMS
+ Manifest file instead of a site.xml and tabs.xml configuration
+ files.
+ </p>
+ <p>
+ Internal plugins provide an <code>internal.xmap</code> file. This
+ provides the infrastructure matchers (i.e. site.xml, faq.xml,
+ issues.xml), and will be mounted before *any* of the Forrest
+ matches. This sitemap can override any behaviour within Forrest and
+ so developers of these plugins must be especially careful with the
+ construction of their matchers, since they will be processed before
+ any other matchers and consequently can easily break existing
+ functionality. You must only do a <map:generate ...> if you
+ are certain you are going to process the full result.
+ </p>
</section>
</section>
-
<section>
<title>Naming Conventions</title>
- <p>Technically you can name a plugin anything you like with one
- small restriction (see below). However, we
- do have some naming conventions that we recomend you follow. This is
- to minimise the chances of collision between plugins from different
- developers.</p>
-
- <p>The name should be structured like a java package name, and should
- include a relevant reverse domain name. For example:</p>
-
+ <p>
+ Technically you can name a plugin anything you like with one small
+ restriction (see below). However, we do have some naming conventions
+ that we recomend you follow. This is to minimise the chances of
+ collision between plugins from different developers.
+ </p>
+ <p>
+ The name should be structured like a java package name, and should
+ include a relevant reverse domain name. For example:
+ </p>
<source>org.apache.forrest.plugin.PLUGIN_TYPE.PLUGIN_NAME</source>
<source>net.sf.forrestPlugins.PLUGIN_TYPE.PLUGIN_NAME</source>
-
- <p>Where <code>PLUGIN_TYPE</code> is either "internal", "input" or
- "output" and <code>PLUGIN_NAME"</code> is a suitable name chosen by
- yourself.</p>
-
- <warning>Plugin names cannot have a '-' character in them. This character
- is used to indicate the start of a version number when defining a plugin
- to be used. See <a href="site:plugins/using">Using Plugins</a> for more
- information.</warning>
-
+ <p>
+ Where <code>PLUGIN_TYPE</code> is either "internal", "input" or
+ "output" and <code>PLUGIN_NAME"</code> is a suitable name chosen by
+ yourself.
+ </p>
+ <warning>
+ Plugin names cannot have a '-' character in them. This character is
+ used to indicate the start of a version number when defining a plugin
+ to be used. See <a href="site:plugins/using">Using Plugins</a> for
+ more information.
+ </warning>
</section>
-
<section>
<title>An Example Plugin</title>
-
- <p>In order to fully understand the applicability of Forrest Plugins we
- will consider an extension to the way in which Forrest defines the
- structure of the site. By default Forrest uses a site.xml file to
- define navigation through the site and a tabs.xml file to define the
- tabs across the top of the page. But what if we want to use a different
- file to describe site structure? For example, what if we want to use an
- IMS Manifest file from the SCORM content package standards
- (http://www.adlnet.org/).</p>
-
- <p>An IMS Manifest file describes the structure of a site. It is also
- possible to define a set of rules for extracting tab information from
- such a file. Consequently, it is possible to use an IMSManifest file to
- create Forrest's site.xml and tabs.xml files. The advantage would be that
- we can then use SCORM compliant content objects within Forrest.</p>
-
- <p>Unfortunately, IMS Manifests are much more complex than site.xml and
- tabs.xml files. Therefore, not all users will want to use them. Adding
- the functionality as an optional plugin seems to be the ideal
- solution.</p>
+ <p>
+ In order to fully understand the applicability of Forrest Plugins we
+ will consider an extension to the way in which Forrest defines the
+ structure of the site. By default Forrest uses a site.xml file to
+ define navigation through the site and a tabs.xml file to define the
+ tabs across the top of the page. But what if we want to use a
+ different file to describe site structure? For example, what if we
+ want to use an IMS Manifest file from the SCORM content package
+ standards (http://www.adlnet.org/).
+ </p>
+ <p>
+ An IMS Manifest file describes the structure of a site. It is also
+ possible to define a set of rules for extracting tab information from
+ such a file. Consequently, it is possible to use an IMSManifest file
+ to create Forrest's site.xml and tabs.xml files. The advantage would
+ be that we can then use SCORM compliant content objects within
+ Forrest.
+ </p>
+ <p>
+ Unfortunately, IMS Manifests are much more complex than site.xml and
+ tabs.xml files. Therefore, not all users will want to use them. Adding
+ the functionality as an optional plugin seems to be the ideal
+ solution.
+ </p>
</section>
</section>
-
<section>
<title>What Does a Forrest Plugin Look Like?</title>
-
- <p>Plugins will need to conform to a specified directory structure.
- This mirrors the default forrest directory structure:</p>
-
-<source>
+ <p>
+ Plugins will need to conform to a specified directory structure. This
+ mirrors the default forrest directory structure:
+ </p>
+ <source>
[plugin_name]
|
|-- config files (xmap, skinconf etc.)
@@ -194,15 +204,13 @@
|
|-- stylesheets (XSLs etc.)
</source>
-
- <section>
- <title>The IMS Manifest Plugin</title>
-
- <p>If we consider the IMS Manifest Plugin described above, we see that we
- will need the following files and directory structure:</p>
-
-
-<source>
+ <section>
+ <title>The IMS Manifest Plugin</title>
+ <p>
+ If we consider the IMS Manifest Plugin described above, we see that we
+ will need the following files and directory structure:
+ </p>
+ <source>
org.apache.forrest.plugin.internal.IMSManifest
|
|-- internal.xmap
@@ -216,12 +224,13 @@
|- pathutils.xsl
|- repositoryUtils.xsl
</source>
-
- <p>The internal.xmap file will override the default behaviour for the
- navigation generation matchers in Forrest, for example, it contains
- a matcher as follows:</p>
-
-<source><![CDATA[
+ <p>
+ The internal.xmap file will override the default behaviour for the
+ navigation generation matchers in Forrest, for example, it contains a
+ matcher as follows:
+ </p>
+ <source>
+<![CDATA[
<map:match pattern="abs-menulinks">
<map:select type="exists">
<map:when test="{properties:content.xdocs}imsmanifest.xml">
@@ -240,25 +249,30 @@
</map:when>
</map:select>
</map:match>
-]]></source>
-
- <note>Note that this matcher will default to the behaviour provided by
- Forrest if there is no imsmanifest.xml file present in the project.
- At present it is necessary to copy this default behaviour from the original
- Forrest *.xmap files. We hope to improve on this in the future.</note>
+]]>
+ </source>
+ <note>
+ Note that this matcher will default to the behaviour provided by
+ Forrest if there is no imsmanifest.xml file present in the project. At
+ present it is necessary to copy this default behaviour from the
+ original Forrest *.xmap files. We hope to improve on this in the
+ future.
+ </note>
+ </section>
</section>
- </section>
-
- <section>
- <title>How does Installation work?</title>
- <p>When Forrest installs a plugin it downloads a zip of the plugin code and
- extracts it into the <code>plugins</code> directory of Forrest and an entry is made
- in <code>src/plugins/[input|internal|output].xmap</code> (recall the actual sitemap
- name is dependant on the type of plugin it belongs to. For example, installing the
- IMSManifest plugin described above will result in the following entry
- being added to the plugin sitemap:</p>
-
- <source><![CDATA[
+ <section>
+ <title>How does Installation work?</title>
+ <p>
+ When Forrest installs a plugin it downloads a zip of the plugin code and
+ extracts it into the <code>plugins</code> directory of Forrest and an
+ entry is made in <code>src/plugins/[input|internal|output].xmap</code>
+ (recall the actual sitemap name is dependant on the type of plugin it
+ belongs to. For example, installing the IMSManifest plugin described
+ above will result in the following entry being added to the plugin
+ sitemap:
+ </p>
+ <source>
+<![CDATA[
<map:select type="exists">
<map:when test="input.xmap">
<map:mount uri-prefix=""
@@ -267,29 +281,34 @@
pass-through="true"/>
</map:when>
</map:select>
- ]]></source>
-
- <p>Installed plugins are managed by the
- FORREST_INSTALL_DIR/build/plugins/sitemap.xmap file. This file is mounted
- by the main Forrest sitemap with the following code:</p>
-
- <source><![CDATA[
+ ]]>
+ </source>
+ <p>
+ Installed plugins are managed by the
+ FORREST_INSTALL_DIR/build/plugins/sitemap.xmap file. This file is
+ mounted by the main Forrest sitemap with the following code:
+ </p>
+ <source>
+<![CDATA[
<map:pipeline internal-only="false">
<map:mount uri-prefix=""
src="{forrest:forrest.plugins}/sitemap.xmap"
check-reload="yes"
pass-through="true"/>
</map:pipeline>
- ]]></source>
-
- <note>The above plugin sitemap.xmap file is automatically managed by Forrest, the
- end user need never edit this file.</note>
+ ]]>
+ </source>
+ <note>
+ The above plugin sitemap.xmap file is automatically managed by Forrest,
+ the end user need never edit this file.
+ </note>
+ </section>
+ <section>
+ <title>Further Reading</title>
+ <p>
+ If you want to build a plugin you might like to start with our
+ <a href="site:v0.70//buildPlugin">HowTo on Building Plugins</a>.
+ </p>
</section>
-
- <section>
- <title>Further Reading</title>
- <p>If you want to build a plugin you might like to start with our
- <a href="site:v0.70//buildPlugin">HowTo on Building Plugins</a>.</p>
- </section>
</body>
</document>
Modified: forrest/trunk/site-author/content/xdocs/pluginDocs/plugins_0_70/usingPlugins.xml
URL: http://svn.apache.org/viewvc/forrest/trunk/site-author/content/xdocs/pluginDocs/plugins_0_70/usingPlugins.xml?view=diff&rev=527010&r1=527009&r2=527010
==============================================================================
--- forrest/trunk/site-author/content/xdocs/pluginDocs/plugins_0_70/usingPlugins.xml (original)
+++ forrest/trunk/site-author/content/xdocs/pluginDocs/plugins_0_70/usingPlugins.xml Mon Apr 9 20:48:52 2007
@@ -16,100 +16,108 @@
limitations under the License.
-->
<!DOCTYPE document PUBLIC "-//APACHE//DTD Documentation V2.0//EN" "http://forrest.apache.org/dtd/document-v20.dtd">
-
<document>
<header>
<title>Extending Forrest with Plugins</title>
</header>
-
<body>
<section id="overview">
<title>Overview</title>
- <p>Forrest provides the core functionality for generating documentation
- in various output formats from a range of input formats. However, it
- does not end there. Forrest can be extended through the addition of
- plugins. This document serves as an introduction to the Forrest
- plugin mechanism.</p>
-
+ <p>
+ Forrest provides the core functionality for generating documentation in
+ various output formats from a range of input formats. However, it does
+ not end there. Forrest can be extended through the addition of plugins.
+ This document serves as an introduction to the Forrest plugin mechanism.
+ </p>
<section>
<title>What plugins are available?</title>
- <p>You can run the command <code>forrest available-plugins</code> to get
- a list of the known plugins for Forrest.</p>
-
- <p>If you would like to have your own plugin added to this list then
- contact the <a href="site:mail-lists">developer mailing list</a>.</p>
+ <p>
+ You can run the command <code>forrest available-plugins</code> to get
+ a list of the known plugins for Forrest.
+ </p>
+ <p>
+ If you would like to have your own plugin added to this list then
+ contact the <a href="site:mail-lists">developer mailing list</a>.
+ </p>
</section>
</section>
-
<section>
<title>How is a Plugin Installed?</title>
-
- <p>If a site requires one or more plugins then the site designer will
- have named them in the <code>project.required.plugins</code> property
- in the projects <code>forrest.properties</code> file. When Forrest
- builds the site it will automatically discover the plugin and install
- it. In otherwords, the user need do nothing. For example,
- <code>project.required.plugins=org.apache.forrest.plugin.input.OpenOffice.org,org.apache.forrest.plugin.input.simplifiedDocbook</code>
- will cause Forrest to load the plugins called "org.apache.forrest.plugin.input.OpenOffice.org" and
- "org.apache.forrest.plugin.input.simplifiedDocbook".</p>
-
- <p>In the absence of a version number for the plugin (as is the case in the examples above)
- the most recent version that is applicabe to your release of Forrest will be used. This
- may result in unexpected behaviour if a new version of the plugin has been released that
- is incompatible with your current site. To force Forrest into using a specific version of
- a plugin you shuld add "-VERSION_NUMBER" to the end of the plugin name. For example,
- to force forrest to use the 1.0 version of the OpenOffice.org plugin you would use
- <code>org.apache.forrest.plugin.input.OpenOffice.org-1.0</code> If you define a version of the
- plugin that does not exist then it will fall back to using the most recent version avialable.
- This feature is useful when
- developing a new site as you can quickly force a plugin upgrade by deleting all installed
- plugins (use the command 'ant cleanPlugins'). However, this might result in the installation
- of an in-development plugin, therefore in a production environment you should always specify
- a known working version.</p>
-
- <p>By default a new forrest project includes plugins to generate
- PDF output from your source documents.</p>
-
+ <p>
+ If a site requires one or more plugins then the site designer will have
+ named them in the <code>project.required.plugins</code> property in the
+ projects <code>forrest.properties</code> file. When Forrest builds the
+ site it will automatically discover the plugin and install it. In
+ otherwords, the user need do nothing. For example,
+ <code>project.required.plugins=org.apache.forrest.plugin.input.OpenOffice.org,org.apache.forrest.plugin.input.simplifiedDocbook</code>
+ will cause Forrest to load the plugins called
+ "org.apache.forrest.plugin.input.OpenOffice.org" and
+ "org.apache.forrest.plugin.input.simplifiedDocbook".
+ </p>
+ <p>
+ In the absence of a version number for the plugin (as is the case in the
+ examples above) the most recent version that is applicabe to your
+ release of Forrest will be used. This may result in unexpected behaviour
+ if a new version of the plugin has been released that is incompatible
+ with your current site. To force Forrest into using a specific version
+ of a plugin you shuld add "-VERSION_NUMBER" to the end of the plugin
+ name. For example, to force forrest to use the 1.0 version of the
+ OpenOffice.org plugin you would use
+ <code>org.apache.forrest.plugin.input.OpenOffice.org-1.0</code> If you
+ define a version of the plugin that does not exist then it will fall
+ back to using the most recent version avialable. This feature is useful
+ when developing a new site as you can quickly force a plugin upgrade by
+ deleting all installed plugins (use the command 'ant cleanPlugins').
+ However, this might result in the installation of an in-development
+ plugin, therefore in a production environment you should always specify
+ a known working version.
+ </p>
+ <p>
+ By default a new forrest project includes plugins to generate PDF output
+ from your source documents.
+ </p>
<section>
<title>Upgrading from a Version of Forrest Without Plugins</title>
- <p>The plugin functionality was introduced in version 0.7 of Forrest.
- At this time some of the functionality previously in Forrest was
- extracted into a plugin. However, we have not broken backward
- compatability with earlier versions. In the absence of a
- <code>project.required.plugins</code> property in the projects
- <code>forrest.properties</code> file all plugins that contain
- functionality previously part of Forrest itself will be loaded
- automatically. Unless you intend to use new functionality provided
- by a plugin you will not need to make any changes top your project.</p>
-
- <p>If you do require additional plugin functionality, be sure to
- include all required plugins in the
- <code>project.required.plugins</code> property in the project's
- <code>forrest.properties</code>. You can view
- <code>main/webapp/default-forrest.properties</code>
- to see the names of plugins that provide previously core
- functionality.</p>
-
- <p>It is also worth noting that there is a small performance
- improvement if you remove plugins that are not in use. Therefore,
- if you do not use one or more of the plugins named in the
- <code>project.required.plugins</code> property of
- <code>main/webapp/default-forrest.properties</code>
- it is recomended that you override this value in your project's
- <code>forrest.properties</code> file.</p>
+ <p>
+ The plugin functionality was introduced in version 0.7 of Forrest. At
+ this time some of the functionality previously in Forrest was
+ extracted into a plugin. However, we have not broken backward
+ compatability with earlier versions. In the absence of a
+ <code>project.required.plugins</code> property in the projects
+ <code>forrest.properties</code> file all plugins that contain
+ functionality previously part of Forrest itself will be loaded
+ automatically. Unless you intend to use new functionality provided by
+ a plugin you will not need to make any changes top your project.
+ </p>
+ <p>
+ If you do require additional plugin functionality, be sure to include
+ all required plugins in the <code>project.required.plugins</code>
+ property in the project's <code>forrest.properties</code>. You can
+ view <code>main/webapp/default-forrest.properties</code> to see the
+ names of plugins that provide previously core functionality.
+ </p>
+ <p>
+ It is also worth noting that there is a small performance improvement
+ if you remove plugins that are not in use. Therefore, if you do not
+ use one or more of the plugins named in the
+ <code>project.required.plugins</code> property of
+ <code>main/webapp/default-forrest.properties</code> it is recomended
+ that you override this value in your project's
+ <code>forrest.properties</code> file.
+ </p>
</section>
</section>
-
<section>
<title>Avoiding Plugin Conflicts</title>
- <p>Clashes between plugins can occur. For example, the simplified-docbook
- and full docbook plugins may try and process the same files. In this
- instance the one that is mounted first will take precedence. Plugins
- are mounted in the order they appear in the
- <code>project.required.plugins</code> property, therefore the mounting
- order and therefore processing precedence is under user control.</p>
+ <p>
+ Clashes between plugins can occur. For example, the simplified-docbook
+ and full docbook plugins may try and process the same files. In this
+ instance the one that is mounted first will take precedence. Plugins are
+ mounted in the order they appear in the
+ <code>project.required.plugins</code> property, therefore the mounting
+ order and therefore processing precedence is under user control.
+ </p>
</section>
-
<section>
<title>Further Reading</title>
<ul>