forrest-svn mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From thors...@apache.org
Subject svn commit: r808385 [6/14] - in /forrest/branches/dispatcher_rewrite/plugins/org.apache.forrest.plugin.internal.dispatcher: ./ resources/stylesheets/ resources/stylesheets/fo/ resources/stylesheets/helper/ resources/stylesheets/html/ resources/styleshe...
Date Thu, 27 Aug 2009 12:07:47 GMT
Modified: forrest/branches/dispatcher_rewrite/plugins/org.apache.forrest.plugin.internal.dispatcher/src/documentation/content/xdocs/how/howto-dispatcher-quickstart.xml
URL: http://svn.apache.org/viewvc/forrest/branches/dispatcher_rewrite/plugins/org.apache.forrest.plugin.internal.dispatcher/src/documentation/content/xdocs/how/howto-dispatcher-quickstart.xml?rev=808385&r1=808384&r2=808385&view=diff
==============================================================================
--- forrest/branches/dispatcher_rewrite/plugins/org.apache.forrest.plugin.internal.dispatcher/src/documentation/content/xdocs/how/howto-dispatcher-quickstart.xml (original)
+++ forrest/branches/dispatcher_rewrite/plugins/org.apache.forrest.plugin.internal.dispatcher/src/documentation/content/xdocs/how/howto-dispatcher-quickstart.xml Thu Aug 27 12:07:38 2009
@@ -1,4 +1,4 @@
-<?xml version="1.0" encoding="UTF-8"?>
+<?xml version="1.0" encoding="utf-8"?>
 <!--
   Licensed to the Apache Software Foundation (ASF) under one or more
   contributor license agreements.  See the NOTICE file distributed with
@@ -15,7 +15,8 @@
   See the License for the specific language governing permissions and
   limitations under the License.
 -->
-<!DOCTYPE howto PUBLIC "-//APACHE//DTD How-to V2.0//EN" "http://forrest.apache.org/dtd/howto-v20.dtd">
+<!DOCTYPE howto PUBLIC "-//APACHE//DTD How-to V2.0//EN"
+"http://forrest.apache.org/dtd/howto-v20.dtd">
 <howto>
   <header>
     <title>Dispatcher quickstart</title>
@@ -23,234 +24,183 @@
     <last-modified-content-date date="2007-04-09" />
   </header>
   <audience title="Intended Audience">
-    <p>
-      People who are helping to develop the Dispatcher.
-    </p>
-    <warning>
-      The "Dispatcher" (previously known as "Views") is new functionality which
-      is still in development phase. That is why it is in the "whiteboard"
-      section of Forrest. This document will also need to change to keep pace.
-      We are working at the moment on moving this plugin from the whiteboard
-      into the core plugins. See <a href="ext:forrest/status-themes">Status of
-      Themes: Skins and Dispatcher</a>.
-    </warning>
+    <p>People who are helping to develop the Dispatcher.</p>
+    <warning>The "Dispatcher" (previously known as "Views") is new
+    functionality which is still in development phase. That is why it is in the
+    "whiteboard" section of Forrest. This document will also need to change to
+    keep pace. We are working at the moment on moving this plugin from the
+    whiteboard into the core plugins. See 
+    <a href="ext:forrest/status-themes">Status of Themes: Skins and
+    Dispatcher</a>.</warning>
   </audience>
   <purpose title="Purpose">
-    <p>
-      This document will get you started. We will Dispatcher-enable an existing
-      site and show how to add/remove ready-made contacts. Then we will discuss
-      how add your own new contracts.
-    </p>
-    <p>
-      This document encourages developers to get involved with fine-tuning and
-      testing the dispatcher. Please help to enhance the current core contracts
-      so that people do not need to re-invent the wheel.
-    </p>
+    <p>This document will get you started. We will Dispatcher-enable an
+    existing site and show how to add/remove ready-made contacts. Then we will
+    discuss how add your own new contracts.</p>
+    <p>This document encourages developers to get involved with fine-tuning and
+    testing the dispatcher. Please help to enhance the current core contracts
+    so that people do not need to re-invent the wheel.</p>
   </purpose>
   <prerequisites title="Prerequisites">
     <ul>
-      <li>Using Forrest trunk of SVN (i.e. head of development).
-      </li>
+      <li>Using Forrest trunk of SVN (i.e. head of development).</li>
       <li>Followed the installation instructions below.</li>
-      <li>You have an existing forrest site and want to try the
-        new Dispatcher. Otherwise create a 'forrest seed-sample' site.</li>
+      <li>You have an existing forrest site and want to try the new Dispatcher.
+      Otherwise create a 'forrest seed-sample' site.</li>
     </ul>
   </prerequisites>
   <steps title="Steps">
-    <note>
-      When developing with the dispatcher we assume you are using 'forrest run'
-      and the following workflow "change files -&gt; refresh browser".
-      <br/>
-      Installing a mozilla browser and the
-      <a href="ext:forrestbar">Forrestbar</a> helps a lot with developing, but
-      is not necessary.
-    </note>
+    <note>When developing with the dispatcher we assume you are using 'forrest
+    run' and the following workflow "change files -&gt; refresh browser". 
+    <br />Installing a mozilla browser and the 
+    <a href="ext:forrestbar">Forrestbar</a>helps a lot with developing, but is
+    not necessary.</note>
     <section id="patch">
       <title>Get ready</title>
       <ul>
         <li>Do 'svn update' on forrest/trunk</li>
-        <li>Do the 'cd main; build clean; build' (necessary because the Dispatcher is changing rapidly and uses some Java)</li>
+        <li>Do the 'cd main; build clean; build' (necessary because the
+        Dispatcher is changing rapidly and uses some Java)</li>
       </ul>
     </section>
     <section id="enable">
       <title>Dispatcher-enable the existing site</title>
       <ul>
         <li>Add the new plugins to forrest.properties ...
-        ,org.apache.forrest.plugin.internal.dispatcher,org.apache.forrest.themes.core
-        </li>
+        ,org.apache.forrest.plugin.internal.dispatcher,org.apache.forrest.themes.core</li>
         <li>localhost:8888/index.html ... fantastic. See the pelt view.</li>
       </ul>
     </section>
     <section id="another-theme">
       <title>Use another theme</title>
       <ul>
-        <li>Add <![CDATA[<property name="dispatcher.theme" value="pelt"/>]]> 
-          to your forrest.properties.xml</li>
+        <li>Add 
+<![CDATA[<property name="dispatcher.theme" value="pelt"/>]]>
+to your forrest.properties.xml</li>
         <li>Re-start 'forrest run'</li>
         <li>localhost:8888/index.html ... See the new view.</li>
       </ul>
     </section>
     <section id="our-structurer">
       <title>Create our own structurer by copy-and-customise</title>
-      <p>
-        Copy the default structurer for the pelt theme and make local changes.
-      </p>
-      <note>
-        At this stage of rapid development of the Dispatcher, be sure to keep
-        your copy synchronised. Use 'diff' against the known svn version of the
-        core pelt.fv to track your local changes. Also please consider
-        contributing new contracts and changes to the default structurers to the
-        Forrest projects. That eases your local version management and everyone
-        will benefit.
-      </note>
-      <note>
-        We use <code>${themer.project.dir}</code> for
-        PROJECT_HOME/src/documentation/resources/themes (create the new
-        directory first). You can change this location by adding
+      <p>Copy the default structurer for the pelt theme and make local
+      changes.</p>
+      <note>At this stage of rapid development of the Dispatcher, be sure to
+      keep your copy synchronised. Use 'diff' against the known svn version of
+      the core pelt.fv to track your local changes. Also please consider
+      contributing new contracts and changes to the default structurers to the
+      Forrest projects. That eases your local version management and everyone
+      will benefit.</note>
+      <note>We use 
+      <code>${themer.project.dir}</code>for
+      PROJECT_HOME/src/documentation/resources/themes (create the new directory
+      first). You can change this location by adding 
 <![CDATA[<match pattern="themer.project.dir">
           <location src="{properties:resources}/themes" />
         </match> ]]>
-        to your locationmap and point to another directory.
-      </note>
-      <note>
-      By default THEMER_PLUGIN can be located at FORREST_HOME/whiteboard/plugins/org.apache.forrest.themes.core
-      </note>           
+to your locationmap and point to another directory.</note>
+      <note>By default THEMER_PLUGIN can be located at
+      FORREST_HOME/whiteboard/plugins/org.apache.forrest.themes.core</note>
       <ul>
         <li>Copy THEMER_PLUGIN/themes/pelt.fv into your project at
-          ${themer.project.dir}/pelt.fv
-        </li>
-        <li>Copy THEMER_PLUGIN/themes/pelt/panels/pelt-html.header.panel.xml into your
-          project at ${themer.project.dir}/pelt/panels/pelt-html.header.panel.xml
-        </li>
+        ${themer.project.dir}/pelt.fv</li>
+        <li>Copy THEMER_PLUGIN/themes/pelt/panels/pelt-html.header.panel.xml
+        into your project at
+        ${themer.project.dir}/pelt/panels/pelt-html.header.panel.xml</li>
         <li>Re-start 'forrest run'</li>
-        <li>localhost:8888/index.html ... See the same view, now structured
-          by us.
-        </li>
-        <li>In localhost:8888/resolve.structurer.index you can find a copy of your current structurer. Any change  made to your pelt.fv file will be added here.
-        </li>
+        <li>localhost:8888/index.html ... See the same view, now structured by
+        us.</li>
+        <li>In localhost:8888/resolve.structurer.index you can find a copy of
+        your current structurer. Any change made to your pelt.fv file will be
+        added here.</li>
       </ul>
-      <p>
-        From here on there is no need to re-start 'forrest run'. Just edit the
-        structurer and see the effect.
-      </p>
-      <warning>
-      Right now the dispatcher is heavely cached, so maybe in the current version it should be
-      necessary to reboot the system in order to see the changes. To avoid temporally this problem,
-      turn off the cache system changing:
-      
+      <p>From here on there is no need to re-start 'forrest run'. Just edit the
+      structurer and see the effect.</p>
+      <warning>Right now the dispatcher is heavely cached, so maybe in the
+      current version it should be necessary to reboot the system in order to
+      see the changes. To avoid temporally this problem, turn off the cache
+      system changing: 
 <![CDATA[
-<forrest:views xmlns:forrest="http://apache.org/forrest/templates/1.0"
-	xmlns:jx="http://apache.org/cocoon/templates/jx/1.0"
-	jx:cache-key="#{$cocoon/parameters/getRequest}"
-	jx:cache-validity="${Packages.org.apache.excalibur.source.impl.validity.NOPValidity()}">
+<forrest:structurer xmlns:forrest="http://apache.org/forrest/templates/1.0"
+        xmlns:jx="http://apache.org/cocoon/templates/jx/1.0"
+        jx:cache-key="#{$cocoon/parameters/getRequest}"
+        jx:cache-validity="${Packages.org.apache.excalibur.source.impl.validity.NOPValidity()}">
 ]]>
