forrest-svn mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From thors...@apache.org
Subject svn commit: r185097 - in /forrest/trunk/site-author/content/xdocs: docs/howto/howto-view-contracts.xml docs/howto/howto-view-dsl.xml docs/howto/howto-view-install.xml site.xml
Date Mon, 06 Jun 2005 23:37:58 GMT
Author: thorsten
Date: Mon Jun  6 16:37:55 2005
New Revision: 185097

URL: http://svn.apache.org/viewcvs?rev=185097&view=rev
Log:
I added three how-to's about views but I only finished one and when I started the second I
had to look into another thing. Anyway I will work on them ASAP and finish them

Added:
    forrest/trunk/site-author/content/xdocs/docs/howto/howto-view-contracts.xml   (with props)
    forrest/trunk/site-author/content/xdocs/docs/howto/howto-view-dsl.xml   (with props)
    forrest/trunk/site-author/content/xdocs/docs/howto/howto-view-install.xml   (with props)
Modified:
    forrest/trunk/site-author/content/xdocs/site.xml

Added: forrest/trunk/site-author/content/xdocs/docs/howto/howto-view-contracts.xml
URL: http://svn.apache.org/viewcvs/forrest/trunk/site-author/content/xdocs/docs/howto/howto-view-contracts.xml?rev=185097&view=auto
==============================================================================
--- forrest/trunk/site-author/content/xdocs/docs/howto/howto-view-contracts.xml (added)
+++ forrest/trunk/site-author/content/xdocs/docs/howto/howto-view-contracts.xml Mon Jun  6
16:37:55 2005
@@ -0,0 +1,133 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+  Copyright 2002-2005 The Apache Software Foundation or its licensors,
+  as applicable.
+
+  Licensed under the Apache License, Version 2.0 (the "License");
+  you may not use this file except in compliance with the License.
+  You may obtain a copy of the License at
+
+      http://www.apache.org/licenses/LICENSE-2.0
+
+  Unless required by applicable law or agreed to in writing, software
+  distributed under the License is distributed on an "AS IS" BASIS,
+  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+  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">
+
+<howto>
+ <header>
+  <title>How to write a view:contract?</title>
+  <abstract>
+    This How-To has to be written soon.
+  </abstract>
+  <last-modified-content-date date="2005-06-06"/>
+ </header>
+
+  <!--<audience title="Intended Audience">
+    <p>
+      Users/devs who wants to get started with view development.
+      This setup guide is valid for both user and devs.
+    </p>
+  </audience>
+  
+  <purpose title="Purpose">
+    <p>
+      To help user installing views. This is the "getting started" setup-guide.
+    </p>
+  </purpose>
+
+  <prerequisites title="Prerequisites">
+    <ul>
+      <li>You have to use the trunk version of forrest for using views because it is
in an early stage</li>
+    </ul>
+  </prerequisites>
+
+  <steps title="Steps">
+    <p>
+      The process of setting up the plugin is quite heavy. We promise it will be easier in
the future. 
+      Some of the instructions has to be modified with your local settings.
+    </p>
+    <section id="localBuild">
+      <title>Build the view and the viewHelper plugins</title>
+      <p>
+        The first step is to build the view and the viewHelper plugins. Change to a console
of your choice
+        and go (cd) to the trunk version of forrest {forrest-trunk}. Then do an update and
after this 
+        deploy both plugins locally.
+      </p>
+      <source>
+cd {forrest-trunk}
+svn up
+cd whiteboard/plugins/org.apache.forrest.plugin.internal.view/
+ant local-deploy
+cd ../org.apache.forrest.plugin.output.viewHelper.xhtml/
+ant local-deploy
+      </source>
+    </section>
+    <section id="newSeed">
+      <title>Seed a new project</title>
+      <p> 
+				Go to the dir where you want to seed a new project and seed it. 
+        Then we have to prepare a default.fv directory in project.conf-dir (forrest.properties)

+        of the fresh seed. That will be needed as soon you modify the default view of your
project.
+      </p>
+      <source>
+cd ~/src/newSeed
+forrest seed
+mkdir src/documentation/conf
+      </source>
+    </section>
+    <section id="forrestProperties">
+      <title>Modifying forrest.properties</title>
+      <p>
+        Now we have to tell forrest that we are planing to use the view plugins. We will
do that
+        by editing to the forrest.properties to add the plugins:
+      </p>
+      <source>
+project.required.plugins=org.apache.forrest.plugin.output.viewHelper.xhtml,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".  
+      </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=leather-dev
+      </source>
+    </section>
+    <section id="testing">
+      <title>Test your new view based project</title>
+      <p> 
+        Now you have finished the preparation and the setup to finally try
+      </p>
+      <source>
+forrest run
+      </source>
+      <p>then point to <a href="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>
+  <extension title="Further Reading">
+    <p>
+      Congratulations you are now able to work with views. 
+      From here we recommend to read the following How-To's:
+    </p>
+    <ul>
+      <li><a href="site:howto/view/DSL">Getting started with forrest:view DSL</a>
</li>
+      <li><a href="site:howto/view/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>
+  </feedback>-->
+</howto>

