forrest-svn mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From thors...@apache.org
Subject svn commit: r427359 - in /forrest/trunk/whiteboard/plugins/org.apache.forrest.plugin.internal.dispatcher: ./ src/documentation/content/xdocs/ src/documentation/content/xdocs/how/
Date Mon, 31 Jul 2006 23:27:37 GMT
Author: thorsten
Date: Mon Jul 31 16:27:37 2006
New Revision: 427359

URL: http://svn.apache.org/viewvc?rev=427359&view=rev
Log:
Refactoring the docu for the dispatcher. Removing it from site-author, adding it to the plugin.

Added:
    forrest/trunk/whiteboard/plugins/org.apache.forrest.plugin.internal.dispatcher/src/documentation/content/xdocs/how/howto-dispatcher-quickstart.xml
      - copied, changed from r427306, forrest/trunk/site-author/content/xdocs/docs_0_80/howto/howto-dispatcher-quickstart.xml
    forrest/trunk/whiteboard/plugins/org.apache.forrest.plugin.internal.dispatcher/src/documentation/content/xdocs/how/howto-structurer-contracts.xml
      - copied, changed from r427039, forrest/trunk/site-author/content/xdocs/docs_0_80/howto/howto-structurer-contracts.xml
    forrest/trunk/whiteboard/plugins/org.apache.forrest.plugin.internal.dispatcher/src/documentation/content/xdocs/how/howto-structurer-dsl.xml
      - copied, changed from r427039, forrest/trunk/site-author/content/xdocs/docs_0_80/howto/howto-structurer-dsl.xml
    forrest/trunk/whiteboard/plugins/org.apache.forrest.plugin.internal.dispatcher/src/documentation/content/xdocs/index.xml
      - copied, changed from r427352, forrest/trunk/whiteboard/plugins/org.apache.forrest.plugin.internal.dispatcher/src/documentation/content/xdocs/dispatcher.xml
Removed:
    forrest/trunk/whiteboard/plugins/org.apache.forrest.plugin.internal.dispatcher/src/documentation/content/xdocs/dispatcher.xml
Modified:
    forrest/trunk/whiteboard/plugins/org.apache.forrest.plugin.internal.dispatcher/src/documentation/content/xdocs/site.xml
    forrest/trunk/whiteboard/plugins/org.apache.forrest.plugin.internal.dispatcher/status.xml

Copied: forrest/trunk/whiteboard/plugins/org.apache.forrest.plugin.internal.dispatcher/src/documentation/content/xdocs/how/howto-dispatcher-quickstart.xml
(from r427306, forrest/trunk/site-author/content/xdocs/docs_0_80/howto/howto-dispatcher-quickstart.xml)
URL: http://svn.apache.org/viewvc/forrest/trunk/whiteboard/plugins/org.apache.forrest.plugin.internal.dispatcher/src/documentation/content/xdocs/how/howto-dispatcher-quickstart.xml?p2=forrest/trunk/whiteboard/plugins/org.apache.forrest.plugin.internal.dispatcher/src/documentation/content/xdocs/how/howto-dispatcher-quickstart.xml&p1=forrest/trunk/site-author/content/xdocs/docs_0_80/howto/howto-dispatcher-quickstart.xml&r1=427306&r2=427359&rev=427359&view=diff
==============================================================================
--- forrest/trunk/site-author/content/xdocs/docs_0_80/howto/howto-dispatcher-quickstart.xml
(original)
+++ forrest/trunk/whiteboard/plugins/org.apache.forrest.plugin.internal.dispatcher/src/documentation/content/xdocs/how/howto-dispatcher-quickstart.xml
Mon Jul 31 16:27:37 2006
@@ -30,7 +30,7 @@
       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="site:v0.80//status-themes">Status of Themes: Skins and Dispatcher</a>.
+      See <a href="ext:forrest/status-themes">Status of Themes: Skins and Dispatcher</a>.
     </warning>
   </audience>
   
@@ -62,7 +62,7 @@
     <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="site:forrestbar">Forrestbar</a> helps a lot with developing,
