You are viewing a plain text version of this content. The canonical link for it is here.
Posted to svn@forrest.apache.org by cr...@apache.org on 2006/03/24 05:41:00 UTC
svn commit: r388365 - in
/forrest/branches/forrest_07_branch/site-author/content/xdocs/docs_0_70/howto:
howto-view-dsl.xml howto-view-install.xml
Author: crossley
Date: Thu Mar 23 20:40:59 2006
New Revision: 388365
URL: http://svn.apache.org/viewcvs?rev=388365&view=rev
Log:
Text tweaks and fix typos.
Submitted by: Addison Berry
Issue: FOR-540
Modified:
forrest/branches/forrest_07_branch/site-author/content/xdocs/docs_0_70/howto/howto-view-dsl.xml
forrest/branches/forrest_07_branch/site-author/content/xdocs/docs_0_70/howto/howto-view-install.xml
Modified: forrest/branches/forrest_07_branch/site-author/content/xdocs/docs_0_70/howto/howto-view-dsl.xml
URL: http://svn.apache.org/viewcvs/forrest/branches/forrest_07_branch/site-author/content/xdocs/docs_0_70/howto/howto-view-dsl.xml?rev=388365&r1=388364&r2=388365&view=diff
==============================================================================
--- forrest/branches/forrest_07_branch/site-author/content/xdocs/docs_0_70/howto/howto-view-dsl.xml (original)
+++ forrest/branches/forrest_07_branch/site-author/content/xdocs/docs_0_70/howto/howto-view-dsl.xml Thu Mar 23 20:40:59 2006
@@ -22,7 +22,7 @@
<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.
+ to create a beautiful website in no time.
</abstract>
<last-modified-content-date date="2005-06-06"/>
</header>
@@ -30,20 +30,20 @@
<audience title="Intended Audience">
<warning>
-"Views" are new functionality which is still in development phase. That is why it is in the
+"Views" are a new functionality which is still in development phase. That is why it is in the
"whiteboard" section of the Forrest distribution.
This HowTo is far from being finished.
</warning>
<p>
- This part of the views is dedicated to webdesigner and user with some knowlegde of css.
+ This part of the views is dedicated to web designers and users with some knowlegde of css.
</p>
</audience>
<purpose title="Purpose">
<p>
- This how-to will show you how to write a<strong> forrest:view</strong> 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.
+ This how-to will show you how to write a <strong> forrest:view</strong> from the ground up.
+ We will focus on html as the output format and show how to add your own css implementation to the view.
</p>
</purpose>
@@ -56,7 +56,7 @@
This includes as well all additional plugins that are mentioned in <a href="site:howto/view/install">Install views</a>.
</li>
<li>
- Reading that how-to is as well a good idea to understand the used dir-structure in this how-to.
+ Reading the Intall views HowTo is also a good idea to help understand the dir-structure used in this how-to.
</li>
</ul>
</prerequisites>
@@ -67,32 +67,33 @@
change files -> refresh browser
</note>
<p>
- We developed<strong> forrest:view</strong> to let the user decide where to place elements in e.g. html-pages.
+ We developed <strong> forrest:view</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. This elements was known under certain names. It was up to the skin-designer to support
+ their positions. These elements were known by established names and 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
+ We started by grouping the elements (from skinconf) and using 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 of these contracts refer to the
<a href="http://svn.apache.org/viewcvs.cgi/*checkout*/forrest/trunk/main/webapp/skins/leather-dev/contracts.inicial.txt">
- inicial contract list
- </a>
+ initial contract list
+ </a>.
</p>
<p>
- Around this contracts we developed a configuration Domain Specific Language and called it<strong> forrest:view</strong> .
- <strong> forrest:view</strong> 's 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.
+ Around these contracts we developed a configuration Domain Specific Language and called it<strong> forrest:view</strong> .
+ <strong> forrest:view</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 container that are only used for layout reasons. They <strong>do not</strong> add
+ <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 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 skin can use to display the requested
+ <strong>forrest:contract</strong>s add functionality or extra content that a skin can use to display the requested
document (content-main). Sometimes a contract delivers <strong>format-specific markup</strong>, other times it delivers
a <strong>format-independent string</strong>.
</p>
@@ -104,8 +105,9 @@
</forrest:views>]]>
</source>
<p>
- <strong> forrest:view</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 xhtml for now. This is as well true for the delivered contracts.
+ <strong> forrest:view</strong> is designed to be available for any format that can use<strong>
+ forrest:view</strong> as a configuration file.
+ The only format we have implemented is xhtml for now. This is also true for the delivered contracts.
</p>
<p>
Now lets start to skin our site. :)
@@ -115,18 +117,18 @@
<section id="firstView">
<title>Creating your first view</title>
<p>
- In this section we will create a new view. We will override the default view of the view-plugin
+ In this section we will create a new view. We will override the default view of the view plugin
for the index page of the <a href="site:howto/view/install">newSeed</a>.
- For that we will create a file called <code>index.ft</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.
+ To do this we will create a file called <code>index.ft</code> and save it in our xdocs directory.
+ This will <strong>only</strong> make the index.html page look different from the rest of the project.
</p>
<p>
Remember: pointing your browser to <code>http://localhost:8888/ls.contracts.html</code> will
show a page with all contracts that you can use in your project.
</p>
<p>
- Let use the blank view from the earlier step and add the content-main contract. In
- ls.contracts.html we find the information how to use the contract in our view. Our
+ Let's use the blank view from the earlier step and add the content-main contract. In
+ ls.contracts.html we find the information about how to use the contract in our view. Our
<code>index.fv</code> should look like:
</p>
<source><![CDATA[<forrest:views xmlns:forrest="http://apache.org/forrest/templates/1.0" >
@@ -148,16 +150,16 @@
</forrest:views>]]>
</source>
<p>
- We find now the main content and the section navigation after each other and in the order
- we placed them in the view, but we want it next to each other
+ We now see the main content and the section navigation in the order
+ we placed them in the view, but we want them next to each other
(left: nav-section; right: content-main).
</p>
</section>
<section id="hookView">
<title>Hooks in views</title>
<p>
- We will use now the first time a <code><![CDATA[<forrest:hook name="layoutId"/>]]></code>.
- Hooks are the styling side of views. We can imitate arbitrary html skeleton
+ We will now use for the first time a <code><![CDATA[<forrest:hook name="layoutId"/>]]></code>.
+ Hooks are the styling side of views. We can imitate an arbitrary html skeleton
with their help. Before we explain how to use your own css in views we will use the default css.
In the default.css we can find
</p>
@@ -170,12 +172,12 @@
}
</source>
<p>
- With this information we know to use <code><![CDATA[<forrest:hook name="leftbar"/>]]></code>
+ With this information we can see the purpose of <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 side position
- of the site we need to place the contract into that hook. Like:
+ of the site we need to place the contract into that hook like so:
</p>
<source><![CDATA[<forrest:hook name="leftbar">
<forrest:contract name="nav-section"/>
@@ -197,12 +199,13 @@
<section id="cssView">
<title>CSS in views</title>
<p>
- We know now how to place contracts and hooks in our view, till this stage we only used the default.css.
- CSS-support of views is as easy as placing contracts/hooks. To override the default.css
+ We now know how to place contracts and hooks in our view, but until this stage we have only
+ used the default.css.
+ CSS support within views is as easy as placing contracts/hooks. To override the default.css
stylesheet we use another tag within our view <code><![CDATA[<forrest:css url="default.css"/>]]></code>.
</p>
<p>
- We will now create a file in <code><![CDATA[{project:skins-dir}{path}/{name}.css]]></code>. In our case
+ Now we will create a new file as <code><![CDATA[{project:skins-dir}{path}/{name}.css]]></code>. In our case
we will save a file called howTo.css in newSeed/src/documentation/skins/css/howTo.css containing only
the following css:
</p>
@@ -220,7 +223,7 @@
by adding the tag <code><![CDATA[<forrest:css url="howTo.css"/>]]></code> to our view.
</p>
<note>
- <code><![CDATA[<forrest:css url="howTo.css"/>]]></code> has to be direct son of
+ <code><![CDATA[<forrest:css url="howTo.css"/>]]></code> has to be the direct son of
<code><![CDATA[<forrest:view type="xhtml">]]></code>!!!
</note>
<source><![CDATA[<forrest:views xmlns:forrest="http://apache.org/forrest/templates/1.0" >
@@ -235,8 +238,9 @@
</source>
<p>
Now you see a white page where the menu is sourrounded by a solid border with the defined background.
- As 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
+ For a second example let's change the content-main by adding another hook
+ <code><![CDATA[<forrest:hook name="content"/>]]></code>. We need to add the new layout
+ container
to our howTo.css:
</p>
<source>
@@ -248,7 +252,7 @@
}
</source>
<p>
- Then we have to add the 'content-main' contract to the 'content' hook, the resulting view looks like:
+ Then we have to add the 'content-main' contract to the 'content' hook. The resulting view looks like:
</p>
<source><![CDATA[<forrest:views xmlns:forrest="http://apache.org/forrest/templates/1.0" >
<forrest:view type="xhtml">
@@ -263,7 +267,7 @@
</forrest:views>]]>
</source>
<p>
- We are now able to place contracts into layout container and add custom css to the view.
+ We are now able to place contracts and layout containers and add custom css to the view.
</p>
<fixme author="thorsten">
Let us now look into advanced features of views.
@@ -274,8 +278,8 @@
</steps>
<extension title="Further Reading">
<p>
- Congratulations you are now able to work with the view DSL.
- From here we recommend to read the following How-To's:
+ Congratulations, you are now able to work with the view DSL.
+ From here we recommend reading the following How-To's:
</p>
<ul>
<li><a href="site:howto/view/contracts">Create your own contract implementation</a> </li>
Modified: forrest/branches/forrest_07_branch/site-author/content/xdocs/docs_0_70/howto/howto-view-install.xml
URL: http://svn.apache.org/viewcvs/forrest/branches/forrest_07_branch/site-author/content/xdocs/docs_0_70/howto/howto-view-install.xml?rev=388365&r1=388364&r2=388365&view=diff
==============================================================================
--- forrest/branches/forrest_07_branch/site-author/content/xdocs/docs_0_70/howto/howto-view-install.xml (original)
+++ forrest/branches/forrest_07_branch/site-author/content/xdocs/docs_0_70/howto/howto-view-install.xml Thu Mar 23 20:40:59 2006
@@ -29,33 +29,34 @@
<audience title="Intended Audience">
<warning>
-"Views" are new functionality which is still in development phase. That is why it is in the
+"Views" are a 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 proof-reading.
</warning>
<p>
Users/devs who wants to get started with view development.
- This setup guide is valid for both user and devs.
+ This setup guide is valid for both users and devs.
</p>
</audience>
<purpose title="Purpose">
<p>
- To help user installing views. This is the "getting started" setup-guide.
+ To help users install 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>
+ <li>You have to use the trunk version of forrest to use views because it is in an early stage
+ of development.</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.
+ The process of setting up the plugin is quite involved. We promise it will be easier in the future.
+ Some of the instructions have to be modified with your local settings.
</p>
<section id="localBuild">
<title>Build the view and the viewHelper plugins</title>
@@ -77,9 +78,9 @@
<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.
- The "templates"-directory is need for your project specific contract implementations.
+ Next we have to prepare a default.fv directory ("conf") in project.conf-dir (forrest.properties)
+ of the fresh seed. This will be needed as soon you modify the default view of your project.
+ A "templates" directory is needed as well, for your project-specific contract implementations.
</p>
<source>
cd ~/src/newSeed
@@ -91,25 +92,24 @@
<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
+ Now we have to tell forrest that we are planning 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".
+ We also have to change the project skin to leather-dev. The reason for this is that the plugins are still
+ not independent from 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>
+ <note>We are 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>
+ <title>Test your new view-based project</title>
<p>
Now you have finished the preparation and the setup to finally try
</p>
@@ -117,7 +117,7 @@
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>
+ 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>
@@ -136,8 +136,8 @@
ant local-deploy
</source>
<p>
- The newly installed plugin will show the available contracts as html page.
- First we have to tell forrest that we are planing to use the new plugin. We will do that
+ The newly installed plugin will show the available contracts listed in an html page.
+ First we have to tell forrest that we are planning to use the new plugin. We will do that
by editing the forrest.properties of the <a href="site:howto/view/install">newSeed</a>
to <strong>add</strong> the plugin:
</p>
@@ -152,8 +152,8 @@
</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:
+ Congratulations, you are now able to work with views.
+ From here we recommend reading the following How-To's:
</p>
<ul>
<li><a href="site:v0.70//howto/view/DSL">Getting started with forrest:view DSL</a> </li>