mcconnell 2002/08/21 10:14:06
Modified: assembly/src/xdocs assembly.xml classpath.xml container.xml
extensions.xml install.xml kernel.xml logging.xml
support.xml
Log:
More updates to sync with Cocoon doc generation.
Revision Changes Path
1.8 +7 -7 jakarta-avalon-excalibur/assembly/src/xdocs/assembly.xml
Index: assembly.xml
===================================================================
RCS file: /home/cvs/jakarta-avalon-excalibur/assembly/src/xdocs/assembly.xml,v
retrieving revision 1.7
retrieving revision 1.8
diff -u -r1.7 -r1.8
--- assembly.xml 21 Aug 2002 17:00:52 -0000 1.7
+++ assembly.xml 21 Aug 2002 17:14:06 -0000 1.8
@@ -17,7 +17,7 @@
<p>
Manifest entries are used to declare the existence of one or more component
implementations within a jar file. An example of a manifest declaration is included
here.
</p>
-<pre>
+<source>
Manifest-Version: 1.0
Created-By: OSM SARL
Extension-List: merlin
@@ -45,7 +45,7 @@
Name: org/apache/excalibur/playground/EmbeddedDemo.class
Avalon: Type
-</pre>
+</source>
</s1>
<s1 title="Candidate Establishment">
<p>
@@ -65,7 +65,7 @@
</ul>
</p>
<p>An example of a component .xinfo resource is presented in the following XML.</p>
-<pre>
+<source>
<font color="gray"><i><!--
Example of a component meta info external XML form.
@@ -271,14 +271,14 @@
</type>
-</pre>
+</source>
<p>
Given a set of component types Merlin initially establishes the set of candidates
based on the declared dependencies and services. For every component declared or
implied in the assembly Merlin will attempt to locate a set of candidate supplies.
For every supplier Merlin will attempt to resolve the suppliers dependencies. If a
failure occurs, the failed component is discarded as a potential supplier candidate.
Each component type is associated with at least one instantiation profile (explicit,
packaged, and/or explicit). Profiles imply an initial ranking of candidates.
Explicit profiles (that is component declarations included within a container
declaration in the kernel definition) are given highest priority. Package profiles
(profiles declared in a <class-name>.xprofile resource take second priority,
following by implicit profiles (only generated in the absence of explicit or packaged
profiles).
</p>
<p>Profiles appear as declarations inside container definitions. A typical profile
declaration includes information about the configuration, context and logging set-up
of the component type. An example component profile is included below:</p>
-<pre>
+<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
@@ -325,7 +325,7 @@
<parameters/>
</component>
-</pre>
+</source>
<p>In the majority of cases, a single candidate will be located to act as a
supplier. In those occasions where multiple candidates exist, Merlin will invoke a
candidate selection process. This involves instantiation of a service selector from
one of the following sources:</p>
<p>
1.5 +17 -17 jakarta-avalon-excalibur/assembly/src/xdocs/classpath.xml
Index: classpath.xml
===================================================================
RCS file: /home/cvs/jakarta-avalon-excalibur/assembly/src/xdocs/classpath.xml,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -r1.4 -r1.5
--- classpath.xml 21 Aug 2002 17:00:52 -0000 1.4
+++ classpath.xml 21 Aug 2002 17:14:06 -0000 1.5
@@ -21,28 +21,28 @@
<p>A kernel may contain a single extensions element that declares the directories
in which extension jar files may be located. Extensions are available to the root
classloader and as such are available to all containers. An example of an extensions
declaration is included below.</p>
-<pre>
+<source>
<kernel>
-</pre>
+</source>
<p><font color="gray"><i><!--
Declaration of possibly multiple extension directories. The extensions element may
contain multiple directory-set declarations, each containing possible multiple
relative directory paths. On initialisation, the kernel classloader will be
established with references to the supplied directories. Merlin will attempt to
resolve any jar files declaring extension dependencies based on the jar files included
in the declared extension directories.
--></i></font></p>
-<pre>
+<source>
<ibrary dir="<font color="darkred">.</font>">
<include name="<font color="darkred">dist</font>"/>
<include name="<font color="darkred">lib</font>"/>
</ibrary">
-</pre>
+</source>
<p><font color="gray"><i><!--
Other kernel declarations.
--></i></font></p>
-<pre>
+<source>
</kernel>
-</pre>
+</source>
</s2>
@@ -50,51 +50,51 @@
<a href="extension"/>
<p>A classpath declaration may occur at kernel and container scope. A kernel
classpath is accessible by the root container and all subsidiary containers. A
classpath declared at container scope is accessible only to the immediate container in
which the classpath is defined and its subsidiary containers. An example of a
classpath declaration is included below.</p>
-<pre>
+<source>
<kernel>
-</pre>
+</source>
<p><font color="gray"><i><!--
Declaration of a kernel level classpath.
--></i></font></p>
-<pre>
+<source>
<classpath">
<fileset dir="<font color="darkred">lib</font>">
<include name="<font color="darkred">avalon-framework.jar</font>"/>
<include name="<font color="darkred">logkit.jar</font>"/>
</fileset>
</classpath">
-</pre>
+</source>
<p><font color="gray"><i><!--
Other kernel declarations.
--></i></font></p>
-<pre>
+<source>
<container name="<font color="darkred">root</font>">
-</pre>
+</source>
<p><font color="gray"><i><!--
Declaration of a container level classpath.
--></i></font></p>
-<pre>
+<source>
<classpath">
<fileset dir="<font color="darkred">dist</font>">
<include name="<font color="darkred">demo.jar</font>"/>
</fileset>
</classpath">
-</pre>
+</source>
<p><font color="gray"><i><!--
Component profiles and/or subsidiary containers will normally appear here.
--></i></font></p>
-<pre>
+<source>
</container>
</kernel>
-</pre>
+</source>
</s2>
</s1>
1.4 +3 -3 jakarta-avalon-excalibur/assembly/src/xdocs/container.xml
Index: container.xml
===================================================================
RCS file: /home/cvs/jakarta-avalon-excalibur/assembly/src/xdocs/container.xml,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- container.xml 21 Aug 2002 17:00:52 -0000 1.3
+++ container.xml 21 Aug 2002 17:14:06 -0000 1.4
@@ -21,7 +21,7 @@
<p>A new container is created using a container model. The model is the
definition of the container, its classpath, and the profiles of the components it is
responsible for managing. Container models are declared programmatically or via an
XML description.</p>
<p><i>Minimilist container definition.</i></p>
-<pre>
+<source>
<container name="<font color="darkred">root</font>">
<classpath>
<fileset dir=<font color="darkred">"dist"</font>>
@@ -30,7 +30,7 @@
</classpath>
<component name="<font color="darkred">test</font>" class="<font
color="darkred">org.apache.excalibur.playground.BasicComponent</font>"/>
</container>
-</pre>
+</source>
</s1>
1.6 +3 -3 jakarta-avalon-excalibur/assembly/src/xdocs/extensions.xml
Index: extensions.xml
===================================================================
RCS file: /home/cvs/jakarta-avalon-excalibur/assembly/src/xdocs/extensions.xml,v
retrieving revision 1.5
retrieving revision 1.6
diff -u -r1.5 -r1.6
--- extensions.xml 21 Aug 2002 17:00:52 -0000 1.5
+++ extensions.xml 21 Aug 2002 17:14:06 -0000 1.6
@@ -14,7 +14,7 @@
<p>The following XML type declaration depicts a component that declares a
dependency on two lifecycle phase extensions (Securable and Persistable) and in
addition, declares itself as a provider of lifecycle extension handling for the phase
interface DemoExtension.</p>
-<pre>
+<source>
<type>
<component>
@@ -65,7 +65,7 @@
</type>
-</pre>
+</source>
</s1>
</body>
1.5 +7 -7 jakarta-avalon-excalibur/assembly/src/xdocs/install.xml
Index: install.xml
===================================================================
RCS file: /home/cvs/jakarta-avalon-excalibur/assembly/src/xdocs/install.xml,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -r1.4 -r1.5
--- install.xml 21 Aug 2002 17:00:52 -0000 1.4
+++ install.xml 21 Aug 2002 17:14:06 -0000 1.5
@@ -23,13 +23,13 @@
The Merlin distribution is available via the Apache CVS server. To access the
server, simply use the following commands (if you are using a GUI CVS client,
configure it appropriately):
</p>
-<pre>
+<source>
cvs -d :pserver:[EMAIL PROTECTED]:/home/cvspublic login
password: anoncvs
cvs -d :pserver:[EMAIL PROTECTED]:/home/cvspublic checkout
jakarta-avalon-excalibur/assembly
-</pre>
+</source>
</s2>
<s2 title="Build Procedure">
@@ -37,9 +37,9 @@
<p>
To build the Merlin installation, cd to the location of the Merlin project (e.g.
C:\jakarta-avalon-excalibur\merlin ) and invoke ant.
</p>
-<pre>
+<source>
$ ant
-</pre>
+</source>
</s2>
</s1>
@@ -49,9 +49,9 @@
To run a demonstration of Merlin run the kernel command file.
</p>
-<pre>
+<source>
$ kernel
-</pre>
+</source>
</s1>
</body>
1.5 +4 -4 jakarta-avalon-excalibur/assembly/src/xdocs/kernel.xml
Index: kernel.xml
===================================================================
RCS file: /home/cvs/jakarta-avalon-excalibur/assembly/src/xdocs/kernel.xml,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -r1.4 -r1.5
--- kernel.xml 21 Aug 2002 17:00:52 -0000 1.4
+++ kernel.xml 21 Aug 2002 17:14:06 -0000 1.5
@@ -19,7 +19,7 @@
<p><i>Kernel to Container conceptual relationship.</i></p>
- <img src="/images/overview.gif" />
+ <img src="images/overview.gif" />
</s1>
@@ -28,7 +28,7 @@
<p>A Merlin kernel is created using a kernel model (<a
href="api/assembly/org/apache/excalibur/merlin/model/KernelDescriptor.html">KernelDescriptor</a>).
The model may be defined programmatically or through an XML file. A kernel XML file
contains the definition of kernel execution parameters and a root container.</p>
<p><i>Minimilist kernel definition.</i></p>
-<pre>
+<source>
<kernel>
<classpath>
<fileset dir="<font color="darkred">dist</font>">
@@ -45,7 +45,7 @@
activation="<font color="darkred">true</font>"/>
</container>
</kernel>
-</pre>
+</source>
</s1>
1.6 +25 -25 jakarta-avalon-excalibur/assembly/src/xdocs/logging.xml
Index: logging.xml
===================================================================
RCS file: /home/cvs/jakarta-avalon-excalibur/assembly/src/xdocs/logging.xml,v
retrieving revision 1.5
retrieving revision 1.6
diff -u -r1.5 -r1.6
--- logging.xml 21 Aug 2002 17:00:52 -0000 1.5
+++ logging.xml 21 Aug 2002 17:14:06 -0000 1.6
@@ -16,29 +16,29 @@
<s1 title="Kernel Directives">
<p>A kernel may be configured with an option logging system creation directive.
The logging element declares the application wide default logging priority. A target
element enables definition of a logging file to which log entries will be directed.
The target name attribute is the name referenced by category elements defined within
the loggers element. Child category declarations must include a name (the logging
category), and may optionally include a target and a priority attribute. The target
defaults of "default" which corresponds to a internal default logging target that
issue messages to System.out (unless overridden by a target named default). If the
target is declared inside a category element, it must refer to a named target element.
The priority attribute may container one of the values <code>DEBUG</code>,
<code>INFO</code>, <code>WARN</code> or <code>ERROR</code>. The target must contain a
single file element with the attribute <code>location</code> the corresponds to the
name of the logging file.</p>
-<pre>
+<source>
<kernel>
-</pre>
+</source>
<font color="gray"><i><!--
Definition of a logging system. The priority and target attributes declare
system wide defaults
--></i></font>
-<pre>
+<source>
<logging priority="<font color="darkred">INFO</font>" target="<font
color="darkred">kernel</font>">
-</pre>
+</source>
<font color="gray"><i><!--
Multiple targets may be included - each defining a logging file.
--></i></font>
-<pre>
+<source>
<target name="<font color="darkred">kernel</font>">
<file location="<font color="darkred">kernel.log</font>" />
</target>
</logging>
-</pre>
+</source>
<p><font color="gray"><i><!--
Multiple categories may be declared - each category defines a priority and
target
@@ -49,7 +49,7 @@
will overide the system wide defaults relative to kernel sub-categories.
--></i></font></p>
-<pre>
+<source>
<categories priority="<font color="darkred">INFO</font>">
<category name="<font color="darkred">logging</font>" priority="<font
color="darkred">WARN</font>"/>
<category name="<font color="darkred">installer</font>" priority="<font
color="darkred">WARN</font>"/>
@@ -60,15 +60,15 @@
<category name="<font color="darkred">loader.type.builder</font>"
priority="<font color="darkred">WARN</font>"/>
<category name="<font color="darkred">export</font>" priority="<font
color="darkred">WARN</font>"/>
</categories>
-</pre>
+</source>
<p><font color="gray"><i><!--
Other kernel declarations.
--></i></font></p>
-<pre>
+<source>
</kernel>
-</pre>
+</source>
<p>Logging sub-categories within the kernel category include:
<ul>
@@ -102,15 +102,15 @@
<p>An example container logging declaration is shown below.</p>
-<pre>
+<source>
<kernel>
<container name="<font color="darkred">root</font>">
-</pre>
+</source>
<p><font color="gray"><i><!--
Multiple categories may be declared - each category defines a priority and target
to be used for the respective category. Category names are scoped relative to the
container. As such a category name of "logging" translates to a full logging category
path of "root.logging". The logging element may contain priority and target attribute
values. These values will override the system wide defaults relative to kernel
sub-categories. --></i></font>
</p>
-<pre>
+<source>
<categories priority="<font color="darkred">INFO</font>">
<category name="<font color="darkred">loader</font>" priority="<font
color="darkred">WARN</font>"/>
<category name="<font color="darkred">loader.type</font>"
priority="<font color="darkred">WARN</font>"/>
@@ -120,53 +120,53 @@
<category name="<font color="darkred">provider</font>" priority="<font
color="darkred">WARN</font>"/>
<category name="<font color="darkred">lifecycle</font>" priority="<font
color="darkred">WARN</font>"/>
</categories>
-</pre>
+</source>
<p><font color="gray"><i><!--
Other container declarations.
--></i></font></p>
-<pre>
+<source>
</container>
</kernel>
-</pre>
+</source>
</s1>
<s1 title="Component Directives">
<p>Component scoped logging directives are relative to the enclosing component
profile declaration. The logging categories are component specific and will normally
be documented as part of the component you are using. The following example is the
logging configuration for the demonstration component included with the
distribution.</p>
-<pre>
+<source>
<kernel>
<p><font color="gray"><i><!-- A classpath declaration could be included here or
under the container scope. --></i></font></p>
<container name="<font color="darkred">root</font>">
-</pre>
+</source>
<font color="gray"><i><!--
Component profile declaration.
--></i></font>
-<pre>
+<source>
<component name="<font color="darkred">complex</font>"
class="<font
color="darkred">org.apache.excalibur.playground.ComplexComponent</font>"
activation="<font color="darkred">true</font>">
-</pre>
+</source>
<p><font color="gray"><i><!--
Multiple categories may be declared - each category defines a priority and target
to be used for the respective caegory. Category names are scoped relative to the
component. As such a category name of "init" translates to a full logging category
path of <container-path>root.init. The logging element may contain priority and
target attribute values. These values will overide the container wide defaults.
--></i></font>
</p>
-<pre>
+<source>
<categories priority="<font color="darkred">DEBUG</font>">
<category name="<font color="darkred">init</font>" priority="<font
color="darkred">WARN</font>"/>
</categories>
</component>
-</pre>
+</source>
<p><font color="gray"><i><!-- Other container declarations. --></i></font></p>
-<pre>
+<source>
</container>
</kernel>
-</pre>
+</source>
</s1>
1.5 +1 -2 jakarta-avalon-excalibur/assembly/src/xdocs/support.xml
Index: support.xml
===================================================================
RCS file: /home/cvs/jakarta-avalon-excalibur/assembly/src/xdocs/support.xml,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -r1.4 -r1.5
--- support.xml 21 Aug 2002 17:00:52 -0000 1.4
+++ support.xml 21 Aug 2002 17:14:06 -0000 1.5
@@ -38,7 +38,6 @@
<td class="mini"><a
href="http://home.osm.net/doc/gateway/index.html";>Gateway</a></td>
<td class="mini">Services supporting user centric web based
interaction with business processes, tasks, workspaces, and service directories. The
Gateway services defines a suite of servlet that provide a consistent view of a user's
business context, available resources, and the characteristics, features, and policies
of the resources available and in use.</td></tr>
</table>
- <p><img src="/images/nothing.gif" border="0"/></p>
</s1>
</body>
<footer>
--
To unsubscribe, e-mail: <mailto:[EMAIL PROTECTED]>
For additional commands, e-mail: <mailto:[EMAIL PROTECTED]>
