mcconnell 2003/08/27 21:07:44
Added: merlin/merlin-platform/xdocs/meta/config index.xml
navigation.xml
merlin/merlin-platform/xdocs/meta/config/target
configuration.xml index.xml navigation.xml
merlin/merlin-platform/xdocs/meta/config/target/categories
category.xml index.xml navigation.xml
Log:
Updated config override meta-data spec.
Revision Changes Path
1.1
avalon-sandbox/merlin/merlin-platform/xdocs/meta/config/index.xml
Index: index.xml
===================================================================
<?xml version="1.0"?>
<document>
<header>
<title>Targets 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/index.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>yes</td>
<td>
Absolute or relative path of the component that the target is qualifying.
</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[
<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>
]]></source>
</subsection>
</section>
</body>
</document>
1.1
avalon-sandbox/merlin/merlin-platform/xdocs/meta/config/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="kernel.xml" href="/meta/kernel/index.html"/>
<item name="block.xml" href="/meta/block/index.html"/>
<item name="config.xml" href="/meta/config/index.html">
<item name="target" href="/meta/config/target/index.html"/>
</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/config/target/configuration.xml
Index: configuration.xml
===================================================================
<?xml version="1.0"?>
<document>
<header>
<title>Configuration Directive</title>
<authors>
<person name="Stephen McConnell" email="[EMAIL PROTECTED]"/>
</authors>
</header>
<body>
<section name="Configuration Directive">
<subsection name="Specification">
<p>A configuration directive is a configuration fragment that will be supplied to a
component that implements the org.apache.avalon.configuration.Configurable interface.
The attributes and content of a configuration element are application specific. The
<configuration> element is the root element passed to the component.</p>
<p><strong>Sample XML</strong></p>
<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.1
avalon-sandbox/merlin/merlin-platform/xdocs/meta/config/target/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="Target Directive">
<subsection name="Nested Elements">
<table>
<tr><th>Element</th><th>Occurance</th><th>Description</th></tr>
<tr>
<td><a href="categories/index.html">categories</a></td>
<td>0..1</td>
<td>
A logging categories directive.
</td>
</tr>
<tr>
<td><a href="configuration.html">configuration</a></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.1
avalon-sandbox/merlin/merlin-platform/xdocs/meta/config/target/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="kernel.xml" href="/meta/kernel/index.html"/>
<item name="block.xml" href="/meta/block/index.html"/>
<item name="config.xml" href="/meta/config/index.html">
<item name="target" href="/meta/config/target/index.html">
<item name="categories"
href="/meta/config/target/categories/index.html"/>
<item name="configuration"
href="/meta/config/target/configuration.html"/>
</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/config/target/categories/category.xml
Index: category.xml
===================================================================
<?xml version="1.0"?>
<document>
<header>
<title>Category Directive</title>
<authors>
<person name="Stephen McConnell" email="[EMAIL PROTECTED]"/>
</authors>
</header>
<body>
<section name="Category Directive">
<subsection name="Attributes">
<table>
<tr><th>Attribute</th><th>Required</th><th>Description</th></tr>
<tr>
<td>name</td><td>yes</td>
<td>
Logging category name. The category name refers to
a logging sub-category within the enclosing category.
</td>
</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>
<subsection name="Sample XML">
<source><![CDATA[
<category name="/sys" priority="INFO"/>
]]></source>
</subsection>
</section>
</body>
</document>
1.1
avalon-sandbox/merlin/merlin-platform/xdocs/meta/config/target/categories/index.xml
Index: index.xml
===================================================================
<?xml version="1.0"?>
<document>
<header>
<title>Categories Directive</title>
<authors>
<person name="Stephen McConnell" email="[EMAIL PROTECTED]"/>
</authors>
</header>
<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 sub-category directive.</td>
</tr>
</table>
</subsection>
<subsection name="Description">
<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[
<!--
Create a component with a logging channel priority of INFO.
Set the subsidiary channel for tutorial.data to a priority
of DEBUG and the tutorial.data.model channel to a ERROR
priority.
-->
<component name="tutorial">
<categories priority="INFO">
<category name="/data" priority="DEBUG"/>
<category name="/data/model" priority="ERROR"/>
</categories>
</component>
]]></source>
</subsection>
</section>
</body>
</document>
1.1
avalon-sandbox/merlin/merlin-platform/xdocs/meta/config/target/categories/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="kernel.xml" href="/meta/kernel/index.html"/>
<item name="block.xml" href="/meta/block/index.html"/>
<item name="config.xml" href="/meta/config/index.html">
<item name="target" href="/meta/config/target/index.html">
<item name="categories" href="/meta/config/target/categories/index.html">
<item name="category"
href="/meta/config/target/categories/category.html"/>
</item>
<item name="configuration"
href="/meta/config/target/configuration.html"/>
</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>
---------------------------------------------------------------------
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]
