mcconnell 2003/06/15 10:43:24
Modified: merlin/merlin-platform/xdocs/meta/model/block info.xml
merlin/merlin-platform/xdocs/meta/model/block/container
index.xml navigation.xml
merlin/merlin-platform/xdocs/meta/model/block/container/components
navigation.xml
merlin/merlin-platform/xdocs/meta/model/block/container/components/categories
category.xml index.xml navigation.xml
merlin/merlin-platform/xdocs/meta/model/block/container/components/context
navigation.xml
merlin/merlin-platform/xdocs/meta/model/block/container/components/context/entry
navigation.xml
merlin/merlin-platform/xdocs/meta/model/block/container/components/parameters
navigation.xml
merlin/merlin-platform/xdocs/meta/model/block/container/engine
navigation.xml
merlin/merlin-platform/xdocs/meta/model/block/container/engine/classpath
navigation.xml
merlin/merlin-platform/xdocs/resources download.xml
notebook.xml roadmap.xml
merlin/merlin-platform/xdocs/starting/advanced/lifecycle
navigation.xml
merlin/merlin-platform/xdocs/starting/tutorial/config
block.xml configurable.xml defaults.xml
override.xml
Added: merlin/merlin-platform/xdocs/meta/model/block/container/include
index.xml navigation.xml resource.xml source.xml
merlin/merlin-platform/xdocs/meta/model/block/container/include/targets
index.xml navigation.xml target.xml
Log:
Document updating to include more detailed information of configuration and logging
categeory customization via target override defintions.
Revision Changes Path
1.2 +6 -2
avalon-sandbox/merlin/merlin-platform/xdocs/meta/model/block/info.xml
Index: info.xml
===================================================================
RCS file:
/home/cvs/avalon-sandbox/merlin/merlin-platform/xdocs/meta/model/block/info.xml,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- info.xml 10 Jun 2003 02:14:18 -0000 1.1
+++ info.xml 15 Jun 2003 17:43:23 -0000 1.2
@@ -17,7 +17,11 @@
<tr>
<td>name</td><td>1</td>
<td>
- Declaration of the block name.
+ Declaration of the block name. The block name is used
+ to construct partition names. A block acting as root is always
+ named "/" (the block delimiter character). Subsidiary blocks for
+ a partition path commencing with the root ("/") followed by the
+ block name.
</td>
</tr>
<tr>
1.2 +1 -1
avalon-sandbox/merlin/merlin-platform/xdocs/meta/model/block/container/index.xml
Index: index.xml
===================================================================
RCS file:
/home/cvs/avalon-sandbox/merlin/merlin-platform/xdocs/meta/model/block/container/index.xml,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- index.xml 10 Jun 2003 02:14:20 -0000 1.1
+++ index.xml 15 Jun 2003 17:43:23 -0000 1.2
@@ -55,7 +55,7 @@
</td>
</tr>
<tr>
- <td><a href="includes.html">include</a></td><td>0..n</td>
+ <td><a href="include/index.html">include</a></td><td>0..n</td>
<td>
An include directive instructs Merlin to include an external
block within the container. Services exported by the block will
1.2 +1 -1
avalon-sandbox/merlin/merlin-platform/xdocs/meta/model/block/container/navigation.xml
Index: navigation.xml
===================================================================
RCS file:
/home/cvs/avalon-sandbox/merlin/merlin-platform/xdocs/meta/model/block/container/navigation.xml,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- navigation.xml 10 Jun 2003 02:14:20 -0000 1.1
+++ navigation.xml 15 Jun 2003 17:43:23 -0000 1.2
@@ -28,7 +28,7 @@
<item name="Engine"
href="/meta/model/block/container/engine/index.html"/>
<item name="Component"
href="/meta/model/block/container/components/index.html"/>
<item name="Container"
href="/meta/model/block/container/containers.html"/>
- <item name="Include"
href="/meta/model/block/container/includes.html"/>
+ <item name="Include"
href="/meta/model/block/container/include/index.html"/>
</item>
</item>
</item>
1.2 +1 -1
avalon-sandbox/merlin/merlin-platform/xdocs/meta/model/block/container/components/navigation.xml
Index: navigation.xml
===================================================================
RCS file:
/home/cvs/avalon-sandbox/merlin/merlin-platform/xdocs/meta/model/block/container/components/navigation.xml,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- navigation.xml 10 Jun 2003 02:14:20 -0000 1.1
+++ navigation.xml 15 Jun 2003 17:43:23 -0000 1.2
@@ -39,7 +39,7 @@
</item>
<item name="Container"
href="/meta/model/block/container/containers.html"/>
- <item name="Include"
href="/meta/model/block/container/includes.html"/>
+ <item name="Include"
href="/meta/model/block/container/include/index.html"/>
</item>
</item>
</item>
1.2 +20 -0
avalon-sandbox/merlin/merlin-platform/xdocs/meta/model/block/container/components/categories/category.xml
Index: category.xml
===================================================================
RCS file:
/home/cvs/avalon-sandbox/merlin/merlin-platform/xdocs/meta/model/block/container/components/categories/category.xml,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- category.xml 10 Jun 2003 02:14:20 -0000 1.1
+++ category.xml 15 Jun 2003 17:43:23 -0000 1.2
@@ -12,6 +12,26 @@
<body>
<section name="Category Directive">
+ <subsection name="Attributes">
+
+ <table>
+ <tr><th>Attribute</th><th>Required</th><th>Description</th></tr>
+ <tr>
+ <td>priority</td><td>no</td>
+ <td>
+ The logging priority (one of INFO, WARN, ERROR, FATAL, DEBUG).
+ </td>
+ </tr>
+ <tr>
+ <td>target</td><td>no</td>
+ <td>
+ Named logging target.
+ </td>
+ </tr>
+ </table>
+
+ </subsection>
+
<subsection name="Description">
<p>The logging channel category directive.</p>
</subsection>
1.2 +25 -3
avalon-sandbox/merlin/merlin-platform/xdocs/meta/model/block/container/components/categories/index.xml
Index: index.xml
===================================================================
RCS file:
/home/cvs/avalon-sandbox/merlin/merlin-platform/xdocs/meta/model/block/container/components/categories/index.xml,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- index.xml 10 Jun 2003 02:14:20 -0000 1.1
+++ index.xml 15 Jun 2003 17:43:23 -0000 1.2
@@ -12,26 +12,48 @@
<body>
<section name="Categories Directive">
+ <subsection name="Attributes">
+
+ <table>
+ <tr><th>Attribute</th><th>Required</th><th>Description</th></tr>
+ <tr>
+ <td>priority</td><td>no</td>
+ <td>
+ The default logging priority (one of INFO, WARN, ERROR, FATAL,
DEBUG)
+ to assign to the component.
+ </td>
+ </tr>
+ <tr>
+ <td>target</td><td>no</td>
+ <td>
+ Named default logging target.
+ </td>
+ </tr>
+ </table>
+
+ </subsection>
+
<subsection name="Nested Elements">
<table>
<tr><th>Element</th><th>Cardinality</th><th>Description</th></tr>
<tr>
<td><a href="category.html">category</a></td><td>0..n</td>
- <td>Logging category directive.</td>
+ <td>Logging sub-category directive.</td>
</tr>
</table>
</subsection>
<subsection name="Description">
-<p>The logging channels used a component may be parameterized using a context
directive. The directive allows the declaration of multiple logging channel category
directives. Each category directive enables customization of the priority and target
of a particuar logging channel used by the component.</p>
+<p>The logging channels used by a component may be parameterized using a categories
directive. Each category with a categories directive enables customization of the
priority and targets of logging channels used by the component.</p>
</subsection>
<subsection name="Sample XML">
<source><![CDATA[
-<categories>
+<categories priority="WARN">
<category name="/sys" priority="INFO"/>
+ <category name="/sys/logging" priority="DEBUG"/>
</categories>
]]></source>
</subsection>
1.2 +1 -1
avalon-sandbox/merlin/merlin-platform/xdocs/meta/model/block/container/components/categories/navigation.xml
Index: navigation.xml
===================================================================
RCS file:
/home/cvs/avalon-sandbox/merlin/merlin-platform/xdocs/meta/model/block/container/components/categories/navigation.xml,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- navigation.xml 10 Jun 2003 02:14:21 -0000 1.1
+++ navigation.xml 15 Jun 2003 17:43:23 -0000 1.2
@@ -37,7 +37,7 @@
</item>
<item name="Container"
href="/meta/model/block/container/containers.html"/>
- <item name="Include"
href="/meta/model/block/container/includes.html"/>
+ <item name="Include"
href="/meta/model/block/container/include/index.html"/>
</item>
</item>
</item>
1.2 +1 -1
avalon-sandbox/merlin/merlin-platform/xdocs/meta/model/block/container/components/context/navigation.xml
Index: navigation.xml
===================================================================
RCS file:
/home/cvs/avalon-sandbox/merlin/merlin-platform/xdocs/meta/model/block/container/components/context/navigation.xml,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- navigation.xml 10 Jun 2003 02:14:21 -0000 1.1
+++ navigation.xml 15 Jun 2003 17:43:24 -0000 1.2
@@ -39,7 +39,7 @@
</item>
<item name="Container"
href="/meta/model/block/container/containers.html"/>
- <item name="Include"
href="/meta/model/block/container/includes.html"/>
+ <item name="Include"
href="/meta/model/block/container/include/index.html"/>
</item>
</item>
</item>
1.2 +1 -1
avalon-sandbox/merlin/merlin-platform/xdocs/meta/model/block/container/components/context/entry/navigation.xml
Index: navigation.xml
===================================================================
RCS file:
/home/cvs/avalon-sandbox/merlin/merlin-platform/xdocs/meta/model/block/container/components/context/entry/navigation.xml,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- navigation.xml 10 Jun 2003 02:14:22 -0000 1.1
+++ navigation.xml 15 Jun 2003 17:43:24 -0000 1.2
@@ -42,7 +42,7 @@
</item>
<item name="Container"
href="/meta/model/block/container/containers.html"/>
- <item name="Include"
href="/meta/model/block/container/includes.html"/>
+ <item name="Include"
href="/meta/model/block/container/include/index.html"/>
</item>
</item>
</item>
1.2 +1 -1
avalon-sandbox/merlin/merlin-platform/xdocs/meta/model/block/container/components/parameters/navigation.xml
Index: navigation.xml
===================================================================
RCS file:
/home/cvs/avalon-sandbox/merlin/merlin-platform/xdocs/meta/model/block/container/components/parameters/navigation.xml,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- navigation.xml 10 Jun 2003 02:14:22 -0000 1.1
+++ navigation.xml 15 Jun 2003 17:43:24 -0000 1.2
@@ -42,7 +42,7 @@
</item>
<item name="Container"
href="/meta/model/block/container/containers.html"/>
- <item name="Include"
href="/meta/model/block/container/includes.html"/>
+ <item name="Include"
href="/meta/model/block/container/include/index.html"/>
</item>
</item>
</item>
1.2 +1 -1
avalon-sandbox/merlin/merlin-platform/xdocs/meta/model/block/container/engine/navigation.xml
Index: navigation.xml
===================================================================
RCS file:
/home/cvs/avalon-sandbox/merlin/merlin-platform/xdocs/meta/model/block/container/engine/navigation.xml,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- navigation.xml 10 Jun 2003 02:14:23 -0000 1.1
+++ navigation.xml 15 Jun 2003 17:43:24 -0000 1.2
@@ -31,7 +31,7 @@
</item>
<item name="Component"
href="/meta/model/block/container/components/index.html"/>
<item name="Container"
href="/meta/model/block/container/containers.html"/>
- <item name="Include"
href="/meta/model/block/container/includes.html"/>
+ <item name="Include"
href="/meta/model/block/container/include/index.html"/>
</item>
</item>
</item>
1.2 +1 -1
avalon-sandbox/merlin/merlin-platform/xdocs/meta/model/block/container/engine/classpath/navigation.xml
Index: navigation.xml
===================================================================
RCS file:
/home/cvs/avalon-sandbox/merlin/merlin-platform/xdocs/meta/model/block/container/engine/classpath/navigation.xml,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- navigation.xml 10 Jun 2003 02:14:23 -0000 1.1
+++ navigation.xml 15 Jun 2003 17:43:24 -0000 1.2
@@ -34,7 +34,7 @@
</item>
<item name="Component"
href="/meta/model/block/container/components/index.html"/>
<item name="Container"
href="/meta/model/block/container/containers.html"/>
- <item name="Include"
href="/meta/model/block/container/includes.html"/>
+ <item name="Include"
href="/meta/model/block/container/include/index.html"/>
</item>
</item>
</item>
1.1
avalon-sandbox/merlin/merlin-platform/xdocs/meta/model/block/container/include/index.xml
Index: index.xml
===================================================================
<?xml version="1.0"?>
<document>
<header>
<title>Include Directive</title>
<authors>
<person name="Stephen McConnell" email="[EMAIL PROTECTED]"/>
</authors>
</header>
<body>
<section name="Include Directive">
<subsection name="Nested Elements">
<table>
<tr><th>Element</th><th>Occurance</th><th>Description</th></tr>
<tr>
<td><a href="source.html">source</a></td><td>0..1</td>
<td>
A block.xml source include directive.
</td>
</tr>
<tr>
<td><a href="resource.html">resource</a></td><td>0..1</td>
<td>
A repository references from which a block descriptor will be resolved.
</td>
</tr>
<tr>
<td><a href="targets/index.html">targets</a></td><td>0..1</td>
<td>
Configuration target overrride directive.
</td>
</tr>
</table>
<p>
NOTE: It is an error if the include directive does not contain one of
two possible include forms ("source" or "resource").
</p>
</subsection>
<subsection name="Attributes">
<table>
<tr><th>Attribute</th><th>Required</th><th>Description</th></tr>
<tr>
<td>name</td><td>yes</td>
<td>
A name to assign to the container created by the block include.
Will default to the name of the included block.
</td>
</tr>
</table>
</subsection>
<subsection name="Description">
<p>An include directive instructs Merlin to load and deploy the block defined within
the referenced jar file as a subcontainer within the enclosing container. The include
directive is equivalent to the nesting of a full block definition within another
block. Block includes enable composition of pre-packaged component based solutions as
the included block appears to other components as a regular component (exposing
services and dependecies, etc.).</p>
</subsection>
<subsection name="Sample XML">
<p>
The following example block.xml demonstrates the inclusion of three blocks within
another enclosing block. In this example, the common shared API (containing service
interfaces classes is declared in the containing block classloader).
</p>
<source><![CDATA[
<block>
<info>
<name>tutorial</name>
</info>
<implementation>
<engine>
<classpath>
<repository>
<resource id="tutorial:composition-api" version="1.0"/>
</repository>
</classpath>
</engine>
<include name="publisher">
<resource id="tutorial:composition-publisher" version="1.0"/>
</include>
<include name="application">
<resource id="tutorial:composition-application" version="1.0"/>
</include>
<include name="location">
<resource id="tutorial:composition-location" version="1.0"/>
</include>
</implementation>
</block>
]]></source>
</subsection>
</section>
</body>
</document>
1.1
avalon-sandbox/merlin/merlin-platform/xdocs/meta/model/block/container/include/navigation.xml
Index: navigation.xml
===================================================================
<?xml version="1.0" encoding="UTF-8"?>
<project>
<title>Merlin</title>
<body>
<links>
<item name="Home" href="http://avalon.apache.org/"/>
<item name="Framework" href="http://avalon.apache.org/framework/"/>
<item name="Components" href="http://avalon.apache.org/components"/>
<item name="Containers" href="http://avalon.apache.org/containers/"/>
<item name="Sandbox" href="http://avalon.apache.org/sandbox/"/>
</links>
<menu name="About Merlin">
<item name="Overview" href="/about/index.html"/>
<item name="Getting Started" href="/starting/index.html"/>
<item name="Merlin System" href="/merlin/index.html"/>
<item name="Meta Model" href="/meta/index.html">
<item name="Meta Info" href="/meta/info/index.html"/>
<item name="Meta Data" href="/meta/model/index.html">
<item name="Kernel" href="/meta/model/kernel/index.html"/>
<item name="Block" href="/meta/model/block/index.html">
<item name="Info" href="/meta/model/block/info.html"/>
<item name="Services" href="/meta/model/block/export/index.html"/>
<item name="Dependencies" href="/meta/model/block/import/index.html"/>
<item name="Implementation"
href="/meta/model/block/container/index.html">
<item name="Engine"
href="/meta/model/block/container/engine/index.html"/>
<item name="Component"
href="/meta/model/block/container/components/index.html"/>
<item name="Container"
href="/meta/model/block/container/containers.html"/>
<item name="Include"
href="/meta/model/block/container/include/index.html">
<item name="Source"
href="/meta/model/block/container/include/source.html"/>
<item name="Resource"
href="/meta/model/block/container/include/resource.html"/>
<item name="Targets"
href="/meta/model/block/container/include/targets/index.html"/>
</item>
</item>
</item>
</item>
</item>
<item name="Tools" href="/tools/index.html"/>
<item name="Resources" href="/resources/index.html"/>
</menu>
<menu name="Extensions">
<item name="JNDI" href="/extensions/jndi/index.html"/>
<item name="Servlet" href="/extensions/servlet/index.html"/>
</menu>
</body>
</project>
1.1
avalon-sandbox/merlin/merlin-platform/xdocs/meta/model/block/container/include/resource.xml
Index: resource.xml
===================================================================
<?xml version="1.0"?>
<document>
<header>
<title>Include Directive</title>
<authors>
<person name="Stephen McConnell" email="[EMAIL PROTECTED]"/>
</authors>
</header>
<body>
<section name="Resource Include Directive">
<subsection name="Attributes">
<table>
<tr><th>Attribute</th><th>Required</th><th>Description</th></tr>
<tr>
<td>id</td><td>yes</td>
<td>
A resource artifact identifier in form [group]:[artifact-name]. The value
identifes a jar file containing a block defintition that is resolved
relative to a repository established by the Merlin Kernel.
</td>
</tr>
<tr>
<td>version</td><td>no</td>
<td>
Used in conjuction with the id attribute to qualify the artifact version.
</td>
</tr>
</table>
</subsection>
<subsection name="Description">
<p>
The defintion of the block to include will be resolved from the jar file referenced
by the resource directive. The jar file shall be assumed to be a packaged block
containing a block defintion under the path BLOCK-INF/block.xml.
</p>
</subsection>
<subsection name="Sample XML">
<p>
The following example block.xml demonstrates the inclusion of three blocks within
another enclosing block. In this example, the common shared API (containing service
interfaces classes is declared in the containing block classloader).
</p>
<source><![CDATA[
<block>
<info>
<name>tutorial</name>
</info>
<implementation>
<include name="publisher">
<resource id="tutorial:composition-publisher" version="1.0"/>
</include>
</implementation>
</block>
]]></source>
</subsection>
</section>
</body>
</document>
1.1
avalon-sandbox/merlin/merlin-platform/xdocs/meta/model/block/container/include/source.xml
Index: source.xml
===================================================================
<?xml version="1.0"?>
<document>
<header>
<title>Source Include Directive</title>
<authors>
<person name="Stephen McConnell" email="[EMAIL PROTECTED]"/>
</authors>
</header>
<body>
<section name="Source Include Directive">
<subsection name="Attributes">
<table>
<tr><th>Attribute</th><th>Required</th><th>Description</th></tr>
<tr>
<td>path</td><td>no</td>
<td>
URL used to reference a block directive as a URL. Is useful as an
alternative form to the resource include during development.
</td>
</tr>
</table>
</subsection>
<subsection name="Description">
<p>
Includes a block defined by the block descriptor referenced by the path attribute
value.
</p>
</subsection>
<subsection name="Sample XML">
<source><![CDATA[
<block>
<info>
<name>tutorial</name>
</info>
<implementation>
<engine>
<classpath>
<repository>
<resource id="tutorial:composition-api" version="1.0"/>
</repository>
</classpath>
</engine>
<include name="publisher">
<source path="conf/include.xml"/>
</include>
</implementation>
</block>
]]></source>
</subsection>
</section>
</body>
</document>
1.1
avalon-sandbox/merlin/merlin-platform/xdocs/meta/model/block/container/include/targets/index.xml
Index: index.xml
===================================================================
<?xml version="1.0"?>
<document>
<header>
<title>Include Directive</title>
<authors>
<person name="Stephen McConnell" email="[EMAIL PROTECTED]"/>
</authors>
</header>
<body>
<section name="Targets Directive">
<subsection name="Nested Elements">
<table>
<tr><th>Element</th><th>Occurance</th><th>Description</th></tr>
<tr>
<td><a href="target.html">target</a></td><td>0..n</td>
<td>
A target override configuration directive.
</td>
</tr>
</table>
</subsection>
<subsection name="Attributes">
<table>
<tr><th>Attribute</th><th>Required</th><th>Description</th></tr>
<tr>
<td>path</td><td>no</td>
<td>
Absolute or relative URL of a configuration targets file.
If the path attribute is not declared, the container will attempt
to build configuration targets based on nested <target>
elements.
</td>
</tr>
</table>
</subsection>
<subsection name="Description">
<p>
A targets configuration contains named configuration target declarations that can be
used to override configurations for component and container directives. A targets
configuration may contain multiple target declarations, each referencing a named
deloyment target (component or container).
</p>
</subsection>
<subsection name="Sample XML">
<source><![CDATA[
<!-- embedded targets example -->
<include name="subscriber">
<source path="conf/subscriber.xml"/>
<targets>
<target path="/main">
<configuration>
<frequency>100</frequency>
</configuration>
<categories priority="WARN"/>
</target>
<target path="/main/protocol-handler">
<configuration>
<activity>NORMAL</activity>
</configuration>
<categories priority="DEBUG"/>
</target>
</targets>
</include>
<!-- imported targets example -->
<include name="publisher">
<source path="conf/include.xml"/>
<targets path="conf/config.xml"/>
</include>
]]></source>
</subsection>
<subsection name="Targets File Format">
<p>
When a <targets> elements references an external file via the path attribute,
the Merlin platform will attempt to read in a XML file. The file root element is
expected to be a <targets> element. The "includes" tutorial under the directory
tutorials/includes contains examples of the application of embedded and imported
target definitions.
</p>
<p>
Example targets file:
</p>
<source><![CDATA[
<targets>
<!-- classic target configuration override declarations -->
<target path="/test1">
<configuration>
<source>from config.xml</source>
</configuration>
<categories priority="FATAL"/>
</target>
<target path="/subcontainer/test2">
<configuration>
<source>inside config.xml</source>
</configuration>
</target>
</targets>
]]></source>
</subsection>
</section>
</body>
</document>
1.1
avalon-sandbox/merlin/merlin-platform/xdocs/meta/model/block/container/include/targets/navigation.xml
Index: navigation.xml
===================================================================
<?xml version="1.0" encoding="UTF-8"?>
<project>
<title>Merlin</title>
<body>
<links>
<item name="Home" href="http://avalon.apache.org/"/>
<item name="Framework" href="http://avalon.apache.org/framework/"/>
<item name="Components" href="http://avalon.apache.org/components"/>
<item name="Containers" href="http://avalon.apache.org/containers/"/>
<item name="Sandbox" href="http://avalon.apache.org/sandbox/"/>
</links>
<menu name="About Merlin">
<item name="Overview" href="/about/index.html"/>
<item name="Getting Started" href="/starting/index.html"/>
<item name="Merlin System" href="/merlin/index.html"/>
<item name="Meta Model" href="/meta/index.html">
<item name="Meta Info" href="/meta/info/index.html"/>
<item name="Meta Data" href="/meta/model/index.html">
<item name="Kernel" href="/meta/model/kernel/index.html"/>
<item name="Block" href="/meta/model/block/index.html">
<item name="Info" href="/meta/model/block/info.html"/>
<item name="Services" href="/meta/model/block/export/index.html"/>
<item name="Dependencies" href="/meta/model/block/import/index.html"/>
<item name="Implementation"
href="/meta/model/block/container/index.html">
<item name="Engine"
href="/meta/model/block/container/engine/index.html"/>
<item name="Component"
href="/meta/model/block/container/components/index.html"/>
<item name="Container"
href="/meta/model/block/container/containers.html"/>
<item name="Include"
href="/meta/model/block/container/include/index.html">
<item name="Source"
href="/meta/model/block/container/include/source.html"/>
<item name="Resource"
href="/meta/model/block/container/include/resource.html"/>
<item name="Targets"
href="/meta/model/block/container/include/targets/index.html">
<item name="Target"
href="/meta/model/block/container/include/targets/target.html"/>
</item>
</item>
</item>
</item>
</item>
</item>
<item name="Tools" href="/tools/index.html"/>
<item name="Resources" href="/resources/index.html"/>
</menu>
<menu name="Extensions">
<item name="JNDI" href="/extensions/jndi/index.html"/>
<item name="Servlet" href="/extensions/servlet/index.html"/>
</menu>
</body>
</project>
1.1
avalon-sandbox/merlin/merlin-platform/xdocs/meta/model/block/container/include/targets/target.xml
Index: target.xml
===================================================================
<?xml version="1.0"?>
<document>
<header>
<title>Include Directive</title>
<authors>
<person name="Stephen McConnell" email="[EMAIL PROTECTED]"/>
</authors>
</header>
<body>
<section name="Target Directive">
<subsection name="Nested Elements">
<table>
<tr><th>Element</th><th>Occurance</th><th>Description</th></tr>
<tr>
<td><a href="../../components/categories/index.html">categories</a></td>
<td>0..1</td>
<td>
A logging categories directive.
</td>
</tr>
<tr>
<td>configuration</td>
<td>0..1</td>
<td>
An overriding configuration.
</td>
</tr>
</table>
</subsection>
<subsection name="Attributes">
<table>
<tr><th>Attribute</th><th>Required</th><th>Description</th></tr>
<tr>
<td>path</td>
<td>yes</td>
<td>
The address of a named component or container relative
the container in which the target has been imported
e.g (/xxx/yyy/zzz).
</td>
</tr>
</table>
</subsection>
<subsection name="Description">
<p>
A target is structure containing a relative component name together with a
configuration and a logging <a
href="../../components/categories/index.html">categories directive</a>. The supplied
configuration and logging directive are used to override values for the identified
component.
</p>
</subsection>
<subsection name="Sample XML">
<source><![CDATA[
<!--
a target that overrides the configuration and logging
priority of a component named "test3 in the containment
path /subcontainer/include
-->
<target path="/subcontainer/include/test3">
<configuration>
<source>using config.xml file</source>
</configuration>
<categories priority="DEBUG"/>
</target>
]]></source>
</subsection>
</section>
</body>
</document>
1.2 +2 -2
avalon-sandbox/merlin/merlin-platform/xdocs/resources/download.xml
Index: download.xml
===================================================================
RCS file:
/home/cvs/avalon-sandbox/merlin/merlin-platform/xdocs/resources/download.xml,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- download.xml 10 Jun 2003 02:14:25 -0000 1.1
+++ download.xml 15 Jun 2003 17:43:24 -0000 1.2
@@ -8,8 +8,8 @@
</properties>
<body>
- <section name="Resources">
- <subsection name="Download">
+ <section name="Download">
+ <subsection name="Instructions">
<p>PLACEHOLDER</p>
</subsection>
</section>
1.3 +4 -40
avalon-sandbox/merlin/merlin-platform/xdocs/resources/notebook.xml
Index: notebook.xml
===================================================================
RCS file:
/home/cvs/avalon-sandbox/merlin/merlin-platform/xdocs/resources/notebook.xml,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- notebook.xml 10 Jun 2003 05:10:41 -0000 1.2
+++ notebook.xml 15 Jun 2003 17:43:24 -0000 1.3
@@ -4,53 +4,17 @@
<properties>
<author email="[EMAIL PROTECTED]">Stephen McConnell</author>
- <title>Cornerstone</title>
+ <title>Resources</title>
</properties>
<body>
- <section name="Resources">
- <subsection name="Notebook">
+ <section name="Notebook">
+ <subsection name="Maven beta 9 Manifest Issue">
<p>
-Over the last few months the level of interest and activity in Merlin has been
growing. In addition I have received several requests for a release of Merlin by
people that want to get involved but really need a release before jumping in.
+The Merlin build is based on the Maven beta 9 release. There is a know problem
with the relase concerning manifest generation (extension lists are incorrectly
delimited). The solution to the problem is to download the 1.9 version version of the
jar:jar <a
href="http://cvs.apache.org/viewcvs/maven/src/plugins-build/jar/plugin.jelly";>plugin.jelly</a>
file and use it to replace the version in you Maven installation under the path
maven/plugins/maven-jar-plugin-1.0/plugin./jelly. Once replaced, the manifests
included in Maven generated jar file will not include extension list declarations. It
is anticipated that this issue will be resolved in a subsequent release of the Maven
build system.
</p>
-<p>Doing a release has several benefits:</p>
-
- <ul>
- <li>will facilitate broader feedback from users</li>
- <li>will facilitate the expansion of the development community</li>
- <li>will enable classic binary downloads for people without CVS access</li>
- </ul>
-
-
- </subsection>
- <subsection name="Action List">
-
-<p>
-Some of the actions that should be taken before a release include the following:
-</p>
-
- <table>
- <tr><th>Action</th><th>Status</th></tr>
- <tr><td>custom contextualization tutorials</td><td>DONE</td></tr>
- <tr><td>dynamic componentstutorials</td><td>PENDING</td></tr>
- <tr><td>complete the documentation about the James
example</td><td>PENDING</td></tr>
- <tr><td>add documentation concerning the Merlin/Maven
plugin</td><td>DONE</td></tr>
- <tr><td>resolve a manifest generation problem that is currently
- preventing the proper management of extensions</td><td>PENDING</td></tr>
- <tr><td>either release Excalibur Extension or include a fork
- under the Merlin project</td><td>PENDING</td></tr>
- <tr><td>test and validation</td><td>ONGOING</td></tr>
- <tr><td>tag the CVS</td><td>PENDING</td></tr>
- <tr><td>vote on a release</td><td>PENDING</td></tr>
- </table>
- </subsection>
-
- <subsection name="Voluntees">
-<p>
-Any volunteers out there willing to help with release preparation - please post a
note to the avalon dev or users list. Help can be in all sorts of areas - validating
documentation, packaging, testing, etc.
-</p>
</subsection>
</section>
</body>
1.3 +53 -2
avalon-sandbox/merlin/merlin-platform/xdocs/resources/roadmap.xml
Index: roadmap.xml
===================================================================
RCS file:
/home/cvs/avalon-sandbox/merlin/merlin-platform/xdocs/resources/roadmap.xml,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- roadmap.xml 10 Jun 2003 05:10:41 -0000 1.2
+++ roadmap.xml 15 Jun 2003 17:43:24 -0000 1.3
@@ -8,8 +8,52 @@
</properties>
<body>
- <section name="Resources">
- <subsection name="Roadmap">
+ <section name="Roadmap">
+ <subsection name="Release Preparation">
+
+<p>
+Over the last few months the level of interest and activity in Merlin has been
growing. In addition I have received several requests for a release of Merlin by
people that want to get involved but really need a release before jumping in.
+</p>
+
+<p>Doing a release has several benefits:</p>
+
+ <ul>
+ <li>will facilitate broader feedback from users</li>
+ <li>will facilitate the expansion of the development community</li>
+ <li>will enable classic binary downloads for people without CVS access</li>
+ </ul>
+
+<p>
+Some of the actions that should be taken before a release include the following:
+</p>
+
+ <table>
+ <tr><th>Action</th><th>Status</th></tr>
+ <tr><td>custom contextualization tutorials</td><td>DONE</td></tr>
+ <tr><td>dynamic components tutorials</td><td>PENDING</td></tr>
+ <tr><td>complete the documentation about the James
example</td><td>PENDING</td></tr>
+ <tr>
+ <td>add documentation concerning the Merlin/Maven plugin</td>
+ <td>DONE</td>
+ </tr>
+ <tr>
+ <td>provide solution for the a manifest generation problem that
+ is currently preventing the proper management of
+ extensions</td><td>DONE
+ </td>
+ </tr>
+ <tr>
+ <td>either release Excalibur Extension or include a fork
+ under the Merlin project</td>
+ <td>PENDING</td>
+ </tr>
+ <tr><td>test and validation</td><td>ONGOING</td></tr>
+ <tr><td>tag the CVS</td><td>PENDING</td></tr>
+ <tr><td>vote on a release</td><td>PENDING</td></tr>
+ </table>
+ </subsection>
+
+ <subsection name="Priority Development Areas">
<table>
<tr>
<th>Topic</th><th>Description</th>
@@ -38,6 +82,13 @@
</tr>
</table>
</subsection>
+
+ <subsection name="Voluntees">
+<p>
+Any volunteers out there willing to help with release preparation - please post a
note to the avalon dev or users list. Help can be in all sorts of areas - validating
documentation, packaging, testing, etc.
+</p>
+ </subsection>
+
</section>
</body>
1.2 +2 -0
avalon-sandbox/merlin/merlin-platform/xdocs/starting/advanced/lifecycle/navigation.xml
Index: navigation.xml
===================================================================
RCS file:
/home/cvs/avalon-sandbox/merlin/merlin-platform/xdocs/starting/advanced/lifecycle/navigation.xml,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- navigation.xml 10 Jun 2003 02:14:28 -0000 1.1
+++ navigation.xml 15 Jun 2003 17:43:24 -0000 1.2
@@ -23,10 +23,12 @@
<item name="Interfaces"
href="/starting/advanced/lifecycle/interfaces.html"/>
<item name="Example" href="/starting/advanced/lifecycle/example.html"/>
</item>
+ <item name="Contextulization" href="/starting/advanced/context.html"/>
<item name="Deployment Templates"
href="/starting/advanced/profiles.html"/>
<item name="Profile Selectors" href="/starting/advanced/selectors.html"/>
<item name="Block Includes" href="/starting/advanced/includes.html"/>
<item name="Block Composition" href="/starting/advanced/composite.html"/>
+ <item name="Custom Containers" href="/starting/advanced/containers.html"/>
</item>
<item name="Examples" href="/starting/examples/index.html"/>
</item>
1.2 +11 -7
avalon-sandbox/merlin/merlin-platform/xdocs/starting/tutorial/config/block.xml
Index: block.xml
===================================================================
RCS file:
/home/cvs/avalon-sandbox/merlin/merlin-platform/xdocs/starting/tutorial/config/block.xml,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- block.xml 10 Jun 2003 02:14:34 -0000 1.1
+++ block.xml 15 Jun 2003 17:43:24 -0000 1.2
@@ -12,13 +12,17 @@
<subsection name="Declaring a configuration in the Component Directive">
<p>
We can modify the configuration behaviour at a more general level
- by including a configuration within the block.xml directive.
+ by including an overriding configuration within the block.xml directive.
+ </p>
+ <p>
+ Resources supporting this turorial are contained in the
+ tutorial/configuration/block directory.
</p>
<source><![CDATA[
<block>
<info>
- <name>banking</name>
+ <name>hello</name>
</info>
<implementation>
@@ -35,8 +39,8 @@
Build and run the tutorial again.
</p>
<source>
-$ ant jar
-$ merlin build\classes
+$ maven clean jar
+$ merlin target\classes -execute
</source>
<p>
In the logging output we see that the configuration
@@ -45,9 +49,9 @@
directive.
</p>
<source>
-[INFO ] (tutorial.hello): configuration stage
-[INFO ] (tutorial.hello): initialization stage
-[INFO ] (tutorial.hello): source: explicit configuration within block
+[INFO ] (hello): configuration stage
+[INFO ] (hello): initialization stage
+[INFO ] (hello): source: explicit configuration within block
</source>
</subsection>
1.2 +12 -2
avalon-sandbox/merlin/merlin-platform/xdocs/starting/tutorial/config/configurable.xml
Index: configurable.xml
===================================================================
RCS file:
/home/cvs/avalon-sandbox/merlin/merlin-platform/xdocs/starting/tutorial/config/configurable.xml,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- configurable.xml 10 Jun 2003 02:14:34 -0000 1.1
+++ configurable.xml 15 Jun 2003 17:43:24 -0000 1.2
@@ -17,6 +17,10 @@
Configurable, and updates to the inialize method to log the source
of the configuration based on runtime information.
</p>
+ <p>
+ Resources supporting this turorial are contained in the
+ tutorial/configuration/simple directory.
+ </p>
<source>
package tutorial;
@@ -26,6 +30,12 @@
import org.apache.avalon.framework.configuration.Configuration;
import org.apache.avalon.framework.configuration.ConfigurationException;
+/**
+ * A configurable component.
+ *
+ * @avalon.meta.version 1.0
+ * @avalon.meta.name simple
+ */
public class HelloComponent extends AbstractLogEnabled
implements Configurable, Initializable
{
@@ -62,8 +72,8 @@
Build and run the tutorial without declaring any configuration.
</p>
<source>
-$ ant jar
-$ merlin build\classes
+$ maven clean jar
+$ merlin target\classes -execute
</source>
<p>
In the logging output we see that Merlin has created and
1.2 +6 -2
avalon-sandbox/merlin/merlin-platform/xdocs/starting/tutorial/config/defaults.xml
Index: defaults.xml
===================================================================
RCS file:
/home/cvs/avalon-sandbox/merlin/merlin-platform/xdocs/starting/tutorial/config/defaults.xml,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- defaults.xml 10 Jun 2003 02:14:35 -0000 1.1
+++ defaults.xml 15 Jun 2003 17:43:24 -0000 1.2
@@ -16,6 +16,10 @@
<classname>.xconfig resource co-located with the
component class.
</p>
+ <p>
+ Resources supporting this turorial are contained in the
+ tutorial/configuration/defaults directory.
+ </p>
<p><i>HelloComponent.xconfig</i></p>
@@ -28,8 +32,8 @@
Build and run the tutorial again.
</p>
<source>
-$ ant jar
-$ merlin build\classes
+$ maven clean jar
+$ merlin build\classes -execute
</source>
<p>
In the logging output we see that the configuration
1.2 +9 -4
avalon-sandbox/merlin/merlin-platform/xdocs/starting/tutorial/config/override.xml
Index: override.xml
===================================================================
RCS file:
/home/cvs/avalon-sandbox/merlin/merlin-platform/xdocs/starting/tutorial/config/override.xml,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- override.xml 10 Jun 2003 02:14:35 -0000 1.1
+++ override.xml 15 Jun 2003 17:43:24 -0000 1.2
@@ -18,6 +18,10 @@
configuration without modification of a packaged block.xml
file.
</p>
+ <p>
+ Resources supporting this turorial are contained in the
+ tutorial/configuration/override directory.
+ </p>
</subsection>
<subsection name="Target Override Format">
<source><![CDATA[
@@ -37,12 +41,13 @@
in the tutorials/configuration package).
</p>
<source>
-$ merlin -config src\config\config.xml tutorial.jar
+$ maven clean jar
+$ merlin -config conf\config.xml target\classes
</source>
<p>
Executing Merlin demonstrates that the configuration supplied
to the hello component reflects the configuration element contained
- in the target name "hello".
+ in the target name "\hello".
</p>
<source>
[INFO ] (sys.hello): configuration stage
@@ -60,9 +65,9 @@
</p>
<source><![CDATA[
<targets>
- <target path="/container/hello">
+ <target path="/container/component-name">
<configuration>
- <source>External configuration target.</source>
+ <!-- your configuration info -->
</configuration>
</target>
</targets>
---------------------------------------------------------------------
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]