-      
-      to
-      
+to 
 <![CDATA[
-<forrest:views xmlns:forrest="http://apache.org/forrest/templates/1.0"
-	xmlns:jx="http://apache.org/cocoon/templates/jx/1.0">
+<forrest:structurer xmlns:forrest="http://apache.org/forrest/templates/1.0"
+        xmlns:jx="http://apache.org/cocoon/templates/jx/1.0">
 ]]>
-      
-      in your THEMER_PLUGIN/themes/pelt.fv file.
-      </warning>
+in your THEMER_PLUGIN/themes/pelt.fv file.</warning>
     </section>
     <section id="remove-default-contract">
       <title>Remove a default contract</title>
       <ul>
-        <li>Remove the top breadcrumb trail. Edit your pelt-html.header.panel.xml, find the
-          "branding-breadcrumbs" contract and comment it out.
-        </li>
+        <li>Remove the top breadcrumb trail. Edit your
+        pelt-html.header.panel.xml, find the "branding-breadcrumbs" contract
+        and comment it out.</li>
       </ul>
     </section>
     <section id="add-default-contract">
       <title>Add a default contract</title>
-      <p>
-        Forrest provides many default contracts. If you are using the Forrestbar
-        then choose "dispatcher-devs =&gt; ls.contracts". Otherwise visit
-        localhost:8888/ls.contracts.html
-      </p>
+      <p>Forrest provides many default contracts. If you are using the
+      Forrestbar then choose "dispatcher-devs =&gt; ls.contracts". Otherwise
+      visit localhost:8888/ls.contracts.html</p>
       <ul>
-        <li>
-          See the usage detail for your chosen contract via the above mentioned list.
-          e.g. "siteinfo-current-time"
-        </li>
-        <li>
-          Insert it at the appropriate point in your structurer. Note that it
-          will need to go inside the appropriate CSS hook, e.g.
+        <li>See the usage detail for your chosen contract via the above
+        mentioned list. e.g. "siteinfo-current-time"</li>
+        <li>Insert it at the appropriate point in your structurer. Note that it
+        will need to go inside the appropriate CSS hook, e.g. 
         <source>
