You are viewing a plain text version of this content. The canonical link for it is here.
Posted to svn@forrest.apache.org by gm...@apache.org on 2007/03/23 14:13:23 UTC

svn commit: r521716 - /forrest/trunk/whiteboard/plugins/org.apache.forrest.plugin.internal.dispatcher/src/documentation/content/xdocs/dispatcher-glossary.xml

Author: gmcdonald
Date: Fri Mar 23 06:13:23 2007
New Revision: 521716

URL: http://svn.apache.org/viewvc?view=rev&rev=521716
Log:
Add some definitions, Issue FOR-639

Modified:
    forrest/trunk/whiteboard/plugins/org.apache.forrest.plugin.internal.dispatcher/src/documentation/content/xdocs/dispatcher-glossary.xml

Modified: forrest/trunk/whiteboard/plugins/org.apache.forrest.plugin.internal.dispatcher/src/documentation/content/xdocs/dispatcher-glossary.xml
URL: http://svn.apache.org/viewvc/forrest/trunk/whiteboard/plugins/org.apache.forrest.plugin.internal.dispatcher/src/documentation/content/xdocs/dispatcher-glossary.xml?view=diff&rev=521716&r1=521715&r2=521716
==============================================================================
--- forrest/trunk/whiteboard/plugins/org.apache.forrest.plugin.internal.dispatcher/src/documentation/content/xdocs/dispatcher-glossary.xml (original)
+++ forrest/trunk/whiteboard/plugins/org.apache.forrest.plugin.internal.dispatcher/src/documentation/content/xdocs/dispatcher-glossary.xml Fri Mar 23 06:13:23 2007
@@ -41,23 +41,34 @@
       </notes>
     </item>
   </part>
-  <part id="b">
-    <title>B</title>
-    <item>
-      <term></term>
-      <definitions>
-        <definition></definition>
-      </definitions>
-    </item>
-  </part>
   <part id="c">
     <title>C</title>
     <item id="Contracts">
       <term>Contracts</term>
       <definitions>
-        <definition></definition>
-      </definitions>
-    </item>
+              <definition>A contract is a snippet of re-usable code that gets used in a structurer file.</definition>
+              <definition>Contracts can be used or omitted as neccessary, though a few are really compulsary in
+                      order to define a basic skeleton structure and to include some styling (CSS)</definition>
+              <definition>Contracts mainly come in three (3) types, static, semi-static &amp; dynamic.<br />
+                      Static Contracts are pre-defined snippets of code that need no further information.<br />
+                      Semi-static Contracts can include extra configuration variables, these would over-ride otherwise
+                      default variables.<br />
+                      Dynamic Contracts can have extra configuration variables, but can also define their own snippets
+                      of code information. (Such as extra CSS elements, or generic markup elements).</definition>
+      </definitions>
+    </item>
+    <item id="Class">
+            <term>Class</term>
+<see>
+        <id>Name</id>
+        <text>Name</text>
+      </see>
+            <definitions>
+                    <definition>In the context of the dispatcher, a <strong>Class</strong> is used as an optional attribute to
+                            the forrest:hook. This converts to <code><![CDATA[<div class="example"></div>]]></code>.
+                    </definition>
+            </definitions>
+            </item>
   </part>
   <part id="d">
     <title>D</title>
@@ -95,28 +106,45 @@
       </definitions>
     </item>
   </part>
-  <part id="e">
-    <title>E</title>
-    <item>
-      <term></term>
-      <definitions>
-        <definition></definition>
-      </definitions>
-    </item>
-  </part>
   <part id="h">
     <title>H</title>
     <item id="Hooks">
-      <term>forrest:hooks</term>
+            <term>forrest:hooks</term>
+      <see>
+        <id>Contracts</id>
+        <text>Contracts</text>
+      </see>
+      <see>
+        <id>Structurer</id>
+        <text>Structurer</text>
+      </see>
       <definitions>
         <definition>forrest:hooks is a concept of defining format independent hooks to structure
         the output.</definition>
         <definition>Hooks are used to help define the layout of a page. Hooks are only used to
         define the structure in our output that is required to enable a theme to apply its look and
         feel.</definition>
+<definition>Hooks convert to layout <![CDATA[<div></div>]]> container blocks and usually only consist
+        of forrest:contracts</definition>
+<definition>Hooks are applied currently in the themes.core plugin as part of a themes structurer configuration
+        file such as %themename%-html.vt.xml (e.g pelt-html.vt.xml)</definition>
       </definitions>
     </item>
   </part> 
+  <part id="n">
+    <title>N</title>
+    <item id="Name">
+            <term>Name</term>
+<see>
+        <id>Class</id>
+        <text>Class</text>
+      </see>
+      <definitions>
+        <definition>In the context of the dispatcher, a <strong>name</strong> is used as an optional attribute to 
+                the forrest:hook. This converts to <code><![CDATA[<div id="example"></div>]]></code>.</definition>
+      </definitions>
+    </item>
+  </part>
   <part id="s">
     <title>S</title>
     <item id="Structurer">
