forrest-site-svn mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From cross...@apache.org
Subject svn commit: r529915 [8/20] - in /forrest/site: ./ docs_0_70/ docs_0_70/howto/ docs_0_70/howto/cvs-ssh/ docs_0_70/howto/multi/ docs_0_80/ docs_0_80/howto/ docs_0_80/howto/cvs-ssh/ docs_0_80/howto/multi/ dtdx/ plan/ pluginDocs/ pluginDocs/plugins_0_70/ p...
Date Wed, 18 Apr 2007 08:36:26 GMT
Modified: forrest/site/docs_0_70/howto/howto-custom-html-source.html
URL: http://svn.apache.org/viewvc/forrest/site/docs_0_70/howto/howto-custom-html-source.html?view=diff&rev=529915&r1=529914&r2=529915
==============================================================================
--- forrest/site/docs_0_70/howto/howto-custom-html-source.html (original)
+++ forrest/site/docs_0_70/howto/howto-custom-html-source.html Wed Apr 18 01:36:14 2007
@@ -3,7 +3,7 @@
 <head>
 <META http-equiv="Content-Type" content="text/html; charset=UTF-8">
 <meta content="Apache Forrest" name="Generator">
-<meta name="Forrest-version" content="0.8-dev">
+<meta name="Forrest-version" content="0.9-dev">
 <meta name="Forrest-skin-name" content="pelt">
 <title>How to customize processing of html source (v0.7)</title>
 <link type="text/css" href="../../skin/basic.css" rel="stylesheet">
@@ -87,7 +87,7 @@
     |start Subtabs
     +-->
 <div id="level2tabs">
-<a class="selected" href="../../docs_0_70/index.html">0.70 (current)</a><a class="unselected" href="../../docs_0_80/index.html">0.80-dev (under development)</a><a class="unselected" href="../../docs_0_60/index.html">0.60 (past)</a>
+<a class="unselected" href="../../docs_0_80/index.html">0.80 (current)</a><a class="unselected" href="../../docs_0_90/index.html">0.90-dev (under development)</a><a class="selected" href="../../docs_0_70/index.html">0.70 (past)</a>
 </div>
 <!--+
     |end Endtabs
@@ -100,7 +100,7 @@
     |breadtrail
     +-->
 <div class="breadtrail">
-             
+
              &nbsp;
            </div>
 <!--+
@@ -283,7 +283,7 @@
 </div>
 <div id="credit">
 <hr>
-        This is documentation for current version v0.7
+        This is documentation for past version v0.7
        (<a href="http://forrest.apache.org/versions/">More</a>)</div>
 <div id="roundbottom">
 <img style="display: none" class="corner" height="15" width="15" alt="" src="../../skin/images/rc-b-l-15-1body-2menu-3menu.png"></div>
@@ -315,7 +315,7 @@
       Explains how to do additional processing of html source documents.
     </div>
 <div id="motd-area">
-        This is documentation for current version v0.7
+        This is documentation for past version v0.7
        (<a href="http://forrest.apache.org/versions/">More</a>)</div>
 <div id="minitoc-area">
 <ul class="minitoc">
@@ -398,25 +398,26 @@
 <h2 class="underlined_10">Intended Audience</h2>
 <div class="section">
 <p>
-      Users who want to integrate HTML-pages that require custom
-      adjustments and everybody who wants to learn more about Forrest's
-      pipelines in general.
+      Users who want to integrate HTML-pages that require custom adjustments and
+      everybody who wants to learn more about Forrest's pipelines in general.
     </p>
 </div>
 <a name="N10018"></a><a name="Purpose"></a>
 <h2 class="underlined_10">Purpose</h2>
 <div class="section">
 <p>
-      Integrating legacy HTML pages is a common task when migrating
-      existing websites to Forrest. This document explains how to implement
-      custom processing which is required when Forrest's standard pipeline
-      for html does not suffice.
+      Integrating legacy HTML pages is a common task when migrating existing
+      websites to Forrest. This document explains how to implement custom
+      processing which is required when Forrest's standard pipeline for html
+      does not suffice.
     </p>
 </div>
 <a name="N10020"></a><a name="Prerequisites"></a>
 <h2 class="underlined_10">Prerequisites</h2>
 <div class="section">
-<p>To follow these instructions you will need:</p>
+<p>
+      To follow these instructions you will need:
+    </p>
 <ol>
       
 <li>
@@ -451,130 +452,115 @@
 <h2 class="underlined_10">Understanding the HTML-Pipeline</h2>
 <div class="section">
 <p>
-      The first part of this howto explains the html pipeline, so as to
-      provide the background to enable you to add additional processing
-      for legacy html documents. If you already know how pipelines work,
-      then skip to the section about
-      <a href="#custom">Customizing the html pipeline</a>.
+      The first part of this howto explains the html pipeline, so as to provide
+      the background to enable you to add additional processing for legacy html
+      documents. If you already know how pipelines work, then skip to the
+      section about <a href="#custom">Customizing the html pipeline</a>.
     </p>
 <a name="N1004B"></a><a name="example"></a>
 <h3 class="underlined_5">Driven by Example</h3>
 <p>
-        The best way to learn about Forrest pipelines is follow
-        the processing of an imaginary request through the forrest
-        machinery.
+        The best way to learn about Forrest pipelines is follow the processing
+        of an imaginary request through the forrest machinery.
       </p>
 <p>
-        So let's see what happens, when a client asks Forrest to
-        serve the document
+        So let's see what happens, when a client asks Forrest to serve the
+        document
         <br>
         'http://some.domain.org/mytest/mybad.html'.
       </p>
 <a name="N1005A"></a><a name="sitemap"></a>
 <h3 class="underlined_5">Finding the Sitemap</h3>
 <p>
-        Like all applications based on Apache Cocoon, each request for
-        a given document is processed by searching a sitemap for a
-        matching processing pipeline. With Forrest, this core sitemap
-        is found in the file
+        Like all applications based on Apache Cocoon, each request for a given
+        document is processed by searching a sitemap for a matching processing
+        pipeline. With Forrest, this core sitemap is found in the file
         'main/webapp/sitemap.xmap' in Forrest's program directory.
       </p>
 <p class="instruction">
-        Open the file 'main/webapp/sitemap.xmap' in Forrest's
-        program directory with a text editor of your choice.
+        Open the file 'main/webapp/sitemap.xmap' in Forrest's program directory
+        with a text editor of your choice.
       </p>
 <div class="note">
 <div class="label">Note</div>
 <div class="content">
-        Any simple text editor will suffice, since the XML in
-        this file is quite simple in structure and easy to read.
+        Any simple text editor will suffice, since the XML in this file is quite
+        simple in structure and easy to read.
       </div>
 </div>
 <p>
-        To help you to easily follow the next steps, we have added
-        comments and anchors to 'sitemap.xmap',
-        so that you can quickly jump to all relevant sections
-        and read them more easily.
+        To help you to easily follow the next steps, we have added comments and
+        anchors to 'sitemap.xmap', so that you can quickly jump to all relevant
+        sections and read them more easily.
       </p>
 <p class="instruction">
-        Follow this link to the
-        <a href="sitemap.xmap.html#Start+of+Sitemap">
-          start of the Sitemap.
-        </a>
+        Follow this link to the <a href="sitemap.xmap.html#Start+of+Sitemap">
+        start of the Sitemap. </a>
       
 </p>
 <p>
-        As the comment explains, this sitemap is the starting point
-        for all requests. So even if there are other sitemaps
-        (which we will see later on), we always start looking for a
-        matching pattern right here.
+        As the comment explains, this sitemap is the starting point for all
+        requests. So even if there are other sitemaps (which we will see later
+        on), we always start looking for a matching pattern right here.
       </p>
 <a name="N10079"></a><a name="pipelines"></a>
 <h3 class="underlined_5">Find the Beginning of the Pipelines Section</h3>
 <p>
-        Modular as everything else in Cocoon, Forrest's sitemap
-        starts with a long list of declarations for all the
-        components used later on. We can safely ignore these at
-        the moment.
+        Modular as everything else in Cocoon, Forrest's sitemap starts with a
+        long list of declarations for all the components used later on. We can
+        safely ignore these at the moment.
       </p>
 <p class="instruction">
-        So let's skip right to the start of the
-        Pipelines-Section. Search for &lt;map:pipelines&gt; or
-        follow this link to the
-        <a href="sitemap.xmap.html#Start+of+Pipelines">
-          beginning of the pipelines-element
-        </a>
+        So let's skip right to the start of the Pipelines-Section. Search for
+        &lt;map:pipelines&gt; or follow this link to the
+        <a href="sitemap.xmap.html#Start+of+Pipelines"> beginning of the
+        pipelines-element </a>
       
 </p>
 <p>
-        Within the pipelines-element you will find a long list
-        of pipeline-Elements (no trailing 's'), each one of them defining a
+        Within the pipelines-element you will find a long list of
+        pipeline-Elements (no trailing 's'), each one of them defining a
         processing pipeline within Forrest.
       </p>
 <p>
