leosimons 2002/11/22 13:44:29
Modified: info/src/xdocs attributes.xml
Added: info/src/xdocs experimental-attributes.xml
Log:
Some docs on experimental attributes. Submitted by Peter Donald
Revision Changes Path
1.4 +5 -3 jakarta-avalon-excalibur/info/src/xdocs/attributes.xml
Index: attributes.xml
===================================================================
RCS file: /home/cvs/jakarta-avalon-excalibur/info/src/xdocs/attributes.xml,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- attributes.xml 12 Nov 2002 19:49:06 -0000 1.3
+++ attributes.xml 22 Nov 2002 21:44:29 -0000 1.4
@@ -8,9 +8,11 @@
<body>
<section name="Introduction">
<p>This document aims to describe the attributes that define
- functionality common to multiple containers. These Info attributes
- are usually generated from source files that have been decorated
- with <a href="doclet.html">Javadoc</a> tags.</p>
+ functionality common to multiple containers. The
+ <a href="experimental-attributes.xml">Experimental
+ Attributes</a> document describes a set of attributes that
+ are currently under development and have yet to be
+ standardized across containers.</p>
</section>
<section name="Tags">
<p>The list of standard metadata attributes includes;</p>
1.1
jakarta-avalon-excalibur/info/src/xdocs/experimental-attributes.xml
Index: experimental-attributes.xml
===================================================================
<?xml version="1.0"?>
<document>
<properties>
<title>Experimental Attribute Definitions</title>
<author email="peter at apache.org">Peter Donald</author>
</properties>
<body>
<section name="Introduction">
<p>
Attribute definition is the primary mechanims via
which component meta can be extended. So if you need
to add a new
<a href="features.xml">Feature</a> to
a container that requires meta data from a component
then you need to extend the Meta Data model by
defining attributes. See the section on the
<a href="#process">Attribute Definition Process</a>
for details on how to define new attributes.
</p>
</section>
<section name="Work in progress">
<p>The current list of experimental attributes follows;</p>
<ul>
<li>
<b>x-mx</b>: This is a set of attributes that declares
management attributes and operations for an object. By
interpreting these attributes the container can export
an object to a management system.
</li>
</ul>
</section>
<a name="process"/>
<section name="Attribute Definition Process">
<p>Anytime a group or individual wishes to define an attribute
they need to produce a document defining the attribute and all
it's parameters. At that stage it should be presented to the
community for discussion.</p>
<p>Once the initial document has been finalized and there is a
container or tool that actually supports the attribute, a link
to the document will be added to the list of Attribute works in
progress.</p>
<p>If after six months no changes have been required then the
attribute is put to a majority vote by the community. If successful
it will be placed on the list of stable attributes.</p>
</section>
</body>
</document>
--
To unsubscribe, e-mail: <mailto:[EMAIL PROTECTED]>
For additional commands, e-mail: <mailto:[EMAIL PROTECTED]>