Propchange: forrest/trunk/site-author/content/xdocs/docs/howto/howto-view-contracts.xml
------------------------------------------------------------------------------
    svn:eol-style = native

Added: 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=185097&view=auto
==============================================================================
--- forrest/trunk/site-author/content/xdocs/docs/howto/howto-view-dsl.xml (added)
+++ forrest/trunk/site-author/content/xdocs/docs/howto/howto-view-dsl.xml Mon Jun  6 16:37:55
2005
@@ -0,0 +1,135 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+  Copyright 2002-2005 The Apache Software Foundation or its licensors,
+  as applicable.
+
+  Licensed under the Apache License, Version 2.0 (the "License");
+  you may not use this file except in compliance with the License.
+  You may obtain a copy of the License at
+
+      http://www.apache.org/licenses/LICENSE-2.0
+
+  Unless required by applicable law or agreed to in writing, software
+  distributed under the License is distributed on an "AS IS" BASIS,
+  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+  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">
+
+<howto>
+ <header>
+  <title>How to use the forrest:view config-DSL</title>
+  <abstract>
+    This How-To describes the usage of the forrest:view config Domain Specific Language 
+    to create beautiful website in no time.
+  </abstract>
+  <last-modified-content-date date="2005-06-06"/>
+ </header>
+
+  <audience title="Intended Audience">
+    <p>
+      This part of the views is dedicated to webdesigner and user with some knowlegde of
css.
+    </p>
+  </audience>
+  
+  <purpose title="Purpose">
+    <p>
+      This how-to will show you how to write a forrest:view from ground on. 
+      We will focus on html as output format. 
+      As well it will show how to add your own css implementation to the view.
+    </p>
+  </purpose>
+
+  <prerequisites title="Prerequisites">
+    <ul>
+      <li>You have a ready-to-go new seed based on views (like described in <a href="site:howto/view/install">Install
views</a>). </li>
+    </ul>
+  </prerequisites>
+
+ <!-- <steps title="Steps">
+    <p>
+      The process of setting up the plugin is quite heavy. We promise it will be easier in
the future. 
+      Some of the instructions has to be modified with your local settings.
+    </p>
+    <section id="localBuild">
+      <title>Build the view and the viewHelper plugins</title>
+      <p>
+        The first step is to build the view and the viewHelper plugins. Change to a console
of your choice
+        and go (cd) to the trunk version of forrest {forrest-trunk}. Then do an update and
after this 
+        deploy both plugins locally.
+      </p>
+      <source>
+cd {forrest-trunk}
+svn up
+cd whiteboard/plugins/org.apache.forrest.plugin.internal.view/
+ant local-deploy
+cd ../org.apache.forrest.plugin.output.viewHelper.xhtml/
+ant local-deploy
+      </source>
+    </section>
+    <section id="newSeed">
+      <title>Seed a new project</title>
+      <p> 
+				Go to the dir where you want to seed a new project and seed it. 
+        Then we have to prepare a default.fv directory in project.conf-dir (forrest.properties)

+        of the fresh seed. That will be needed as soon you modify the default view of your
project.
+      </p>
+      <source>
+cd ~/src/newSeed
+forrest seed
+mkdir src/documentation/conf
+      </source>
+    </section>
+    <section id="forrestProperties">
+      <title>Modifying forrest.properties</title>
+      <p>
+        Now we have to tell forrest that we are planing to use the view plugins. We will
do that
+        by editing to the forrest.properties to add the plugins:
+      </p>
+      <source>
+project.required.plugins=org.apache.forrest.plugin.output.viewHelper.xhtml,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".  
+      </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=leather-dev
+      </source>
+    </section>
+    <section id="testing">
+      <title>Test your new view based project</title>
+      <p> 
+        Now you have finished the preparation and the setup to finally try
+      </p>
+      <source>
+forrest run
+      </source>
+      <p>then point to <a href="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>
+  <extension title="Further Reading">
+    <p>
+      Congratulations you are now able to work with views. 
+      From here we recommend to read the following How-To's:
+    </p>
+    <ul>
+      <li><a href="site:howto/view/DSL">Getting started with forrest:view DSL</a>
</li>
+      <li><a href="site:howto/view/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>
+  </feedback>-->
+</howto>

Propchange: forrest/trunk/site-author/content/xdocs/docs/howto/howto-view-dsl.xml
------------------------------------------------------------------------------
    svn:eol-style = native