-        When handling a request, Forrest will check the
-        Pipelines from top to bottom until it encounters a
-        Pipeline that will take care of our request.
+        When handling a request, Forrest will check the Pipelines from top to
+        bottom until it encounters a Pipeline that will take care of our
+        request.
       </p>
 <a name="N10091"></a><a name="matches"></a>
 <h3 class="underlined_5">Looking for a Match</h3>
 <p>
-        Like all Cocoon applications, Forrest knows which
-        pipeline to use for processing a certain request by
-        looking at the entry criteria for each pipeline it comes
-        across. These can be a match against a given pattern,
-        the test if a certain files exists or one of many other
-        possible tests that Cocoon supports.
+        Like all Cocoon applications, Forrest knows which pipeline to use for
+        processing a certain request by looking at the entry criteria for each
+        pipeline it comes across. These can be a match against a given pattern,
+        the test if a certain files exists or one of many other possible tests
+        that Cocoon supports.
       </p>
 <p class="instruction">
-        To better know what we are talking about, let's follow
-        Forrest down the list to the
-        <a href="sitemap.xmap.html#Test+for+First+Pipeline">
-          Test for the First Pipeline
-        </a>.
+        To better know what we are talking about, let's follow Forrest down the
+        list to the <a href="sitemap.xmap.html#Test+for+First+Pipeline"> Test
+        for the First Pipeline </a>.
       </p>
 <p>
-        Here you can see that very specialized matches need to occur
-        early in the sitemap. The
-        requested file (and pathname) is compared to a pattern
-        '*.xlex' that would match if our request ended with
-        '.xlex' and had no pathname. Since it doesn't, we don't
-        have a match and need to keep looking.
+        Here you can see that very specialized matches need to occur early in
+        the sitemap. The requested file (and pathname) is compared to a pattern
+        '*.xlex' that would match if our request ended with '.xlex' and had no
+        pathname. Since it doesn't, we don't have a match and need to keep
+        looking.
       </p>
 <p class="instruction">
         Skip forward until we find the
-        <a href="sitemap.xmap.html#First+Match+for+%22**%2F*.html%22">
-          First Match for "**/*.html"
-        </a>
-        (&lt;map:match pattern="**/*.html"&gt;).
+        <a href="sitemap.xmap.html#First+Match+for+%22**%2F*.html%22"> First
+        Match for "**/*.html" </a> (&lt;map:match pattern="**/*.html"&gt;).
       </p>
 <a name="N100AE"></a><a name="html-pipeline"></a>
 <h3 class="underlined_5">Processing in the '**/*.html' Pipeline</h3>
-<p>  
-        Let's take a quick look at this pipeline to understand
-        what's happening here:
+<p>
+        Let's take a quick look at this pipeline to understand what's happening
+        here:
       </p>
 <pre class="code">
+
 &lt;map:match pattern="**/*.html"&gt;
     &lt;map:aggregate element="site"&gt;
       &lt;map:part src="cocoon:/skinconf.xml"/&gt;
@@ -587,59 +573,60 @@
       &lt;map:parameter name="type" value="site2xhtml"/&gt;
       &lt;map:parameter name="path" value="{0}"/&gt;
     &lt;/map:call&gt;
-&lt;/map:match&gt;</pre>
+&lt;/map:match&gt;
+      </pre>
 <p>
-        In the first part of this pipeline, the
-        aggregate-element assembles information required to build
-        a Forrest page with menu and tabs from different sources.
-        Then the call to the skinit-resource picks up the
-        aggregated info and generates a page in the
-        style of the current skin. That's easy, isn't it?
+        In the first part of this pipeline, the aggregate-element assembles
+        information required to build a Forrest page with menu and tabs from
+        different sources. Then the call to the skinit-resource picks up the
+        aggregated info and generates a page in the style of the current skin.
+        That's easy, isn't it?
       </p>
 <p>
-        Well, the complex part begins, when we take a closer look at
-        the sources of the aggregation.
+        Well, the complex part begins, when we take a closer look at the sources
+        of the aggregation.
       </p>
-<pre class="code">&lt;map:part src="cocoon:/{1}/body-{2}.html"/&gt;</pre>
+<pre class="code">
+&lt;map:part src="cocoon:/{1}/body-{2}.html"/&gt;
+      </pre>
 <p>
-        This mysterious element is most easily explained as a
-        secondary request to the Forrest system.
+        This mysterious element is most easily explained as a secondary request
+        to the Forrest system.
       </p>
 <p>
-        The 'cocoon:'-part is called a pseudo-protocol and tells the
-        processor to ask Forrest for the resource named behind
-        the colon, process that request and feed the output as input
-        back into our pipeline.
-        (The 'pseudo' goes back to the fact that unlike
-        'http' or 'ftp', which are real protocols, you can use cocoon:
-        only within the cocoon environments as only they will know what to
-        do with it.)
+        The 'cocoon:'-part is called a pseudo-protocol and tells the processor
+        to ask Forrest for the resource named behind the colon, process that
+        request and feed the output as input back into our pipeline. (The
+        'pseudo' goes back to the fact that unlike 'http' or 'ftp', which are
+        real protocols, you can use cocoon: only within the cocoon environments
+        as only they will know what to do with it.)
       </p>
 <p>
-        So even though we have already seen the end of our pipeline
-        (the skinning), we still don't know, what goes into the skinning and
-        where it comes from. To find out, we have to look at the sources
-        of the aggregation.
+        So even though we have already seen the end of our pipeline (the
+        skinning), we still don't know, what goes into the skinning and where it
+        comes from. To find out, we have to look at the sources of the
+        aggregation.
       </p>
 <a name="N100CF"></a><a name="protocols"></a>
 <h3 class="underlined_5">Following the Pseudo-Protocols</h3>
 <p>
-        To find out what goes into our aggregation, we'll need to look
-        at the pipeline that is called by
+        To find out what goes into our aggregation, we'll need to look at the
+        pipeline that is called by
+      </p>
+<pre class="code">
+&lt;map:part src="cocoon:/{1}/body-{2}.html"/&gt;
+      </pre>
+<p>
+        To do that, it's always a good idea to write down what this call
+        actually looks like when all the variables are replaced by real values.
+        A safe way to do that is to look at the matcher to start with, build a
+        list of the numbered variables and their meaning in the current context
+        and then assemble the actual expression(s) from it.
       </p>
-<pre class="code">&lt;map:part src="cocoon:/{1}/body-{2}.html"/&gt;</pre>
 <p>
-        To do that, it's always a good idea to write down what this
-        call actually looks like when all the variables are replaced by real
-        values.
-        A safe way to do that is to look at the matcher to start with,
-        build a list of the numbered variables and their meaning in the
-        current context and then assemble the actual expression(s) from it.
-      </p>
-<p>In our example the matcher pattern
-       <span class="codefrag">**/*.html</span> is applied to the request-name
-       <span class="codefrag">mytest/mybad.html</span>, so we have three variables
-       altogether:
+        In our example the matcher pattern <span class="codefrag">**/*.html</span> is applied to
+        the request-name <span class="codefrag">mytest/mybad.html</span>, so we have three
+        variables altogether:
       </p>
 <table class="ForrestTable" cellspacing="1" cellpadding="4">
         
@@ -668,78 +655,90 @@
 </tr>
       
 </table>
-<p>If we insert that into </p>
-<pre class="code">&lt;map:part src="cocoon:/{1}/body-{2}.html"/&gt;</pre>
-<p>we get</p>
-<pre class="code">&lt;map:part src="cocoon:/mytest/body-mybad.html"/&gt;</pre>
 <p>
-        As you can easily tell, we are suddenly calling for a whole
-        new document. Let's see where that takes us:
+        If we insert that into
+      </p>
+<pre class="code">
+&lt;map:part src="cocoon:/{1}/body-{2}.html"/&gt;
+      </pre>
+<p>
+        we get
+      </p>
+<pre class="code">
+&lt;map:part src="cocoon:/mytest/body-mybad.html"/&gt;
+      </pre>
+<p>
+        As you can easily tell, we are suddenly calling for a whole new
+        document. Let's see where that takes us:
       </p>
 <a name="N10133"></a><a name="call"></a>
 <h3 class="underlined_5">Second Call for Content</h3>
 <p>
-        Processing of cocoon-calls is not much different from
-        normal requests by a client. When you launch a call like
+        Processing of cocoon-calls is not much different from normal requests by
+        a client. When you launch a call like
       </p>
-<pre class="code">&lt;map:part src="cocoon:/mytest/body-mybad.html"/&gt;</pre>
+<pre class="code">
+&lt;map:part src="cocoon:/mytest/body-mybad.html"/&gt;
+      </pre>
 <p>
-        Forrest will once again start searching its main sitemap
-        from the beginning and look for a pipeline to match that call.
+        Forrest will once again start searching its main sitemap from the
+        beginning and look for a pipeline to match that call.
       </p>
 <p class="instruction">
-         Search for '**body-*.html' from the beginning of the
-         sitemap or jump to the
-         <a href="sitemap.xmap.html#First+Match+for+%27**body-*.html%27">First Match for '**body-*.html'</a>
-         to see where we find our next match.
+        Search for '**body-*.html' from the beginning of the sitemap or jump to
+        the
+        <a href="sitemap.xmap.html#First+Match+for+%27**body-*.html%27">First
+        Match for '**body-*.html'</a> to see where we find our next match.
       </p>
 <a name="N1014C"></a><a name="match-1"></a>
 <h3 class="underlined_5">First Match for '**body-*.html'</h3>
 <p>