+      <a href="ext:forrestbar">Forrestbar</a> helps a lot with developing,
       but is not necessary.
     </note>
 
@@ -234,15 +234,15 @@
       we recommend to read the following How-Tos: </p>
     <ul>
       <li>
-        <a href="site:v0.80//dispatcher/structurer">How to use the structurer</a>
+        <a href="site:dispatcher/structurer">How to use the structurer</a>
       </li>
       <li>
-        <a href="site:v0.80//dispatcher/structurer">Create your own contract 
+        <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="site: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>

Copied: forrest/trunk/whiteboard/plugins/org.apache.forrest.plugin.internal.dispatcher/src/documentation/content/xdocs/how/howto-structurer-contracts.xml
(from r427039, forrest/trunk/site-author/content/xdocs/docs_0_80/howto/howto-structurer-contracts.xml)
URL: http://svn.apache.org/viewvc/forrest/trunk/whiteboard/plugins/org.apache.forrest.plugin.internal.dispatcher/src/documentation/content/xdocs/how/howto-structurer-contracts.xml?p2=forrest/trunk/whiteboard/plugins/org.apache.forrest.plugin.internal.dispatcher/src/documentation/content/xdocs/how/howto-structurer-contracts.xml&p1=forrest/trunk/site-author/content/xdocs/docs_0_80/howto/howto-structurer-contracts.xml&r1=427039&r2=427359&rev=427359&view=diff
==============================================================================
--- forrest/trunk/site-author/content/xdocs/docs_0_80/howto/howto-structurer-contracts.xml
(original)
+++ forrest/trunk/whiteboard/plugins/org.apache.forrest.plugin.internal.dispatcher/src/documentation/content/xdocs/how/howto-structurer-contracts.xml
Mon Jul 31 16:27:37 2006
@@ -30,7 +30,7 @@
 <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="site:v0.80//status-themes">Status of Themes: Skins and Dispatcher</a>.
+      See <a href="ext:forrest/status-themes">Status of Themes: Skins and Dispatcher</a>.
 </warning>
     <p>
       Devs and skin developer that wants to get started with forrest:contract development.

@@ -48,12 +48,6 @@
 
   <prerequisites title="Prerequisites">
     <ul>
-      <li>
-        You have a ready-to-go new seed-v2 (v2) based on the dispatcher like described in
<a href="site:howto/dispatcher/install">Install</a>.
-      </li>
-      <li>
-        Reading that how-to is as well a good idea to understand the used directory structure
in this how-to.
-      </li>
       <li>Installing a mozilla browser and the forrestbar helps a lot in developing.</li>
     </ul>
   </prerequisites>
@@ -275,7 +269,7 @@
       <p>
         To see whether the new contract works we need to add it to our structurer.
         The contract usage contains the contract-tag <code><![CDATA[<forrest:contract
name="siteinfo-last-published-howto"/>]]></code>
-        Please see <a href="site:v0.80//dispatcher/structurer">Getting started with
the "structurer"</a> for more details.
+        Please see <a href="site:dispatcher/structurer">Getting started with the "structurer"</a>
for more details.
       </p>
        <note>
         Next to write are parameter-contracts with advanced features of the dispatcher. 
@@ -288,13 +282,13 @@
       From here we recommend to read the following How-To's (if not already done):
     </p>
     <ul>
-      <li><a href="site:v0.80//dispatcher/structurer">Getting started with the
"structurer"</a> </li>
+      <li><a href="site:dispatcher/structurer">Getting started with the "structurer"</a>
</li>
     </ul>
   </extension>
   <feedback title="Feedback">
     <p>
       Please provide feedback about this document via the
-      <a href="site:mail-lists">mailing lists</a>.
+      <a href="ext:mail-lists">mailing lists</a>.
     </p>
   </feedback>
 </howto>