Added: forrest/trunk/site-author/content/xdocs/docs/howto/howto-view-install.xml
URL: http://svn.apache.org/viewcvs/forrest/trunk/site-author/content/xdocs/docs/howto/howto-view-install.xml?rev=185097&view=auto
==============================================================================
--- forrest/trunk/site-author/content/xdocs/docs/howto/howto-view-install.xml (added)
+++ forrest/trunk/site-author/content/xdocs/docs/howto/howto-view-install.xml Mon Jun  6 16:37:55
2005
@@ -0,0 +1,133 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+  Copyright 2002-2005 The Apache Software Foundation or its licensors,
+  as applicable.
+
+  Licensed under the Apache License, Version 2.0 (the "License");
+  you may not use this file except in compliance with the License.
+  You may obtain a copy of the License at
+
+      http://www.apache.org/licenses/LICENSE-2.0
+
+  Unless required by applicable law or agreed to in writing, software
+  distributed under the License is distributed on an "AS IS" BASIS,
+  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+  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">
+
+<howto>
+ <header>
+  <title>How to install the view package</title>
+  <abstract>
+    This How-To describes the setup of the plugins (needed to work with forrest:views and
forrest:contracts) and a fresh seed.
+  </abstract>
+  <last-modified-content-date date="2005-06-06"/>
+ </header>
+
+  <audience title="Intended Audience">
+    <p>
+      Users/devs who wants to get started with view development.
+      This setup guide is valid for both user and devs.
+    </p>
+  </audience>
+  
+  <purpose title="Purpose">
+    <p>
+      To help user installing views. This is the "getting started" setup-guide.
+    </p>
+  </purpose>
+
+  <prerequisites title="Prerequisites">
+    <ul>
+      <li>You have to use the trunk version of forrest for using views because it is
in an early stage</li>
+    </ul>
+  </prerequisites>
+
+  <steps title="Steps">
+    <p>
+      The process of setting up the plugin is quite heavy. We promise it will be easier in
the future. 
+      Some of the instructions has to be modified with your local settings.
+    </p>
+    <section id="localBuild">
+      <title>Build the view and the viewHelper plugins</title>
+      <p>
+        The first step is to build the view and the viewHelper plugins. Change to a console
of your choice
+        and go (cd) to the trunk version of forrest {forrest-trunk}. Then do an update and
after this 
+        deploy both plugins locally.
+      </p>
+      <source>
+cd {forrest-trunk}
+svn up
+cd whiteboard/plugins/org.apache.forrest.plugin.internal.view/
+ant local-deploy
+cd ../org.apache.forrest.plugin.output.viewHelper.xhtml/
+ant local-deploy
+      </source>
+    </section>
+    <section id="newSeed">
+      <title>Seed a new project</title>
+      <p> 
+				Go to the dir where you want to seed a new project and seed it. 
+        Then we have to prepare a default.fv directory in project.conf-dir (forrest.properties)

+        of the fresh seed. That will be needed as soon you modify the default view of your
project.
+      </p>
+      <source>
+cd ~/src/newSeed
+forrest seed
+mkdir src/documentation/conf
+      </source>
+    </section>
+    <section id="forrestProperties">
+      <title>Modifying forrest.properties</title>
+      <p>
+        Now we have to tell forrest that we are planing to use the view plugins. We will
do that
+        by editing to the forrest.properties to add the plugins:
+      </p>
+      <source>
+project.required.plugins=org.apache.forrest.plugin.output.viewHelper.xhtml,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".  
+      </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=leather-dev
+      </source>
+    </section>
+    <section id="testing">
+      <title>Test your new view based project</title>
+      <p> 
+        Now you have finished the preparation and the setup to finally try
+      </p>
+      <source>
+forrest run
+      </source>
+      <p>then point to <a href="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>
+  <extension title="Further Reading">
+    <p>
+      Congratulations you are now able to work with views. 
+      From here we recommend to read the following How-To's:
+    </p>
+    <ul>
+      <li><a href="site:howto/view/DSL">Getting started with forrest:view DSL</a>
</li>
+      <li><a href="site:howto/view/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>
+  </feedback>
+</howto>

Propchange: forrest/trunk/site-author/content/xdocs/docs/howto/howto-view-install.xml
------------------------------------------------------------------------------
    svn:eol-style = native

Modified: forrest/trunk/site-author/content/xdocs/site.xml
URL: http://svn.apache.org/viewcvs/forrest/trunk/site-author/content/xdocs/site.xml?rev=185097&r1=185096&r2=185097&view=diff
==============================================================================
--- forrest/trunk/site-author/content/xdocs/site.xml (original)
+++ forrest/trunk/site-author/content/xdocs/site.xml Mon Jun  6 16:37:55 2005
@@ -145,6 +145,11 @@
       <maven label="Maven Integration" href="howto-forrest-from-maven.html"/>
       <buildPlugin label="Build a Plugin" href="howto-buildPlugin.html"/>
       <custom-html-source label="Custom html source" href="howto-custom-html-source.html"/>
+      <view label="views">
+	      <install label="Install views" href="howto-view-install.html"/>
+	      <DSL label="forrest:view DSL" href="howto-view-dsl.html"/>
+	      <contracts label="contract implementations" href="howto-view-contracts.html"/>
+      </view>
     </howto>
     
     <plugins label="Plugins" href="plugins/" tab="plugins">



Mime
View raw message