Author: crossley
Date: Fri Dec 16 15:45:51 2005
New Revision: 357253
URL: http://svn.apache.org/viewcvs?rev=357253&view=rev
Log:
Explain the common.fv template.
Submitted by: Paul Bolger
Issue: FOR-766
Modified:
forrest/trunk/site-author/content/xdocs/docs_0_80/howto/howto-structurer-dsl.xml
Modified:
forrest/trunk/site-author/content/xdocs/docs_0_80/howto/howto-structurer-dsl.xml
URL:
http://svn.apache.org/viewcvs/forrest/trunk/site-author/content/xdocs/docs_0_80/howto/howto-structurer-dsl.xml?rev=357253&r1=357252&r2=357253&view=diff
==============================================================================
---
forrest/trunk/site-author/content/xdocs/docs_0_80/howto/howto-structurer-dsl.xml
(original)
+++
forrest/trunk/site-author/content/xdocs/docs_0_80/howto/howto-structurer-dsl.xml
Fri Dec 16 15:45:51 2005
@@ -16,7 +16,6 @@
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 structurer</title>
@@ -39,7 +38,7 @@
this. All this will ATM happen in the v2 seed-target till the dispatcher
will be realesed to the stable plugins. So make regular updates of your
forrest-trunk to keep track. </note>
- <warning> The way we develope contracts will/may change with introduction
+ <warning> The way we develop contracts will/may change with introduction
of java based processing rather then xsl. Please keep this in mind and
help updating the documentation by sending patches. TIA. ;-) </warning>
</audience>
@@ -64,7 +63,7 @@
<steps title="Steps">
<note> When developing with the dispatcher we assume you are using
'forrest
- run' and the following workflow "change files -> refresh browser"<br/>
+ run' and the following workflow "change files -> refresh
browser"<br/>
Installing a mozilla browser and the forrestbar helps a lot in
developing. Many instructions assumes that you have the forrestbar
installed. </note>
@@ -76,8 +75,7 @@
<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 <a
-
href="http://svn.apache.org/repos/asf/forrest/trunk/main/webapp/skins/leather-dev/contracts.initial.txt";>
+ skins. For the full list refer to the <a
href="http://svn.apache.org/repos/asf/forrest/trunk/main/webapp/skins/leather-dev/contracts.initial.txt";>
initial contract list </a> </p>
<p> Around this contracts we developed a configuration Domain Specific
Language - called <strong>the structurer</strong>. The
@@ -135,11 +133,15 @@
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 <a
href="site:howto/dispatcher/install">v2</a>. 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>
+
+ <note>You can set a view for an individual file, a directory, or the
whole site. To address multiple files in a directory call your
<code>.fv</code> file <code>common.fv</code>. If Forrest doesn't find a
<code>.fv</code> file with the same name as the current file it will use the
common.fv file in that directory, or the first one it finds going upwards
through the directory structure.
+ <code>common.fv</code> files affect all subdirectories unless they are
overidden by another <code>common.fv</code> or a file-specific
<code>foo.fv</code> file.
+ </note>
+
<p> Remember: pointing your browser to
<code>http://localhost:8888/ls.contracts.html</code> will show a page
with all contracts and themes that you can use in your project
provided
@@ -418,7 +420,6 @@
</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="site:mail-lists">mailing lists</a>. </p>
</feedback>
</howto>
