You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@turbine.apache.org by jv...@apache.org on 2002/02/10 04:26:23 UTC
cvs commit: jakarta-turbine-3/xdocs/stylesheets site.dvsl
jvanzyl 02/02/09 19:26:23
Modified: xdocs glossary.xml index.xml project.xml
xdocs/stylesheets site.dvsl
Log:
- adding some simple macros to process the glossary
Revision Changes Path
1.3 +158 -160 jakarta-turbine-3/xdocs/glossary.xml
Index: glossary.xml
===================================================================
RCS file: /home/cvs/jakarta-turbine-3/xdocs/glossary.xml,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- glossary.xml 9 Feb 2002 18:46:26 -0000 1.2
+++ glossary.xml 10 Feb 2002 03:26:23 -0000 1.3
@@ -10,165 +10,163 @@
<body>
<section name="Glossary">
- <glossary>
- <entries>
- <!--
- <entry>
- <name>
- </name>
- <definition>
- </definition>
- </entry>
- -->
- <entry>
- <id>module</id>
- <name>
- Module
- </name>
- <definition>
- </definition>
- </entry>
-
- <entry>
- <id>pipeline</id>
- <name>
- Pipeline
- </name>
- <definition>
- A pipeline consists of a sequence
- of <a href="#valve">valve</a> instances that operate
- together to produce the desired output for the user. Please
- see the <a href="pipeline.html">Pipeline</a> and the
- <a href="pipeline-advanced.html">Advanced Pipeline Techniques</a>
- documents for more detail.
- </definition>
- </entry>
-
- <entry>
- <id>renderer</id>
- <name>
- Renderer
- </name>
- <definition>
- A Renderer is a class that interfaces with a Turbine View System
- to generate content based on the current <a href="#target">target</a>.
- A Renderer may, or may not cooperate with a
- <a href="#resolver">resolver</a> to generate the output.
- </definition>
- </entry>
-
- <entry>
- <id>resolver</id>
- <name>
- Resolver
- </name>
- <definition>
- A Resolver follows the <a href="turbine-patterns.html#strategy">
- Strategy</a> pattern whereby an algorithm responsible for matching
- <a href="#sibling-template">sibling templates</a> and
- <a href="#module">modules</a> to the requested
- <a href="#target">target</a>.
- </definition>
- </entry>
-
- <entry>
- <id>rundata</id>
- <name>
- RunData
- </name>
- <definition>
- RunData is an interface in Turbine that is implemented by classes
- that are responsible for encapsulating the information generated
- by a request.
- </definition>
- </entry>
-
- <entry>
- <id>security-model</id>
- <name>
- Security Model
- </name>
- <definition>
- A Security Model is a set of <a href="turbine-patterns.html#strategy">
- strategies</a> encapsulated in a class that allows any degree of freedom
- when implementing a security mechanism in a Turbine application. There
- is a default security model that comes with Turbine 3, but an
- application developer may use a completely different model is
- the default model provided with Turbine doesn't meet the requirements
- for a given application.
- </definition>
- </entry>
-
- <entry>
- <id>sibling-template</id>
- <name>
- Sibling Template
- </name>
- <definition>
- A sibling template is a template that is associated with the
- <a href="#target">target</a> template by name. An example of this
- is the Turbine 2 classic rendering mechanism: when a target named
- <b>Index.vm</b> is selected the classic model dictates that a layout
- template named <b>Index.vm</b> will be used to decorate the target
- template. The layout template in this case is considered a
- sibling template.
- </definition>
- </entry>
-
- <entry>
- <id>sub-system</id>
- <name>
- Sub System
- </name>
- <definition>
- A sub system is a class that adheres to the lifecycle interfaces to
- provide a control mechanism that Turbine can use to manage
- a set of functionality provided by a third party library. A sub
- system is really a thin veneer of an <a href="turbine-patterns.html#adapter">
- adapter</a> for an external tool like <a href="http://jakarta.apache.org/velocity">
- Velocity</a>.
- </definition>
- </entry>
-
- <entry>
- <id>valve</id>
- <name>
- Valve
- </name>
- <definition>
- A valve is responsible for a specific stage of processing in
- a <a href="#pipeline">pipeline</a>. A valve's behaviour can range
- from determining the target template from a request to providing
- access to an underlying <a href="#security-model">Security Model</a>.
- </definition>
- </entry>
-
- <entry>
- <id>target</id>
- <name>
- Target
- </name>
- <definition>
- The target is the entity that is used at the beginning of the
- request processing cycle in Turbine.
- </definition>
- </entry>
-
- <entry>
- <id>view-system</id>
- <name>
- View System
- </name>
- <definition>
- A View System is Sub System that is responsible for providing
- access to a rendering system like Velocity.
- </definition>
- </entry>
-
-
- </entries>
- </glossary>
</section>
-
- </body>
+
+ <glossary>
+ <entries>
+ <!--
+ <entry>
+ <name>
+ </name>
+ <definition>
+ </definition>
+ </entry>
+ -->
+ <entry>
+ <id>module</id>
+ <name>
+ Module
+ </name>
+ <definition>
+ </definition>
+ </entry>
+
+ <entry>
+ <id>pipeline</id>
+ <name>
+ Pipeline
+ </name>
+ <definition>
+ A pipeline consists of a sequence
+ of <a href="#valve">valve</a> instances that operate
+ together to produce the desired output for the user. Please
+ see the <a href="pipeline.html">Pipeline</a> and the
+ <a href="pipeline-advanced.html">Advanced Pipeline Techniques</a>
+ documents for more detail.
+ </definition>
+ </entry>
+
+ <entry>
+ <id>renderer</id>
+ <name>
+ Renderer
+ </name>
+ <definition>
+ A Renderer is a class that interfaces with a Turbine View System
+ to generate content based on the current <a href="#target">target</a>.
+ A Renderer may, or may not cooperate with a
+ <a href="#resolver">resolver</a> to generate the output.
+ </definition>
+ </entry>
+
+ <entry>
+ <id>resolver</id>
+ <name>
+ Resolver
+ </name>
+ <definition>
+ A Resolver follows the <a href="turbine-patterns.html#strategy">
+ Strategy</a> pattern whereby an algorithm responsible for matching
+ <a href="#sibling-template">sibling templates</a> and
+ <a href="#module">modules</a> to the requested
+ <a href="#target">target</a>.
+ </definition>
+ </entry>
+
+ <entry>
+ <id>rundata</id>
+ <name>
+ RunData
+ </name>
+ <definition>
+ RunData is an interface in Turbine that is implemented by classes
+ that are responsible for encapsulating the information generated
+ by a request.
+ </definition>
+ </entry>
+
+ <entry>
+ <id>security-model</id>
+ <name>
+ Security Model
+ </name>
+ <definition>
+ A Security Model is a set of <a href="turbine-patterns.html#strategy">
+ strategies</a> encapsulated in a class that allows any degree of freedom
+ when implementing a security mechanism in a Turbine application. There
+ is a default security model that comes with Turbine 3, but an
+ application developer may use a completely different model is
+ the default model provided with Turbine doesn't meet the requirements
+ for a given application.
+ </definition>
+ </entry>
+
+ <entry>
+ <id>sibling-template</id>
+ <name>
+ Sibling Template
+ </name>
+ <definition>
+ A sibling template is a template that is associated with the
+ <a href="#target">target</a> template by name. An example of this
+ is the Turbine 2 classic rendering mechanism: when a target named
+ <b>Index.vm</b> is selected the classic model dictates that a layout
+ template named <b>Index.vm</b> will be used to decorate the target
+ template. The layout template in this case is considered a
+ sibling template.
+ </definition>
+ </entry>
+
+ <entry>
+ <id>sub-system</id>
+ <name>
+ Sub System
+ </name>
+ <definition>
+ A sub system is a class that adheres to the lifecycle interfaces to
+ provide a control mechanism that Turbine can use to manage
+ a set of functionality provided by a third party library. A sub
+ system is really a thin veneer of an <a href="turbine-patterns.html#adapter">
+ adapter</a> for an external tool like <a href="http://jakarta.apache.org/velocity">
+ Velocity</a>.
+ </definition>
+ </entry>
+
+ <entry>
+ <id>valve</id>
+ <name>
+ Valve
+ </name>
+ <definition>
+ A valve is responsible for a specific stage of processing in
+ a <a href="#pipeline">pipeline</a>. A valve's behaviour can range
+ from determining the target template from a request to providing
+ access to an underlying <a href="#security-model">Security Model</a>.
+ </definition>
+ </entry>
+
+ <entry>
+ <id>target</id>
+ <name>
+ Target
+ </name>
+ <definition>
+ The target is the entity that is used at the beginning of the
+ request processing cycle in Turbine.
+ </definition>
+ </entry>
+
+ <entry>
+ <id>view-system</id>
+ <name>
+ View System
+ </name>
+ <definition>
+ A View System is Sub System that is responsible for providing
+ access to a rendering system like Velocity.
+ </definition>
+ </entry>
+ </entries>
+ </glossary>
+</body>
</document>
1.2 +7 -1 jakarta-turbine-3/xdocs/index.xml
Index: index.xml
===================================================================
RCS file: /home/cvs/jakarta-turbine-3/xdocs/index.xml,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- index.xml 18 Jan 2002 13:28:31 -0000 1.1
+++ index.xml 10 Feb 2002 03:26:23 -0000 1.2
@@ -3,6 +3,7 @@
<properties>
<author email="mpoeschl@marmot.at">Martin Poeschl</author>
+ <author email="jason@zenplex.com">Jason van Zyl</author>
<title>Jakarta Turbine</title>
</properties>
@@ -19,7 +20,12 @@
but the TDK is evolving to include migration tools which should
make the process relatively painless.
</p>
-
+
+ <p>
+ The documentation will slowly come into form over the next few
+ weeks so please be patient.
+ </p>
+
</section>
</body>
1.3 +5 -1 jakarta-turbine-3/xdocs/project.xml
Index: project.xml
===================================================================
RCS file: /home/cvs/jakarta-turbine-3/xdocs/project.xml,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- project.xml 9 Feb 2002 18:46:26 -0000 1.2
+++ project.xml 10 Feb 2002 03:26:23 -0000 1.3
@@ -5,10 +5,14 @@
<logo href="/images/logo.gif">Turbine</logo>
<body>
- <menu name="Torque">
+ <menu name="Turbine">
<item name="Overview" href="/index.html"/>
<item name="Changes" href="/changes.html"/>
<item name="Testing" href="/core-testing.html"/>
+ </menu>
+ <menu name="Development Docs">
+ <item name="Pipeline" href="/pipeline.html"/>
+ <item name="Glossary" href="/glossary.html"/>
</menu>
</body>
</project>
1.3 +59 -16 jakarta-turbine-3/xdocs/stylesheets/site.dvsl
Index: site.dvsl
===================================================================
RCS file: /home/cvs/jakarta-turbine-3/xdocs/stylesheets/site.dvsl,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- site.dvsl 9 Feb 2002 18:46:26 -0000 1.2
+++ site.dvsl 10 Feb 2002 03:26:23 -0000 1.3
@@ -13,23 +13,27 @@
#match( "document" )
- #set( $project = $node.selectSingleNode("document('xdocs/project.xml')/project" ) )
+ #set( $project = $node.selectSingleNode("document('xdocs/project.xml')/project" ) )
- <html>
+ <html>
<head>
<title>$project.title - $node.properties.title</title>
- #foreach( $n in $node.properties.selectNodes("author") )
+ #foreach( $n in $node.properties.selectNodes("author") )
<meta name="author" value="$n"/>
<meta name="email" value="$n.attribute("email")" />
- #end
+ #end
</head>
- <body bgcolor="$body-bg" text="$body-fg" link="$body-link"
- alink="$body-link" vlink="$body-link">
+ <body
+ bgcolor="$body-bg"
+ text="$body-fg"
+ link="$body-link"
+ alink="$body-link"
+ vlink="$body-link">
- <table border="0" width="100%" cellspacing="4">
+ <table border="0" width="100%" cellspacing="4">
## PAGE HEADER
<tr><td colspan="2">
@@ -71,6 +75,7 @@
<!-- RIGHT SIDE MAIN BODY -->
<td width="80%" valign="top" align="left">
$context.applyTemplates("body/section")
+ $context.applyTemplates("body/glossary")
</td>
</tr>
@@ -217,10 +222,20 @@
#set ($colspan = $attrib.colspan)
#set ($rowspan = $attrib.rowspan)
-<td bgcolor="$table-td-bg" colspan="$!colspan" rowspan="$!rowspan" valign="top" align="left">
- <font color="#000000" size="-1" face="arial,helvetica,sanserif">
- $node.copy( $node.children() )
- </font>
+<td
+ bgcolor="$table-td-bg"
+ colspan="$!colspan"
+ rowspan="$!rowspan"
+ valign="top"
+ align="left">
+
+ <font
+ color="#000000"
+ size="-1"
+ face="arial,helvetica,sanserif">
+
+ $node.copy( $node.children() )
+ </font>
</td>
#end
@@ -229,14 +244,42 @@
#set ($colspan = $attrib.colspan )
#set ($rowspan = $attrib.rowspan )
-<td bgcolor="$table-th-bg" colspan="$!colspan" rowspan="$!rowspan" valign="top" align="left">
- <font color="#000000" size="-1" face="arial,helvetica,sanserif">
- $node.copy( $node.children())
- </font>
+<td
+ bgcolor="$table-th-bg"
+ colspan="$!colspan"
+ rowspan="$!rowspan"
+ valign="top"
+ align="left">
+
+ <font
+ color="#000000"
+ size="-1"
+ face="arial,helvetica,sanserif">
+
+ $node.copy( $node.children())
+ </font>
</td>
#end
+## -----------------------------------------------------
+## G L O S S A R Y
+## -----------------------------------------------------
+
+#match ( "glossary" )
+ $context.applyTemplates("entries/entry")
+#end
+
+#match ("entry")
+ <b>$context.node.name</b>
+ <br/>
+ $context.node.definition
+ <p/>
+#end
+
+## -----------------------------------------------------
+## D E F A U L T C O P Y
+## -----------------------------------------------------
+
#match("*")
$node.copy()
#end
-
--
To unsubscribe, e-mail: <ma...@jakarta.apache.org>
For additional commands, e-mail: <ma...@jakarta.apache.org>