notify-dpml AT lists.ibiblio.org

Subject: DPML Notify

List archive

r1982 - in trunk/central/site/src/docs/metro: component/directive parts

From: mcconnell at BerliOS <mcconnell AT mail.berlios.de>
To: notify-dpml AT lists.ibiblio.org
Subject: r1982 - in trunk/central/site/src/docs/metro: component/directive parts
Date: Mon, 23 Apr 2007 18:24:11 +0200

Author: mcconnell
Date: 2007-04-23 18:24:11 +0200 (Mon, 23 Apr 2007)
New Revision: 1982

Added:
trunk/central/site/src/docs/metro/component/directive/part.xml
Modified:
trunk/central/site/src/docs/metro/component/directive/navigation.xml
trunk/central/site/src/docs/metro/component/directive/parts.xml
trunk/central/site/src/docs/metro/parts/index.xml
Log:
Add documentation concerning <part> as a mechanisms to include a part by
reference.

Modified: trunk/central/site/src/docs/metro/component/directive/navigation.xml
===================================================================
--- trunk/central/site/src/docs/metro/component/directive/navigation.xml
2007-04-23 16:22:39 UTC (rev 1981)
+++ trunk/central/site/src/docs/metro/component/directive/navigation.xml
2007-04-23 16:24:11 UTC (rev 1982)
@@ -32,6 +32,7 @@
<item name="Entry" href="entry.html"/>
<item name="Param" href="value.html"/>
<item name="Parts" href="parts.html"/>
+ <item name="Part" href="part.html"/>
</menu>

</body>

Added: trunk/central/site/src/docs/metro/component/directive/part.xml
===================================================================
--- trunk/central/site/src/docs/metro/component/directive/part.xml
2007-04-23 16:22:39 UTC (rev 1981)
+++ trunk/central/site/src/docs/metro/component/directive/part.xml
2007-04-23 16:24:11 UTC (rev 1982)
@@ -0,0 +1,74 @@
+<?xml version="1.0" encoding="UTF-8"?>
+
+<document>
+
+ <properties>
+ <author email="mcconnell AT dpml.net">Stephen McConnell</author>
+ <title>DPML Metro: Parts Directive</title>
+ </properties>
+
+ <body>
+
+ <section name="Part Reference Directive">
+
+ <subsection name="Description">
+
+ <p>
+ A <tt><part></tt> elements enables the declaration of a single
+ nested component via specification of a part uri. During
construction
+ of a component, a classloader chain will be constructured using the
enclosing
+ classloader as an anchor and a chain definition based on the
supplied part
+ classpath definition.
+ </p>
+
+ </subsection>
+
+ <subsection name="Element Attributes">
+ <table>
+ <tr>
+ <td><tt>key</tt></td>
+ <td>A required key identifying the nested part.</td>
+ </tr>
+ <tr>
+ <td><tt>uri</tt></td>
+ <td>A required artifact uri resolvable to a part
datastructure.</td>
+ </tr>
+ </table>
+ </subsection>
+
+ <subsection name="Nested Elements">
+
+ <table>
+ <tr>
+ <td><tt>param</tt></td>
+ <td><tt>0..n</tt> a key/value binding used to construct a uri
query argument.</td>
+ </tr>
+ </table>
+
+ </subsection>
+
+ </section>
+
+ <section name="Example">
+
+ <p>
+ The following XML fragment demonstrates a component directive
containing a single
+ nested part reference. The example demonstrates the declaration of a
context entry
+ query qualifier using a nested param value.
+ </p>
+
+<pre>
+ <component xmlns="dpml:metro" name="demo" class="org.acme.Demo">
+ <parts>
+ <font color="darkred"><part key="widget"
uri="link:part:org/acme/org-acme-widget">
+ <param key="message" value="Hello"/>
+ </part></font>
+ </parts>
+ </component>
+</pre>
+
+ </section>
+
+ </body>
+
+</document>

Modified: trunk/central/site/src/docs/metro/component/directive/parts.xml
===================================================================
--- trunk/central/site/src/docs/metro/component/directive/parts.xml
2007-04-23 16:22:39 UTC (rev 1981)
+++ trunk/central/site/src/docs/metro/component/directive/parts.xml
2007-04-23 16:24:11 UTC (rev 1982)
@@ -27,6 +27,10 @@
<td><a href="component.html"><tt>component</tt></a></td>
<td><tt>0..n</tt> nested components.</td>
</tr>
+ <tr>
+ <td><a href="part.html"><tt>part</tt></a></td>
+ <td><tt>0..n</tt> nested components references.</td>
+ </tr>
</table>

</subsection>

Modified: trunk/central/site/src/docs/metro/parts/index.xml
===================================================================
--- trunk/central/site/src/docs/metro/parts/index.xml 2007-04-23 16:22:39
UTC (rev 1981)
+++ trunk/central/site/src/docs/metro/parts/index.xml 2007-04-23 16:24:11
UTC (rev 1982)
@@ -82,13 +82,11 @@
by the part content handler. If the qualfied element name is
recognized
an internal handler is assigned, otherwise value of the
<tt>handler</tt>
attribute is used to resolve a uri identifying a strategy
plugin.
- The Metro system provides three recognized strategy element
handlers -
- <tt><plugin></tt> and <tt><resource></tt> and
- <tt><component></tt>. The <tt><plugin></tt>
strategy is a
- simple object deployment handler suitable for low-level
facilities, the
+ The Metro system provides two bundled strategy element
handlers -
+ <tt><component></tt> and <tt><resource></tt>. The
<tt><resource></tt> handler provides support for Antlib
loading, and
- the <tt><component></tt> strategy is the standard
component deployment
- framework.
+ the <tt><component></tt> strategy details the standard
Metro component
+ deployment model.
</td>
</tr>
<tr>

r1982 - in trunk/central/site/src/docs/metro: component/directive parts, mcconnell at BerliOS, 04/23/2007