-         Our first match is different to the previous ones because
-         there is a second condition placed inside the matcher.
-         Doing the replacements
-       </p>
+        Our first match is different to the previous ones because there is a
+        second condition placed inside the matcher. Doing the replacements
+      </p>
 <pre class="code">
+
 &lt;map:select type="exists"&gt;
-   &lt;map:when test="{properties:content.xdocs}mytests/mybad.ehtml"&gt;</pre>
+   &lt;map:when test="{properties:content.xdocs}mytests/mybad.ehtml"&gt;
+      </pre>
+<p>
+        we quickly discover that there can't be a file of that name in the
+        project-directory.
+        <br>
+        (The variable '{properties:content.xdocs}' is always replaced with the
+        name of your project directory that you can change in the
+        'forrest.properties'-file.)
+      </p>
 <p>
-         we quickly discover that there can't be a file of
-         that name in the project-directory.
-         <br>
-         (The variable '{properties:content.xdocs}' is always replaced with
-         the name of your project directory that you can change
-         in the 'forrest.properties'-file.)
-       </p>
-<p>
-         So we have a pipeline, but it doesn't do anything.
-         In this case Forrest will simply keep looking for
-         the next match further down.
-       </p>
+        So we have a pipeline, but it doesn't do anything. In this case Forrest
+        will simply keep looking for the next match further down.
+      </p>
 <a name="N10162"></a><a name="match-2"></a>
 <h3 class="underlined_5">Second Match for '**body-*.html'</h3>
 <p class="instruction">
-         Continue searching downwards for '**body-*.html' in the
-         sitemap-file or jump directly to the
-         <a href="sitemap.xmap.html#Second+Match+for+%27**body-*.html%27">Second Match for '**body-*.html'</a>.
+        Continue searching downwards for '**body-*.html' in the sitemap-file or
+        jump directly to the
+        <a href="sitemap.xmap.html#Second+Match+for+%27**body-*.html%27">Second
+        Match for '**body-*.html'</a>.
       </p>
 <p>
-        Looking at the pipeline that handles the request, we see that
-        the cocoon-protocol is once again invoked
+        Looking at the pipeline that handles the request, we see that the
+        cocoon-protocol is once again invoked
       </p>
-<pre class="code">&lt;map:generate src="cocoon:/{1}{2}.xml"/&gt;</pre>
+<pre class="code">
+&lt;map:generate src="cocoon:/{1}{2}.xml"/&gt;
+      </pre>
 <p>
         this time as a direct generator of input for our pipeline.
       </p>
 <p>
-        So once again we ask Forrest to process a request for content.
-        To know what matcher to look for, let's first expand the variables:
+        So once again we ask Forrest to process a request for content. To know
+        what matcher to look for, let's first expand the variables:
       </p>
 <p>
-        In our example the matcher pattern
-        <span class="codefrag">**body-*.html</span> is applied to the request-name
-        <span class="codefrag">mytest/body-mybad.html</span>.
-        Which means that we have three variables altogether:
+        In our example the matcher pattern <span class="codefrag">**body-*.html</span> is applied
+        to the request-name <span class="codefrag">mytest/body-mybad.html</span>. Which means
+        that we have three variables altogether:
       </p>
 <table class="ForrestTable" cellspacing="1" cellpadding="4">
         
@@ -771,11 +770,15 @@
 <p>
         If we insert that into
       </p>
-<pre class="code">&lt;map:generate src="cocoon:/{1}{2}.xml"/&gt;</pre>
+<pre class="code">
+&lt;map:generate src="cocoon:/{1}{2}.xml"/&gt;
+      </pre>
 <p>
         we get
       </p>
-<pre class="code">&lt;map:generate src="cocoon:/mytests/mybad.xml"/&gt;</pre>
+<pre class="code">
+&lt;map:generate src="cocoon:/mytests/mybad.xml"/&gt;
+      </pre>
 <a name="N101CE"></a><a name="match-3"></a>
 <h3 class="underlined_5">Third Call for Content</h3>
 <p class="instruction">
@@ -788,59 +791,57 @@
         which is the standard handling for all xml-requests.
       </p>
 <p>
-        Since our request fulfils none of the secondary criteria in
-        this pipeline, it falls right through to the map:mount-element
-        at the end:
-        </p>
-<pre class="code">&lt;map:mount uri-prefix="" src="forrest.xmap" check-reload="yes" /&gt;</pre>
+        Since our request fulfils none of the secondary criteria in this
+        pipeline, it falls right through to the map:mount-element at the end:
+      </p>
+<pre class="code">
+&lt;map:mount uri-prefix="" src="forrest.xmap" check-reload="yes" /&gt;
+      </pre>
 <p>
-        which makes Forrest load and process a secondary sitemap,
-        the file 'forrest.xmap' in the same directory.
+        which makes Forrest load and process a secondary sitemap, the file
+        'forrest.xmap' in the same directory.
       </p>
 <p class="instruction">
-        Open the file 'forrest.xmap' and continue the search for a
-        matching pattern.
+        Open the file 'forrest.xmap' and continue the search for a matching
+        pattern.
       </p>
 <p>
-        Our search leads us to the 
-        <a href="forrest.xmap.html#Second+Match+for+%27**.xml%27">
-          Second Match for '**.xml'
-        </a>,
-        a pipeline designed to handle internationalisation if that
-        feature is configured. Since it is not, all it does is
-        call the file-resolver-resource with the full pathname of
-        our file but no extension.
+        Our search leads us to the
+        <a href="forrest.xmap.html#Second+Match+for+%27**.xml%27"> Second Match
+        for '**.xml' </a>, a pipeline designed to handle internationalisation if
+        that feature is configured. Since it is not, all it does is call the
+        file-resolver-resource with the full pathname of our file but no
+        extension.
       </p>
 <pre class="code">
+
 &lt;map:call resource="file-resolver"&gt;
   &lt;map:parameter name="uri" value="mytests/mybad"/&gt;
-&lt;/map:call&gt;</pre>
+&lt;/map:call&gt;
+      </pre>
 <a name="N101F9"></a><a name="file"></a>
 <h3 class="underlined_5">Introducing the File-Resolver</h3>
 <p class="instruction">
-        To find out more about the working of the file-resolver,
-        search for the definition of the
+        To find out more about the working of the file-resolver, search for the
+        definition of the
         <a href="forrest.xmap.html#Definition+of+File-Resolver-Resource">
-          &lt;map:resource name="file-resolver"&gt;
-        </a>
-        higher up in the file.
+        &lt;map:resource name="file-resolver"&gt; </a> higher up in the file.
       </p>
 <p>
-        Here you will find a pipeline that tests for the existence of
-        the file with different extensions. '.html' is second in this
-        list and leads to the processing steps shown below:
+        Here you will find a pipeline that tests for the existence of the file
+        with different extensions. '.html' is second in this list and leads to
+        the processing steps shown below:
       </p>
 <a name="N1020B"></a><a name="process-html"></a>
 <h3 class="underlined_5">html-Default Processing</h3>
 <p>
-        The default processing of html-files consists of four
-        processing steps:
+        The default processing of html-files consists of four processing steps:
       </p>
 <ol>
         
 <li>
-          
 <span class="codefrag">&lt;map:generate src="{properties:content.xdocs}{uri}.html" type="html"/&gt;</span>
+          
 <br>
             Using the html-generator, Forrest reads the html-document
             from file and uses JTidy to clean up and convert it to xml
@@ -852,23 +853,23 @@
         </li>
         
 <li>
-            
 <span class="codefrag">&lt;map:transform src="{forrest:forrest.stylesheets}/html2document.xsl"/&gt;</span>
+          
 <br>
           Using the standard stylesheet 'html2document.xsl', this XHTML is 
           transformed into Forrest standard document format.
         </li>
         
 <li>
-          
 <span class="codefrag">&lt;map:transform type="idgen"/&gt;</span>
+          
 <br>
           This step generates IDs required for navigation within the page.
         </li>
         
 <li>
-          
 <span class="codefrag">&lt;map:serialize type="xml-document"/&gt;</span>
+          
 <br>
           Finally the document is serialized as XML and returned to the
           calling pipeline.
@@ -876,35 +877,34 @@
       
 </ol>
 <p>
-        As a result, we now hand back the content of the html-document
-        in Forrest standard document format to the calling pipeline
+        As a result, we now hand back the content of the html-document in
+        Forrest standard document format to the calling pipeline
       </p>
 <div class="note">
 <div class="label">Note</div>
 <div class="content">
-        To look at the output of this pipeline you can simply
-        point you browser to 'http://localhost:8888/mytest/mybad.xml'
-        (assuming that you are currently running Forrest on your
-        machine and there is an html-page of that name).
+        To look at the output of this pipeline you can simply point you browser
+        to 'http://localhost:8888/mytest/mybad.xml' (assuming that you are
+        currently running Forrest on your machine and there is an html-page of
+        that name).
       </div>
 </div>
 <a name="N1023E"></a><a name="body"></a>
 <h3 class="underlined_5">Returning to the '**body-*.html'-Pipeline</h3>
 <p>
         On returning into the