Copied: forrest/trunk/whiteboard/plugins/org.apache.forrest.plugin.internal.dispatcher/src/documentation/content/xdocs/how/howto-structurer-dsl.xml
(from r427039, forrest/trunk/site-author/content/xdocs/docs_0_80/howto/howto-structurer-dsl.xml)
URL: http://svn.apache.org/viewvc/forrest/trunk/whiteboard/plugins/org.apache.forrest.plugin.internal.dispatcher/src/documentation/content/xdocs/how/howto-structurer-dsl.xml?p2=forrest/trunk/whiteboard/plugins/org.apache.forrest.plugin.internal.dispatcher/src/documentation/content/xdocs/how/howto-structurer-dsl.xml&p1=forrest/trunk/site-author/content/xdocs/docs_0_80/howto/howto-structurer-dsl.xml&r1=427039&r2=427359&rev=427359&view=diff
==============================================================================
--- forrest/trunk/site-author/content/xdocs/docs_0_80/howto/howto-structurer-dsl.xml (original)
+++ forrest/trunk/whiteboard/plugins/org.apache.forrest.plugin.internal.dispatcher/src/documentation/content/xdocs/how/howto-structurer-dsl.xml
Mon Jul 31 16:27:37 2006
@@ -29,7 +29,7 @@
       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="site:v0.80//status-themes">Status of Themes: Skins and Dispatcher</a>.
+      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>
@@ -44,10 +44,6 @@
 
   <prerequisites title="Prerequisites">
     <ul>
-      <li> You have a ready-to-go new dispatcher based project like 
-        described in <a href="site:howto/dispatcher/install">Install</a>. </li>
-      <li> Reading that how-to is as well a good idea to understand the used 
-        directory structure in this how-to. </li>
       <li>Installing a mozilla browser and the forrestbar helps a lot in 
         developing.</li>
     </ul>
@@ -119,7 +115,7 @@
         alias-xsl stylesheet. That is heavy on performance and we will change 
         this ASAP. Mind the warning at the start of the howto. </warning>
       <p> In this section we will create a new structurer. We will override the 
-        default structurer of the themer-plugin for the index page of the <a href="site:howto/dispatcher/install">v2</a>.
For that we will create a 
+        default structurer of the themer-plugin for the index page of the new seed. For that
we will create a 
         file called <code>index.fv</code> and save it in our xdocs directory.

         This will make <strong>only</strong> the index.html page look different

         from the rest of the project. </p>
@@ -441,12 +437,12 @@
       we recommend to read the following How-Tos: </p>
     <ul>
       <li>
-        <a href="site:howto/dispatcher/contracts">Create your own contract 
+        <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="site: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>

Copied: forrest/trunk/whiteboard/plugins/org.apache.forrest.plugin.internal.dispatcher/src/documentation/content/xdocs/index.xml
(from r427352, forrest/trunk/whiteboard/plugins/org.apache.forrest.plugin.internal.dispatcher/src/documentation/content/xdocs/dispatcher.xml)
URL: http://svn.apache.org/viewvc/forrest/trunk/whiteboard/plugins/org.apache.forrest.plugin.internal.dispatcher/src/documentation/content/xdocs/index.xml?p2=forrest/trunk/whiteboard/plugins/org.apache.forrest.plugin.internal.dispatcher/src/documentation/content/xdocs/index.xml&p1=forrest/trunk/whiteboard/plugins/org.apache.forrest.plugin.internal.dispatcher/src/documentation/content/xdocs/dispatcher.xml&r1=427352&r2=427359&rev=427359&view=diff
==============================================================================
--- forrest/trunk/whiteboard/plugins/org.apache.forrest.plugin.internal.dispatcher/src/documentation/content/xdocs/dispatcher.xml
(original)
+++ forrest/trunk/whiteboard/plugins/org.apache.forrest.plugin.internal.dispatcher/src/documentation/content/xdocs/index.xml
Mon Jul 31 16:27:37 2006
@@ -117,7 +117,7 @@
     <section id="info">
       <title>Further information</title>
       <p> See the various How-to documents about the dispatcher, starting with 
-         the <a href="site:v0.80//dispatcher/quickstart">quickstart</a>
+         the <a href="site:dispatcher/quickstart">quickstart</a>
       </p>
       <p> Apache Forrest 1.0 Specification (Draft, not yet published): 
         <code>site-author/content/xdocs/TR/2005/WD-forrest10.html</code> </p>

