Return-Path: 
 <svn-return-2668-apmail-forrest-svn-archive=forrest.apache.org@forrest.apache.org>
Delivered-To: apmail-forrest-svn-archive@www.apache.org
Received: (qmail 89307 invoked from network); 11 Jun 2005 19:01:04 -0000
Received: from hermes.apache.org (HELO mail.apache.org) (209.237.227.199)
  by minotaur.apache.org with SMTP; 11 Jun 2005 19:01:04 -0000
Received: (qmail 75260 invoked by uid 500); 11 Jun 2005 19:01:04 -0000
Delivered-To: apmail-forrest-svn-archive@forrest.apache.org
Received: (qmail 75210 invoked by uid 500); 11 Jun 2005 19:01:03 -0000
Mailing-List: contact svn-help@forrest.apache.org; run by ezmlm
Precedence: bulk
list-help: <mailto:svn-help@forrest.apache.org>
list-unsubscribe: <mailto:svn-unsubscribe@forrest.apache.org>
List-Post: <mailto:svn@forrest.apache.org>
Reply-To: "Forrest Developers List" <dev@forrest.apache.org>
List-Id: <svn.forrest.apache.org>
Delivered-To: mailing list svn@forrest.apache.org
Received: (qmail 75195 invoked by uid 99); 11 Jun 2005 19:01:03 -0000
X-ASF-Spam-Status: No, hits=-9.3 required=10.0
	tests=ALL_TRUSTED,NO_REAL_NAME,WEIRD_PORT
X-Spam-Check-By: apache.org
Received: from minotaur.apache.org (HELO minotaur.apache.org)
 (209.237.227.194)
  by apache.org (qpsmtpd/0.28) with SMTP; Sat, 11 Jun 2005 12:01:02 -0700
Received: (qmail 89295 invoked by uid 65534); 11 Jun 2005 19:01:01 -0000
Message-ID: <20050611190101.89294.qmail@minotaur.apache.org>
Content-Type: text/plain; charset="utf-8"
MIME-Version: 1.0
Content-Transfer-Encoding: quoted-printable
Subject: svn commit: r190163 -
 /forrest/trunk/site-author/content/xdocs/docs/howto/howto-view-contracts.xml
 /forrest/trunk/site-author/content/xdocs/docs/howto/howto-view-dsl.xml
Date: Sat, 11 Jun 2005 19:01:00 -0000
To: svn@forrest.apache.org
From: thorsten@apache.org
X-Mailer: svnmailer-1.0.0-dev
X-Virus-Checked: Checked
X-Spam-Rating: minotaur.apache.org 1.6.2 0/1000/N

Author: thorsten
Date: Sat Jun 11 12:01:00 2005
New Revision: 190163

URL: http://svn.apache.org/viewcvs?rev=3D190163&view=3Drev
Log:
Further written the dsl howto till section css which will be next.

Modified:
    forrest/trunk/site-author/content/xdocs/docs/howto/howto-view-contracts=
.xml
    forrest/trunk/site-author/content/xdocs/docs/howto/howto-view-dsl.xml

Modified: forrest/trunk/site-author/content/xdocs/docs/howto/howto-view-con=
tracts.xml
URL: http://svn.apache.org/viewcvs/forrest/trunk/site-author/content/xdocs/=
docs/howto/howto-view-contracts.xml?rev=3D190163&r1=3D190162&r2=3D190163&vi=
ew=3Ddiff
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=
=3D=3D=3D
--- forrest/trunk/site-author/content/xdocs/docs/howto/howto-view-contracts=
.xml (original)
+++ forrest/trunk/site-author/content/xdocs/docs/howto/howto-view-contracts=
.xml Sat Jun 11 12:01:00 2005
@@ -87,16 +87,16 @@
     <section id=3D"enhanceMaintainment">
       <title>Enhance the maintainment</title>
       <p>Now we can enhance the maintainment for the future and we started=
 to
-give this code snippets contracts names. This naming enables us to keep
+give this code snippets contracts names (based on their functionality). Th=
is naming enables us to keep
 the contract separate from the position code itself. In xsl you would
 simply do:
       </p>
       <ol>