-        <a href="sitemap.xmap.html#Returning+to+the+%27**body-*.html%27+Pipeline">'**body-*.html' pipeline</a>,
-        procesing continues with the next components in this pipeline:
+        <a href="sitemap.xmap.html#Returning+to+the+%27**body-*.html%27+Pipeline">'**body-*.html'
+        pipeline</a>, procesing continues with the next components in this
+        pipeline:
       </p>
 <ul>
         
 <li>
-          
 <strong>idgen</strong> will generate unique IDs for all elements
           that need to be referenced within a page (mainly headlines).
         </li>
         
 <li>
-          
 <strong>xinclude</strong> would process any xinclude statements
           in the source.
           Since HTML does not support this mechanism, nothing happens
@@ -912,7 +912,6 @@
         </li>
         
 <li>
-          
 <strong>linkrewriter</strong> adjusts links between pages
           so that they will still work in the final Forrest output
           directory structure. It also resolves any special Forrest links.
@@ -932,50 +931,49 @@
 <div class="note">
 <div class="label">Note</div>
 <div class="content">
-        To look at the output of this pipeline you can simply
-        point you browser to 'http://localhost:8888/mytest/body-mybad.html'
-        (assuming that you are currently running Forrest on your machine
-        and there is an html-page of that name).
+        To look at the output of this pipeline you can simply point you browser
+        to 'http://localhost:8888/mytest/body-mybad.html' (assuming that you are
+        currently running Forrest on your machine and there is an html-page of
+        that name).
       </div>
 </div>
-<a name="N1026A"></a><a name="aggregate"></a>
+<a name="N10267"></a><a name="aggregate"></a>
 <h3 class="underlined_5">Returning to the '**/*.html'-Pipeline</h3>
 <p>
-        At the end of this pipeline, processing returns the results into
-        the aggregation section of the
-        <a href="#html-pipeline">'**/*.html' Pipeline</a>,
-        merges it with other data, skins and serializes for presentation
-        in the requesting client.
+        At the end of this pipeline, processing returns the results into the
+        aggregation section of the <a href="#html-pipeline">'**/*.html'
+        Pipeline</a>, merges it with other data, skins and serializes for
+        presentation in the requesting client.
       </p>
-<a name="N10278"></a><a name="custom"></a>
+<a name="N10275"></a><a name="custom"></a>
 <h3 class="underlined_5">Customizing the html pipeline</h3>
 <p>
         In this last part of this document, we will show how to customize the
         HTML-pipeline to add your additional steps to the default processing.
       </p>
-<a name="N10281"></a><a name="when"></a>
+<a name="N1027E"></a><a name="when"></a>
 <h4>When to customize?</h4>
 <p>
-          The html-Pipeline in Forrest is designed to be able to also
-          integrate legacy html-Pages in a Forrest project. In doing so,
-          it will fix common markup errors and convert html to Forrest's
-          intermediate document format.
+          The html-Pipeline in Forrest is designed to be able to also integrate
+          legacy html-Pages in a Forrest project. In doing so, it will fix
+          common markup errors and convert html to Forrest's intermediate
+          document format.
         </p>
 <p>
           Due to the nature of html as presentational markup, there is no way
-          this automated process can identify elements in your pages that
-          are not required or even unwanted in the Forrest environment. 
+          this automated process can identify elements in your pages that are
+          not required or even unwanted in the Forrest environment.
         </p>
 <p>
           A good example are pages from sites where the navigational elements
-          (menus, tabs etc.) are embedded in the html of each page.
-          Since Forrest can't know what is an unwanted menu and what belongs
-          to the page body that you want to keep, you will need to customize
-          the process to remove elements that are not needed. If you don't,
-          then you will see the original page from your legacy website,
-          menu and all, embedded in your new Forrest site.
+          (menus, tabs etc.) are embedded in the html of each page. Since
+          Forrest can't know what is an unwanted menu and what belongs to the
+          page body that you want to keep, you will need to customize the
+          process to remove elements that are not needed. If you don't, then you
+          will see the original page from your legacy website, menu and all,
+          embedded in your new Forrest site.
         </p>
-<a name="N10291"></a><a name="how"></a>
+<a name="N1028E"></a><a name="how"></a>
 <h4>How to customize?</h4>
 <p>
           To add your own custom processing for a group of pages, you will
@@ -984,73 +982,74 @@
         </p>
 <p>
           This project sitemap is located in the file
-          'src/documentation/sitemap.xmap' in your Forrest project directory
-          and will be created automatically when you seed a new project.
-          At this point it contains only one
+          'src/documentation/sitemap.xmap' in your Forrest project directory and
+          will be created automatically when you seed a new project. At this
+          point it contains only one
           <a href="project_sitemap.xmap.html#Example+pipeline+for+%27**custom.xml%27">
           pipeline for handling the '**custom.xml'-pattern</a> as an example.
         </p>
 <p>
           To add your own custom processing, edit the file and add a new
-          pipeline to the project sitemap. Since the project sitemap is
-          loaded into the main sitemap
-          <a href="sitemap.xmap.html#Insertion+Point+for+Project+Sitemap">
-          right at the top</a>, your pipeline intercepts practically all
-          of Forrest's standard pipelines.
+          pipeline to the project sitemap. Since the project sitemap is loaded
+          into the main sitemap
+          <a href="sitemap.xmap.html#Insertion+Point+for+Project+Sitemap"> right
+          at the top</a>, your pipeline intercepts practically all of Forrest's
+          standard pipelines.
         </p>
-<a name="N102A9"></a><a name="what"></a>
+<a name="N102A6"></a><a name="what"></a>
 <h4>What to intercept?</h4>
 <p>
           Where to intercept standard processing is really a matter of your
-          choice. A good rule is to replace as little standard handling
-          as possible so that future changes in the Forrest architecture are
-          less likely to break your application.
+          choice. A good rule is to replace as little standard handling as
+          possible so that future changes in the Forrest architecture are less
+          likely to break your application.
         </p>
 <p>
-          In our case all we need to do is add a transformation that
-          removes all the unwanted elements. The best place to do this
-          would be right after the generator has converted our document to
-          xhtml.
+          In our case all we need to do is add a transformation that removes all
+          the unwanted elements. The best place to do this would be right after
+          the generator has converted our document to xhtml.
         </p>
 <p>
-          However, since we can only replace a complete pipeline,
-          we'll create a new pipeline that intercepts **.xml for our pages,
-          copy the steps the original processor is doing and add a
-          transformation of our own to it.
+          However, since we can only replace a complete pipeline, we'll create a
+          new pipeline that intercepts **.xml for our pages, copy the steps the
+          original processor is doing and add a transformation of our own to it.
         </p>
-<a name="N102B9"></a><a name="intercept"></a>
+<a name="N102B6"></a><a name="intercept"></a>
 <h4>Intercept pattern</h4>
 <p>
-          Take great care when intercepting very basic pipelines.
-          Instead of designing our custom pipeline to match the
-          original **.xml pattern, try to narrow your matcher down to
-          something that will only match your pages.
+          Take great care when intercepting very basic pipelines. Instead of
+          designing our custom pipeline to match the original **.xml pattern,
+          try to narrow your matcher down to something that will only match your
+          pages.
         </p>
 <p>
-          If all your pages are located in a directory called mytest,
-          then use a matcher like '/mytest/*.xml' to avoid highjacking
-          the processing for all the other requests.
+          If all your pages are located in a directory called mytest, then use a
+          matcher like '/mytest/*.xml' to avoid highjacking the processing for
+          all the other requests.
         </p>
 <p class="instruction">
-          Add a new pipeline in your project sitemap and set the matcher
-          to '/mytest/*.xml'.
+          Add a new pipeline in your project sitemap and set the matcher to
+          '/mytest/*.xml'.
         </p>
 <p>
           The new pipeline should look like this and does nothing so far.
         </p>
 <pre class="code">
+
 &lt;!--Custom Pipeline for my bad html-pages--&gt;        
 &lt;map:pipeline&gt;
     &lt;map:match pattern="mytest/*.xml"&gt;
 
     &lt;/map:match&gt;
-&lt;/map:pipeline&gt;</pre>
+&lt;/map:pipeline&gt;
+        </pre>
 <p class="instruction">
-          Open the 'forrest.xmap', navigate to the file-resolver-section,
-          copy the four lines for handling *.html files and paste them into
-          your new pipeline.
+          Open the 'forrest.xmap', navigate to the file-resolver-section, copy
+          the four lines for handling *.html files and paste them into your new
+          pipeline.
         </p>
 <pre class="code">
+
 &lt;!--Custom Pipeline for my bad html-pages--&gt;        
 &lt;map:pipeline&gt;
     &lt;map:match pattern="mytest/*.xml"&gt;
@@ -1059,24 +1058,26 @@
       &lt;map:transform type="idgen"/&gt;
       &lt;map:serialize type="xml-document"/&gt;
     &lt;/map:match&gt;
-&lt;/map:pipeline&gt;</pre>
+&lt;/map:pipeline&gt;
+        </pre>
 <p>
           Your custom pipeline will now behave exactly like the standard
