mcconnell 2003/10/01 20:13:16
Modified: merlin/platform/xdocs/meta/block index.xml
merlin/platform/xdocs/meta/block/services index.xml
navigation.xml service.xml
Log:
Add documetation on the services block tag.
Revision Changes Path
1.2 +1 -1 avalon/merlin/platform/xdocs/meta/block/index.xml
Index: index.xml
===================================================================
RCS file: /home/cvs/avalon/merlin/platform/xdocs/meta/block/index.xml,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- index.xml 24 Sep 2003 09:34:45 -0000 1.1
+++ index.xml 2 Oct 2003 03:13:16 -0000 1.2
@@ -66,7 +66,7 @@
<table>
<tr><th>Element</th><th>Occurance</th><th>Description</th></tr>
<tr>
- <td><a href="services/index.html">services</a></td><td>0..n</td>
+ <td><a href="services/index.html">services</a></td><td>0..1</td>
<td>
A container can declare the export of a set of services established
by the components contained within it. This enables a container to
1.2 +66 -3 avalon/merlin/platform/xdocs/meta/block/services/index.xml
Index: index.xml
===================================================================
RCS file: /home/cvs/avalon/merlin/platform/xdocs/meta/block/services/index.xml,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- index.xml 24 Sep 2003 09:35:04 -0000 1.1
+++ index.xml 2 Oct 2003 03:13:16 -0000 1.2
@@ -59,14 +59,77 @@
<body>
<section name="Block Service Export">
- <p>In preparation.</p>
+
+ <subsection name="Nested Elements">
+
+ <table>
+ <tr><th>Element</th><th>Occurance</th><th>Description</th></tr>
+ <tr>
+ <td><a href="service.html">service</a></td><td>0..n</td>
+ <td>
+ Publication of a service exported by the block.
+ </td>
+ </tr>
+ </table>
+ </subsection>
+
+ <subsection name="Description">
+ <p>
+ Declaration of the set of services the a block exports. Collectively
+ the service set represent the services that that block provides in its role
+ as a composite component.
+ </p>
+ </subsection>
+
+ <subsection name="Sample XML">
+ <p>
+ The following XML is a sample of a service export declaration within
+ a sample block defintion.
+ </p>
+
+<source><![CDATA[
+ <!-- block implementation declaration -->
+<container name="locator">
+
+ <!-- declaration of one or more services and the underling provider -->
+
+ <services>
+ <service type="tutorial.location.LocationService">
+ <source>info</source>
+ </service>
+ </services>
+
+ <classloader>
+ <classpath>
+ <repository>
+ <resource id="avalon-framework:avalon-framework-api" version="4.1.5"/>
+ <resource id="avalon-framework:avalon-framework-impl" version="4.1.5"/>
+ <resource id="merlin-tutorial:locator-api" version="1.0"/>
+ <resource id="merlin-tutorial:locator-impl" version="1.0"/>
+ </repository>
+ </classpath>
+ </classloader>
+
+ <!-- the service provider component -->
+
+ <component name="info"
+ class="tutorial.location.LocationComponent">
+ <configuration>
+ <source>Paris</source>
+ </configuration>
+ </component>
+
+</container>
+]]></source>
+ </subsection>
</section>
+
</body>
<footer>
<legal>
- Copyright (c) @year@ The Jakarta Apache Project All rights reserved.
+ Copyright (c) @year@ The Avalon Apache Project All rights reserved.
$Revision$ $Date$
</legal>
</footer>
1.3 +1 -1 avalon/merlin/platform/xdocs/meta/block/services/navigation.xml
Index: navigation.xml
===================================================================
RCS file: /home/cvs/avalon/merlin/platform/xdocs/meta/block/services/navigation.xml,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- navigation.xml 1 Oct 2003 10:03:09 -0000 1.2
+++ navigation.xml 2 Oct 2003 03:13:16 -0000 1.3
@@ -70,7 +70,7 @@
<item name="kernel.xml" href="/meta/kernel/index.html"/>
<item name="block.xml" href="/meta/block/index.html">
<item name="services" href="/meta/block/services/index.html">
- <item name="services" href="/meta/block/services/service.html"/>
+ <item name="service" href="/meta/block/services/service.html"/>
</item>
<item name="classloader" href="/meta/block/classloader/index.html"/>
<item name="component" href="/meta/block/components/index.html"/>
1.2 +52 -3 avalon/merlin/platform/xdocs/meta/block/services/service.xml
Index: service.xml
===================================================================
RCS file: /home/cvs/avalon/merlin/platform/xdocs/meta/block/services/service.xml,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- service.xml 24 Sep 2003 09:35:05 -0000 1.1
+++ service.xml 2 Oct 2003 03:13:16 -0000 1.2
@@ -60,14 +60,63 @@
<body>
<section name="Block Service Export">
- <p>In preparation.</p>
+ <subsection name="Attributes">
+
+ <table>
+ <tr><th>Attribute</th><th>Required</th><th>Description</th></tr>
+ <tr>
+ <td>type</td><td>yes</td>
+ <td>
+ The classname of the service exported. The value must
+ be an interface.
+ </td>
+ </tr>
+ </table>
+ </subsection>
+
+ <subsection name="Nested Elements">
+ <table>
+ <tr><th>Element</th><th>Cardinality</th><th>Description</th></tr>
+ <tr>
+ <td>source</td><td>1</td>
+ <td>
+ Declaration of the relative address of the component that
+ shall be used to fulfil the service.
+ </td>
+ </tr>
+ </table>
+ </subsection>
+
+ <subsection name="Description">
+<p>Declaration of an exported service and the association to an implementation
component.</p>
+ </subsection>
+
+ <subsection name="Sample XML">
+
+<source><![CDATA[
+ <!-- locally source reference -->
+
+ <service type="tutorial.location.LocationService">
+ <source>info</source>
+ </service>
+
+ <!-- nested source reference to component named xyz
+ in the subcontainer aaa -->
+
+ <service type="tutorial.location.LocationService">
+ <source>aaaa/xyz</source>
+ </service>
+]]></source>
+
+ </subsection>
+
</section>
</body>
<footer>
<legal>
- Copyright (c) @year@ The Jakarta Apache Project All rights reserved.
+ Copyright (c) @year@ The Avalon Apache Project All rights reserved.
$Revision$ $Date$
</legal>
</footer>
---------------------------------------------------------------------
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]