-        <li>replace the script by <![CDATA[<xsl:call-template name=3D"last=
-published"/>]]></li>
+        <li>replace the script by <![CDATA[<xsl:call-template name=3D"site=
info-last-published"/>]]></li>
         <li>and add:</li>
       </ol>
      =20
-      <source><![CDATA[<xsl:template name=3D"last-published">
+      <source><![CDATA[<xsl:template name=3D"siteinfo-last-published">
  <script type=3D"text/javascript">
   document.write("<i18n:text >Last Published:</i18n:text>&#160;" + documen=
t=2ElastModified);
  </script>
@@ -104,7 +104,7 @@
       </source>
       <p>
         This allows us in a next maintainment just change the code of
-        <![CDATA[<xsl:template name=3D"last-published"/>]]> and apply it i=
n any position where
+        <![CDATA[<xsl:template name=3D"siteinfo-last-published"/>]]> and a=
pply it in any position where
         it is placed. =20
       </p>
       <note>
@@ -116,7 +116,8 @@
       <p>
         To start a new forrest:contract you can copy the "blank.ft" from
         <code>org.apache.forrest.plugin.output.viewHelper.xhtml/resources/=
templates</code>.=20
-        It is a simple xml file with the following code which you can use =
to base new contracts on:
+        It is a simple xml file with the following code which you can use =
to base new contracts=20
+        on (note to close the CDATA element before the <code><![CDATA[</us=
age>]]></code>!):
       </p>
       <source>
 <![CDATA[<forrest:contract=20
@@ -128,9 +129,9 @@
     When using the blank template as c'n p master just search and replace =
'blank' by the {contract-name}!-->
  =20
   <description>
-    {contract-name} contract. This functions will output {contract-funtion=
}=2E
+    {contract-name} will output {contract-funtion}. This is just a blank c=
ontract, it will output *nothing*.
   </description>
- =20
+  <usage><![CDATA[<forrest:contract name=3D"doNotUseJustDummy"/>]] ></usag=
e>
   <forrest:template xmlns:forrest=3D"http://apache.org/forrest/templates/1=
.0"
     format=3D"xhtml" name=3D"blank" inputFormat=3D"xsl" body=3D"false" hea=
d=3D"false">
     <xsl:stylesheet version=3D"1.1"=20
@@ -153,6 +154,10 @@
         Here we have to explain what this contract is doing.
       </p>
       <p>
+        The <code><![CDATA[<usage/>]]></code> tag is self explaining.=20
+        Here we have to explain how the designer can use the contract in h=
is view.
+      </p>
+      <p>
         <code><![CDATA[<forrest:template name=3D"blank" body=3D"false" hea=
d=3D"false">]]> </code>=20
         That leads to the template attribute @body=3D"true" and
 				@head=3D"false". In xhtml a contract can add content to the <![CDATA[<=
body/>]]> or/and
@@ -189,13 +194,13 @@
         Now the maintainment optimized code (xpath=3D"/html/body/*") was:
       </p>
       <source>
-<![CDATA[<xsl:template name=3D"last-published">
+<![CDATA[<xsl:template name=3D"siteinfo-last-published">
  <script type=3D"text/javascript">
   document.write("<i18n:text >Last Published:</i18n:text>&#160;" + documen=
t=2ElastModified);
  </script>
 </xsl:template>]]></source>
       <ul>
-        <li>Search and replace "blank" with "last-publish-howTo"</li>
+        <li>Search and replace "blank" with "siteinfo-last-publish-howTo"<=
/li>
         <li>Add description of the contract</li>
         <li>Set @body=3D"true"</li>
       </ul>
@@ -235,12 +240,11 @@
   </steps>
   <extension title=3D"Further Reading">
     <p>
-      Congratulations you are now able to work with views.=20
+      Congratulations you are now able to work with view contracts.=20
       From here we recommend to read the following How-To's:
     </p>
     <ul>
       <li><a href=3D"site:howto/view/DSL">Getting started with forrest:vie=
w DSL</a> </li>
-      <li><a href=3D"site:howto/view/contracts">Create your own contract i=
mplementation</a> </li>
     </ul>
   </extension>
   <feedback title=3D"Feedback">

Modified: forrest/trunk/site-author/content/xdocs/docs/howto/howto-view-dsl=
.xml
URL: http://svn.apache.org/viewcvs/forrest/trunk/site-author/content/xdocs/=
docs/howto/howto-view-dsl.xml?rev=3D190163&r1=3D190162&r2=3D190163&view=3Dd=
iff
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=
=3D=3D=3D
--- forrest/trunk/site-author/content/xdocs/docs/howto/howto-view-dsl.xml (=
original)
+++ forrest/trunk/site-author/content/xdocs/docs/howto/howto-view-dsl.xml S=
at Jun 11 12:01:00 2005
@@ -77,7 +77,8 @@
     <p>
      forrest:hook's are container that are only used for layout reasons. T=
hey <strong>do not</strong> add=20
      any content nor functionality to the output. They add <strong>only</s=
trong> layout information to=20
-     the output.
+     the output. Actually a <code><![CDATA[<forrest:hook name=3D"layoutId"=
/>]]></code> will be transformed
+     to <code><![CDATA[<div id=3D"layoutId"/>]]> </code>
     </p>
     <p>
      forrest:contract's are functionality or extra content that a skin can=
 use to display the requested
@@ -99,62 +100,141 @@
         Now lets start to skin our site. :)
       </p>
     </section>
-<!--
-    <section id=3D"usingContracts">
-    <title>Using contracts</title>
+
+    <section id=3D"availableContracts">
+    <title>Available contracts</title>
     <p>=20
      To start your skin you need to know which contracts you can use.=20
+     For this we will install another plugin <code>org.apache.forrest.plug=
in.input.viewHelper.xhtml.ls</code>.
+     The setup is:
     </p>
     <source>
-cd ~/src/newSeed
-forrest seed
-mkdir src/documentation/conf
+cd {forrest-trunk}
+svn up
+cd whiteboard/plugins/org.apache.forrest.plugin.input.viewHelper.xhtml.ls/
+ant local-deploy
 </source>
-</section>
--->
-<!--
-<section id=3D"forrestProperties">
-<title>Modifying forrest.properties</title>
-<p>
-Now we have to tell forrest that we are planing to use the view plugins. W=
e will do that
-by editing to the forrest.properties to add the plugins:
-</p>
-<source>
-project.required.plugins=3Dorg.apache.forrest.plugin.output.viewHelper.xht=
ml,org.apache.forrest.plugin.internal.view
-</source>
-<p>
-     Now we have to change the project skin to leather-dev. The reason is =
that the plugins are still
-not independend form the "old fashion skins". =20
-</p>
-<note>We exchanging only
-     site2xhtml.xsl of leather-dev skin by the plugins and some contracts =
are based
-     on e.g. document2html.xsl output of leather-dev.</note>
-<source>
-project.skin=3Dleather-dev
-</source>
-</section>
-<section id=3D"testing">
-<title>Test your new view based project</title>
-<p>=20
-Now you have finished the preparation and the setup to finally try
-</p>
-<source>
-forrest run
-</source>
-<p>then point to <a href=3D"http://localhost:8888/">http://localhost:8888/=
</a> and you should see the default
-view based skin.</p>
-<note>When developing styles with views 'forrest run' is the quickest
-way. You will see you do not have to build your project to see the
-changes on your pages when working with *.fv. </note>
-</section>-->
-  </steps><!--
+			<p>
+        The newly installed plugin will show the available contracts as ht=
ml page.
+        First we have to tell forrest that we are planing to use the new p=
lugin. We will do that
+        by editing the forrest.properties of the <a href=3D"site:howto/vie=
w/install">newSeed</a>=20
+        to <strong>add</strong> the plugin:
+      </p>
+      <source>
+project.required.plugins=3Dorg.apache.forrest.plugin.input.viewHelper.xhtm=
l=2Els
+      </source>
+      <p>
+        Now point your browser to <code>http://localhost:8888/ls.contracts=
.html</code>.=20
+        On this page you will find all contracts that you can use in your =
project.
+      </p>
+    </section>
+    <section id=3D"firstView">
+			<title>Creating your first view</title>
+			<p>
+				In this section we will create a new view. We will override the defaul=
t view of the view-plugin
+        for the index page of the <a href=3D"site:howto/view/install">newS=
eed</a>.
+        For that we will create a file called <code>index.ft</code> and sa=
ve it in our xdocs directory.=20
+        This will make <strong>only</strong> the index.html page look diff=
erent from the rest of the project.
+			</p>
+      <p>
+        Let use the blank view from the earlier step and add the content-m=
ain contract. In=20
+        ls.contracts.html we find the information how to use the contract =
in our view. Our=20
+        <code>index.fv</code> should look like:
+      </p>
+      <source><![CDATA[<forrest:views xmlns:forrest=3D"http://apache.org/f=
orrest/templates/1.0" >
+  <forrest:view type=3D"xhtml">   =20
+    <forrest:contract name=3D"content-main"/>
+  </forrest:view> =20
+</forrest:views>]]>
+      </source>
+      <p>
+        Let's try our new view by pointing to <code>http://localhost:8888/=
index.html</code>.=20
+        We will see only the main content. :) Now let's add the section na=
vigation to our view.
+        The contract usage in the view can be looked up in ls.contracts.ht=
ml. Our view now looks like:
+      </p>
+      <source><![CDATA[<forrest:views xmlns:forrest=3D"http://apache.org/f=
orrest/templates/1.0" >
+  <forrest:view type=3D"xhtml">   =20
+    <forrest:contract name=3D"content-main"/>
+    <forrest:contract name=3D"nav-section"/>
+  </forrest:view> =20
+</forrest:views>]]>
+      </source>
+      <p>
+        We find now the main content and the section navigation after each=
 other and in the order=20
+        we placed them in the view, but we want it next to each other=20
+        (left: nav-section; right: content-main).
+      </p>
+    </section>
+    <section id=3D"hookView">
+      <title>Hooks in views</title>
+      <p>
+        We will use now the first time a <code><![CDATA[<forrest:hook name=
=3D"layoutId"/>]]></code>.
+        Hooks are the styling side of views. We can imitate arbitrary html=
 skeleton=20
+        with their help. Before we explain how to use your own css in view=
s we will use the default css.
+        In the default.css we can find=20
+      </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=3D"leftbar"/>]]></code>=20
+        and add contracts into that container. If we want to put a contrac=
t into the left side position
+        of the site we need to place the contract into that hook. Like:
+      </p> =20
+      <source><![CDATA[<forrest:views xmlns:forrest=3D"http://apache.org/f=
orrest/templates/1.0" >
+  <forrest:view type=3D"xhtml">
+    <forrest:hook name=3D"leftbar">
+      <forrest:contract name=3D"nav-section"/>
+    </forrest:hook>
+    <forrest:contract name=3D"content-main"/>  =20
+  </forrest:view> =20
+</forrest:views>]]>
+      </source>
+    </section>
+    <section id=3D"cssView">
+      <title>CSS in views</title>
+      <fixme author=3D"thorsten">This section is next to write</fixme>
+      <!--<p>
+        We will use now the first time a <code><![CDATA[<forrest:hook name=
=3D"layoutId"/>]]></code>.
+        Hooks in views are the styling side of views. We can imitate arbit=
rary html skeleton=20
+        with their help. Before we explain how to use your own css in view=
s we will use the default css.
+        In the default.css we can find=20
+      </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=3D"leftbar"/>]]></code>=20
+        to add contracts into that container. If we want to put a contract=
 into the side position
+        of the site we need to place the contract into that hook. Like:
+      </p> =20
+      <source><![CDATA[<forrest:views xmlns:forrest=3D"http://apache.org/f=
orrest/templates/1.0" >
+  <forrest:view type=3D"xhtml">
+    <forrest:hook name=3D"leftbar">
+      <forrest:contract name=3D"nav-section"/>
+    </forrest:hook>
+    <forrest:contract name=3D"content-main"/>  =20
+  </forrest:view> =20
+</forrest:views>]]>
+      </source>-->
+    </section>
+  </steps>
   <extension title=3D"Further Reading">
     <p>
-      Congratulations you are now able to work with views.=20
+      Congratulations you are now able to work with the view DSL.=20
       From here we recommend to read the following How-To's:
     </p>
     <ul>
-      <li><a href=3D"site:howto/view/DSL">Getting started with forrest:vie=
w DSL</a> </li>
       <li><a href=3D"site:howto/view/contracts">Create your own contract i=
mplementation</a> </li>
     </ul>
   </extension>
@@ -163,5 +243,5 @@
       Please provide feedback about this document via the
       <a href=3D"site:mail-lists">mailing lists</a>.
     </p>
-  </feedback>-->
+  </feedback>
 </howto>