-          html-handler. Now all that is left to be done is creating the
-          custom transformation and adding it the pipeline.
+          html-handler. Now all that is left to be done is creating the custom
+          transformation and adding it the pipeline.
         </p>
 <p class="instruction">
-          Design and test a new XSL-Transformation that removes the
-          unwanted elements and save it in your project's stylesheet
-          directory, usually src/documentation/resources/stylesheets
-          (defined in project.stylesheets-dir of forrest.properties),
-          which is central storage for all stylesheets in a project.
+          Design and test a new XSL-Transformation that removes the unwanted
+          elements and save it in your project's stylesheet directory, usually
+          src/documentation/resources/stylesheets (defined in
+          project.stylesheets-dir of forrest.properties), which is central
+          storage for all stylesheets in a project.
         </p>
 <p class="instruction">
           Add the new transformation as a new line, straight after the
-          generator, and save the changes. 
+          generator, and save the changes.
         </p>
 <pre class="code">
+
 &lt;!--Custom Pipeline for my bad html-pages--&gt;        
 &lt;map:pipeline&gt;
     &lt;map:match pattern="mytest/*.xml"&gt;
@@ -1086,19 +1087,19 @@
       &lt;map:transform type="idgen" /&gt;
       &lt;map:serialize type="xml-document"/&gt;
     &lt;/map:match&gt;
-&lt;/map:pipeline&gt;</pre>
+&lt;/map:pipeline&gt;
+        </pre>
 <p>
-          Done! You have just added your own custom-processing.
-          Don't forget to view the pages to verify that it is working
-          properly.
+          Done! You have just added your own custom-processing. Don't forget to
+          view the pages to verify that it is working properly.
         </p>
 <div class="note">
 <div class="label">Note</div>
 <div class="content">
-          Our pipeline does not exactly do what the original pipeline does.
-          To make things easier, we omitted the internationalization part
-          in our pipeline. So if you need to create multi-language sites,
-          make sure that you adjust your pipeline accordingly.
+          Our pipeline does not exactly do what the original pipeline does. To
+          make things easier, we omitted the internationalization part in our
+          pipeline. So if you need to create multi-language sites, make sure
+          that you adjust your pipeline accordingly.
         </div>
 </div>
 </div>

Modified: forrest/site/docs_0_70/howto/howto-custom-html-source.pdf
URL: http://svn.apache.org/viewvc/forrest/site/docs_0_70/howto/howto-custom-html-source.pdf?view=diff&rev=529915&r1=529914&r2=529915
==============================================================================
Binary files - no diff available.

Modified: forrest/site/docs_0_70/howto/howto-editcss.html
URL: http://svn.apache.org/viewvc/forrest/site/docs_0_70/howto/howto-editcss.html?view=diff&rev=529915&r1=529914&r2=529915
==============================================================================
--- forrest/site/docs_0_70/howto/howto-editcss.html (original)
+++ forrest/site/docs_0_70/howto/howto-editcss.html Wed Apr 18 01:36:14 2007
@@ -3,7 +3,7 @@
 <head>
 <META http-equiv="Content-Type" content="text/html; charset=UTF-8">
 <meta content="Apache Forrest" name="Generator">
-<meta name="Forrest-version" content="0.8-dev">
+<meta name="Forrest-version" content="0.9-dev">
 <meta name="Forrest-skin-name" content="pelt">
 <title>How to customize Forrest CSS 
       WYSIWYG-style (v0.7)</title>
@@ -88,7 +88,7 @@
     |start Subtabs
     +-->
 <div id="level2tabs">
-<a class="selected" href="../../docs_0_70/index.html">0.70 (current)</a><a class="unselected" href="../../docs_0_80/index.html">0.80-dev (under development)</a><a class="unselected" href="../../docs_0_60/index.html">0.60 (past)</a>
+<a class="unselected" href="../../docs_0_80/index.html">0.80 (current)</a><a class="unselected" href="../../docs_0_90/index.html">0.90-dev (under development)</a><a class="selected" href="../../docs_0_70/index.html">0.70 (past)</a>
 </div>
 <!--+
     |end Endtabs
@@ -101,7 +101,7 @@
     |breadtrail
     +-->
 <div class="breadtrail">
-             
+
              &nbsp;
            </div>
 <!--+
@@ -284,7 +284,7 @@
 </div>
 <div id="credit">
 <hr>
-        This is documentation for current version v0.7
+        This is documentation for past version v0.7
        (<a href="http://forrest.apache.org/versions/">More</a>)</div>
 <div id="roundbottom">
 <img style="display: none" class="corner" height="15" width="15" alt="" src="../../skin/images/rc-b-l-15-1body-2menu-3menu.png"></div>
@@ -313,12 +313,12 @@
 </div>
 <h1>How to customize Forrest CSS 
       WYSIWYG-style</h1>
-<div class="abstract"> This How-To shows how to use Mozilla 
-      Firebird and the free EditCSS-Plugin to 
-      customize your Forrest design in a 
-      WYSIWYG-way.</div>
+<div class="abstract">
+      This How-To shows how to use Mozilla Firebird and the free EditCSS-Plugin
+      to customize your Forrest design in a WYSIWYG-way.
+    </div>
 <div id="motd-area">
-        This is documentation for current version v0.7
+        This is documentation for past version v0.7
        (<a href="http://forrest.apache.org/versions/">More</a>)</div>
 <div id="minitoc-area">
 <ul class="minitoc">
@@ -356,30 +356,32 @@
 <a name="N10010"></a><a name="Intended Audience"></a>
 <h2 class="underlined_10">Intended Audience</h2>
 <div class="section">
-<p> Users who want to customize the Forrest look 
-      and feel or simply experiment with changing 
-      certain CSS-styles settings to see what 
-      happens.</p>
+<p>
+      Users who want to customize the Forrest look and feel or simply experiment
+      with changing certain CSS-styles settings to see what happens.
+    </p>
 </div>
 <a name="N10018"></a><a name="Purpose"></a>
 <h2 class="underlined_10">Purpose</h2>
 <div class="section">
-<p> A major part of Forrest's look and feel is 
-      controlled by a few CSS style sheets. Since 
-      Forrest allows you to override these settings, 
-      changing the CSS is a quick and easy 
-      alternative to creating (and maintaining) a 
-      whole new skin.</p>
-<p> You'll learn how to use free tools to change 
-      and experiment with styles in a WYSIWYG way, so 
-      that you can immediately see what effect 
-      changing a CSS property will have on the 
-      look and feel of your Forrest.</p>
+<p>
+      A major part of Forrest's look and feel is controlled by a few CSS style
+      sheets. Since Forrest allows you to override these settings, changing the
+      CSS is a quick and easy alternative to creating (and maintaining) a whole
+      new skin.
+    </p>
+<p>
+      You'll learn how to use free tools to change and experiment with styles in
+      a WYSIWYG way, so that you can immediately see what effect changing a CSS
+      property will have on the look and feel of your Forrest.
+    </p>
 </div>
 <a name="N10023"></a><a name="Prerequisites"></a>
 <h2 class="underlined_10">Prerequisites</h2>
 <div class="section">
-<p>To follow these instructions you will need:</p>
+<p>
+      To follow these instructions you will need:
+    </p>
 <ol>
       
 <li>Browser-access to the Forrest-site you want 
@@ -387,37 +389,34 @@
         good for your first attempt.
         <div class="note">
 <div class="label">Note</div>
-<div class="content">You can even 
-        experiment with Forrest's core skins CSS. Please send patches if
-        you enhance something.
+<div class="content">
+          You can even experiment with Forrest's core skins CSS. Please send
+          patches if you enhance something.
         </div>
-</div> 
+</div>
 </li>
       
 <li>The current version of the free Mozilla 
         Firefox-Browser installed on your system. 
         If you don't already use it, you can 
-        download it from <a href="http://www.mozilla.org/products/firefox/">http://www.mozilla.org/products/firefox/</a> 
-        
+        download it from <a href="http://www.mozilla.org/products/firefox/">http://www.mozilla.org/products/firefox/</a>
 </li>
-
       
 <li>The Firefox-PlugIn EditCSS. It downloads 
         and installs in just a few seconds from the 
-        Install-Link at <a href="http://editcss.mozdev.org/">http://editcss.mozdev.org/</a> 
+        Install-Link at <a href="http://editcss.mozdev.org/">http://editcss.mozdev.org/</a>
         
 <div class="note">
 <div class="label">Note</div>
-<div class="content">With standard security settings in 
-        place, Firefox will pop up a line at the top 
-        of the window because this site has by 
-        default no permission to install plugins on 
-        your computer. Click "Edit Options" and 
-        then "Allow" to change that, then click on 
-        the Install-link again. Don't forget to 
-        close and restart Firebird when the
-        installation is finished.</div>
-</div> 
+<div class="content">
+          With standard security settings in place, Firefox will pop up a line
+          at the top of the window because this site has by default no
+          permission to install plugins on your computer. Click "Edit Options"
+          and then "Allow" to change that, then click on the Install-link again.
+          Don't forget to close and restart Firebird when the installation is
+          finished.
+        </div>
+</div>
 </li>
       
 <li>A basic understanding of CSS and access to 
