donaldp 2002/09/15 00:44:37
Modified: info/src/xdocs menu.xml
Added: info/src/xdocs tags.xml
Log:
Start documenting the tags that are common between multiple containers.
Revision Changes Path
1.6 +1 -0 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.5
retrieving revision 1.6
diff -u -r1.5 -r1.6
--- menu.xml 15 Sep 2002 01:42:30 -0000 1.5
+++ menu.xml 15 Sep 2002 07:44:36 -0000 1.6
@@ -13,6 +13,7 @@
</menu>
<menu name="Specifications">
<item name="Context Entry Spec" href="/context.html"/>
+ <item name="Common Tags" href="/tags.html"/>
</menu>
<menu name="Tools">
<item name="Ant Tasks" href="/tasks.html"/>
1.1 jakarta-avalon-excalibur/info/src/xdocs/tags.xml
Index: tags.xml
===================================================================
<?xml version="1.0"?>
<document>
<properties>
<title>Tag Definitions</title>
<author email="peter at apache.org">Peter Donald</author>
</properties>
<body>
<section name="Introduction">
<p>This document aims to describe the tags that define
functionality common to multiple containers. These Info tags
are usually generated from source files that have been decorated
with <a href="doclet.html">Javadoc</a> tags.</p>
</section>
<section name="Tags">
<p>The list of standard metadata tags includes;</p>
<ul>
<li><a href="#doc">doc</a>: documentation tag</li>
<li><a href="#feature">feature</a>: tag for specifying
which container extensions are required or supported.</li>
</ul>
<subsection name="doc">
<table>
<tr><th>Target</th><td>All</td></tr>
<tr><th>Allow Multiple</th><td>false</td></tr>
<tr><th>Inherit</th><td>true</td></tr>
<tr>
<th>Description</th>
<td>The "doc" tag is used to document artefacts in the
system. The documentation can either be read from
ResourceBundles or loaded directly from the
Parameters.
Loading descriptions from ResourceBundles is supported
to enable internationalization of descriptions and
display strings.</td>
</tr>
</table>
<h4>Parameters:</h4>
<table>
<tr>
<th>Name</th>
<th>Default</th>
<th>Required</th>
<th>Description</th>
</tr>
<tr>
<td>display-string</td>
<td></td>
<td>false</td>
<td>This specifies string to display on the
User Interface when labeling artefact.</td>
</tr>
<tr>
<td>description</td>
<td></td>
<td>false</td>
<td>This specifies a human readable description of
artefact.</td>
</tr>
<tr>
<td>i18n-bundle</td>
<td>Component Name + "Info"</td>
<td>false</td>
<td>This specifies the location of ResourceBundle to
use when
looking up display string and the description via
keys.</td>
</tr>
<tr>
<td>display-string-key</td>
<td></td>
<td>false</td>
<td>This is an alternative to display-string
parameter. It
defines a key to use when loading display-string from
the
ResourceBundle.</td>
</tr>
<tr>
<td>description-key</td>
<td></td>
<td>false</td>
<td>This is an alternative to description parameter.
It
defines a key to use when loading description from the
ResourceBundle.</td>
</tr>
</table>
<p>The following is an example info fragment that defines a
display string and description by directly storing data in
descriptor.</p>
<source>
<![CDATA[
<tag name="doc">
<param name="display-name" value="My Magic Component"/>
<param name="description"
value="My Magic Component does Magic."/>
</tag>
]]></source>
<p>The following is an example info fragment that loads the
display string and description from a resource bundle.</p>
<source>
<![CDATA[
<tag name="doc">
<param name="display-name-key" value="component.display-name"/>
<param name="description-key" value="component.description"/>
</tag>
]]></source>
</subsection>
<subsection name="feature">
<table>
<tr><th>Target</th><td>Component,Service</td></tr>
<tr><th>Allow Multiple</th><td>false</td></tr>
<tr><th>Inherit</th><td>true</td></tr>
<tr>
<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
extensions.</td>
</tr>
</table>
<h4>Parameters:</h4>
<table>
<tr>
<th>Name</th>
<th>Default</th>
<th>Required</th>
<th>Description</th>
</tr>
<tr>
<td>required</td>
<td></td>
<td>false</td>
<td>This whitespace seprated list of features
that this component requires.</td>
</tr>
<tr>
<td>optional</td>
<td></td>
<td>false</td>
<td>This whitespace seprated list of features
that this component will use if present.</td>
</tr>
</table>
<p>The following is an example of a component declaring
that it requires extension sec, tx and will use mx if
present.</p>
<source>
<![CDATA[
<tag name="feature">
<param name="required" value="sec tx"/>
<param name="optional" value="mx"/>
</tag>
]]></source>
</subsection>
</section>
</body>
</document>
--
To unsubscribe, e-mail: <mailto:[EMAIL PROTECTED]>
For additional commands, e-mail: <mailto:[EMAIL PROTECTED]>