Modified: forrest/trunk/whiteboard/plugins/org.apache.forrest.plugin.internal.dispatcher/src/documentation/content/xdocs/site.xml
URL: http://svn.apache.org/viewvc/forrest/trunk/whiteboard/plugins/org.apache.forrest.plugin.internal.dispatcher/src/documentation/content/xdocs/site.xml?rev=427359&r1=427358&r2=427359&view=diff
==============================================================================
--- forrest/trunk/whiteboard/plugins/org.apache.forrest.plugin.internal.dispatcher/src/documentation/content/xdocs/site.xml
(original)
+++ forrest/trunk/whiteboard/plugins/org.apache.forrest.plugin.internal.dispatcher/src/documentation/content/xdocs/site.xml
Mon Jul 31 16:27:37 2006
@@ -33,12 +33,17 @@
 <site label="org.apache.forrest.plugin.internal.views" href="" xmlns="http://apache.org/forrest/linkmap/1.0"
tab="">
 
   <about label="About">
-    <index label="Index" href="index.html" description="Welcome to org.apache.forrest.plugin.internal.views"/>
-    <dispatcher-concept label="Dispatcher development" href="dispatcher.html"/>
-  	<howItWorks label="howItWorks" href="how/howItWork.html" description="howItWorks"/>
+    <dispatcher-concept label="Dispatcher development" href="index.html"/>
+    <dispatcher label="How to">
+      <quickstart label="Quickstart" href="how/howto-dispatcher-quickstart.html"/>
+      <structurer label="Structurer" href="how/howto-structurer-dsl.html"/>
+      <contracts label="Contracts" href="how/howto-structurer-contracts.html"/>
+    </dispatcher>
+    <glossary label="(FIXME: add content) Glossary" href="dispatcher-glossary.html" description="Dispactcher
related terms and meanings" />
+    <index label="(FIXME: old) Index" href="index.old.html" description="(FIXME: old)
index"/>
+  	<howItWorks label="(FIXME: old) howItWorks" href="how/howItWork.html" description="(FIXME:
old) howItWorks"/>
     <changes label="Changes" href="changes.html" description="History of Changes" />
     <todo label="Todo" href="todo.html" description="Todo List" />
-  <glossary label="Glossary" href="dispatcher-glossary.html" description="Dispactcher
related terms and meanings" />
   </about>
 
 
@@ -56,6 +61,9 @@
       <validation href="docs/validation.html"/>
       <webapp href="docs/your-project.html#webapp"/>
       <dtd-docs href="docs/dtd-docs.html"/>
+      <mail-lists href="mail-lists.html"/>
+      <status-themes href="docs_0_80/status-themes.html"/>
+      <forrestbar href="tools/forrestbar.html"/>
     </forrest>
   	<sun href="http://java.sun.com/">
       <j2ee href="j2ee/">

Modified: forrest/trunk/whiteboard/plugins/org.apache.forrest.plugin.internal.dispatcher/status.xml
URL: http://svn.apache.org/viewvc/forrest/trunk/whiteboard/plugins/org.apache.forrest.plugin.internal.dispatcher/status.xml?rev=427359&r1=427358&r2=427359&view=diff
==============================================================================
--- forrest/trunk/whiteboard/plugins/org.apache.forrest.plugin.internal.dispatcher/status.xml
(original)
+++ forrest/trunk/whiteboard/plugins/org.apache.forrest.plugin.internal.dispatcher/status.xml
Mon Jul 31 16:27:37 2006
@@ -37,6 +37,9 @@
   <changes>
     <!-- Add new releases here -->
     <release version="0.1" date="unreleased">
+      <action dev="TS" type="add" context="docs">
+        Adding the "how tos" from the site-author to this plugin.
+      </action>
       <!-- 07/2006 -->
       <action dev="TS" type="add" context="code"> Extending the dispatcher 
           with an internal format. This internal format is our xdoc or 



Mime
View raw message