@@ -426,55 +425,61 @@
     
 </ol>
 </div>
-<a name="N1004C"></a><a name="Steps"></a>
+<a name="N10049"></a><a name="Steps"></a>
 <h2 class="underlined_10">Steps</h2>
 <div class="section">
-<a name="N10051"></a><a name="openForrest"></a>
+<a name="N1004E"></a><a name="openForrest"></a>
 <h3 class="underlined_5">Open your Forrest</h3>
-<p class="instruction">Start your Firefox 
-        Browser and open the Forrest you'd like to 
-        work on/play with.</p>
-<p>The page you have pointed to will show up in 
-        Firefox's main window.</p>
-<a name="N1005F"></a><a name="OpenEditCSS"></a>
+<p class="instruction">
+        Start your Firefox Browser and open the Forrest you'd like to work
+        on/play with.
+      </p>
+<p>
+        The page you have pointed to will show up in Firefox's main window.
+      </p>
+<a name="N1005C"></a><a name="OpenEditCSS"></a>
 <h3 class="underlined_5">Open the EditCSS-Sidebar</h3>
-<p class="instruction">Select 
-        View-Sidebar-EditCSS from Firefox's main 
-        menu to open the EditCSS sidebar.</p>
-<p>The EditCSS sidebar will show next to the 
-        main window and load all the styles from 
-        the main page.</p>
-<a name="N1006D"></a><a name="changeCSS"></a>
+<p class="instruction">
+        Select View-Sidebar-EditCSS from Firefox's main menu to open the EditCSS
+        sidebar.
+      </p>
+<p>
+        The EditCSS sidebar will show next to the main window and load all the
+        styles from the main page.
+      </p>
+<a name="N1006A"></a><a name="changeCSS"></a>
 <h3 class="underlined_5">Change any CSS</h3>
-<p class="instruction">Change any style you'd 
-        like to experiment with or add new settings 
-        and styles of your choice by simply 
-        editing the text of the sidebar.</p>
-<p>EditCSS pushes any change you make in the 
-        sidebar right back into the style-settings 
-        of the main window, so that effects will 
-        show right away.</p>
+<p class="instruction">
+        Change any style you'd like to experiment with or add new settings and
+        styles of your choice by simply editing the text of the sidebar.
+      </p>
+<p>
+        EditCSS pushes any change you make in the sidebar right back into the
+        style-settings of the main window, so that effects will show right away.
+      </p>
 <div class="note">
 <div class="label">Note</div>
-<div class="content">On slow systems or when inserting big 
-        changes it might be a good idea to paste 
-        these from the clipboard to avoid a zillion 
-        updates to the main windows for every 
-        character you type.</div>
+<div class="content">
+        On slow systems or when inserting big changes it might be a good idea to
+        paste these from the clipboard to avoid a zillion updates to the main
+        windows for every character you type.
+      </div>
 </div>
-<a name="N1007E"></a><a name="saveChanges"></a>
+<a name="N1007B"></a><a name="saveChanges"></a>
 <h3 class="underlined_5">How to save changes?</h3>
-<p>Since it takes a few explanations to apply 
-        the changes to your Forrest, I've made 
-        this the topic of yet another HowTo called 
-        "Howto change and extend Forrest-CSS"</p>
+<p>
+        Since it takes a few explanations to apply the changes to your Forrest,
+        I've made this the topic of yet another HowTo called "Howto change and
+        extend Forrest-CSS"
+      </p>
 </div>
-<a name="N10088"></a><a name="Feedback and further development of this How-To"></a>
+<a name="N10085"></a><a name="Feedback and further development of this How-To"></a>
 <h2 class="underlined_10">Feedback and further development of this How-To</h2>
 <div class="section">
-<p> Please provide feedback about this document via 
-      the <a href="../../mail-lists.html">mailing 
-      lists</a>. </p>
+<p>
+      Please provide feedback about this document via the
+      <a href="../../mail-lists.html">mailing lists</a>.
+    </p>
 </div>
 </div>
 <!--+

Modified: forrest/site/docs_0_70/howto/howto-editcss.pdf
URL: http://svn.apache.org/viewvc/forrest/site/docs_0_70/howto/howto-editcss.pdf?view=diff&rev=529915&r1=529914&r2=529915
==============================================================================
Binary files - no diff available.

Modified: forrest/site/docs_0_70/howto/howto-forrest-from-maven.html
URL: http://svn.apache.org/viewvc/forrest/site/docs_0_70/howto/howto-forrest-from-maven.html?view=diff&rev=529915&r1=529914&r2=529915
==============================================================================
--- forrest/site/docs_0_70/howto/howto-forrest-from-maven.html (original)
+++ forrest/site/docs_0_70/howto/howto-forrest-from-maven.html Wed Apr 18 01:36:14 2007
@@ -3,7 +3,7 @@
 <head>
 <META http-equiv="Content-Type" content="text/html; charset=UTF-8">
 <meta content="Apache Forrest" name="Generator">
-<meta name="Forrest-version" content="0.8-dev">
+<meta name="Forrest-version" content="0.9-dev">
 <meta name="Forrest-skin-name" content="pelt">
 <title>How to run Forrest from within Maven (v0.7)</title>
 <link type="text/css" href="../../skin/basic.css" rel="stylesheet">
@@ -87,7 +87,7 @@
     |start Subtabs
     +-->
 <div id="level2tabs">
-<a class="selected" href="../../docs_0_70/index.html">0.70 (current)</a><a class="unselected" href="../../docs_0_80/index.html">0.80-dev (under development)</a><a class="unselected" href="../../docs_0_60/index.html">0.60 (past)</a>
+<a class="unselected" href="../../docs_0_80/index.html">0.80 (current)</a><a class="unselected" href="../../docs_0_90/index.html">0.90-dev (under development)</a><a class="selected" href="../../docs_0_70/index.html">0.70 (past)</a>
 </div>
 <!--+
     |end Endtabs
@@ -100,7 +100,7 @@
     |breadtrail
     +-->
 <div class="breadtrail">
-             
+
              &nbsp;
            </div>
 <!--+
@@ -283,7 +283,7 @@
 </div>
 <div id="credit">
 <hr>
-        This is documentation for current version v0.7
+        This is documentation for past version v0.7
        (<a href="http://forrest.apache.org/versions/">More</a>)</div>
 <div id="roundbottom">
 <img style="display: none" class="corner" height="15" width="15" alt="" src="../../skin/images/rc-b-l-15-1body-2menu-3menu.png"></div>
@@ -311,10 +311,11 @@
 	          &nbsp;<input value="+a" class="biggerfont" title="Enlarge text" onclick="ndeSetTextSize('incr'); return false;" type="button">
 </div>
 <h1>How to run Forrest from within Maven</h1>
-<div class="abstract">This How-To describes how to run Forrest from within
-    Maven.</div>
+<div class="abstract">
+      This How-To describes how to run Forrest from within Maven.
+    </div>
 <div id="motd-area">
-        This is documentation for current version v0.7
+        This is documentation for past version v0.7
        (<a href="http://forrest.apache.org/versions/">More</a>)</div>
 <div id="minitoc-area">
 <ul class="minitoc">
@@ -353,13 +354,17 @@
 <a name="N10010"></a><a name="Intended Audience"></a>
 <h2 class="underlined_10">Intended Audience</h2>
 <div class="section">
-<p>Users who want to run Forrest from within Maven.</p>
+<p>
+      Users who want to run Forrest from within Maven.
+    </p>
 </div>
 <a name="N10018"></a><a name="Purpose"></a>
 <h2 class="underlined_10">Purpose</h2>
 <div class="section">
-<p>One may want to generate their project's documentation and/or website
-    using Forrest in lieu of Maven's site plugin.</p>
+<p>
+      One may want to generate their project's documentation and/or website
+      using Forrest in lieu of Maven's site plugin.
+    </p>
 </div>
 <a name="N10020"></a><a name="Prerequisites"></a>
 <h2 class="underlined_10">Prerequisites</h2>
@@ -373,24 +378,31 @@
 <a name="N1002F"></a><a name="Steps"></a>
 <h2 class="underlined_10">Steps</h2>
 <div class="section">
-<p>The procedure outlined below describes how to add a goal to your
-    project's maven.xml that will invoke Forrest's <span class="codefrag">site</span>
-    target.</p>
+<p>
+      The procedure outlined below describes how to add a goal to your project's
+      maven.xml that will invoke Forrest's <span class="codefrag">site</span> target.
+    </p>
 <a name="N1003A"></a><a name="set-maven-home"></a>
 <h3 class="underlined_5">Set the FORREST_HOME environment variable</h3>
-<p>Make sure the FORREST_HOME environment variable points to your
-      Forrest home directory (i.e. the directory that contains
-      <span class="codefrag">forrest.build.xml</span>) (e.g. C:\opt\apache-forrest-0.7)</p>
+<p>
+        Make sure the FORREST_HOME environment variable points to your Forrest
+        home directory (i.e. the directory that contains
+        <span class="codefrag">forrest.build.xml</span>) (e.g. C:\opt\apache-forrest-0.7)
+      </p>
 <a name="N10047"></a><a name="define-ant-environment-prop"></a>
 <h3 class="underlined_5">Initialize an Ant environment property at the top of
       maven.xml</h3>