@@ -138,16 +166,37 @@
         <text>Themes</text>
       </see>
       <definitions>
-        <definition>The Structurer is ...</definition>
+              <definition>The Structurer allows a user to define the layout and content of a site or parts of a site.</definition>
+              <definition>Structurer files contain hooks &amp; contracts which you can include to build up a site structure template</definition>
+              <definition>A completed structurer file defines an overall theme (look and feel) for a site</definition>
       </definitions>
     </item>
+    <item id="Skins">
+            <term>Skins</term>
+      <see>
+        <id>Themes</id>
+        <text>Themes</text>
+</see>
+      <see>
+        <id>Dispatcher</id>
+        <text>Dispatcher</text>
+</see>
+<definitions>
+        <definition>Skins is the name of the older alternative way for structuring and styling your site pages.</definition>
+        <definition>Skins is still used in Forrest versions 0.7 and 0.8-dev, though for 0.8-dev and beyond it can be
+                concidered an option with Dispatcher being the other.(It is enabled as the default option currently)</definition>
+</definitions>
+</item>
   </part>
   <part id="t">
     <title>T</title>
     <item id="Themes">
       <term>Themes</term>
       <definitions>
-        <definition>Theming</definition>
+              <definition>A more extensible and adaptable solution than its alternative 'Skins'. A 'Theme' is an overall content &amp; style set.</definition>
+              <definition>A master 'common' theme provides the basis in which you can extend, over-ride or add to in order to make your own theme, you do not
+                      have to create a complete theme from scratch, simply include/exclude/over-ride/add what you need. The current 'Pelt Theme' based on its
+                      'Pelt Skin' counterpart, but uses functionality and extends/inherits what it needs to from the 'common' theme.</definition>
       </definitions>
     </item>
   </part>



RE: svn commit: r521716 -/forrest/trunk/whiteboard/plugins/org.apache.forrest.plugin.internal.dispatcher/src/documentation/content/xdocs/dispatcher-glossary.xml

Posted by Thorsten Scherler <th...@apache.org>.
On Tue, 2007-03-27 at 21:09 +0800, Gav.... wrote:

> > > ...
> > > > +<definition>Hooks are applied currently in the themes.core plugin as
> > > part of a themes structurer configuration
> > > > +        file such as %themename%-html.vt.xml (e.g pelt-
> > > html.vt.xml)</definition>
> > > ...
> > >
> > > Actually we only moved all the hooks and contracts into panels to make
> > > them easier to override, but mainly they are used in structure files
> > > (*.fv).
> > 
> > Sorry I am misunderstanding what you are doing then,
> > 
> > currently there are no hooks or contracts in any *.fv file.
> > They used to be , which is all of my sites stopped working
> > recently when it changed.
> > They are imported in now and all examples show them to be in
> > the .xml files. Am I wrong to reflect this way of doing things
> > in the documentation then?
> 
> I stand partially corrected, they are imported into pelt and common
> themes, the others still have the contracts in the *.fv files.

Yes, I propose something like:

<definition>Hooks are applied currently in the themes.core plugin as
part of a themes structurer configuration file such as %themename
%-html.vt.xml (e.g pelt-html.vt.xml) or included in such configuration
files via a panel file such as %themename%-%format%.vt.xml (e.g
pelt-html.vt.xml)</definition>

If that is ok with you I will commit it if you have not been quicker
then me.

> Thanks for looking over my changes Thorsten, I again know a little
> bit more about how it works :)
> 

Thanks to you, tackling the documentation makes me most grateful. I am
biased in terms of using the dispatcher since I too deeply know its
internals. 

> Gav...

Thanks, Gav.
-- 
Thorsten Scherler                                 thorsten.at.apache.org
Open Source Java & XML                consulting, training and solutions


RE: svn commit: r521716 -/forrest/trunk/whiteboard/plugins/org.apache.forrest.plugin.internal.dispatcher/src/documentation/content/xdocs/dispatcher-glossary.xml

Posted by "Gav...." <br...@brightontown.com.au>.

> -----Original Message-----
> From: Gav.... [mailto:brightoncomputers@brightontown.com.au]
> Sent: Tuesday, 27 March 2007 5:15 PM
> To: dev@forrest.apache.org
> Subject: RE: svn commit: r521716 -
> /forrest/trunk/whiteboard/plugins/org.apache.forrest.plugin.internal.dispa
> tcher/src/documentation/content/xdocs/dispatcher-glossary.xml
> 
> 
> 
> > -----Original Message-----
> > From: Thorsten Scherler [mailto:thorsten@apache.org]
> > Sent: Tuesday, 27 March 2007 8:39 AM
> > To: Forrest Developers List
> > Subject: Re: svn commit: r521716 -
> >
> /forrest/trunk/whiteboard/plugins/org.apache.forrest.plugin.internal.dispa
> > tcher/src/documentation/content/xdocs/dispatcher-glossary.xml
> >
> > On Fri, 2007-03-23 at 13:13 +0000, gmcdonald@apache.org wrote:
> > > Author: gmcdonald
> > > Date: Fri Mar 23 06:13:23 2007
> > > New Revision: 521716
> > >
> > > URL: http://svn.apache.org/viewvc?view=rev&rev=521716
> > > Log:
> > > Add some definitions, Issue FOR-639
> > >
> > ...
> > > +<definition>Hooks are applied currently in the themes.core plugin as
> > part of a themes structurer configuration
> > > +        file such as %themename%-html.vt.xml (e.g pelt-
> > html.vt.xml)</definition>
> > ...
> >
> > Actually we only moved all the hooks and contracts into panels to make
> > them easier to override, but mainly they are used in structure files
> > (*.fv).
> 
> Sorry I am misunderstanding what you are doing then,
> 
> currently there are no hooks or contracts in any *.fv file.
> They used to be , which is all of my sites stopped working
> recently when it changed.
> They are imported in now and all examples show them to be in
> the .xml files. Am I wrong to reflect this way of doing things
> in the documentation then?

