donaldp 2002/09/14 01:05:27
Modified: info/src/xdocs menu.xml
Added: info/src/xdocs context.xml
Log:
Convert context document into xdoc doc.
Revision Changes Path
1.3 +3 -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.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- menu.xml 8 Sep 2002 02:57:53 -0000 1.2
+++ menu.xml 14 Sep 2002 08:05:27 -0000 1.3
@@ -11,5 +11,8 @@
<item name="Download"
href="http://jakarta.apache.org/builds/jakarta-avalon-excalibur/release"/>
<item name="API Docs" href="/api/"/>
</menu>
+ <menu name="Specifications">
+ <item name="Context Entry Spec" href="/context.html"/>
+ </menu>
</body>
</project>
1.1 jakarta-avalon-excalibur/info/src/xdocs/context.xml
Index: context.xml
===================================================================
<?xml version="1.0"?>
<document>
<properties>
<title>Context Entrys</title>
<author email="peter at apache.org">Peter Donald</author>
</properties>
<body>
<section name="Overview">
<p>The Context interface gives the component writer an interface
via
which to access resources that are provided by the container. Each
component declares the resources it requires (or will use if
present)
under a specific key with a specific type.</p>
<p>The list of context keys that is supported by the container is
extensible and follows the namespacing conventions outlined in the
<a href="namespaces.html">Namespace</a> document. However there
are
a set of standard key-value pairs. It is recomended that container
recognize these if they support the particular feature.</p>
</section>
<section name="Entry Definitions">
<table>
<tr>
<th>Key</th>
<th>Type</th>
<th>Description</th>
</tr>
<tr>
<td>component:name</td>
<td><code>java.lang.String</code></td>
<td>This entry defines the name of the component.</td>
</tr>
<tr>
<td>component:classloader</td>
<td><code>java.lang.ClassLoader</code></td>
<td>The classloader via which the component was loaded.
May
differ from the ClassLoader returned by
getClass().getClassLoader()
if the component was loaded from parent classloader.</td>
</tr>
<tr>
<td>partition:name</td>
<td><code>java.lang.String</code></td>
<td>This entry defines the name of the partition.</td>
</tr>
<tr>
<td>application:name</td>
<td><code>java.lang.String</code></td>
<td>This entry defines the name of the application.</td>
</tr>
<tr>
<td>component:home</td>
<td><code>java.io.File</code></td>
<td>The location in which the component
to store persistent data relevent to the
component.</td>
</tr>
<tr>
<td>component:work</td>
<td><code>java.io.File</code></td>
<td>This directory in which to store temporary or working
information. It may not persist over restarts of
the component.</td>
</tr>
</table>
</section>
</body>
</document>
--
To unsubscribe, e-mail: <mailto:[EMAIL PROTECTED]>
For additional commands, e-mail: <mailto:[EMAIL PROTECTED]>