-<p>Paste the following line at the top of your maven.xml:</p>
+<p>
+        Paste the following line at the top of your maven.xml:
+      </p>
 <pre class="code">
 &lt;property environment="env" /&gt;
       </pre>
 <a name="N10055"></a><a name="add-forrest-goal-to-maven-xml"></a>
 <h3 class="underlined_5">Add forrest goal to maven.xml</h3>
-<p>Paste the following goal into your project's maven.xml:</p>
+<p>
+        Paste the following goal into your project's maven.xml:
+      </p>
 <pre class="code">
 &lt;goal name="forrest" description="runs Forrest"&gt;
   &lt;property name="forrest.home" location="${env.FORREST_HOME}" /&gt;
@@ -410,19 +422,27 @@
   &lt;/java&gt;
 &lt;/goal&gt;      
       </pre>
-<p>It is necessary to fork a separate java process because Maven 1.0
-      embeds Ant 1.5.2, but Forrest's forrest.build.xml requires Ant 1.6. The
-      goal makes use of the copy of Ant 1.6 that is bundled with Forrest, so
-      it's not even necessary to have Ant 1.6 installed separately.</p>
+<p>
+        It is necessary to fork a separate java process because Maven 1.0 embeds
+        Ant 1.5.2, but Forrest's forrest.build.xml requires Ant 1.6. The goal
+        makes use of the copy of Ant 1.6 that is bundled with Forrest, so it's
+        not even necessary to have Ant 1.6 installed separately.
+      </p>
 <a name="N10066"></a><a name="Alternative+file"></a>
 <h3 class="underlined_5">Alternative file</h3>
-<p>Under <span class="codefrag">$FORREST_HOME/tools/targets/maven.xml</span>
+<p>
+        Under <span class="codefrag">$FORREST_HOME/tools/targets/maven.xml</span>
+      
 </p>
 </div>
-<a name="N10072"></a><a name="Feedback"></a>
+<a name="N10073"></a><a name="Feedback"></a>
 <h2 class="underlined_10">Feedback</h2>
 <div class="section">
-<p>Please provide feedback about this document via the <a href="../../mail-lists.html">mailing lists</a>.<!-- Original author: Ian Springer (ips AT apache DOT org) --></p>
+<p>
+      Please provide feedback about this document via the
+      <a href="../../mail-lists.html">mailing lists</a>.
+<!-- Original author: Ian Springer (ips AT apache DOT org) -->
+    </p>
 </div>
 </div>
 <!--+

Modified: forrest/site/docs_0_70/howto/howto-forrest-from-maven.pdf
URL: http://svn.apache.org/viewvc/forrest/site/docs_0_70/howto/howto-forrest-from-maven.pdf?view=diff&rev=529915&r1=529914&r2=529915
==============================================================================
Binary files - no diff available.

Modified: forrest/site/docs_0_70/howto/howto-howto.html
URL: http://svn.apache.org/viewvc/forrest/site/docs_0_70/howto/howto-howto.html?view=diff&rev=529915&r1=529914&r2=529915
==============================================================================
--- forrest/site/docs_0_70/howto/howto-howto.html (original)
+++ forrest/site/docs_0_70/howto/howto-howto.html Wed Apr 18 01:36:14 2007
@@ -3,7 +3,7 @@
 <head>
 <META http-equiv="Content-Type" content="text/html; charset=UTF-8">
 <meta content="Apache Forrest" name="Generator">
-<meta name="Forrest-version" content="0.8-dev">
+<meta name="Forrest-version" content="0.9-dev">
 <meta name="Forrest-skin-name" content="pelt">
 <title>How to write a How-To (v0.7)</title>
 <link type="text/css" href="../../skin/basic.css" rel="stylesheet">
@@ -87,7 +87,7 @@
     |start Subtabs
     +-->
 <div id="level2tabs">
-<a class="selected" href="../../docs_0_70/index.html">0.70 (current)</a><a class="unselected" href="../../docs_0_80/index.html">0.80-dev (under development)</a><a class="unselected" href="../../docs_0_60/index.html">0.60 (past)</a>
+<a class="unselected" href="../../docs_0_80/index.html">0.80 (current)</a><a class="unselected" href="../../docs_0_90/index.html">0.90-dev (under development)</a><a class="selected" href="../../docs_0_70/index.html">0.70 (past)</a>
 </div>
 <!--+
     |end Endtabs
@@ -100,7 +100,7 @@
     |breadtrail
     +-->
 <div class="breadtrail">
-             
+
              &nbsp;
            </div>
 <!--+
@@ -283,7 +283,7 @@
 </div>
 <div id="credit">
 <hr>
-        This is documentation for current version v0.7
+        This is documentation for past version v0.7
        (<a href="http://forrest.apache.org/versions/">More</a>)</div>
 <div id="roundbottom">
 <img style="display: none" class="corner" height="15" width="15" alt="" src="../../skin/images/rc-b-l-15-1body-2menu-3menu.png"></div>
@@ -311,11 +311,12 @@
 	          &nbsp;<input value="+a" class="biggerfont" title="Enlarge text" onclick="ndeSetTextSize('incr'); return false;" type="button">
 </div>
 <h1>How to write a How-To</h1>
-<div class="abstract">This How-To describes the steps necessary to write a How-To
-    document. Writing documentation is a valuable way to give back to the
-    community.</div>
+<div class="abstract">
+      This How-To describes the steps necessary to write a How-To document.
+      Writing documentation is a valuable way to give back to the community.
+    </div>
 <div id="motd-area">
-        This is documentation for current version v0.7
+        This is documentation for past version v0.7
        (<a href="http://forrest.apache.org/versions/">More</a>)</div>
 <div id="minitoc-area">
 <ul class="minitoc">
@@ -406,37 +407,40 @@
 <a name="N10013"></a><a name="Intended Audience"></a>
 <h2 class="underlined_10">Intended Audience</h2>
 <div class="section">
-<p>Users who are ready to share their knowledge and experiences with the
-    community.</p>
+<p>
+      Users who are ready to share their knowledge and experiences with the
+      community.
+    </p>
 </div>
 <a name="N1001B"></a><a name="Purpose"></a>
 <h2 class="underlined_10">Purpose</h2>
 <div class="section">
-<p>These guidelines are based on successful how-to document structures
-    used by other open source projects with diverse author groups. Following
-    these tried and true guidelines will help to insure the effectiveness of
-    your work.</p>
+<p>
+      These guidelines are based on successful how-to document structures used
+      by other open source projects with diverse author groups. Following these
+      tried and true guidelines will help to insure the effectiveness of your
+      work.
+    </p>
 </div>
 <a name="N10023"></a><a name="Prerequisites"></a>
 <h2 class="underlined_10">Prerequisites</h2>
 <div class="section">
-<p>How-To authors should have:</p>
+<p>
+      How-To authors should have:
+    </p>
 <ul>
       
 <li>A unique How-To topic, related to using Forrest, which fulfills a
       specific need. Check out existing How-Tos to find a niche for your work.
       Consider posting your idea for the How-To to user mailing list, to make
       sure another author's draft is not already in process.</li>
-
       
 <li>A sufficient ability in English to write the FAQ. However, we would
       rather that you just make a start, as the community can help to
       fine-tune the document.</li>
       
-      
 <li>Copy this template document "howto-howto.xml" to be modified with
       your own content as necessary.</li>
-
       
 <li>An understanding of the How-To document structure. Just use this
       template document and you will be safe.
@@ -446,85 +450,112 @@
 </ul>
 <div class="note">
 <div class="label">Note</div>
-<div class="content">See the <a href="../../docs_0_80/../dtdx/howto-v13.dtdx.html">DTD documentation</a>
-    which explains the document structure.</div>
+<div class="content">
+      See the <a href="../../docs_0_90/../dtdx/howto-v13.dtdx.html">DTD documentation</a> which explains
+      the document structure.
+    </div>
 </div>
 </div>
 <a name="N10044"></a><a name="Steps"></a>
 <h2 class="underlined_10">Steps</h2>
 <div class="section">
-<p>Here is how to proceed.</p>
+<p>
+      Here is how to proceed.
+    </p>
 <a name="N1004C"></a><a name="overview"></a>
 <h3 class="underlined_5">Write the Overview</h3>
-<p>An overview helps potential readers to determine quickly if a
-      particular How-To matches their interests or needs. In a few sentences,
-      summarize the main points of your How-To. Make sure to include any
-      critical definitions which will help readers evaluate the utility of
-      your How-To. Consider writing the overview last, after you have
-      completed all other sections.</p>
+<p>
+        An overview helps potential readers to determine quickly if a particular
+        How-To matches their interests or needs. In a few sentences, summarize
+        the main points of your How-To. Make sure to include any critical
+        definitions which will help readers evaluate the utility of your How-To.
+        Consider writing the overview last, after you have completed all other
+        sections.
+      </p>
 <a name="N10056"></a><a name="audience"></a>
 <h3 class="underlined_5">Describe your Intended Audience</h3>
