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/05/09 11:02:26 UTC
svn commit: r536466 [2/2] - in /forrest/site: ./ docs_0_80/ docs_0_90/
Modified: forrest/site/docs_0_90/glossary.html
URL: http://svn.apache.org/viewvc/forrest/site/docs_0_90/glossary.html?view=diff&rev=536466&r1=536465&r2=536466
==============================================================================
--- forrest/site/docs_0_90/glossary.html (original)
+++ forrest/site/docs_0_90/glossary.html Wed May 9 02:02:23 2007
@@ -332,12 +332,30 @@
<a href="#c">C</a>
</li>
<li>
+<a href="#d">D</a>
+</li>
+<li>
+<a href="#g">G</a>
+</li>
+<li>
+<a href="#i">I</a>
+</li>
+<li>
+<a href="#l">L</a>
+</li>
+<li>
+<a href="#p">P</a>
+</li>
+<li>
<a href="#r">R</a>
</li>
<li>
<a href="#s">S</a>
</li>
<li>
+<a href="#t">T</a>
+</li>
+<li>
<a href="#x">X</a>
</li>
</ul>
@@ -350,7 +368,7 @@
<p>
This is a glossary of terms and their definitions for the Apache Forrest
project. Some plugins also have a glossary, for example
- <a href="http://forrest.apache.org/pluginDocs/dev/org.apache.forrest.plugin.internal.dispatcher/">Dispatcher</a>.
+ <a href="http://forrest.apache.org/pluginDocs/plugins_0_80/org.apache.forrest.plugin.internal.dispatcher/dispatcher-glossary.html">Dispatcher</a>.
</p>
</introduction>
@@ -394,14 +412,38 @@
<a name="ASF"></a><td class="term" id="ASF">The Apache Software Foundation (ASF)</td><td class="definitions">
<p>
1. <a href="http://apache.org/">The Apache Software Foundation</a> is the home of Apache
- Forrest.<br>
+ Forrest.
+ The ASF is a non-profit charity, membership-based corporation.
+ <br>
</p>
-</td><td class="notes"></td>
+</td><td class="notes">
+<ul>
+
+<li>
+
+<a href="http://apache.org/foundation/">Foundation website</a>
+
+</li>
+
+<li>
+
+<a href="http://apache.org/foundation/faq.html">Foundation FAQ</a>
+
+</li>
+
+<li>
+
+<a href="http://apache.org/foundation/how-it-works.html">How it works</a>
+
+</li>
+
+</ul>
+</td>
</tr>
</table>
</div>
-<a name="N10055"></a><a name="c"></a>
+<a name="N1006C"></a><a name="c"></a>
<h2 class="underlined_10">C</h2>
<div class="section">
<table class="ForrestTable" cellspacing="1" cellpadding="4">
@@ -434,7 +476,244 @@
</tr>
</table>
</div>
-<a name="N10082"></a><a name="r"></a>
+<a name="N10099"></a><a name="d"></a>
+<h2 class="underlined_10">D</h2>
+<div class="section">
+<table class="ForrestTable" cellspacing="1" cellpadding="4">
+<tr>
+<th>Term</th><th>Definitions</th><th>Notes</th>
+</tr>
+<tr>
+<a name="dispatcher"></a><td class="term" id="dispatcher">Dispatcher</td><td class="definitions">
+<p>
+ 1.
+ The aim of the "Dispatcher" concept is to provide a flexible framework for
+ creating site and page specific layout.
+ See the Dispatcher documentation and the Dispatcher Glossary for specific terminology.
+ <br>
+
+</p>
+</td><td class="notes">
+<ul>
+
+<li>
+
+<a href="http://forrest.apache.org/pluginDocs/plugins_0_80/org.apache.forrest.plugin.internal.dispatcher/">Dispatcher plugin documentation</a>
+
+</li>
+
+<li>
+
+<a href="http://forrest.apache.org/pluginDocs/plugins_0_80/org.apache.forrest.plugin.internal.dispatcher/dispatcher-glossary.html">Dispatcher glossary</a>
+
+</li>
+
+<li>
+
+<a href="../docs_0_90/status-themes.html">Status of themes: Skins and Dispatcher</a>
+
+</li>
+
+</ul>
+</td>
+</tr>
+</table>
+</div>
+<a name="N100C9"></a><a name="g"></a>
+<h2 class="underlined_10">G</h2>
+<div class="section">
+<table class="ForrestTable" cellspacing="1" cellpadding="4">
+<tr>
+<th>Term</th><th>Definitions</th><th>Notes</th>
+</tr>
+<tr>
+<a name="generator"></a><td class="term" id="generator">Generator</td><td class="definitions">
+<p>
+ 1.
+ A Generator is a Cocoon <a href="#sitemap">sitemap</a> component.
+ Each <a href="#pipeline">pipeline</a> begins with a Generator. Its job
+ is to generate XML content as SAX events and initialize the pipeline processing.
+ The default generator is the "File Generator" which reads an xml document
+ from the local file system or from any url.
+ <br>
+
+</p>
+</td><td class="notes">
+<ul>
+
+<li>
+
+<a href="../docs_0_90/sitemap-ref.html">Sitemap Reference</a> and the Cocoon documents linked from there.
+ </li>
+
+</ul>
+</td>
+</tr>
+</table>
+</div>
+<a name="N100F3"></a><a name="i"></a>
+<h2 class="underlined_10">I</h2>
+<div class="section">
+<table class="ForrestTable" cellspacing="1" cellpadding="4">
+<tr>
+<th>Term</th><th>Definitions</th><th>Notes</th>
+</tr>
+<tr>
+<a name="internal-xml"></a><td class="term" id="internal-xml">Internal document format</td><td class="definitions">
+<p>
+ 1.
+ Forrest's <em>internal</em> document format (defined by an XML-grammar).
+ This format is the common denominator for all things going into or coming
+ out of Forrest's core processing. All input-plugins will translate their
+ supported documents into this format, all output-plugins will create the
+ output by transforming this format into something else.
+ Currently Forrest uses "xdoc" <a href="../docs_0_90/../dtdx/document-v13.dtdx.html">document-v13-dtd</a>
+ as its internal format (see definition of <a href="#xdoc">xdoc</a> below).
+ We plan to later use a set of xhtml2 as the internal format.
+ <br>
+
+</p>
+</td><td class="notes"></td>
+</tr>
+</table>
+</div>
+<a name="N10117"></a><a name="l"></a>
+<h2 class="underlined_10">L</h2>
+<div class="section">
+<table class="ForrestTable" cellspacing="1" cellpadding="4">
+<tr>
+<th>Term</th><th>Definitions</th><th>Notes</th>
+</tr>
+<tr>
+<a name="linkmap"></a><td class="term" id="linkmap">Linkmap</td><td class="definitions">
+<p>
+ 1.
+ The "linkmap" is an internal resource that transforms the
+ <a href="#site-xml">site.xml</a> navigation and linking configuration
+ file into a table-of-contents. Every site has one at localhost:8888/linkmap.html
+ <br>
+
+</p>
+</td><td class="notes">
+<ul>
+
+<li>
+ For example, Forrest's <a href="../linkmap.html">Table of Contents</a>.
+ </li>
+
+</ul>
+</td>
+</tr>
+<tr>
+<a name="locationmap"></a><td class="term" id="locationmap">Locationmap</td><td class="definitions">
+<p>
+ 1.
+ Locationmaps define the mapping from requests to locations,
+ which enables content and resources to be located at various
+ different sources. The advantage of this is that the URL seen
+ by the user need bear no relation to the location of the source
+ document, thus Forrest can separate the client URL space from
+ the source document URL space. Thus, using the locationmap
+ it is possible to pull together documents from many different
+ locations into a single uniform site. In addition, since the
+ user URL space is now unconnected to the source URL space it is
+ possible to move source documents without breaking any existing
+ user links. There are various core locationmaps in the main/webapp
+ directory, each plugin can utilise locationmaps, and projects can
+ manage their resources with a project-specific locationmap.
+ <br>
+
+</p>
+</td><td class="notes">
+<ul>
+
+<li>
+
+<a href="../docs_0_90/locationmap.html">Locationmap</a>
+
+</li>
+
+</ul>
+</td>
+</tr>
+</table>
+</div>
+<a name="N10153"></a><a name="p"></a>
+<h2 class="underlined_10">P</h2>
+<div class="section">
+<table class="ForrestTable" cellspacing="1" cellpadding="4">
+<tr>
+<th>Term</th><th>Definitions</th><th>Notes</th>
+</tr>
+<tr>
+<a name="pipeline"></a><td class="term" id="pipeline">Pipeline</td><td class="definitions">
+<p>
+ 1.
+ The Cocoon <a href="#sitemap">Sitemaps</a> have one or more pipelines
+ which handle the processing of various pieces of xml content.
+ Each pipeline begins with a
+ <a href="#generator">Generator</a>, continues with zero or more
+ <a href="#transformer">Transformers</a>, and ends with a
+ <a href="#serializer">Serializer</a>.
+ Aggregation enables building a hierarchy of pipelines.
+ <br>
+
+</p>
+</td><td class="notes">
+<ul>
+
+<li>
+
+<a href="../docs_0_90/sitemap-ref.html">Sitemap Reference</a> and the Cocoon documents linked from there.
+ </li>
+
+</ul>
+</td>
+</tr>
+<tr>
+<a name="plugins"></a><td class="term" id="plugins">Plugins</td><td class="definitions">
+<p>
+ 1.
+ A Forrest Plugin is a set of resources and configuration files that extend the functionality of Forrest.
+ Plugins are a way of extending Forrest to satisfy site-specific needs.
+ The core of Forrest handles certain processing via the
+ <a href="#sitemap">sitemaps</a> in main/webapp/*.xmap files.
+ The main sitemap mounts a plugin sitemap from each declared plugin.
+ For example an input plugin might handle projectInfo source documents
+ to convert them into the <a href="#internal-xml">internal document format</a>
+ for further processing, while an output plugin would concern itself
+ with generating output PDF documents. Nice <a href="#SoC">Separation of Concerns</a>.
+ If no plugin is found to handle a certain document type, then processing falls back to the core.
+ <br>
+
+</p>
+</td><td class="notes">
+<ul>
+
+<li>
+
+<a href="../pluginDocs/plugins_0_90/index.html">Plugins index</a>
+
+</li>
+
+<li>
+
+<a href="../pluginDocs/plugins_0_90/usingPlugins.html">Extending Forrest with Plugins</a>
+
+</li>
+
+<li>
+
+<a href="../pluginDocs/plugins_0_90/pluginInfrastructure.html">Plugin infrastructure</a>
+
+</li>
+
+</ul>
+</td>
+</tr>
+</table>
+</div>
+<a name="N101B5"></a><a name="r"></a>
<h2 class="underlined_10">R</h2>
<div class="section">
<table class="ForrestTable" cellspacing="1" cellpadding="4">
@@ -444,14 +723,14 @@
<tr>
<a name="ReleaseCandidate"></a><td class="term" id="ReleaseCandidate">Release Candidate</td><td class="definitions">
<p>
- 1. A temporary Forrest package build from trunk during the <a href="../procedures/release/How_to_release.html">release process</a> to be tested and evaluated.<br>
+ 1. A temporary Forrest package built from trunk during the <a href="../procedures/release/How_to_release.html">release process</a> to be tested and evaluated.<br>
</p>
</td><td class="notes"></td>
</tr>
</table>
</div>
-<a name="N1009F"></a><a name="s"></a>
+<a name="N101D2"></a><a name="s"></a>
<h2 class="underlined_10">S</h2>
<div class="section">
<table class="ForrestTable" cellspacing="1" cellpadding="4">
@@ -484,27 +763,172 @@
</td>
</tr>
<tr>
-<a name="Skins"></a><td class="term" id="Skins">Skins</td><td class="definitions">
+<a name="serializer"></a><td class="term" id="serializer">Serializer</td><td class="definitions">
<p>
- 1. <br>
+ 1.
+ A Serializer is a Cocoon <a href="#sitemap">sitemap</a> component.
+ Each <a href="#pipeline">pipeline</a> ends with a Serializer. Its job
+ is to transform SAX events into binary or character streams for final
+ client consumption. One example (the default) is the "HTML Serializer"
+ which serializes xml content to html. The Serializer can have parameters
+ to configure its behaviour, e.g. to specify the document type declaration.
+ <br>
</p>
-</td><td class="notes"></td>
+</td><td class="notes">
+<ul>
+
+<li>
+
+<a href="../docs_0_90/sitemap-ref.html">Sitemap Reference</a> and the Cocoon documents linked from there.
+ </li>
+
+</ul>
+</td>
</tr>
<tr>
-<a name="StandardDocumentFormat"></a><td class="term" id="StandardDocumentFormat">Standard Document Format</td><td class="definitions">
+<a name="sitemap"></a><td class="term" id="sitemap">Sitemap</td><td class="definitions">
<p>
- 1. Forrests <em>internal</em> document format (defined by an XML-grammar). This format ist the common denominator
- for all things going into or coming out of Forrest's core processing. All input-plugins will translate their supported documents into this
- format, all output-plugins will create the output by transforming this format into something else. Currently Forrest uses <a href="../docs_0_90/../dtdx/document-v13.dtdx.html">document-v13-dtd</a> as its internal format.
- <br>
+ 1.
+ Cocoon Sitemaps (usually a filename ending with *.xmap)
+ is the system to enable Apache Cocoon to know how to process
+ different types of input and output.
+ Note that many other environments use the term "sitemap" to refer to
+ "a map of the site" which is what <a href="#site-xml">site.xml</a> can be considered to be.
+ <br>
</p>
-</td><td class="notes"></td>
+</td><td class="notes">
+<ul>
+
+<li>
+
+<a href="../docs_0_90/sitemap-ref.html">Sitemap Reference</a>
+
+</li>
+
+<li>
+
+<a href="../docs_0_90/project-sitemap.html">Using project sitemaps</a>
+
+</li>
+
+<li>
+
+<a href="../pluginDocs/plugins_0_90/pluginInfrastructure.html">Plugins infrastructure</a>
+
+</li>
+
+</ul>
+</td>
+</tr>
+<tr>
+<a name="site-xml"></a><td class="term" id="site-xml">site.xml</td><td class="definitions">
+<p>
+ 1.
+ The site.xml is the menu navigation and linking configuration file.
+ Don't get confused with <a href="#sitemap">sitemap</a> defined above.
+ <br>
+
+</p>
+</td><td class="notes">
+<ul>
+
+<li>
+
+<a href="../docs_0_90/linking.html">Menus and linking</a>
+
+</li>
+
+</ul>
+</td>
+</tr>
+<tr>
+<a name="skins"></a><td class="term" id="skins">Skins</td><td class="definitions">
+<p>
+ 1.
+ "Skins" are one method of providing alternatives for creating the
+ layout and look-and-feel of the set of documents.
+ Forrest provides one primary skin called <em>pelt</em>.
+ See the definition of <a href="#dispatcher">Dispatcher</a>
+ for another method.
+ <br>
+
+</p>
+</td><td class="notes">
+<ul>
+
+<li>
+
+<a href="../docs_0_90/your-project.html#skins">Using Forrest: Skins</a>
+
+</li>
+
+<li>
+
+<a href="../docs_0_90/status-themes.html">Status of themes: Skins and Dispatcher</a>
+
+</li>
+
+</ul>
+</td>
+</tr>
+<tr>
+<a name="svn"></a><td class="term" id="svn">Subversion (SVN)</td><td class="definitions">
+<p>
+ 1.
+ Subversion, also known as SVN, is the version control system used by all Apache projects.
+ <br>
+
+</p>
+</td><td class="notes">
+<ul>
+
+<li>
+
+<a href="../svn.html">Version control</a>
+
+</li>
+
+</ul>
+</td>
</tr>
</table>
</div>
-<a name="N100E7"></a><a name="x"></a>
+<a name="N10293"></a><a name="t"></a>
+<h2 class="underlined_10">T</h2>
+<div class="section">
+<table class="ForrestTable" cellspacing="1" cellpadding="4">
+<tr>
+<th>Term</th><th>Definitions</th><th>Notes</th>
+</tr>
+<tr>
+<a name="transformer"></a><td class="term" id="transformer">Transformer</td><td class="definitions">
+<p>
+ 1.
+ A Transformer is a Cocoon <a href="#sitemap">sitemap</a> component.
+ Each <a href="#pipeline">pipeline</a> has zero or more Transformers. Its job
+ is to transform SAX events into other SAX events.
+ The default transformer is the "XSLT Transformer" which uses an XSLT
+ stylesheet to transform xml content. The Transformer can have parameters
+ to configure its behaviour or pass data to the stylesheet.
+ <br>
+
+</p>
+</td><td class="notes">
+<ul>
+
+<li>
+
+<a href="../docs_0_90/sitemap-ref.html">Sitemap Reference</a> and the Cocoon documents linked from there.
+ </li>
+
+</ul>
+</td>
+</tr>
+</table>
+</div>
+<a name="N102BD"></a><a name="x"></a>
<h2 class="underlined_10">X</h2>
<div class="section">
<table class="ForrestTable" cellspacing="1" cellpadding="4">
@@ -516,8 +940,10 @@
<p>
1. "xdoc" is an xml documentation stucture that started life at some other ASF
projects. Apache Forrest adopted it and enhanced it to be similar to xhtml2. "xdoc" is
- currently the internal xml structure of Forrest (someday will be xhtml2). "xdocs" can be
- used as an input source format.<br>
+ currently the <a href="#internal-xml">internal xml structure</a>
+ of Forrest (someday will be xhtml2). "xdocs" can be
+ used as an input source format.
+ <br>
</p>
</td><td class="notes">
Modified: forrest/site/docs_0_90/glossary.pdf
URL: http://svn.apache.org/viewvc/forrest/site/docs_0_90/glossary.pdf?view=diff&rev=536466&r1=536465&r2=536466
==============================================================================
Binary files - no diff available.
Modified: forrest/site/docs_0_90/your-project.html
URL: http://svn.apache.org/viewvc/forrest/site/docs_0_90/your-project.html?view=diff&rev=536466&r1=536465&r2=536466
==============================================================================
--- forrest/site/docs_0_90/your-project.html (original)
+++ forrest/site/docs_0_90/your-project.html Wed May 9 02:02:23 2007
@@ -1494,7 +1494,7 @@
<div class="note">
<div class="label">Note</div>
<div class="content">
- Forrest supplies a collection of <a href="../docs_0_90/your-project.html#skins">default
+ Forrest supplies a collection of <a href="../docs_0_90/skins.html">default
skins</a> which are configurable and so should meet the needs of most
projects. The aim is to provide many capabilities so that extra skins
are not needed.
@@ -1695,7 +1695,7 @@
</p>
</div>
-<span class="version">SVN: $Revision: 529825 $ $Date: 2007-04-18 11:56:53 +1000 (Wed, 18 Apr 2007) $</span>
+<span class="version">SVN: $Revision: 536444 $ $Date: 2007-05-09 16:34:45 +1000 (Wed, 09 May 2007) $</span>
</div>
<!--+
|end content
Modified: forrest/site/docs_0_90/your-project.pdf
URL: http://svn.apache.org/viewvc/forrest/site/docs_0_90/your-project.pdf?view=diff&rev=536466&r1=536465&r2=536466
==============================================================================
Binary files - no diff available.
Modified: forrest/site/linkmap.html
URL: http://svn.apache.org/viewvc/forrest/site/linkmap.html?view=diff&rev=536466&r1=536465&r2=536466
==============================================================================
--- forrest/site/linkmap.html (original)
+++ forrest/site/linkmap.html Wed May 9 02:02:23 2007
@@ -818,6 +818,7 @@
+
</ul>
</ul>
@@ -869,7 +870,7 @@
<ul>
<li>
-<a href="docs_0_90/skins.html">Skins</a> ___________________ <em>skins</em> : About default skins, their naming and features</li>
+<a href="docs_0_90/skins.html">Skins</a> ___________________ <em>default-skins</em> : About default skins, their naming and features</li>
</ul>
<ul>
Modified: forrest/site/linkmap.pdf
URL: http://svn.apache.org/viewvc/forrest/site/linkmap.pdf?view=diff&rev=536466&r1=536465&r2=536466
==============================================================================
Binary files - no diff available.
Modified: forrest/site/subversion_bestpractices.html
URL: http://svn.apache.org/viewvc/forrest/site/subversion_bestpractices.html?view=diff&rev=536466&r1=536465&r2=536466
==============================================================================
--- forrest/site/subversion_bestpractices.html (original)
+++ forrest/site/subversion_bestpractices.html Wed May 9 02:02:23 2007
@@ -265,6 +265,9 @@
<li>See ASF-wide notes for <a href="http://www.apache.org/dev/#svn">developers</a>.
</li>
+<li>Use the <a href="http://svnbook.red-bean.com/">SVN Book</a> - Version Control with Subversion.
+ </li>
+
<li>
<a href="contrib.html#svn-config">Configure</a> your svn client.
<div class="fixme">
Modified: forrest/site/subversion_bestpractices.pdf
URL: http://svn.apache.org/viewvc/forrest/site/subversion_bestpractices.pdf?view=diff&rev=536466&r1=536465&r2=536466
==============================================================================
Binary files - no diff available.