I stand partially corrected, they are imported into pelt and common
themes, the others still have the contracts in the *.fv files.

Thanks for looking over my changes Thorsten, I again know a little
bit more about how it works :)

Gav...

> 
> Gav...
> 
> 
> So the instructions are reflecting what we have in the thmes
> >
> > salu2
> > --
> > Thorsten Scherler                                 thorsten.at.apache.org
> > Open Source Java & XML                consulting, training and solutions
> >
> >
> > --
> > No virus found in this incoming message.
> > Checked by AVG Free Edition.
> > Version: 7.5.446 / Virus Database: 268.18.17/730 - Release Date:
> 3/22/2007
> > 7:44 AM
> 
> 
> --
> No virus found in this incoming message.
> Checked by AVG Free Edition.
> Version: 7.5.446 / Virus Database: 268.18.17/730 - Release Date: 3/22/2007
> 7:44 AM


RE: svn commit: r521716 -/forrest/trunk/whiteboard/plugins/org.apache.forrest.plugin.internal.dispatcher/src/documentation/content/xdocs/dispatcher-glossary.xml

Posted by "Gav...." <br...@brightontown.com.au>.

> -----Original Message-----
> From: Thorsten Scherler [mailto:thorsten@apache.org]
> Sent: Tuesday, 27 March 2007 8:39 AM
> To: Forrest Developers List
> Subject: Re: svn commit: r521716 -
> /forrest/trunk/whiteboard/plugins/org.apache.forrest.plugin.internal.dispa
> tcher/src/documentation/content/xdocs/dispatcher-glossary.xml
> 
> On Fri, 2007-03-23 at 13:13 +0000, gmcdonald@apache.org wrote:
> > Author: gmcdonald
> > Date: Fri Mar 23 06:13:23 2007
> > New Revision: 521716
> >
> > URL: http://svn.apache.org/viewvc?view=rev&rev=521716
> > Log:
> > Add some definitions, Issue FOR-639
> >
> ...
> > +<definition>Hooks are applied currently in the themes.core plugin as
> part of a themes structurer configuration
> > +        file such as %themename%-html.vt.xml (e.g pelt-
> html.vt.xml)</definition>
> ...
> 
> Actually we only moved all the hooks and contracts into panels to make
> them easier to override, but mainly they are used in structure files
> (*.fv).

Sorry I am misunderstanding what you are doing then,

currently there are no hooks or contracts in any *.fv file.
They used to be , which is all of my sites stopped working
recently when it changed.
They are imported in now and all examples show them to be in
the .xml files. Am I wrong to reflect this way of doing things
in the documentation then?

Gav...


So the instructions are reflecting what we have in the thmes 
> 
> salu2
> --
> Thorsten Scherler                                 thorsten.at.apache.org
> Open Source Java & XML                consulting, training and solutions
> 
> 
> --
> No virus found in this incoming message.
> Checked by AVG Free Edition.
> Version: 7.5.446 / Virus Database: 268.18.17/730 - Release Date: 3/22/2007
> 7:44 AM


Re: svn commit: r521716 - /forrest/trunk/whiteboard/plugins/org.apache.forrest.plugin.internal.dispatcher/src/documentation/content/xdocs/dispatcher-glossary.xml

Posted by Thorsten Scherler <th...@apache.org>.
On Fri, 2007-03-23 at 13:13 +0000, gmcdonald@apache.org wrote:
> Author: gmcdonald
> Date: Fri Mar 23 06:13:23 2007
> New Revision: 521716
> 
> URL: http://svn.apache.org/viewvc?view=rev&rev=521716
> Log:
> Add some definitions, Issue FOR-639
> 
...
> +<definition>Hooks are applied currently in the themes.core plugin as part of a themes structurer configuration
> +        file such as %themename%-html.vt.xml (e.g pelt-html.vt.xml)</definition>
...

Actually we only moved all the hooks and contracts into panels to make
them easier to override, but mainly they are used in structure files
(*.fv).

salu2
-- 
Thorsten Scherler                                 thorsten.at.apache.org
Open Source Java & XML                consulting, training and solutions