-<p>If your How-To is targetted at a specific audience, describe it here.
-      For example, potential readers will have different levels of skill using
-      Forrest. They will also bring different areas of expertise and
-      backgrounds to their How-To learning experience. When you clarify your
-      target audience up front, you will save all other readers time and
-      confusion.</p>
+<p>
+        If your How-To is targetted at a specific audience, describe it here.
+        For example, potential readers will have different levels of skill using
+        Forrest. They will also bring different areas of expertise and
+        backgrounds to their How-To learning experience. When you clarify your
+        target audience up front, you will save all other readers time and
+        confusion.
+      </p>
 <a name="N10060"></a><a name="purpose"></a>
 <h3 class="underlined_5">State the Purpose</h3>
-<p>State the purpose of your How-To. Explain how the reader will benefit
-      by reading it. Give your reader an incentive or two to continue.</p>
+<p>
+        State the purpose of your How-To. Explain how the reader will benefit by
+        reading it. Give your reader an incentive or two to continue.
+      </p>
 <a name="N1006A"></a><a name="prerequisites"></a>
 <h3 class="underlined_5">List any Prerequisites</h3>
-<p>Inform your reader about any required knowledge, configuration, or
-      resources they may need before stepping through your How-To. Assist them
-      in this preparation by linking to other useful resources on the Forrest
-      site or the web. Helping your readers to prepare increases the
-      likelihood that they will continue reading your How-To.</p>
+<p>
+        Inform your reader about any required knowledge, configuration, or
+        resources they may need before stepping through your How-To. Assist them
+        in this preparation by linking to other useful resources on the Forrest
+        site or the web. Helping your readers to prepare increases the
+        likelihood that they will continue reading your How-To.
+      </p>
 <a name="N10074"></a><a name="steps"></a>
 <h3 class="underlined_5">Describe the Steps of your How-To</h3>
-<p>In a precise, step-by-step approach, walk your reader through the
-      process. Make sure your reader can reproduce your intended result by
-      following your exact steps. Make the learning process efficient by
-      supplying sample code snippets or configuration details as
-      necessary.</p>
+<p>
+        In a precise, step-by-step approach, walk your reader through the
+        process. Make sure your reader can reproduce your intended result by
+        following your exact steps. Make the learning process efficient by
+        supplying sample code snippets or configuration details as necessary.
+      </p>
 <a name="N1007E"></a><a name="extension"></a>
 <h3 class="underlined_5">Extend the Learning</h3>
-<p>Provide your reader with a few real-world examples of how the
-      techniques or capabilities gained from your How-To could be applied.
-      Reward the reader for successfully completing the How-To with a few
-      ideas about how it will pay off.</p>
+<p>
+        Provide your reader with a few real-world examples of how the techniques
+        or capabilities gained from your How-To could be applied. Reward the
+        reader for successfully completing the How-To with a few ideas about how
+        it will pay off.
+      </p>
 <a name="N10088"></a><a name="summarize"></a>
 <h3 class="underlined_5">Summarize the Entire Process</h3>
-<p>In a few sentences, remind the reader what they have just learned.
-      This helps to reinforce the main points of your How-To.</p>
+<p>
+        In a few sentences, remind the reader what they have just learned. This
+        helps to reinforce the main points of your How-To.
+      </p>
 <a name="N10092"></a><a name="tips"></a>
 <h3 class="underlined_5">Additional Tips or FAQs</h3>
-<p>In some cases, step-by-step instructions simply aren't enough. Use
-      this section to pass on any other tips or frequently asked questions.
-      Anticipating the needs of your readers will increase the overall success
-      of your writing effort.</p>
+<p>
+        In some cases, step-by-step instructions simply aren't enough. Use this
+        section to pass on any other tips or frequently asked questions.
+        Anticipating the needs of your readers will increase the overall success
+        of your writing effort.
+      </p>
 <a name="N1009C"></a><a name="references"></a>
 <h3 class="underlined_5">References</h3>
-<p>Remember to acknowledge any third-party resources or individuals who
-      contributed to the development of your How-To. Consider providing links
-      for those motivated readers who want to learn more.</p>
+<p>
+        Remember to acknowledge any third-party resources or individuals who
+        contributed to the development of your How-To. Consider providing links
+        for those motivated readers who want to learn more.
+      </p>
 <a name="N100A6"></a><a name="contribute"></a>
 <h3 class="underlined_5">Submit via the project issue tracker</h3>
-<p>Create an attachment for your How-To document, and submit it via the
-      project <a href="../../issues.html">issue tracker</a>.</p>
+<p>
+        Create an attachment for your How-To document, and submit it via the
+        project <a href="../../issues.html">issue tracker</a>.
+      </p>
 <a name="N100B4"></a><a name="feedback"></a>
 <h3 class="underlined_5">Get some feedback</h3>
-<p>When the committers have added your document then it will be
-      available for everyone to to build upon and enhance. Feedback will
-      happen via the <a href="../../mail-lists.html">mailing lists</a>.</p>
+<p>
+        When the committers have added your document then it will be available
+        for everyone to to build upon and enhance. Feedback will happen via the
+        <a href="../../mail-lists.html">mailing lists</a>.
+      </p>
 </div>
 <a name="N100C2"></a><a name="Extension"></a>
 <h2 class="underlined_10">Extension</h2>
 <div class="section">
-<p>Solutions can be extended to cover many different problem domains. A
-    nearly unlimited number of potential How-To topics, from simple to
-    complex, are available right now, limited only by your imagination.</p>
+<p>
+      Solutions can be extended to cover many different problem domains. A
+      nearly unlimited number of potential How-To topics, from simple to
+      complex, are available right now, limited only by your imagination.
+    </p>
 </div>
 <a name="N100CA"></a><a name="Frequently Asked Questions"></a>
 <h2 class="underlined_10">Frequently Asked Questions</h2>
@@ -533,39 +564,46 @@
 <h3 class="underlined_5">1 General issues</h3>
 <a name="N100D2"></a><a name="1.1+What+is+the+difference+between+a+How-To+and+a+tutorial%3F"></a>
 <h4>1.1 What is the difference between a How-To and a tutorial?</h4>
-<p>The goal of a How-To is to help the reader to accomplish a specific
-          task with clear and consise instructions. While tutorials may contain
-          How-To-like instructions and content, they also include additional
-          background and conceptual content to help teach their readers higher
-          order concepts along the way. How-Tos are concerned about filling an
-          immediate, short-term need. Tutorials often provide long-term
-          knowledge which can be applied across a range of needs.</p>
+<p>
+            The goal of a How-To is to help the reader to accomplish a specific
+            task with clear and consise instructions. While tutorials may
+            contain How-To-like instructions and content, they also include
+            additional background and conceptual content to help teach their
+            readers higher order concepts along the way. How-Tos are concerned
+            about filling an immediate, short-term need. Tutorials often provide
+            long-term knowledge which can be applied across a range of needs.
+          </p>
 <a name="N100DA"></a><a name="2+Style+issues"></a>
 <h3 class="underlined_5">2 Style issues</h3>
 <a name="N100DE"></a><a name="2.1+What+spelling+convention+should+I+follow%3F"></a>
 <h4>2.1 What spelling convention should I follow?</h4>
-<p>Use whatever spelling convention (American, British, etc.) that is
-          most intuitive to you.</p>
+<p>
+            Use whatever spelling convention (American, British, etc.) that is
+            most intuitive to you.
+          </p>
 </div>
 <a name="N100E6"></a><a name="Tips"></a>
 <h2 class="underlined_10">Tips</h2>
 <div class="section">
 <a name="N100EB"></a><a name="tip-dtd"></a>
 <h3 class="underlined_5">How-To dtd</h3>
-<p>The document structure is likely to change soon. Please note that
-      this HOWTO page is likely to change as well.</p>
+<p>
+        The document structure is likely to change soon. Please note that this
+        HOWTO page is likely to change as well.
+      </p>
 </div>
 <a name="N100F5"></a><a name="References"></a>
 <h2 class="underlined_10">References</h2>
 <div class="section">
-<p>This is not the first, nor will it be the last, How-To on writing
-    How-Tos. For other ideas and opinions on the matter, check out the
-    following sources.</p>
+<p>
+      This is not the first, nor will it be the last, How-To on writing How-Tos.
+      For other ideas and opinions on the matter, check out the following
+      sources.
+    </p>
 <ul>
       
 <li>Joel D. Canfield's <a href="http://www.evolt.org/article/How_To_Write_A_How_To/9741/18250/index.html">How
       to Write a How-To</a> on evolt.org.</li>
-
       
 <li>The Linux Documentation Project's <a href="http://www.tldp.org/HOWTO/HOWTO-INDEX/index.html">HOWTO</a>
       index page provides many excellent How-To documents to inspire your
@@ -573,6 +611,7 @@
     
 </ul>
 </div>
+<span class="version">0.3</span>
 </div>
 <!--+
     |end content

Modified: forrest/site/docs_0_70/howto/howto-howto.pdf
URL: http://svn.apache.org/viewvc/forrest/site/docs_0_70/howto/howto-howto.pdf?view=diff&rev=529915&r1=529914&r2=529915
==============================================================================
Binary files - no diff available.



Mime
View raw message