-<![CDATA[  ...
+          <![CDATA[  ...
   <forrest:hook name="footer">
     <forrest:contract name="siteinfo-current-time"/>
     ...
 ]]>
-          </source></li>
+</source></li>
       </ul>
-      <p>
-        Notice that you did not need to copy any other code to your project
-        space. Forrest finds the default contract in its core (the themes.core
-        plugin).
-      </p>
-      <p>
-        You will find some commonly used contracts in place but commented out in
-        both the common and the pelt structurer files. Feel free to uncomment
-        them to activate them, move them around into other hooks or create new
-        hooks for them.
-      </p>
-      <note>
-        Work is currently under way for implementing Panels (was tiles).
-        Currently we now have a 'panels' sub-dir for each 'theme'. This panels
-        sub-dir currently contains a main html panel
-        '%themename%-html.panel.xml' and a CSS panel
-        '%themename%-css.panel.xml'. So you can change a collection of HTML and
-        CSS outputs from these two XML files.
-      </note>
+      <p>Notice that you did not need to copy any other code to your project
+      space. Forrest finds the default contract in its core (the themes.core
+      plugin).</p>
+      <p>You will find some commonly used contracts in place but commented out
+      in both the common and the pelt structurer files. Feel free to uncomment
+      them to activate them, move them around into other hooks or create new
+      hooks for them.</p>
+      <note>Work is currently under way for implementing Panels (was tiles).
+      Currently we now have a 'panels' sub-dir for each 'theme'. This panels
+      sub-dir currently contains a main html panel '%themename%-html.panel.xml'
+      and a CSS panel '%themename%-css.panel.xml'. So you can change a
+      collection of HTML and CSS outputs from these two XML files.</note>
     </section>
     <section id="add-project-contract">
       <title>Add a new project contract</title>
-      <warning>
-        Carefully consider the purpose of your contracts. If they are useful in
-        a wider context, then they belong in plugins or the core of Forrest. See
-        below for further discussion on this important topic.
-      </warning>
-      <p>
-        Project-based contracts are defined in theme-specific and
-        output-format-specific directory structure, e.g.
-        ${themer.project.dir}/THEME_NAME/OUTPUT_FORMAT/
-      </p>
-      <p>
-        Project-based contracts common to all themes go in
-        ${themer.project.dir}/common/OUTPUT_FORMAT/
-      </p>
-      <p>
-        To get started quickly (it is not a project-based contract but a demo),
-        copy one of the default contracts. e.g. copy siteinfo-current-time.ft to
-        become siteinfo-doodad.ft ...
-      </p>
+      <warning>Carefully consider the purpose of your contracts. If they are
+      useful in a wider context, then they belong in plugins or the core of
+      Forrest. See below for further discussion on this important
+      topic.</warning>
+      <p>Project-based contracts are defined in theme-specific and
+      output-format-specific directory structure, e.g.
+      ${themer.project.dir}/THEME_NAME/OUTPUT_FORMAT/</p>
+      <p>Project-based contracts common to all themes go in
+      ${themer.project.dir}/common/OUTPUT_FORMAT/</p>
+      <p>To get started quickly (it is not a project-based contract but a
+      demo), copy one of the default contracts. e.g. copy
+      siteinfo-current-time.ft to become siteinfo-doodad.ft ...</p>
       <ul>
-        <li>
-          Copy THEMER_PLUGIN/themes/common/html/siteinfo-current-time.ft
-          into your project at
-          ${themer.project.dir}/common/html/siteinfo-doodad.ft
-          (create the new directory first).
-        </li>
-        <li>
-          Edit it to suit. Replace all occurrences of "siteinfo-current-time" with
-          "siteinfo-doodad" and make your other changes (e.g. the text and the
-          javascript function).
-        </li>
-        <li>
-          Declare your new contract in your structurer as done above for adding a
-          default contract.
-        </li>
+        <li>Copy THEMER_PLUGIN/themes/common/html/siteinfo-current-time.ft into
+        your project at ${themer.project.dir}/common/html/siteinfo-doodad.ft
+        (create the new directory first).</li>
+        <li>Edit it to suit. Replace all occurrences of "siteinfo-current-time"
+        with "siteinfo-doodad" and make your other changes (e.g. the text and
+        the javascript function).</li>
+        <li>Declare your new contract in your structurer as done above for
+        adding a default contract.</li>
       </ul>
-      <p>
-        See a list of your project-based contracts and their usage notes via
-        Forrestbar "dispatcher-devs =&gt; ls.contracts.project". Otherwise visit
-        localhost:8888/ls.contracts.project.html
-      </p>
+      <p>See a list of your project-based contracts and their usage notes via
+      Forrestbar "dispatcher-devs =&gt; ls.contracts.project". Otherwise visit
+      localhost:8888/ls.contracts.project.html</p>
     </section>
-<!--
+    <!--
     <section id="newSection">
       <title>newSection</title>
       <ul>
@@ -258,7 +208,7 @@
       </ul>
     </section>
 -->
-<!--
+    <!--
     <section id="notes">
       <title>Notes</title>
         <source><![CDATA[
@@ -268,56 +218,48 @@
 -->
     <section id="manage">
       <title>Decide how to manage your contracts</title>
-      <p>
-      Depending on the use of a new contract you can place it in different 
-      locations. General use contracts should be placed in the THEME_PLUGIN 
-      directory. Contracts only suitable for one theme should be stored in 
-      the specific theme directory, that is, 
-      <code>THEMER_PLUGIN/resources/themes/THEME_NAME/OUTPUT_FORMAT</code>. 
+      <p>Depending on the use of a new contract you can place it in different
+      locations. General use contracts should be placed in the THEME_PLUGIN
+      directory. Contracts only suitable for one theme should be stored in the
+      specific theme directory, that is, 
+      <code>THEMER_PLUGIN/resources/themes/THEME_NAME/OUTPUT_FORMAT</code>.
       Otherwise, common contracts should be place in the common folder: 
-      <code>THEMER_PLUGIN/resources/themes/common/OUTPUT_FORMAT</code>.
-      </p>
-      <p>
-      If the contract is specific to a particular purpose, that is a 
-      particular plugin, it should be included with the plugin itself. 
-      For example, the "employment history" contract is specific to the 
-      resume plugin so it should be placed there. The correct location for 
-      contrats with a particular purpose is 
-      <code>PLUGIN_NAME/resources/themes/THEME_NAME/OUTPUT_FORMAT</code>.
-      </p>
-      <p>
-      There is another category for contracts, those that are both specific 
-      to a particular purpose and defined for a specific site. For example, 
-      a "process order" contract that integrates with an in-house order 
-      management system. In this case, another location is more suitable. 
+      <code>THEMER_PLUGIN/resources/themes/common/OUTPUT_FORMAT</code>.</p>
+      <p>If the contract is specific to a particular purpose, that is a
+      particular plugin, it should be included with the plugin itself. For
+      example, the "employment history" contract is specific to the resume
+      plugin so it should be placed there. The correct location for contrats
+      with a particular purpose is 
+      <code>PLUGIN_NAME/resources/themes/THEME_NAME/OUTPUT_FORMAT</code>.</p>
+      <p>There is another category for contracts, those that are both specific
+      to a particular purpose and defined for a specific site. For example, a
+      "process order" contract that integrates with an in-house order
+      management system. In this case, another location is more suitable.
       However, before proceed think again about the uniqueness of the contract.
-      Most contracts can be generalised to be useful in more than one 
-      environment and so one of the above locations can be used. If you are 
+      Most contracts can be generalised to be useful in more than one
+      environment and so one of the above locations can be used. If you are
       still sure that this is a site-specific contract then place it in 
-      <code>PROJECT_HOME/src/documentation/resources/themes/common</code>.
-      </p>
-      <p>
-      If you develop a new contract, please provide a patch via our 
-      <a href="site:issues">issue tracker</a> so that we 
-      can include it in future releases of Forrest.
-      </p>
+      <code>PROJECT_HOME/src/documentation/resources/themes/common</code>.</p>
+      <p>If you develop a new contract, please provide a patch via our 
+      <a href="site:issues">issue tracker</a>so that we can include it in
+      future releases of Forrest.</p>
     </section>
   </steps>
   <extension title="Further Reading">
-    <p>
-      Congratulations you are now able to work with the Dispatcher. From here we
-      recommend to read the following How-Tos:
-    </p>
+    <p>Congratulations you are now able to work with the Dispatcher. From here
+    we recommend to read the following How-Tos:</p>
     <ul>
-      <li><a href="site:dispatcher/structurer">How to use the structurer</a></li>
-      <li><a href="site:dispatcher/contracts">Create your own contract 
-          implementation</a></li>
+      <li>
+        <a href="site:dispatcher/structurer">How to use the structurer</a>
+      </li>
+      <li>
+        <a href="site:dispatcher/contracts">Create your own contract
+        implementation</a>
+      </li>
     </ul>
   </extension>
   <feedback title="Feedback">
-    <p>
-      Please provide feedback about this document via the
-      <a href="ext:mail-lists">mailing lists</a>.
-    </p>
+    <p>Please provide feedback about this document via the 
+    <a href="ext:mail-lists">mailing lists</a>.</p>
   </feedback>
 </howto>

Modified: forrest/branches/dispatcher_rewrite/plugins/org.apache.forrest.plugin.internal.dispatcher/src/documentation/content/xdocs/how/howto-dispatcher-structurer.xml
URL: http://svn.apache.org/viewvc/forrest/branches/dispatcher_rewrite/plugins/org.apache.forrest.plugin.internal.dispatcher/src/documentation/content/xdocs/how/howto-dispatcher-structurer.xml?rev=808385&r1=808384&r2=808385&view=diff
==============================================================================
--- forrest/branches/dispatcher_rewrite/plugins/org.apache.forrest.plugin.internal.dispatcher/src/documentation/content/xdocs/how/howto-dispatcher-structurer.xml (original)
+++ forrest/branches/dispatcher_rewrite/plugins/org.apache.forrest.plugin.internal.dispatcher/src/documentation/content/xdocs/how/howto-dispatcher-structurer.xml Thu Aug 27 12:07:38 2009
@@ -1,4 +1,4 @@
-<?xml version="1.0" encoding="UTF-8"?>
+<?xml version="1.0" encoding="utf-8"?>
 <!--
   Licensed to the Apache Software Foundation (ASF) under one or more
   contributor license agreements.  See the NOTICE file distributed with
@@ -15,109 +15,98 @@
   See the License for the specific language governing permissions and
   limitations under the License.
 -->
-<!DOCTYPE howto PUBLIC "-//APACHE//DTD How-to V2.0//EN" "http://forrest.apache.org/dtd/howto-v20.dtd">
+<!DOCTYPE howto PUBLIC "-//APACHE//DTD How-to V2.0//EN"
+"http://forrest.apache.org/dtd/howto-v20.dtd">
 <howto>
   <header>
     <title>How to use the structurer</title>
-    <abstract>
-      This How-To describes the usage of the structurer config domain specific
-      language to create beautiful websites in no time.
-    </abstract>
-    <last-modified-content-date date="2005-07-17"/>
+    <abstract>This How-To describes the usage of the structurer config domain
+    specific language to create beautiful websites in no time.</abstract>
+    <last-modified-content-date date="2005-07-17" />
   </header>
   <audience title="Intended Audience">
-    <warning>
-      The "Dispatcher" (aka "Views") is new functionality which is still in
-      development phase. That is why it is in the "whiteboard" section of the
-      Forrest distribution. This HowTo is a good start but still needs more
-      work. See <a href="ext:forrest/status-themes">Status of Themes: Skins and
-      Dispatcher</a>.
-    </warning>
-    <p>
-      This part of the the dispatcher is called the structurer and is dedicated
-      to webdesigner and user with some knowledge of css.
-    </p>
+    <warning>The "Dispatcher" (aka "Views") is new functionality which is still
+    in development phase. That is why it is in the "whiteboard" section of the
+    Forrest distribution. This HowTo is a good start but still needs more work.
+    See 
+    <a href="ext:forrest/status-themes">Status of Themes: Skins and
+    Dispatcher</a>.</warning>
+    <p>This part of the the dispatcher is called the structurer and is
+    dedicated to webdesigner and user with some knowledge of css.</p>
   </audience>
   <purpose title="Purpose">
-    <p>
-      This how-to will show you how to write a <strong>structurer</strong> from
-      the ground up. We will focus on html as the output format. As well it will
-      show how to add your own css implementation to the structurer.
-    </p>
+    <p>This how-to will show you how to write a 
+    <strong>structurer</strong>from the ground up. We will focus on html as the
+    output format. As well it will show how to add your own css implementation
+    to the structurer.</p>
   </purpose>
   <prerequisites title="Prerequisites">
     <ul>
-      <li>Installing a mozilla browser and the forrestbar helps a lot in 
-        developing.</li>
+      <li>Installing a mozilla browser and the forrestbar helps a lot in
+      developing.</li>
     </ul>
   </prerequisites>
   <steps title="Steps">
-    <note>
-      When developing with the dispatcher we assume you are using 'forrest run'
-      and the following workflow "change files -&gt; refresh browser"
-      <br/>
-      Installing a mozilla browser and the forrestbar helps a lot in developing.
-      Many instructions assumes that you have the forrestbar installed.
-    </note>
+    <note>When developing with the dispatcher we assume you are using 'forrest
+    run' and the following workflow "change files -&gt; refresh browser" 
+    <br />Installing a mozilla browser and the forrestbar helps a lot in
+    developing. Many instructions assumes that you have the forrestbar
+    installed.</note>
     <section id="emptystructurer">
       <title>Empty structurer file</title>
       <source>
-<![CDATA[<forrest:views 
+        <![CDATA[<forrest:structurer 
   xmlns:forrest="http://apache.org/forrest/templates/1.0"
   xmlns:jx="http://apache.org/cocoon/templates/jx/1.0">
-  <forrest:view type="html">
-  </forrest:view>
-</forrest:views>]]>
-      </source>
-      <p>
-        <strong> The structurer</strong> is designed to be open for any format
-        that can use<strong> forrest:view</strong> as configuration file. The
-        only format we implemented is html for now. This is as well true for the
-        delivered contracts.
-      </p>
+  <forrest:structure type="html">
+  </forrest:structure>
+</forrest:structurer>]]>
+</source>
+      <p>
+      <strong>The structurer</strong>is designed to be open for any format that
+      can use 
+      <strong>forrest:structure</strong>as configuration file. The only format
+      we implemented is html for now. This is as well true for the delivered
+      contracts.</p>
     </section>
     <section id="firststructurer">
       <title>Creating your first structurer</title>
-      <warning>
-        The structurer is based on jx templates to allow simple presentation
-        logic (all code starting with "jx:"). Please refer to the cocoon
-        documentation about jx.
-      </warning>
-      <p>
-        In this section we will create a new structurer. We will override the
-        default structurer of the core themes for the index page of a new seed.
-        For that we will create a file called <code>index.fv</code> and save it
-        in the directory <code>{properties:resources}/structurer/url</code>
-        (create it if needed). This will make <strong>only</strong> the
-        index.html page look different from the rest of the project.
-      </p>
-      <note label="RecursiveDirectoryTraversalAction">
-        You can set a view for an individual file, a directory, or the whole
-        site. To address multiple files in a directory call your
-        <code>.fv</code> file <code>common.fv</code>. If Forrest doesn't find a
-        <code>.fv</code> file with the same name as the current file it will use
-        the common.fv file in that directory, or the first one it finds going
-        upwards through the directory structure. <code>common.fv</code> files
-        affect all subdirectories unless they are overidden by another
-        <code>common.fv</code> or a file-specific <code>foo.fv</code> file.
-      </note>
-      <p>
-        Remember: pointing your browser to
-        <code>http://localhost:8888/ls.contracts.html</code> will show a page
-        with all contracts and themes that you can use in your project provided
-        by forrest.
-      </p>
-      <p>
-        Let us use the blank structurer from the earlier step and add the
-        content-main contract. In ls.contracts.html we find the information for
-        how to use the contract in our structurer. Our <code>index.fv</code>
-        should look like:
-      </p>
+      <warning>The structurer is based on jx templates to allow simple
+      presentation logic (all code starting with "jx:"). Please refer to the
+      cocoon documentation about jx.</warning>
+      <p>In this section we will create a new structurer. We will override the
+      default structurer of the core themes for the index page of a new seed.
+      For that we will create a file called 
+      <code>index.fv</code>and save it in the directory 
+      <code>{properties:resources}/structurer/url</code>(create it if needed).
+      This will make 
+      <strong>only</strong>the index.html page look different from the rest of
+      the project.</p>
+      <note label="RecursiveDirectoryTraversalAction">You can set a view for an
+      individual file, a directory, or the whole site. To address multiple
+      files in a directory call your 
+      <code>.fv</code>file 
+      <code>common.fv</code>. If Forrest doesn't find a 
+      <code>.fv</code>file with the same name as the current file it will use
+      the common.fv file in that directory, or the first one it finds going
+      upwards through the directory structure. 
+      <code>common.fv</code>files affect all subdirectories unless they are
+      overidden by another 
+      <code>common.fv</code>or a file-specific 
+      <code>foo.fv</code>file.</note>
+      <p>Remember: pointing your browser to 
+      <code>http://localhost:8888/ls.contracts.html</code>will show a page with
+      all contracts and themes that you can use in your project provided by
+      forrest.</p>
+      <p>Let us use the blank structurer from the earlier step and add the
+      content-main contract. In ls.contracts.html we find the information for
+      how to use the contract in our structurer. Our 
+      <code>index.fv</code>should look like:</p>
       <source>
-<![CDATA[<forrest:views 
+        <![CDATA[<forrest:structurer 
   xmlns:forrest="http://apache.org/forrest/templates/1.0"
   xmlns:jx="http://apache.org/cocoon/templates/jx/1.0">
-  <forrest:view type="html">
+  <forrest:structure type="html">
     <forrest:contract name="content-main">
     <forrest:properties contract="content-main">
       <forrest:property name="content-main" nugget="get.body">
@@ -129,37 +118,33 @@
       </forrest:property>
     </forrest:properties>
   </forrest:contract>
-  </forrest:view>
-</forrest:views>]]>
-      </source>
-      <p>
-        A contract has to request the data model it want to transform. This
-        happends by defining forrest:properties which have the same name like
-        the contract. In our case we want the HTML rendered from intermediate
-        format (**.body.xml). This we are going to include via: <code>
-<![CDATA[<jx:import uri="cocoon://#{$cocoon/parameters/getRequest}.body.xml"/>]]>
-        </code>
-      </p>
-      <p>
-        Contracts can offer some property configuration of the outcome of the
-        transformation. In our case <code>
+  </forrest:structure>
+</forrest:structurer>]]>
+</source>
+      <p>A contract has to request the data model it want to transform. This
+      happends by defining forrest:properties which have the same name like the
+      contract. In our case we want the HTML rendered from intermediate format
+      (**.body.xml). This we are going to include via: 
+      <code>
+        <![CDATA[<jx:import uri="cocoon://#{$cocoon/parameters/getRequest}.body.xml"/>]]>
+</code></p>
+      <p>Contracts can offer some property configuration of the outcome of the
+      transformation. In our case 
+      <code>
 <![CDATA[<forrest:property name="content-main-conf">
         <headings type="underlined"/>
       </forrest:property>]]>
-        . </code>
-      </p>
-      <p>
-        Lets try our new structurer by pointing to
-        <code>http://localhost:8888/index.html</code>. We will see only the main
-        content. Now let us add the section navigation to our structurer. The
-        contract usage in the structurer can be looked up in ls.contracts.html.
-        Our structurer now looks like:
-      </p>
+.</code></p>
+      <p>Lets try our new structurer by pointing to 
+      <code>http://localhost:8888/index.html</code>. We will see only the main
+      content. Now let us add the section navigation to our structurer. The
+      contract usage in the structurer can be looked up in ls.contracts.html.
+      Our structurer now looks like:</p>
       <source>
-<![CDATA[<forrest:views 
+        <![CDATA[<forrest:structurer 
   xmlns:forrest="http://apache.org/forrest/templates/1.0"
   xmlns:jx="http://apache.org/cocoon/templates/jx/1.0">
-  <forrest:view type="html">
+  <forrest:structure type="html">
     <forrest:contract name="nav-main">
       <forrest:properties contract="nav-main">
         <forrest:property name="nav-main" nugget="get.navigation">
@@ -179,56 +164,43 @@
         </forrest:property>
       </forrest:properties>
     </forrest:contract>
-  </forrest:view>
-</forrest:views>]]>
-      </source>
-      <p>
-        We now find the main content and the section navigation after each other
-        and in the order we placed them in the structurer, but we want it next
-        to each other (left: nav-section; right: content-main).
-      </p>
+  </forrest:structure>
+</forrest:structurer>]]>
+</source>
+      <p>We now find the main content and the section navigation after each
+      other and in the order we placed them in the structurer, but we want it
+      next to each other (left: nav-section; right: content-main).</p>
     </section>
     <section id="hookstructurer">
       <title>Hooks in the structurer</title>
-      <p>
-        We will use now the first time a <code>
-<![CDATA[<forrest:hook name="layoutId"/>]]>
-        </code>. Hooks are the styling side of the structurer. We can imitate
-        arbitrary html skeleton with their help. Before we explain how to use
-        your own css in the structurer, we will use the default css. You can see
-        in our example that we have css included. That is a default fallback
-        coming from the implementation. In this common.css we can find
-      </p>
-      <source>/* menu */
-#leftbar {
-    width: 25%;
-    float: left;
-    background: #eae8e3;
-    border: thin dashed #565248;
-}
-      </source>
-      <p>
-        With this information we know to use <code>
-<![CDATA[<forrest:hook name="leftbar"/>]]>
-        </code> and add contracts into that container.
-      </p>
-      <p>
-        If we want to put the nav-section contract into the left-hand side
-        position of the site we need to place the contract into that hook. Like:
-      </p>
+      <p>We will use now the first time a 
+      <code>
+        <![CDATA[<forrest:hook name="layoutId"/>]]>
+</code>. Hooks are the styling side of the structurer. We can imitate arbitrary
+html skeleton with their help. Before we explain how to use your own css in the
+structurer, we will use the default css. You can see in our example that we
+have css included. That is a default fallback coming from the implementation.
+In this common.css we can find</p>
+      <source>/* menu */ #leftbar { width: 25%; float: left; background:
+      #eae8e3; border: thin dashed #565248; }</source>
+      <p>With this information we know to use 
+      <code>
+        <![CDATA[<forrest:hook name="leftbar"/>]]>
+</code>and add contracts into that container.</p>
+      <p>If we want to put the nav-section contract into the left-hand side
+      position of the site we need to place the contract into that hook.
+      Like:</p>
       <source>
-<![CDATA[<forrest:hook name="leftbar">
+        <![CDATA[<forrest:hook name="leftbar">
   <!-- Include contract here -->
 </forrest:hook>]]>
-      </source>
-      <p>
-        Our structurer will then look like:
-      </p>
+</source>
+      <p>Our structurer will then look like:</p>
       <source>
-<![CDATA[<forrest:views 
+        <![CDATA[<forrest:structurer 
   xmlns:forrest="http://apache.org/forrest/templates/1.0"
   xmlns:jx="http://apache.org/cocoon/templates/jx/1.0">
-  <forrest:view type="html">
+  <forrest:structure type="html">
     <forrest:hook name="leftbar">
       <forrest:contract name="nav-section">
         <forrest:properties contract="nav-section">
@@ -250,21 +222,20 @@
         </forrest:property>
       </forrest:properties>
     </forrest:contract>
-  </forrest:view>
-</forrest:views>]]>
-      </source>
+  </forrest:structure>
+</forrest:structurer>]]>
+</source>
     </section>
     <section id="cssstructurer">
       <title>CSS in the structurer</title>
-      <p>
-        We now know how to place contracts and hooks in our structurer. Until
-        this stage we only used the common.css. CSS-support of the structurer is
-        as easy as placing contracts/hooks. To override the common.css
-        stylesheet we use another tag within our structurer <code>
-<![CDATA[<forrest:css />]]>
-        </code>.
-      </p>
-<!--      <p>We will now create a file in <code><![CDATA[<!-#- 
+      <p>We now know how to place contracts and hooks in our structurer. Until
+      this stage we only used the common.css. CSS-support of the structurer is
+      as easy as placing contracts/hooks. To override the common.css stylesheet
+      we use another tag within our structurer 
+      <code>
+        <![CDATA[<forrest:css />]]>
+</code>.</p>
+      <!--      <p>We will now create a file in <code><![CDATA[<!-#- 
    {1} name
    {2} extension (note we assume e.g. PATH/css/{1}.css)
    -#->
@@ -272,15 +243,13 @@
         we will save a file called howTo.css in v2/src/documentation/resources/themes/common/css/howTo.css containing only 
         the following css:
       </p>-->
-      <p>
-        You can add inline and linked css with the structurer. As soon as you
-        use forrest:css you will disable the fallback css support from forrest.
-        With this tag we tell the dispatcher that we want to override the
-        common.css. After adding the following to our index.fv the design will
-        be different.
-      </p>
+      <p>You can add inline and linked css with the structurer. As soon as you
+      use forrest:css you will disable the fallback css support from forrest.
+      With this tag we tell the dispatcher that we want to override the
+      common.css. After adding the following to our index.fv the design will be
+      different.</p>
       <source>
-<![CDATA[<forrest:css >
+        <![CDATA[<forrest:css >
 /* Extra css */
 /* menu */
 #leftbar {
@@ -290,25 +259,23 @@
   border: thin solid #000000;
 }
 </forrest:css>]]>
-      </source>
-<!--<fixme author="thorsten">from here</fixme>-->
-      <p>
-        We just changed the border-style to 'solid', the background to '#CCCCFF'
-        and the color to '#000000'. So you see a white page where the menu is
-        surrounded by a solid border with the defined background.
-      </p>
+</source>
+      <!--<fixme author="thorsten">from here</fixme>-->
+      <p>We just changed the border-style to 'solid', the background to
+      '#CCCCFF' and the color to '#000000'. So you see a white page where the
+      menu is surrounded by a solid border with the defined background.</p>
       <note>
-        <code>
-<![CDATA[<forrest:css />]]>
-        </code> needs to be the direct child of <code>
-<![CDATA[<forrest:view type="html">]]>
-        </code>
-      </note>
+      <code>
+        <![CDATA[<forrest:css />]]>
+</code>needs to be the direct child of 
+      <code>
+        <![CDATA[<forrest:structure type="html">]]>
+</code></note>
       <source>
-<![CDATA[<forrest:views 
+        <![CDATA[<forrest:structurer 
   xmlns:forrest="http://apache.org/forrest/templates/1.0"
   xmlns:jx="http://apache.org/cocoon/templates/jx/1.0">
-  <forrest:view type="html">
+  <forrest:structure type="html">
     <forrest:css >
 /* Extra css */
 /* menu */
@@ -340,31 +307,23 @@
         </forrest:property>
       </forrest:properties>
     </forrest:contract>
-  </forrest:view>
-</forrest:views>]]>
-      </source>
-      <p>
-        As a second example, let us change as well the content-main by adding
-        another hook <code>
-<![CDATA[<forrest:hook name="content"/>]]>
-        </code> We need to add the new layout container to our inline css:
-      </p>
+  </forrest:structure>
+</forrest:structurer>]]>
+</source>
+      <p>As a second example, let us change as well the content-main by adding
+      another hook 
+      <code>
+        <![CDATA[<forrest:hook name="content"/>]]>
+</code>We need to add the new layout container to our inline css:</p>
+      <source>/* The actual content */ #content { margin-left: 25%; padding: 0
+      20px 0 20px; background: #B9D3EE; }</source>
+      <p>Then we have to add the 'content-main' contract to the 'content' hook.
+      The resulting structurer looks like:</p>
       <source>
-/* The actual content */
-#content {
-  margin-left: 25%;
-  padding: 0 20px 0 20px;
-  background: #B9D3EE;
-}</source>
-      <p>
-        Then we have to add the 'content-main' contract to the 'content' hook.
-        The resulting structurer looks like:
-      </p>
-      <source>
-<![CDATA[<forrest:views 
+        <![CDATA[<forrest:structurer 
   xmlns:forrest="http://apache.org/forrest/templates/1.0"
   xmlns:jx="http://apache.org/cocoon/templates/jx/1.0">
-  <forrest:view type="html">
+  <forrest:structure type="html">
     <forrest:css >
 /* Extra css */
 /* menu */
@@ -404,98 +363,74 @@
       </forrest:properties>
     </forrest:contract>
     </forrest:hook>
-  </forrest:view>
-</forrest:views>]]>
-      </source>
-      <p>
-        We are now able to place contracts into the layout container and add
-        custom css to the structurer.
-      </p>
+  </forrest:structure>
+</forrest:structurer>]]>
+</source>
+      <p>We are now able to place contracts into the layout container and add
+      custom css to the structurer.</p>
     </section>
     <section>
       <title>Linking to an external css file</title>
-      <note>
-        This will change for the next version of views (v3) where we use a
-        generic contract instead of the standalone element (forrest:css).
-      </note>
-      <p>
-        Make sure your project has the following directory structure. If it
-        doesn't you'll have to create it. "common" is the fallback for all
-        themes, if you want to override the css for a specific theme replace
-        "common" with "themeName". This is where Forrest will look for external
-        css stylesheets.
-      </p>
-      <source>
-        $projectHome\src\documentation\resources\themes\common\css</source>
-      <p>
-        Where $projectHome is the directory where your project exists.
-      </p>
-      <p>
-        Put your css stylesheets in this directory. For arguement's sake let's
-        say it's called mystyles.css
-      </p>
-      <p>
-        Edit your common.fv structurer (or whatever structurer (theme) you are
-        using). This will probably be some where in:
-      </p>
+      <note>This will change for the next version of views (v3) where we use a
+      generic contract instead of the standalone element (forrest:css).</note>
+      <p>Make sure your project has the following directory structure. If it
+      doesn't you'll have to create it. "common" is the fallback for all
+      themes, if you want to override the css for a specific theme replace
+      "common" with "themeName". This is where Forrest will look for external
+      css stylesheets.</p>
+      <source>
+      $projectHome\src\documentation\resources\themes\common\css</source>
+      <p>Where $projectHome is the directory where your project exists.</p>
+      <p>Put your css stylesheets in this directory. For arguement's sake let's
+      say it's called mystyles.css</p>
+      <p>Edit your common.fv structurer (or whatever structurer (theme) you are
+      using). This will probably be some where in:</p>
       <source>$projectHome\src\documentation\content\xdocs</source>
-      <p>
-        or if you want to override it for the whole project in:
-      </p>
+      <p>or if you want to override it for the whole project in:</p>
       <source>$projectHome\src\documentation\resources\themes\</source>
-      <p>
-        Add the following element to the *.fv file:
-      </p>
+      <p>Add the following element to the *.fv file:</p>
       <source>
-<![CDATA[<forrest:css url="styles.css" media="screen" theme="pelt"/>]]>
-      </source>
+        <![CDATA[<forrest:css url="styles.css" media="screen" theme="pelt"/>]]>
+</source>
       <p>
-        <strong>Important!</strong> This must appear straight after the "view
-        type" element (as first child):
-      </p>
+      <strong>Important!</strong>This must appear straight after the "view
+      type" element (as first child):</p>
       <source>
-<![CDATA[<forrest:view type="html">]]>
-      </source>
+        <![CDATA[<forrest:structure type="html">]]>
+</source>
       <source>
-<![CDATA[<forrest:css url="mystyles.css" media="screen" theme="pelt"/>]]>
-      </source>
-      <p>
-        The attributes are:
-      </p>
+        <![CDATA[<forrest:css url="mystyles.css" media="screen" theme="pelt"/>]]>
+</source>
+      <p>The attributes are:</p>
       <ol>
-        <li>the url where the css exist (NOTE: it will be rewritten to "../themes/mystyles.css").</li>
-        <li>the media type, you can set different styles for screen and print. 
-          This is really useful if you want to hide elements such as navigation 
-          in the print output (#nav-section{display:none} for example).</li>
-        <li>the theme, "pelt" is the default theme (another is the "common" theme). Change this if you 
-          are using your own theme.</li>
+        <li>the url where the css exist (NOTE: it will be rewritten to
+        "../themes/mystyles.css").</li>
+        <li>the media type, you can set different styles for screen and print.
+        This is really useful if you want to hide elements such as navigation
+        in the print output (#nav-section{display:none} for example).</li>
+        <li>the theme, "pelt" is the default theme (another is the "common"
+        theme). Change this if you are using your own theme.</li>
       </ol>
-      <p>
-        You can have as many css links as you like, and they'll appear in the
-        head of your document in same order as they are in the .fv file.
-      </p>
-      <fixme author="thorsten">
-        Add more information of recent threads around css in the structurer and
-        information how you add an @import? Use e.g.
-        <a 
-        href="http://marc.theaimsgroup.com/?t=113471292700001&amp;r=1&amp;w=2">http://marc.theaimsgroup.com/?t=113471292700001&amp;r=1&amp;w=2</a>
-      </fixme>
+      <p>You can have as many css links as you like, and they'll appear in the
+      head of your document in same order as they are in the .fv file.</p>
+      <fixme author="thorsten">Add more information of recent threads around
+      css in the structurer and information how you add an @import? Use e.g. 
+      <a href="http://marc.theaimsgroup.com/?t=113471292700001&amp;r=1&amp;w=2">
+      http://marc.theaimsgroup.com/?t=113471292700001&amp;r=1&amp;w=2</a></fixme>
     </section>
   </steps>
   <extension title="Further Reading">
-    <p>
-      Congratulations you are now able to work with the structurer. From here we
-      recommend to read the following How-Tos:
-    </p>
+    <p>Congratulations you are now able to work with the structurer. From here
+    we recommend to read the following How-Tos:</p>
     <ul>
-      <li><a href="site:dispatcher/contracts">Create your own contract 
-          implementation</a></li>
+      <li>
+        <a href="site:dispatcher/contracts">Create your own contract
+        implementation</a>
+      </li>
     </ul>
   </extension>
   <feedback title="Feedback">
-    <p>
-      Please provide feedback about this document via the
-      <a href="ext:mail-lists">mailing lists</a>.
-    </p>
+    <p>Please provide feedback about this document via the 
+    <a href="ext:mail-lists">mailing lists</a>.</p>
   </feedback>
 </howto>

Modified: forrest/branches/dispatcher_rewrite/plugins/org.apache.forrest.plugin.internal.dispatcher/src/documentation/content/xdocs/how/perFolderThemes/index.xml
URL: http://svn.apache.org/viewvc/forrest/branches/dispatcher_rewrite/plugins/org.apache.forrest.plugin.internal.dispatcher/src/documentation/content/xdocs/how/perFolderThemes/index.xml?rev=808385&r1=808384&r2=808385&view=diff
==============================================================================
--- forrest/branches/dispatcher_rewrite/plugins/org.apache.forrest.plugin.internal.dispatcher/src/documentation/content/xdocs/how/perFolderThemes/index.xml (original)
+++ forrest/branches/dispatcher_rewrite/plugins/org.apache.forrest.plugin.internal.dispatcher/src/documentation/content/xdocs/how/perFolderThemes/index.xml Thu Aug 27 12:07:38 2009
@@ -1,4 +1,4 @@
-<?xml version="1.0" encoding="UTF-8"?>
+<?xml version="1.0" encoding="utf-8"?>
 <!--
   Licensed to the Apache Software Foundation (ASF) under one or more
   contributor license agreements.  See the NOTICE file distributed with
@@ -15,25 +15,24 @@
   See the License for the specific language governing permissions and
   limitations under the License.
 -->
-<!DOCTYPE document PUBLIC "-//APACHE//DTD Documentation V2.0//EN" 
-  "http://forrest.apache.org/dtd/document-v20.dtd">
+<!DOCTYPE document PUBLIC "-//APACHE//DTD Documentation V2.0//EN"
+"http://forrest.apache.org/dtd/document-v20.dtd">
 <document>
   <header>
     <title>Per Folder/File Themes</title>
   </header>
   <body>
-    <p>It is possible to customise the theme on a per folder or per file basis.</p>
-    
+    <p>It is possible to customise the theme on a per folder or per file
+    basis.</p>
     <p>To do this simply add a *.fv file in the directory that you wish to
     create an alternative theme for. The name of this file must be the same as
     the theme name you are using for your site. For example, this site uses the
     "pelt" theme and the directory containing this file contains a pelt.fv file
     that customises the theme for this file (and any others that may be in this
-    folder). In order to show this working we have simply stripped the PDF
-    link from the theme.</p>
-    
+    folder). In order to show this working we have simply stripped the PDF link
+    from the theme.</p>
     <p>For demonstration purposes we also provide a 
-    <a href="subFolder/index.html">subfolder</a> within this folder
-    that has another modified theme.</p>
+    <a href="subFolder/index.html">subfolder</a>within this folder that has
+    another modified theme.</p>
   </body>
 </document>

Modified: forrest/branches/dispatcher_rewrite/plugins/org.apache.forrest.plugin.internal.dispatcher/src/documentation/content/xdocs/how/perFolderThemes/subFolder/index.xml
URL: http://svn.apache.org/viewvc/forrest/branches/dispatcher_rewrite/plugins/org.apache.forrest.plugin.internal.dispatcher/src/documentation/content/xdocs/how/perFolderThemes/subFolder/index.xml?rev=808385&r1=808384&r2=808385&view=diff
==============================================================================
--- forrest/branches/dispatcher_rewrite/plugins/org.apache.forrest.plugin.internal.dispatcher/src/documentation/content/xdocs/how/perFolderThemes/subFolder/index.xml (original)
+++ forrest/branches/dispatcher_rewrite/plugins/org.apache.forrest.plugin.internal.dispatcher/src/documentation/content/xdocs/how/perFolderThemes/subFolder/index.xml Thu Aug 27 12:07:38 2009
@@ -1,4 +1,4 @@
-<?xml version="1.0" encoding="UTF-8"?>
+<?xml version="1.0" encoding="utf-8"?>
 <!--
   Licensed to the Apache Software Foundation (ASF) under one or more
   contributor license agreements.  See the NOTICE file distributed with
@@ -15,14 +15,14 @@
   See the License for the specific language governing permissions and
   limitations under the License.
 -->
-<!DOCTYPE document PUBLIC "-//APACHE//DTD Documentation V2.0//EN" 
-  "http://forrest.apache.org/dtd/document-v20.dtd">
+<!DOCTYPE document PUBLIC "-//APACHE//DTD Documentation V2.0//EN"
+"http://forrest.apache.org/dtd/document-v20.dtd">
 <document>
   <header>
     <title>Per Folder/File Themes</title>
   </header>
   <body>
-    <p>This file has another customised theme, in this case we have stripped both
-    the pdf and the fontsize trail.</p>
+    <p>This file has another customised theme, in this case we have stripped
+    both the pdf and the fontsize trail.</p>
   </body>
 </document>

Modified: forrest/branches/dispatcher_rewrite/plugins/org.apache.forrest.plugin.internal.dispatcher/src/documentation/content/xdocs/images/group.svg
URL: http://svn.apache.org/viewvc/forrest/branches/dispatcher_rewrite/plugins/org.apache.forrest.plugin.internal.dispatcher/src/documentation/content/xdocs/images/group.svg?rev=808385&r1=808384&r2=808385&view=diff
==============================================================================
--- forrest/branches/dispatcher_rewrite/plugins/org.apache.forrest.plugin.internal.dispatcher/src/documentation/content/xdocs/images/group.svg (original)
+++ forrest/branches/dispatcher_rewrite/plugins/org.apache.forrest.plugin.internal.dispatcher/src/documentation/content/xdocs/images/group.svg Thu Aug 27 12:07:38 2009
@@ -15,7 +15,6 @@
   See the License for the specific language governing permissions and
   limitations under the License.
 -->
-
 <!--
        SVG Anteater logo
 
@@ -23,7 +22,6 @@
 xml-batik CVS module. Then have a look at the xml-batik/samples files. Use the
 SVG spec (http://www.w3.org/TR/SVG/) as a reference.
 -->
-
 <!-- See Forrest Issue: FOR-229
 <!DOCTYPE svg PUBLIC "-//W3C//DTD SVG 1.0//EN"
 "http://www.w3.org/TR/2001/REC-SVG-20010904/DTD/svg10.dtd"
@@ -34,15 +32,11 @@
 ]>
 -->
 <svg xmlns="http://www.w3.org/2000/svg"
-     xmlns:xlink="http://www.w3.org/1999/xlink"
-     xmlns:xsl="http://www.w3.org/1999/XSL/Transform"
-     xsl:version="1.0"
-     xmlns:for="http://apache.org/forrest"
-     width="220" height="65" >
+xmlns:xlink="http://www.w3.org/1999/xlink"
+xmlns:xsl="http://www.w3.org/1999/XSL/Transform" xsl:version="1.0"
+xmlns:for="http://apache.org/forrest" width="220" height="65">
   <title>Anteater logo</title>
-
   <defs>
-
     <!--
     <radialGradient id="radialGradient">
       <stop style="stop-color:gold" offset="0"/>
@@ -55,27 +49,26 @@
       <stop style="stop-color:crimson" offset="1"/>
     </linearGradient>
     -->
-
     <linearGradient id="gradient" x1="0" y1="0" x2="0" y2="1">
-      <stop style="stop-color:white" offset="0"/>
-      <stop style="stop-color:lightgreen" offset="1"/>
+      <stop style="stop-color:white" offset="0" />
+      <stop style="stop-color:lightgreen" offset="1" />
     </linearGradient>
-    <filter id="shadowFilter" filterUnits="objectBoundingBox" width="1.4" height="1.4">
+    <filter id="shadowFilter" filterUnits="objectBoundingBox" width="1.4"
+    height="1.4">
       <!-- Takes the alpha channel (black outline of the text), blurs it and saves as 'blur' -->
-      <feGaussianBlur in="SourceAlpha" stdDeviation="2 2" result="blur"/>
+      <feGaussianBlur in="SourceAlpha" stdDeviation="2 2" result="blur" />
       <!-- Takes saved 'blur' and offsets it by 4 pixels, saves as 'offsetBlur' -->
-      <feOffset in="blur" dx="4" dy="4" result="offsetBlur"/>
+      <feOffset in="blur" dx="4" dy="4" result="offsetBlur" />
       <!-- Merges SourceGraphic (original image) and 'offsetBlur', putting the
       former 'over' the latter, and using the merged result as the finished
       image -->
-      <feComposite in="SourceGraphic" in2="offsetBlur" operator="over"/>
+      <feComposite in="SourceGraphic" in2="offsetBlur" operator="over" />
     </filter>
-
   </defs>
-
   <g filter="url(#shadowFilter)" fill="url(#gradient)">
-    <text x="40%" y="60%" style="font-size:24pt; font-family:Verdana ; text-anchor: middle">
-    <for:group-name />
+    <text x="40%" y="60%"
+    style="font-size:24pt; font-family:Verdana ; text-anchor: middle">
+      <for:group-name />
     </text>
   </g>
 </svg>

Modified: forrest/branches/dispatcher_rewrite/plugins/org.apache.forrest.plugin.internal.dispatcher/src/documentation/content/xdocs/images/project.svg
URL: http://svn.apache.org/viewvc/forrest/branches/dispatcher_rewrite/plugins/org.apache.forrest.plugin.internal.dispatcher/src/documentation/content/xdocs/images/project.svg?rev=808385&r1=808384&r2=808385&view=diff
==============================================================================
--- forrest/branches/dispatcher_rewrite/plugins/org.apache.forrest.plugin.internal.dispatcher/src/documentation/content/xdocs/images/project.svg (original)
+++ forrest/branches/dispatcher_rewrite/plugins/org.apache.forrest.plugin.internal.dispatcher/src/documentation/content/xdocs/images/project.svg Thu Aug 27 12:07:38 2009
@@ -15,7 +15,6 @@
   See the License for the specific language governing permissions and
   limitations under the License.
 -->
-
 <!--
        SVG Anteater logo
 
@@ -23,7 +22,6 @@
 xml-batik CVS module. Then have a look at the xml-batik/samples files. Use the
 SVG spec (http://www.w3.org/TR/SVG/) as a reference.
 -->
-
 <!-- See Forrest Issue: FOR-229
 <!DOCTYPE svg PUBLIC "-//W3C//DTD SVG 1.0//EN"
 "http://www.w3.org/TR/2001/REC-SVG-20010904/DTD/svg10.dtd"
@@ -34,15 +32,11 @@
 ]>
 -->
 <svg xmlns="http://www.w3.org/2000/svg"
-     xmlns:xlink="http://www.w3.org/1999/xlink"
-     xmlns:xsl="http://www.w3.org/1999/XSL/Transform"
-     xsl:version="1.0"
-     xmlns:for="http://apache.org/forrest"
-     width="420" height="65" >
+xmlns:xlink="http://www.w3.org/1999/xlink"
+xmlns:xsl="http://www.w3.org/1999/XSL/Transform" xsl:version="1.0"
+xmlns:for="http://apache.org/forrest" width="420" height="65">
   <title>Anteater logo</title>
-
   <defs>
-
     <!--
     <radialGradient id="radialGradient">
       <stop style="stop-color:gold" offset="0"/>
@@ -55,28 +49,26 @@
       <stop style="stop-color:crimson" offset="1"/>
     </linearGradient>
     -->
-
     <linearGradient id="gradient" x1="0" y1="0" x2="0" y2="1">
-      <stop style="stop-color:white" offset="0"/>
-      <stop style="stop-color:lightgreen" offset="1"/>
+      <stop style="stop-color:white" offset="0" />
+      <stop style="stop-color:lightgreen" offset="1" />
     </linearGradient>
-
-    <filter id="shadowFilter" filterUnits="objectBoundingBox" width="1.4" height="1.4">
+    <filter id="shadowFilter" filterUnits="objectBoundingBox" width="1.4"
+    height="1.4">
       <!-- Takes the alpha channel (black outline of the text), blurs it and saves as 'blur' -->
-      <feGaussianBlur in="SourceAlpha" stdDeviation="2 2" result="blur"/>
+      <feGaussianBlur in="SourceAlpha" stdDeviation="2 2" result="blur" />
       <!-- Takes saved 'blur' and offsets it by 4 pixels, saves as 'offsetBlur' -->
-      <feOffset in="blur" dx="4" dy="4" result="offsetBlur"/>
+      <feOffset in="blur" dx="4" dy="4" result="offsetBlur" />
       <!-- Merges SourceGraphic (original image) and 'offsetBlur', putting the
       former 'over' the latter, and using the merged result as the finished
       image -->
-      <feComposite in="SourceGraphic" in2="offsetBlur" operator="over"/>
+      <feComposite in="SourceGraphic" in2="offsetBlur" operator="over" />
     </filter>
-
   </defs>
-
   <g filter="url(#shadowFilter)" fill="url(#gradient)">
-    <text x="100%" y="60%" style="font-size:24pt; font-family:Verdana ; text-anchor: end" >
-    <for:project-name />
+    <text x="100%" y="60%"
+    style="font-size:24pt; font-family:Verdana ; text-anchor: end">
+      <for:project-name />
     </text>
   </g>
 </svg>

Modified: forrest/branches/dispatcher_rewrite/plugins/org.apache.forrest.plugin.internal.dispatcher/src/documentation/content/xdocs/index.xml
URL: http://svn.apache.org/viewvc/forrest/branches/dispatcher_rewrite/plugins/org.apache.forrest.plugin.internal.dispatcher/src/documentation/content/xdocs/index.xml?rev=808385&r1=808384&r2=808385&view=diff
==============================================================================
--- forrest/branches/dispatcher_rewrite/plugins/org.apache.forrest.plugin.internal.dispatcher/src/documentation/content/xdocs/index.xml (original)
+++ forrest/branches/dispatcher_rewrite/plugins/org.apache.forrest.plugin.internal.dispatcher/src/documentation/content/xdocs/index.xml Thu Aug 27 12:07:38 2009
@@ -1,4 +1,4 @@
-<?xml version="1.0" encoding="UTF-8"?>
+<?xml version="1.0" encoding="utf-8"?>
 <!--
   Licensed to the Apache Software Foundation (ASF) under one or more
   contributor license agreements.  See the NOTICE file distributed with
@@ -15,203 +15,172 @@
   See the License for the specific language governing permissions and
   limitations under the License.
 -->
-<!DOCTYPE document PUBLIC "-//APACHE//DTD Documentation V2.0//EN" 
-  "http://forrest.apache.org/dtd/document-v20.dtd">
+<!DOCTYPE document PUBLIC "-//APACHE//DTD Documentation V2.0//EN"
+"http://forrest.apache.org/dtd/document-v20.dtd">
 <document>
   <header>
     <title>Dispatcher (Draft - feature under development)</title>
   </header>
   <body>
-    <warning>
-      The "dispatcher" is new functionality which is still in development phase.
-      That is why it is in the "whiteboard" section of the Forrest distribution.
-      We are working at the moment on moving this plugin from the whiteboard
-      into the core plugins. Further all dispatcher related documents will be
-      moved into the plugin as well. See
-      <a 
-      href="http://forrest.apache.org/docs_0_80/status-themes.html">Status
-      of Themes: Skins and Dispatcher</a>.
-    </warning>
+    <warning>The "dispatcher" is new functionality which is still in
+    development phase. That is why it is in the "whiteboard" section of the
+    Forrest distribution. We are working at the moment on moving this plugin
+    from the whiteboard into the core plugins. Further all dispatcher related
+    documents will be moved into the plugin as well. See 
+    <a href="http://forrest.apache.org/docs_0_80/status-themes.html">Status of
+    Themes: Skins and Dispatcher</a>.</warning>
     <section id="introduction">
       <title>Introduction</title>
-      <p>
-        As stated in the Skin documentation the aim of the Forrest skins is to
-        provide many capabilities so that extra skins are not needed. Experience
-        showed that many Forrest users still decided to create a new skin
-        because the default skin did not offer the features that they wanted or
-        they "just" needed extra content in some pages. We introduced
-        skinconf.xml where the user could configure some features of skins but
-        it was up to the skin to support it and did not solve the problem to add
-        page specific extra content. That led us to develop a new concept of
-        creating skins (we called the result "themes") which would be more
-        easily extensible by a user.
-      </p>
+      <p>As stated in the Skin documentation the aim of the Forrest skins is to
+      provide many capabilities so that extra skins are not needed. Experience
+      showed that many Forrest users still decided to create a new skin because
+      the default skin did not offer the features that they wanted or they
+      "just" needed extra content in some pages. We introduced skinconf.xml
+      where the user could configure some features of skins but it was up to
+      the skin to support it and did not solve the problem to add page specific
+      extra content. That led us to develop a new concept of creating skins (we
+      called the result "themes") which would be more easily extensible by a
+      user.</p>
     </section>
     <section id="dispatcher">
       <title>Dispatcher - advanced separation of concerns</title>
-      <p>
-        The aim of the "dispatcher" concept is to provide a flexible framework
-        for creating site and page specific layout in different formats from
-        different content through an advanced seperation of concerns.
-      </p>
-      <p>
-        The dispatcher is a filter that limits the data-model to a minimum by
-        only requesting what the structurer (e.g. common-html.vt.xml) need. This
-        leads to a different URL handling focus - away from document centric. A
-        document can (but does not have to) be behind a certain URL. Like said a
-        structurer can request any given data as input not only a document and
-        the forrest core contracts (like navigation). It may be the main
-        enhancement in comparison to skins that this concept lets you easily
-        extend the default data models provided by forrest.
-      </p>
-      <p>
-        Since the dispatcher has implemented a fallback concept it makes
-        maintenance of custom themes which are based on forrest core ones very
-        easy and less time consuming. The principal is to override or extend
-        only certain parts (contracts) of the core. This is based on the
-        observation that normally only a small percentage of core skin contracts
-        have been changed. At the same time the new plugin system emerged.
-        Plugins are a way of extending Forrest to satisfy site-specific needs.
-        This includes to provide for plugin specific contracts.
-      </p>
+      <p>The aim of the "dispatcher" concept is to provide a flexible framework
+      for creating site and page specific layout in different formats from
+      different content through an advanced seperation of concerns.</p>
+      <p>The dispatcher is a filter that limits the data-model to a minimum by
+      only requesting what the structurer (e.g. common-html.vt.xml) need. This
+      leads to a different URL handling focus - away from document centric. A
+      document can (but does not have to) be behind a certain URL. Like said a
+      structurer can request any given data as input not only a document and
+      the forrest core contracts (like navigation). It may be the main
+      enhancement in comparison to skins that this concept lets you easily
+      extend the default data models provided by forrest.</p>
+      <p>Since the dispatcher has implemented a fallback concept it makes
+      maintenance of custom themes which are based on forrest core ones very
+      easy and less time consuming. The principal is to override or extend only
+      certain parts (contracts) of the core. This is based on the observation
+      that normally only a small percentage of core skin contracts have been
+      changed. At the same time the new plugin system emerged. Plugins are a
+      way of extending Forrest to satisfy site-specific needs. This includes to
+      provide for plugin specific contracts.</p>
       <section id="structurer">
         <title>Structurer - configuration for themes</title>
-        <p>
-          We developed<strong> the structurer</strong> to let the user decide
-          where to place elements in e.g. html pages. We started this work with
-          the <code>skinconf.xml</code> where you could configure certain
-          elements and their positions. These elements were known under certain
-          names. It was up to the skin designer to support this configuration
-          and the elements.
-        </p>
-        <p>
-          The work started with grouping elements (the ones from skinconf). We
-          used css-contracts that we added as @attributes e.g. <code>
-<![CDATA[<div id="content-main"/>]]>
-          </code>. That made it possible to use the same elements in different
-          skins. For the full list refer to the
-          <a href="http://svn.apache.org/repos/asf/forrest/trunk/main/webapp/skins/leather-dev/contracts.initial.txt">
-          initial contract list </a>
-        </p>
-        <p>
-          Around this contracts we developed a configuration Domain Specific
-          Language - called <strong>the structurer</strong>. The
-          <strong>structurer</strong> allows us to define the order in which
-          <strong>forrest:contract</strong>s appear, and also to group them
-          using <strong>forrest:hook</strong>s.
-        </p>
-        <p>
-          <strong>forrest:hook</strong>s are containers that are only used for
-          layout reasons. They <strong>do not</strong> add any content nor
-          functionality to the output. They add <strong>only</strong> layout
-          information to the output. Actually e.g. a <code>
-<![CDATA[<forrest:hook name="layoutId"/>]]>
-          </code> will be transformed to <code>
-<![CDATA[<div id="layoutId"/>]]>
-          </code>
-        </p>
-        <p>
-          <strong>forrest:contract</strong>s are functionality or extra content
-          that a theme can use to display the request. Sometimes a contract
-          delivers <strong>format-specific markup</strong>, other times it
-          delivers a <strong>format-independent string</strong>. We decide
-          different kind of contracts, static one (like described in the
-          contract howto), semi static (which offer configuration parameter in
-          the structurer) and dynamic contracts (which offer semi-static
-          configuration and/or requesting the content).
-        </p>
-        <p>
-          The structurer is also a configuration file for the dispatcher. The
-          new thinking on the dispatcher is that one can include any content
-          from any given business service by dispatching a request against it.
-          In "old fashion" skins and in v1 contracts we assumed a given data
-          model. In the dispatcher there is <strong>no</strong> given data model
-          any more. All data has to be defined in the structurer so that they
-          can be dispatched.
-        </p>
+        <p>We developed 
+        <strong>the structurer</strong>to let the user decide where to place
+        elements in e.g. html pages. We started this work with the 
+        <code>skinconf.xml</code>where you could configure certain elements and
+        their positions. These elements were known under certain names. It was
+        up to the skin designer to support this configuration and the
+        elements.</p>
+        <p>The work started with grouping elements (the ones from skinconf). We
+        used css-contracts that we added as @attributes e.g. 
+        <code>
+          <![CDATA[<div id="content-main"/>]]>
+</code>. That made it possible to use the same elements in different skins. For
+the full list refer to the 
+        <a href="http://svn.apache.org/repos/asf/forrest/trunk/main/webapp/skins/leather-dev/contracts.initial.txt">
+        initial contract list</a></p>
+        <p>Around this contracts we developed a configuration Domain Specific
+        Language - called 
+        <strong>the structurer</strong>. The 
+        <strong>structurer</strong>allows us to define the order in which 
+        <strong>forrest:contract</strong>s appear, and also to group them using
+        
+        <strong>forrest:hook</strong>s.</p>
+        <p>
+        <strong>forrest:hook</strong>s are containers that are only used for
+        layout reasons. They 
+        <strong>do not</strong>add any content nor functionality to the output.
+        They add 
+        <strong>only</strong>layout information to the output. Actually e.g. a 
+        <code>
+          <![CDATA[<forrest:hook name="layoutId"/>]]>
+</code>will be transformed to 
+        <code>
+          <![CDATA[<div id="layoutId"/>]]>
+</code></p>
+        <p>
+        <strong>forrest:contract</strong>s are functionality or extra content
+        that a theme can use to display the request. Sometimes a contract
+        delivers 
+        <strong>format-specific markup</strong>, other times it delivers a 
+        <strong>format-independent string</strong>. We decide different kind of
+        contracts, static one (like described in the contract howto), semi
+        static (which offer configuration parameter in the structurer) and
+        dynamic contracts (which offer semi-static configuration and/or
+        requesting the content).</p>
+        <p>The structurer is also a configuration file for the dispatcher. The
+        new thinking on the dispatcher is that one can include any content from
+        any given business service by dispatching a request against it. In "old
+        fashion" skins and in v1 contracts we assumed a given data model. In
+        the dispatcher there is 
+        <strong>no</strong>given data model any more. All data has to be
+        defined in the structurer so that they can be dispatched.</p>
       </section>
       <section id="contracts">
         <title>Contracts - grouped functionality</title>
-        <p>
-          The result of the leather-dev development was grouped functionality in
-          named containers. We gave those code snippets names (based on their
-          functionality) and called them <strong>contracts</strong>. This naming
-          enabled us to keep the contract separate from the positioning of the
-          code itself. Furthermore, since major parts of the code of skins has
-          never been documented, we started to add for each contract a
-          description and an explanation on how to use this contract. The
-          skinconf.xml gave an excellent source for this documentation effort,
-          since it described most features of the pelt skin.
-        </p>
-        <p>
-          Contracts are standalone, self explaining, configurable pieces of xsl
-          templates created purely for ease of maintenance.
-        </p>
-        <p>
-          Since these contracts are working from the input given in the
-          <a 
-            href="#structurer">structurer</a>, it works on
-          different input sources. One can pass variables into the contracts
-          that can be used to apply presentation logic in the xsl (like sorting
-          order, ...).
-        </p>
+        <p>The result of the leather-dev development was grouped functionality
+        in named containers. We gave those code snippets names (based on their
+        functionality) and called them 
+        <strong>contracts</strong>. This naming enabled us to keep the contract
+        separate from the positioning of the code itself. Furthermore, since
+        major parts of the code of skins has never been documented, we started
+        to add for each contract a description and an explanation on how to use
+        this contract. The skinconf.xml gave an excellent source for this
+        documentation effort, since it described most features of the pelt
+        skin.</p>
+        <p>Contracts are standalone, self explaining, configurable pieces of
+        xsl templates created purely for ease of maintenance.</p>
+        <p>Since these contracts are working from the input given in the 
+        <a href="#structurer">structurer</a>, it works on different input
+        sources. One can pass variables into the contracts that can be used to
+        apply presentation logic in the xsl (like sorting order, ...).</p>
       </section>
     </section>
     <section id="background">
       <title>Background</title>
-      <p>
-        The problem with the forrest skins so far has been that even if "only"
-        the design changed (html-skeleton), we still had to write a completely
-        new skin and implement all functionality. Another problem was that the
-        functionality was not easily extensible by a user. We decided to support
-        a standard regarding naming conventions for css elements. This standard
-        has been developed on the
-        <a 
-        href="http://www.oscom.org/events/oscom4/proposals/skins.html">
-        OSCOM website</a>, where you can find some more background information.
-      </p>
+      <p>The problem with the forrest skins so far has been that even if "only"
+      the design changed (html-skeleton), we still had to write a completely
+      new skin and implement all functionality. Another problem was that the
+      functionality was not easily extensible by a user. We decided to support
+      a standard regarding naming conventions for css elements. This standard
+      has been developed on the 
+      <a href="http://www.oscom.org/events/oscom4/proposals/skins.html">OSCOM
+      website</a>, where you can find some more background information.</p>
       <section id="nc-definition">
         <title>Definition of naming conventions</title>
-        <p>
-          "A naming convention is an attempt to systematize names in a field so
-          they unambiguously convey similar information in a similar manner."
-          <a 
-          href="http://en.wikipedia.org/wiki/Naming_conventions">wikipedia</a>
-        </p>
+        <p>"A naming convention is an attempt to systematize names in a field
+        so they unambiguously convey similar information in a similar manner." 
+        <a href="http://en.wikipedia.org/wiki/Naming_conventions">
+        wikipedia</a></p>
       </section>
       <section id="leather">
         <title>leather-dev</title>
-        <p>
-          That led to the development of the "leather-dev" skin which
-          established a semantic container approach for div elements.
-          Leather-dev evolved from the "pelt" skin and used almost the same
-          functionality (contracts). We had started to encapsulate functional
-          code into templates, but there have been still in 4 xsl files and
-          without any documentation on what they are doing and how to use them.
-          The problems with leather-dev was pointed out in the mail
-          "<a 
-          href="http://marc.theaimsgroup.com/?l=forrest-dev&amp;m=111049344517653" 
-          >status
-          on leather-dev?</a>". The main proplem was to limit users to only one
-          html-skeleton which was way too limiting regarding design. Since we
-          had now grouped functionality in named containers we were ready to
-          start the dispatcher (aka forrest:views).
-        </p>
+        <p>That led to the development of the "leather-dev" skin which
+        established a semantic container approach for div elements. Leather-dev
+        evolved from the "pelt" skin and used almost the same functionality
+        (contracts). We had started to encapsulate functional code into
+        templates, but there have been still in 4 xsl files and without any
+        documentation on what they are doing and how to use them. The problems
+        with leather-dev was pointed out in the mail " 
+        <a href="http://marc.theaimsgroup.com/?l=forrest-dev&amp;m=111049344517653">
+        status on leather-dev?</a>". The main proplem was to limit users to
+        only one html-skeleton which was way too limiting regarding design.
+        Since we had now grouped functionality in named containers we were
+        ready to start the dispatcher (aka forrest:structurer).</p>
       </section>
     </section>
     <section id="info">
       <title>Further information</title>
-      <p>
-        See the various How-to documents about the dispatcher, starting with the
-        <a href="site:dispatcher/quickstart">quickstart</a>. It would also be
-        useful to familiarise yourself with some of the terms used in the
-        dispatcher, the <a href="site:about/glossary">Dispatcher Glossary</a>
-        contains some of the terms used.
-      </p>
-      <p>
-        Apache Forrest 1.0 Specification (Draft, not yet published):
-        <code>site-author/content/xdocs/TR/2005/WD-forrest10.html</code>
-      </p>
+      <p>See the various How-to documents about the dispatcher, starting with
+      the 
+      <a href="site:dispatcher/quickstart">quickstart</a>. It would also be
+      useful to familiarise yourself with some of the terms used in the
+      dispatcher, the 
+      <a href="site:about/glossary">Dispatcher Glossary</a>contains some of the
+      terms used.</p>
+      <p>Apache Forrest 1.0 Specification (Draft, not yet published): 
+      <code>site-author/content/xdocs/TR/2005/WD-forrest10.html</code></p>
     </section>
   </body>
 </document>

Modified: forrest/branches/dispatcher_rewrite/plugins/org.apache.forrest.plugin.internal.dispatcher/src/documentation/content/xdocs/int/index.xml
URL: http://svn.apache.org/viewvc/forrest/branches/dispatcher_rewrite/plugins/org.apache.forrest.plugin.internal.dispatcher/src/documentation/content/xdocs/int/index.xml?rev=808385&r1=808384&r2=808385&view=diff
==============================================================================
--- forrest/branches/dispatcher_rewrite/plugins/org.apache.forrest.plugin.internal.dispatcher/src/documentation/content/xdocs/int/index.xml (original)
+++ forrest/branches/dispatcher_rewrite/plugins/org.apache.forrest.plugin.internal.dispatcher/src/documentation/content/xdocs/int/index.xml Thu Aug 27 12:07:38 2009
@@ -1,4 +1,4 @@
-<?xml version="1.0" encoding="UTF-8"?>
+<?xml version="1.0" encoding="utf-8"?>
 <!--
   Licensed to the Apache Software Foundation (ASF) under one or more
   contributor license agreements.  See the NOTICE file distributed with
@@ -15,8 +15,8 @@
   See the License for the specific language governing permissions and
   limitations under the License.
 -->
-<!DOCTYPE document PUBLIC "-//APACHE//DTD Documentation V2.0//EN" 
-  "http://forrest.apache.org/dtd/document-v20.dtd">
+<!DOCTYPE document PUBLIC "-//APACHE//DTD Documentation V2.0//EN"
+"http://forrest.apache.org/dtd/document-v20.dtd">
 <document>
   <header>
     <title>Living on the edge.</title>
@@ -24,62 +24,55 @@
   <body>
     <section id="introduction">
       <title>Introduction</title>
-      <p>
-        Since the dispatcher is in the whiteboard, we can afford to use the
-        latest features available in forrest. This helps to test these new
-        features and to be prepared for the future when this feature is
-        standard.
-      </p>
+      <p>Since the dispatcher is in the whiteboard, we can afford to use the
+      latest features available in forrest. This helps to test these new
+      features and to be prepared for the future when this feature is
+      standard.</p>
     </section>
     <section id="fpx">
       <title>forrest.properties.xml</title>
-      <p>
-        We needed to prevent having references from the core to a plugin. This
-        can be done with the new properties system. You can override any of the
-        following values via a <code>forrest.properties.xml</code> in your
-        project.
-      </p>
+      <p>We needed to prevent having references from the core to a plugin. This
+      can be done with the new properties system. You can override any of the
+      following values via a 
+      <code>forrest.properties.xml</code>in your project.</p>
       <source>
-<![CDATA[  <property name="dispatcher.theme" value="pelt"/>
+        <![CDATA[  <property name="dispatcher.theme" value="pelt"/>
   <property name="dispatcher.fallback.theme" value="common"/>
   <property name="dispatcher.theme-ext" value=".fv"/>
   <property name="dispatcher.fallback.theme-ext" value=".fv"/>
   <property name="dispatcher.home" value="org.apache.forrest.plugin.internal.dispatcher"/>]]>
-      </source>
+</source>
       <section>
         <title>Using properties in contracts</title>
-        <p> In the contract body you can access all forrest properties by</p>
+        <p>In the contract body you can access all forrest properties by</p>
         <source>
           <![CDATA[<xsl:param name="defaultVariables" select="'test.html'"/>]]>
-        </source>
+</source>
         <p>then extract the variable like:</p>
         <source>
-          <![CDATA[<xsl:variable name="skin-img-dir" select="$defaultVariables/*/*[@name='THE_PROPERTY']/@value"/>]]>
-        </source>
+          <![CDATA[<xsl:variable name="skin-img-dir" select="$defaultVariables/*[@name='THE_PROPERTY']/@value"/>]]>
+</source>
         <p>more information which variables are available can be found at
-          http://localhost:8888/**.props which connects to the
-          org.apache.forrest.plugin.output.inputModule plugin. A custom generator
-          contacts the forrest properties input module to get all aviable key/values and
-          outputs them to xml (dtd like forrest.properties.xml). </p>
+        http://localhost:8888/**.props which connects to the
+        org.apache.forrest.plugin.output.inputModule plugin. A custom generator
+        contacts the forrest properties input module to get all aviable
+        key/values and outputs them to xml (dtd like
+        forrest.properties.xml).</p>
       </section>
     </section>
     <section id="lm">
       <title>locationmap.xml</title>
-      <p>
-        One of the main features of the dispatcher is its fallback mechanism. We
-        are not only looking into one or two places but a sophisticated list of
-        locations. These locations are defined in the locationmap.xml. Like with
-        the forrest.properties.xml you can override any match in there by
-        implementing it in your project locationmap.xml.
-      </p>
+      <p>One of the main features of the dispatcher is its fallback mechanism.
+      We are not only looking into one or two places but a sophisticated list
+      of locations. These locations are defined in the locationmap.xml. Like
+      with the forrest.properties.xml you can override any match in there by
+      implementing it in your project locationmap.xml.</p>
       <section id="handson">
         <title>Hands on the lm</title>
-        <p>
-          The resolving process of the structurer responsible for the URL has
-          implemented a high amount of fallbacks. Let us have a look.
-        </p>
+        <p>The resolving process of the structurer responsible for the URL has
+        implemented a high amount of fallbacks. Let us have a look.</p>
         <source>
-<![CDATA[<match pattern="resolve.structurer.**">
+          <![CDATA[<match pattern="resolve.structurer.**">
   <!-- 
       FIXME - Problem with the pattern
       ********************************
@@ -175,7 +168,7 @@
       />
   </select>
 </match>]]>
-        </source>
+</source>
       </section>
     </section>
   </body>



Mime
View raw message