donaldp 2002/09/15 01:14:31
Modified: info/src/xdocs menu.xml tags.xml
Added: info/src/xdocs features.xml
Log:
Start documenting Features (aka Container Extensions).
Revision Changes Path
1.7 +2 -1 jakarta-avalon-excalibur/info/src/xdocs/menu.xml
Index: menu.xml
===================================================================
RCS file: /home/cvs/jakarta-avalon-excalibur/info/src/xdocs/menu.xml,v
retrieving revision 1.6
retrieving revision 1.7
diff -u -r1.6 -r1.7
--- menu.xml 15 Sep 2002 07:44:36 -0000 1.6
+++ menu.xml 15 Sep 2002 08:14:31 -0000 1.7
@@ -12,8 +12,9 @@
<item name="API Docs" href="/api/"/>
</menu>
<menu name="Specifications">
- <item name="Context Entry Spec" href="/context.html"/>
<item name="Common Tags" href="/tags.html"/>
+ <item name="Context Entry Spec" href="/context.html"/>
+ <item name="Features" href="/features.html"/>
</menu>
<menu name="Tools">
<item name="Ant Tasks" href="/tasks.html"/>
1.2 +2 -2 jakarta-avalon-excalibur/info/src/xdocs/tags.xml
Index: tags.xml
===================================================================
RCS file: /home/cvs/jakarta-avalon-excalibur/info/src/xdocs/tags.xml,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- tags.xml 15 Sep 2002 07:44:36 -0000 1.1
+++ tags.xml 15 Sep 2002 08:14:31 -0000 1.2
@@ -110,8 +110,8 @@
<th>Description</th>
<td>The "feature" tag is used to define which
container extensions that the component requires
- or will use if present. See the <a
href="feature.html">
- feature</a> document for details about container
+ or will use if present. See the <a
href="features.html">
+ features</a> document for details about container
extensions.</td>
</tr>
</table>
1.1 jakarta-avalon-excalibur/info/src/xdocs/features.xml
Index: features.xml
===================================================================
<?xml version="1.0"?>
<document>
<properties>
<title>Features</title>
<author email="peter at apache.org">Peter Donald</author>
</properties>
<body>
<section name="Introduction">
<p>A container may support features beyond and above standard
Avalon
lifecycle processing. These features (aka container extensions)
are
given a name. This allows components to refer to specific features
that they require or will use if present.</p>
</section>
<section name="Naming">
<p>Feature names are usually derived from the names of the extra
tags
that they support. For example, a container that supports the
"sec"
(Security) tag will support the feature "sec". Alternatively the
container may support features like "sec.auth" which indicates
they
support a superset or subset of the "sec" tag.</p>
<p>If a particular container extension or feature does not
interpret
specific tags or touches multiple tags then it is recomended that
the short name of the container be used to name the feature (ie
"fortress" or "fortress.lifestyle" to indicate a fortress specific
feature.</p>
<p>Once a name has been found for a partciular feature it should
be
documented and listed in feature registry (unless it is container
specific). No other feature may be defined with the same name.</p>
</section>
<section name="Implementation">
<p>The implementation of the feature is a container specific
decision as long as the container adheres to the documented
behaviour
for an extension. However it is recomended that the
<a
href="http://jakarta.apache.org/avalon/excalibur/interceptor";>Interceptor
</a> project be considered for writing the container
extensions.</p>
</section>
</body>
</document>
--
To unsubscribe, e-mail: <mailto:[EMAIL PROTECTED]>
For additional commands, e-mail: <mailto:[EMAIL PROTECTED]>
