mcconnell 2003/04/02 09:13:27
Modified: merlin/merlin-smp/xdocs/merlin index.xml
merlin/merlin-smp/xdocs/meta/model index.xml
merlin/merlin-smp/xdocs/meta/model/profile index.xml
merlin/merlin-smp/xdocs/starting index.xml
merlin/merlin-smp/xdocs/starting/advanced index.xml
merlin/merlin-smp/xdocs/starting/hello index.xml
Log:
Documentation updates.
Revision Changes Path
1.2 +2 -10 avalon-sandbox/merlin/merlin-smp/xdocs/merlin/index.xml
Index: index.xml
===================================================================
RCS file: /home/cvs/avalon-sandbox/merlin/merlin-smp/xdocs/merlin/index.xml,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- index.xml 2 Apr 2003 15:51:56 -0000 1.1
+++ index.xml 2 Apr 2003 17:13:27 -0000 1.2
@@ -14,20 +14,12 @@
<table>
<tr><th>Topic</th><th>Summary</th></tr>
<tr>
- <td><a href="kernel.html">The Kernel</a></td>
+ <td><a href="kernel.html">The Merlin Kernel</a></td>
<td>A quick introduction to the Merlin Kernel. The kernel is core
controller of the platform and is responsible for the deployment of root block
hierachy, and subsequent block decommissioning.</td>
</tr>
<tr>
- <td><a href="blocks.html">Introducing Blocks</a></td>
+ <td><a href="blocks.html">About Blocks</a></td>
<td>A overview of the block concept including a description of the
concerns addressed by the block architecture.</td>
- </tr>
- <tr>
- <td><a href="tutorial/index.html">Block Tutorial</a></td>
- <td>A block tutorial that takes you though the main concepts related to
block defintion, specification of a block implementation, notions of service export,
subsidiary block management, and block packaging.</td>
- </tr>
- <tr>
- <td><a href="reference/index.html">Reference Specifications</a></td>
- <td>Formal specificaton of kernel and block structures.</td>
</tr>
</table>
</section>
1.2 +31 -83 avalon-sandbox/merlin/merlin-smp/xdocs/meta/model/index.xml
Index: index.xml
===================================================================
RCS file: /home/cvs/avalon-sandbox/merlin/merlin-smp/xdocs/meta/model/index.xml,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- index.xml 2 Apr 2003 15:52:09 -0000 1.1
+++ index.xml 2 Apr 2003 17:13:27 -0000 1.2
@@ -10,89 +10,37 @@
</header>
<body>
-
- <section name="Profile">
-
-<p>A profile is the definition of the criteria for the establishment of a
component. A profile, when included within the scope of a container declaration, will
be instantiated in the model as an EXPLICIT profile resulting in the initiation of
dependency resolution relative to the component as the target deployment objective.
Multiple supplementary profiles may be packaged in a files <classname>.xprofile.
Profile declarations included within an .xprofile resource are refered to as packaged
profiles.</p>
-
-<p>A profile represents an aggregation of the following information:</p>
-<ul>
-<li>the component Type that the profile is qualifying</li>
-<li>a logging directive within which multiple logging categories declare the
priority and target to set for a logging channel</li>
-<li>a context directive that contains:
- <ul>
- <li>import directives the declare to a container that the component expects the
host container to supply the context entry</li>
- <li>context creation directives then enable the declarative specification of
the criteria for the creation of a context value using constructor parameters</li>
- </ul>
-</li>
-<li>the configuration to be used</li>
-<li>the parameters to be applied</li>
-</ul>
-
-<subsection name="UML">
-<p>An overview of the Profile object model is presented in the following UML
diagram.</p>
-<img src="./../../images/Profile.gif" />
-</subsection>
-
-<subsection name="XML">
-<p>The Profile API includes factory services that support the creation of a profile
instance from an XML description. The following XML is an example of a profile
declaration.</p>
-
-<source>
-
- <font color="gray"><i><!--
- Declaration of the services hosted by this container. Service container here
- will be managed relative to other provider components at the same level and
- may be serviced by components declared in parent container.
- --></i></font>
-
- <profile name="<font color="darkred">complex</font>" class="<font
color="darkred">org.apache.excalibur.playground.ComplexComponent</font>"
- activation="<font color="darkred">startup</font>">
-
-
- <font color="gray"><i><!--
- Priority and target assignments for component specific logging categrories.
- --></i></font>
-
- <categories priority="<font color="darkred">DEBUG</font>">
- <category name="<font color="darkred">init</font>" priority="<font
color="darkred">DEBUG</font>" />
- </categories>
-
- <font color="gray"><i><!--
- Include the following context value in the context supplied a component using
this
- profile. Context entries are normally only required in the case where the
component
- type declares a required context type and entry values. Generally speaking, a
component
- will normally qualify it's instantiation criteria through a configuration
declaration.
- Any context values defined at this level will override context values supplied
by the
- container.
- --></i></font>
-
- <context>
- <entry name="<font color="darkred">location</font>"><font
color="darkred">Paris</font>"</entry>
- </context>
-
- <font color="gray"><i><!--
- Apply the following configuration when instantiating the component. This
configuration
- will be applied as the primary configuration in a cascading configuration
chain. A
- type may declare a default configuration under a "classname".xconfig file that
will be
- used to dereference any configuration requests not resolvable by the
configuration
- supplied here.
- --></i></font>
-
- <configuration>
- <message value="<font color="darkred">Hello</font>"/>
- </configuration>
-
- <font color="gray"><i><!--
- The parameterization criteria from this instance of the component type.
- --></i></font>
-
- <parameters/>
-
-</profile>
-
-</source>
-</subsection>
-</section>
+ <section name="Meta Data">
+ <subsection name="Overview">
+ <p>
+ Meta data is the information used by the Merlin system to instantiate
+ system and client aspects to achieve a particular application objective.
+ Meta data is often refered to here under the term 'directive'. This
+ reflects the role of meta-data - information that directs the behaviour
+ of the system. This is in contract with meta-info which more typically
+ establish the requirements.
+ </p>
+ </subsection>
+ <subsection name="Index">
+ <table>
+ <tr><th>Topic</th><th>Summary</th></tr>
+ <tr>
+ <td><a href="kernel/index.html">Kernel Meta Data</a></td>
+ <td>The meta data directives used to establish the Merlin Kernel.</td>
+ </tr>
+ <tr>
+ <td><a href="block/index.html">Block Meta Data</a></td>
+ <td>The meta data directives used to establish a block and the
+ container hierachy and nested component.</td>
+ </tr>
+ <tr>
+ <td><a href="block/index.html">Profile Meta Data</a></td>
+ <td>The meta data directives used to establish component deployment
+ directives.</td>
+ </tr>
+ </table>
+ </subsection>
+ </section>
</body>
</document>
1.2 +8 -0
avalon-sandbox/merlin/merlin-smp/xdocs/meta/model/profile/index.xml
Index: index.xml
===================================================================
RCS file:
/home/cvs/avalon-sandbox/merlin/merlin-smp/xdocs/meta/model/profile/index.xml,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- index.xml 2 Apr 2003 15:52:13 -0000 1.1
+++ index.xml 2 Apr 2003 17:13:27 -0000 1.2
@@ -12,6 +12,14 @@
<body>
<section name="Profile Directive">
+ <subsection name="UML">
+ <p>
+ An overview of the Profile object model is presented in the
+ following UML diagram.
+ </p>
+ <img src="../../../images/Profile.gif" />
+ </subsection>
+
<subsection name="Specification">
<p>
1.2 +6 -2 avalon-sandbox/merlin/merlin-smp/xdocs/starting/index.xml
Index: index.xml
===================================================================
RCS file: /home/cvs/avalon-sandbox/merlin/merlin-smp/xdocs/starting/index.xml,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- index.xml 2 Apr 2003 15:52:15 -0000 1.1
+++ index.xml 2 Apr 2003 17:13:27 -0000 1.2
@@ -13,11 +13,15 @@
<tr><th>Topic</th><th>Summary</th></tr>
<tr>
<td><a href="installation.html">Installation</a></td>
- <td>Installation instructions including build and verification of your
installation.</td>
+ <td>Installation instructions including build and verification
procedures.</td>
</tr>
<tr>
<td><a href="hello/index.html">Using Merlin.</a></td>
- <td>A short introduction to using Merlin based on a Hello Block example
that takes your though the defintion of a block and subsequent deployment.</td>
+ <td>A short introduction to using Merlin based on a Hello Block example
that takes your though the defintion of a block, subsequent deployment, and general
aspects concerning configuration, contextualization, service publication, and service
dependency management.</td>
+ </tr>
+ <tr>
+ <td><a href="hello/index.html">Advanced Features.</a></td>
+ <td>Advanced Merlin features covering aspects related to component
default configurations, deployment templates (profiles), using profile selectors,
import blocks, exporting services, custom appliance handlers and blocks, and custom
contextualization possibilities.</td>
</tr>
</table>
</section>
1.2 +43 -9
avalon-sandbox/merlin/merlin-smp/xdocs/starting/advanced/index.xml
Index: index.xml
===================================================================
RCS file:
/home/cvs/avalon-sandbox/merlin/merlin-smp/xdocs/starting/advanced/index.xml,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- index.xml 2 Apr 2003 15:52:16 -0000 1.1
+++ index.xml 2 Apr 2003 17:13:27 -0000 1.2
@@ -1,20 +1,54 @@
<?xml version="1.0"?>
<document>
-
- <properties>
- <author email="[EMAIL PROTECTED]">Stephen McConnell</author>
- <title>Advanced Features</title>
- </properties>
-
+ <header>
+ <title>Using Merlin</title>
+ <authors>
+ <person name="Stephen McConnell" email="[EMAIL PROTECTED]"/>
+ </authors>
+ </header>
<body>
-
<section name="Advanced Features">
- <p>In preparation.</p>
+ <table>
+ <tr><th>Topic</th><th>Summary</th></tr>
+ <tr>
+ <td><a href="defaults.html">Default Configurations</a></td>
+ <td>Association of a default configuration with a component.</td>
+ </tr>
+ <tr>
+ <td><a href="profiles.html">Deployment Templates</a></td>
+ <td>Creating and associating a deployment template with a
component.</td>
+ </tr>
+ <tr>
+ <td><a href="selectors.html">Profile Selectors</a></td>
+ <td>Using profile selectors to influence and/or override the assembly
process.</td>
+ </tr>
+ <tr>
+ <td><a href="import.html">Importing Blocks</a></td>
+ <td>Example of block composition via import statements.</td>
+ </tr>
+ <tr>
+ <td><a href="export.html">Exporting Services</a></td>
+ <td>Using block level service export statements to isolate a block
implementation from the services it provides.</td>
+ </tr>
+ <tr>
+ <td><a href="context.html">Creating Contextualizers</a></td>
+ <td>Defining a custom contextualization handler and assigning the
handler to your component.</td>
+ </tr>
+ <tr>
+ <td><a href="appliance.html">Using a custom Appliance</a></td>
+ <td>Overview of the cases where a custom appliance can help in
supporting non-classic component models.</td>
+ </tr>
+ <tr>
+ <td><a href="block.html">Using a custom Block</a></td>
+ <td>Overview of the cases where a custom block can help in supporting
non-classic containment solutions.</td>
+ </tr>
+ </table>
</section>
-
</body>
</document>
+
+
1.2 +19 -3 avalon-sandbox/merlin/merlin-smp/xdocs/starting/hello/index.xml
Index: index.xml
===================================================================
RCS file: /home/cvs/avalon-sandbox/merlin/merlin-smp/xdocs/starting/hello/index.xml,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- index.xml 2 Apr 2003 15:52:17 -0000 1.1
+++ index.xml 2 Apr 2003 17:13:27 -0000 1.2
@@ -12,16 +12,32 @@
<table>
<tr><th>Topic</th><th>Summary</th></tr>
<tr>
- <td><a href="creation.html">Hello Block.</a></td>
+ <td><a href="creation.html">Hello Block</a></td>
<td>A simple demonstration of a block defintion.</td>
</tr>
<tr>
- <td><a href="execution.html">Running the block.</a></td>
+ <td><a href="execution.html">Running the block</a></td>
<td>Executing the block from the filestem or as a jar file.</td>
</tr>
<tr>
- <td><a href="internal.html">Behind the Scenes.</a></td>
+ <td><a href="internal.html">Behind the Scenes</a></td>
<td>A review of whats happening behind the scenes when we deploy out
component.</td>
+ </tr>
+ <tr>
+ <td><a href="config.html">Managing Configurations</a></td>
+ <td>Extending HelloComponent to support configuration together with a
guide to declararing configurations in a block.</td>
+ </tr>
+ <tr>
+ <td><a href="context.html">Managing Contextulization</a></td>
+ <td>Extending HelloComponent to receive a runtime context and using
context directives to supply custom context entries to a component.</td>
+ </tr>
+ <tr>
+ <td><a href="dependencies.html">Managing Dependencies</a></td>
+ <td>Addition of a dependency to HelloComponent and the corresponding
declarations in the component type descriptor.</td>
+ </tr>
+ <tr>
+ <td><a href="services.html">Publishing Services</a></td>
+ <td>Extending HelloComponent to expose a service and the respective
type declarations.</td>
</tr>
</table>
</section>
---------------------------------------------------------------------
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]
