forrest-svn mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
Subject svn commit: r697250 - /forrest/trunk/whiteboard/plugins/org.apache.forrest.plugin.internal.dispatcher/src/documentation/content/xdocs/how/howto-dispatcher-quickstart.xml
Date Fri, 19 Sep 2008 21:30:06 GMT
Author: rgardler
Date: Fri Sep 19 14:30:06 2008
New Revision: 697250

various doc improvements provided by Pablo Barrera, ISSUE FOR-1106


Modified: forrest/trunk/whiteboard/plugins/org.apache.forrest.plugin.internal.dispatcher/src/documentation/content/xdocs/how/howto-dispatcher-quickstart.xml
--- forrest/trunk/whiteboard/plugins/org.apache.forrest.plugin.internal.dispatcher/src/documentation/content/xdocs/how/howto-dispatcher-quickstart.xml
+++ forrest/trunk/whiteboard/plugins/org.apache.forrest.plugin.internal.dispatcher/src/documentation/content/xdocs/how/howto-dispatcher-quickstart.xml
Fri Sep 19 14:30:06 2008
@@ -106,7 +106,7 @@
         We use <code>${themer.project.dir}</code> for
         PROJECT_HOME/src/documentation/resources/themes (create the new
-        directory folder first). You can change this location by adding
+        directory first). You can change this location by adding
 <![CDATA[<match pattern="themer.project.dir">
           <location src="{properties:resources}/themes" />
         </match> ]]>
@@ -133,6 +133,27 @@
         From here on there is no need to re-start 'forrest run'. Just edit the
         structurer and see the effect.
+      <warning>
+      Right now the dispatcher is heavely cached, so maybe in the current version it should
+      necessary to reboot the system in order to see the changes. To avoid temporally this
+      turn off the cache system changing:
+<forrest:views xmlns:forrest=""
+	xmlns:jx=""
+	jx:cache-key="#{$cocoon/parameters/getRequest}"
+	jx:cache-validity="${}">
+      to
+<forrest:views xmlns:forrest=""
+	xmlns:jx="">
+      in your THEMER_PLUGIN/themes/pelt.fv file.
+      </warning>
     <section id="remove-default-contract">
       <title>Remove a default contract</title>
@@ -211,7 +232,7 @@
           Copy THEMER_PLUGIN/themes/common/html/siteinfo-current-time.ft
           into your project at
-          (create the new directory folders first).
+          (create the new directory first).
           Edit it to suit. Replace all occurrences of "siteinfo-current-time" with
@@ -247,11 +268,39 @@
     <section id="manage">
       <title>Decide how to manage your contracts</title>
-      <fixme author="open">
-        Glean content from Ross' discussion:
-        <a href=";m=113748831226697">Re:
-        Dispatcher quickstart</a>.
-      </fixme>
+      <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. 
+      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 
+      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="">issue tracker</a> so that we 
+      can include it in future releases of Forrest.
+      </p>
   <extension title="Further Reading">

View raw message