forrest-svn mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
Subject svn commit: r521716 - /forrest/trunk/whiteboard/plugins/org.apache.forrest.plugin.internal.dispatcher/src/documentation/content/xdocs/dispatcher-glossary.xml
Date Fri, 23 Mar 2007 13:13:23 GMT
Author: gmcdonald
Date: Fri Mar 23 06:13:23 2007
New Revision: 521716

Add some definitions, Issue FOR-639


Modified: forrest/trunk/whiteboard/plugins/org.apache.forrest.plugin.internal.dispatcher/src/documentation/content/xdocs/dispatcher-glossary.xml
--- forrest/trunk/whiteboard/plugins/org.apache.forrest.plugin.internal.dispatcher/src/documentation/content/xdocs/dispatcher-glossary.xml
+++ 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 @@
-  <part id="b">
-    <title>B</title>
-    <item>
-      <term></term>
-      <definitions>
-        <definition></definition>
-      </definitions>
-    </item>
-  </part>
   <part id="c">
     <item id="Contracts">
-        <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
+              <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
+      </definitions>
+    </item>
+    <item id="Class">
+            <term>Class</term>
+        <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
+                    </definition>
+            </definitions>
+            </item>
   <part id="d">
@@ -95,28 +106,45 @@
-  <part id="e">
-    <title>E</title>
-    <item>
-      <term></term>
-      <definitions>
-        <definition></definition>
-      </definitions>
-    </item>
-  </part>
   <part id="h">
     <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>
         <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
+<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>
+  <part id="n">
+    <title>N</title>
+    <item id="Name">
+            <term>Name</term>
+        <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">
     <item id="Structurer">
@@ -138,16 +166,37 @@
-        <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>
+    <item id="Skins">
+            <term>Skins</term>
+      <see>
+        <id>Themes</id>
+        <text>Themes</text>
+      <see>
+        <id>Dispatcher</id>
+        <text>Dispatcher</text>
+        <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>
   <part id="t">
     <item id="Themes">
-        <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>

View raw message