notify-dpml AT lists.ibiblio.org

Subject: DPML Notify

List archive

r1024 - trunk/main/central/src/docs/metro/tasks/components

From: mcconnell at BerliOS <mcconnell AT mail.berlios.de>
To: notify-dpml AT lists.ibiblio.org
Subject: r1024 - trunk/main/central/src/docs/metro/tasks/components
Date: Sat, 4 Feb 2006 20:11:45 +0100

Author: mcconnell
Date: 2006-02-04 20:11:42 +0100 (Sat, 04 Feb 2006)
New Revision: 1024

Added:
trunk/main/central/src/docs/metro/tasks/components/parts.xml
Modified:
trunk/main/central/src/docs/metro/tasks/components/index.xml
trunk/main/central/src/docs/metro/tasks/components/navigation.xml
Log:
add documentation concerning the declaration of internal parts (at component
definition level)

Modified: trunk/main/central/src/docs/metro/tasks/components/index.xml
===================================================================
--- trunk/main/central/src/docs/metro/tasks/components/index.xml
2006-02-04 18:54:03 UTC (rev 1023)
+++ trunk/main/central/src/docs/metro/tasks/components/index.xml
2006-02-04 19:11:42 UTC (rev 1024)
@@ -110,6 +110,10 @@
<td><tt><a href="context/index.html">context</a></tt></td>
<td>Declaration of the component initial context state.</td>
</tr>
+ <tr>
+ <td><tt><a href="parts.html">parts</a></tt></td>
+ <td>Declaration of the nested componets.</td>
+ </tr>
</table>

</subsection>

Modified: trunk/main/central/src/docs/metro/tasks/components/navigation.xml
===================================================================
--- trunk/main/central/src/docs/metro/tasks/components/navigation.xml
2006-02-04 18:54:03 UTC (rev 1023)
+++ trunk/main/central/src/docs/metro/tasks/components/navigation.xml
2006-02-04 19:11:42 UTC (rev 1024)
@@ -29,6 +29,7 @@
<item name="Configuration" href="configuration.html"/>
<item name="Parameters" href="parameters.html"/>
<item name="Context" href="context/index.html"/>
+ <item name="Parts" href="parts.html"/>
</menu>

</body>

Added: trunk/main/central/src/docs/metro/tasks/components/parts.xml
===================================================================
--- trunk/main/central/src/docs/metro/tasks/components/parts.xml
2006-02-04 18:54:03 UTC (rev 1023)
+++ trunk/main/central/src/docs/metro/tasks/components/parts.xml
2006-02-04 19:11:42 UTC (rev 1024)
@@ -0,0 +1,91 @@
+<?xml version="1.0" encoding="UTF-8"?>
+
+<document>
+
+ <properties>
+ <author email="mcconnell AT dpml.net">Stephen McConnell</author>
+ <title>DPML Metro Component Categories Datatype</title>
+ </properties>
+
+ <body>
+
+ <section name="Parts">
+
+ <subsection name="Description">
+
+ <p>
+ A <tt><parts></tt> elements enables the declaration of
+ 0..n nested components.
+ </p>
+
+ </subsection>
+
+ <subsection name="Part Nested Elements">
+
+ <table>
+ <tr>
+ <td><a href="index.html"><tt>component</tt></a></td>
+ <td><tt>0..n</tt> nested components.</td>
+ </tr>
+ </table>
+
+ </subsection>
+
+ </section>
+
+ <section name="Example">
+
+ <p>
+ The following component definition has a parts element containing
+ two nested component definitions. The top-level component is defining
+ a HTTP server. The two internal parts are HTTP context handlers. The
+ first component is a static content handler presenting the contents of
+ DPML documents under the context <tt>/docs</tt>. The second component
+ is establishing a servlet to handle requests for the context <tt>/</tt>
+ relative to the resource base directory
<tt>${dpml.data}/temp/http/context</tt>.
+ </p>
+
+<pre><![CDATA[
+ <component xmlns="metro" type="net.dpml.web.server.Server"
lifestyle="singleton">
+ <parts>
+ <component key="context" type="net.dpml.web.server.ContextHandler">
+ <context>
+ <entry key="server" validate="false"/>
+ <entry key="resourceBase" value="${dpml.share}/docs"/>
+ <entry key="contextPath" value="/docs"/>
+ <entry key="handler" class="net.dpml.web.server.ResourceHandler">
+ <value value="resources"/>
+ <value value="/"/>
+ </entry>
+ </context>
+ </component>
+ <component key="servlets" type="net.dpml.web.server.ContextHandler">
+ <context>
+ <entry key="server" validate="false"/>
+ <entry key="resourceBase"
value="${dpml.data}/temp/http/context"/>
+ <entry key="contextPath" value="/"/>
+ <entry key="handler" class="net.dpml.web.server.ServletHandler">
+ <array class="net.dpml.web.server.ServletHolder">
+ <value class="net.dpml.web.server.ServletHolder">
+ <value value="hello"/>
+ <value value="org.mortbay.jetty.servlet.DefaultServlet"/>
+ </value>
+ </array>
+ <array class="net.dpml.web.server.ServletMapping">
+ <value class="net.dpml.web.server.ServletMapping">
+ <value value="hello"/>
+ <value value="/"/>
+ </value>
+ </array>
+ </entry>
+ </context>
+ </component>
+ </parts>
+ </component>
+]]></pre>
+
+ </section>
+
+ </body>
+
+</document>

r1024 - trunk/main/central/src/docs/metro/tasks/components, mcconnell at BerliOS, 02/04/2006