notify-dpml AT lists.ibiblio.org
Subject: DPML Notify
List archive
r1280 - in trunk/main/central/src/docs/transit: . parts parts/classpath parts/info parts/strategy
- From: mcconnell at BerliOS <mcconnell AT mail.berlios.de>
- To: notify-dpml AT lists.ibiblio.org
- Subject: r1280 - in trunk/main/central/src/docs/transit: . parts parts/classpath parts/info parts/strategy
- Date: Tue, 28 Mar 2006 13:51:07 +0200
Author: mcconnell
Date: 2006-03-28 13:50:13 +0200 (Tue, 28 Mar 2006)
New Revision: 1280
Added:
trunk/main/central/src/docs/transit/parts/
trunk/main/central/src/docs/transit/parts/classpath/
trunk/main/central/src/docs/transit/parts/classpath/index.xml
trunk/main/central/src/docs/transit/parts/classpath/navigation.xml
trunk/main/central/src/docs/transit/parts/index.xml
trunk/main/central/src/docs/transit/parts/info/
trunk/main/central/src/docs/transit/parts/info/index.xml
trunk/main/central/src/docs/transit/parts/info/navigation.xml
trunk/main/central/src/docs/transit/parts/navigation.xml
trunk/main/central/src/docs/transit/parts/strategy/
trunk/main/central/src/docs/transit/parts/strategy/index.xml
trunk/main/central/src/docs/transit/parts/strategy/navigation.xml
trunk/main/central/src/docs/transit/setup/
Modified:
trunk/main/central/src/docs/transit/navigation.xml
Log:
general transit doc improvements
Modified: trunk/main/central/src/docs/transit/navigation.xml
===================================================================
--- trunk/main/central/src/docs/transit/navigation.xml 2006-03-28 05:08:20
UTC (rev 1279)
+++ trunk/main/central/src/docs/transit/navigation.xml 2006-03-28 11:50:13
UTC (rev 1280)
@@ -27,6 +27,7 @@
<menu>
<item name="Overview" href="concepts/index.html"/>
<item name="Protocols" href="technical/index.html"/>
+ <item name="Directives" href="parts/index.html"/>
<item name="Services" href="services/index.html"/>
<item name="Properties" href="properties.html"/>
<item name="Configuration" href="config/index.html"/>
Added: trunk/main/central/src/docs/transit/parts/classpath/index.xml
===================================================================
--- trunk/main/central/src/docs/transit/parts/classpath/index.xml
2006-03-28 05:08:20 UTC (rev 1279)
+++ trunk/main/central/src/docs/transit/parts/classpath/index.xml
2006-03-28 11:50:13 UTC (rev 1280)
@@ -0,0 +1,94 @@
+<?xml version="1.0" encoding="UTF-8"?>
+
+<document>
+
+ <properties>
+ <author email="mcconnell AT dpml.net">Stephen McConnell</author>
+ <title>DPML Metro Component Task</title>
+ </properties>
+
+ <body>
+
+ <section name="Classpath Element">
+
+ <subsection name="Description">
+
+ <p>
+ </p>
+
+ <p>Example:</p>
+
+<source>
+<![CDATA[
+ <classpath>
+ <public>
+ <uri>artifact:jar:dpml/util/dpml-logging-api#SNAPSHOT</uri>
+ </public>
+ <protected>
+ <uri>artifact:jar:dpml/metro/dpml-state-api#SNAPSHOT</uri>
+ <uri>artifact:jar:dpml/util/dpml-job-api#SNAPSHOT</uri>
+ <uri>artifact:jar:dpml/transit/dpml-transit-main#SNAPSHOT</uri>
+ <uri>artifact:jar:dpml/metro/dpml-metro-component#SNAPSHOT</uri>
+ <uri>artifact:jar:dpml/util/dpml-parameters-api#SNAPSHOT</uri>
+ <uri>artifact:jar:dpml/util/dpml-configuration-api#SNAPSHOT</uri>
+ <uri>artifact:jar:dpml/metro/dpml-metro-model#SNAPSHOT</uri>
+ </protected>
+ <private>
+ <uri>artifact:jar:dpml/util/dpml-parameters-impl#SNAPSHOT</uri>
+ <uri>artifact:jar:dpml/util/dpml-configuration-impl#SNAPSHOT</uri>
+ <uri>artifact:jar:dpml/util/dpml-job-impl#SNAPSHOT</uri>
+ <uri>artifact:jar:dpml/metro/dpml-state-impl#SNAPSHOT</uri>
+ <uri>artifact:jar:dpml/depot/dpml-library#SNAPSHOT</uri>
+ <uri>artifact:jar:dpml/metro/dpml-metro-builder#SNAPSHOT</uri>
+ <uri>artifact:jar:dpml/metro/dpml-metro-runtime#SNAPSHOT</uri>
+ </private>
+ </classpath>
+]]>
+</source>
+
+ </subsection>
+
+ <subsection name="Nested Elements">
+
+ <table>
+ <tr>
+ <td>
+ <tt>public</tt>
+ </td>
+ <td>
+ Declaration of the collection of resource uris that
collectively
+ define the public classloader. The <tt><public></tt>
element is optional and
+ may contain 0..n nested <tt><uri></tt> elements.
+ </td>
+ </tr>
+ <tr>
+ <td>
+ <tt>protected</tt>
+ </td>
+ <td>
+ Declaration of the collection of resource uris that
collectively
+ define the protected classloader which is itself defined using
the
+ public classloader as its parent. The
<tt><protected></tt>element is optional and
+ may contain 0..n nested <tt><uri></tt> elements.
+ </td>
+ </tr>
+ <tr>
+ <td>
+ <tt>private</tt>
+ </td>
+ <td>
+ Declaration of the collection of resource uris that
collectively
+ define the private implementation classloader which is itself
defined using the
+ protected classloader as its parent. The
<tt><private></tt>element is optional and
+ may contain 0..n nested <tt><uri></tt> elements.
+ </td>
+ </tr>
+ </table>
+
+ </subsection>
+
+ </section>
+
+ </body>
+
+</document>
Added: trunk/main/central/src/docs/transit/parts/classpath/navigation.xml
===================================================================
--- trunk/main/central/src/docs/transit/parts/classpath/navigation.xml
2006-03-28 05:08:20 UTC (rev 1279)
+++ trunk/main/central/src/docs/transit/parts/classpath/navigation.xml
2006-03-28 11:50:13 UTC (rev 1280)
@@ -0,0 +1,32 @@
+<?xml version="1.0" encoding="UTF-8"?>
+
+<!--
+ Copyright 2004 Stephen McConnell
+
+ Licensed under the Apache License, Version 2.0 (the "License");
+ you may not use this file except in compliance with the License.
+ You may obtain a copy of the License at
+
+ http://www.dpml.net/central/about/legal/
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+ implied.
+
+ See the License for the specific language governing permissions and
+ limitations under the License.
+-->
+
+<project>
+
+ <title>Component Strategy Directive Specification</title>
+
+ <body>
+
+ <menu>
+ </menu>
+
+ </body>
+
+</project>
Added: trunk/main/central/src/docs/transit/parts/index.xml
===================================================================
--- trunk/main/central/src/docs/transit/parts/index.xml 2006-03-28 05:08:20
UTC (rev 1279)
+++ trunk/main/central/src/docs/transit/parts/index.xml 2006-03-28 11:50:13
UTC (rev 1280)
@@ -0,0 +1,113 @@
+<?xml version="1.0" encoding="UTF-8"?>
+
+<document>
+
+ <properties>
+ <author email="mcconnell AT dpml.net">Stephen McConnell</author>
+ <title>DPML Metro Component Task</title>
+ </properties>
+
+ <body>
+
+ <section name="Part XML Directive">
+
+ <subsection name="Description">
+
+ <p>
+ A part defines a deployment unit.
+ </p>
+
+ <p>
+ The part specification contains a general <tt><info></tt>
block,
+ a deployment <tt><strategy></tt> specification and a
<tt><classpath></tt>
+ definition.
+ </p>
+
+ <p>Example part definition:</p>
+
+<source>
+<![CDATA[
+<?xml version="1.0"?>
+
+<part xmlns="artifact:xsd:dpml/lang/dpml-part#1.0">
+
+ <info title="Untitled">
+ <description></description>
+ </info>
+
+ <plugin class="net.dpml.metro.runtime.CompositionController"/>
+
+ <classpath>
+ <public>
+ <uri>artifact:jar:dpml/util/dpml-logging-api#SNAPSHOT</uri>
+ </public>
+ <protected>
+ <uri>artifact:jar:dpml/metro/dpml-state-api#SNAPSHOT</uri>
+ <uri>artifact:jar:dpml/util/dpml-job-api#SNAPSHOT</uri>
+ <uri>artifact:jar:dpml/transit/dpml-transit-main#SNAPSHOT</uri>
+ <uri>artifact:jar:dpml/metro/dpml-metro-component#SNAPSHOT</uri>
+ <uri>artifact:jar:dpml/util/dpml-parameters-api#SNAPSHOT</uri>
+ <uri>artifact:jar:dpml/util/dpml-configuration-api#SNAPSHOT</uri>
+ <uri>artifact:jar:dpml/metro/dpml-metro-model#SNAPSHOT</uri>
+ </protected>
+ <private>
+ <uri>artifact:jar:dpml/util/dpml-parameters-impl#SNAPSHOT</uri>
+ <uri>artifact:jar:dpml/util/dpml-configuration-impl#SNAPSHOT</uri>
+ <uri>artifact:jar:dpml/util/dpml-job-impl#SNAPSHOT</uri>
+ <uri>artifact:jar:dpml/metro/dpml-state-impl#SNAPSHOT</uri>
+ <uri>artifact:jar:dpml/depot/dpml-library#SNAPSHOT</uri>
+ <uri>artifact:jar:dpml/metro/dpml-metro-builder#SNAPSHOT</uri>
+ <uri>artifact:jar:dpml/metro/dpml-metro-runtime#SNAPSHOT</uri>
+ </private>
+ </classpath>
+
+</part>]]>
+</source>
+
+ </subsection>
+
+ <subsection name="Nested Elements">
+
+ <table>
+ <tr>
+ <td>
+ <tt><a href="info/index.html">info</a></tt>
+ </td>
+ <td>
+ The info defintion used to associate a title and
+ human readable description.
+ </td>
+ </tr>
+ <tr>
+ <td>
+ <tt><a href="strategy/index.html">strategy</a></tt>
+ </td>
+ <td>
+ Any XML element derived from StrategyType. The schema element
+ defines the deployment strategy. A part handler is resolved
+ through a element builder which is itself resolved relative to
+ the XML schema urn of the strategy element. The Transit system
+ provides two standard strategy elements -
<tt><plugin></tt>
+ and <tt><resource></tt>.
+ </td>
+ </tr>
+ <tr>
+ <td>
+ <tt><a href="classpath/index.html">classpath</a></tt>
+ </td>
+ <td>
+ Definition of the classpath for the part. The classpath
contains
+ the declaration of public, protected and private jar files
referenced
+ via uris that collectively enable the cionstruction of a
cloassloader
+ chain.
+ </td>
+ </tr>
+ </table>
+
+ </subsection>
+
+ </section>
+
+ </body>
+
+</document>
Added: trunk/main/central/src/docs/transit/parts/info/index.xml
===================================================================
--- trunk/main/central/src/docs/transit/parts/info/index.xml 2006-03-28
05:08:20 UTC (rev 1279)
+++ trunk/main/central/src/docs/transit/parts/info/index.xml 2006-03-28
11:50:13 UTC (rev 1280)
@@ -0,0 +1,39 @@
+<?xml version="1.0" encoding="UTF-8"?>
+
+<document>
+
+ <properties>
+ <author email="mcconnell AT dpml.net">Stephen McConnell</author>
+ <title>DPML Part Directive</title>
+ </properties>
+
+ <body>
+
+ <section name="Info Element">
+
+ <subsection name="Description">
+
+ <p>
+ The <tt><info></tt> element associates a human-readable
+ title and description with a part definition.
+ </p>
+
+ <p>Example:</p>
+
+<source>
+<![CDATA[
+ <info title="ACME Widget">
+ <description>
+ The ACME Widget is a generalized factory for
+ the production of Gizmos.
+ </description>
+ </info>]]>
+</source>
+
+ </subsection>
+
+ </section>
+
+ </body>
+
+</document>
Added: trunk/main/central/src/docs/transit/parts/info/navigation.xml
===================================================================
--- trunk/main/central/src/docs/transit/parts/info/navigation.xml
2006-03-28 05:08:20 UTC (rev 1279)
+++ trunk/main/central/src/docs/transit/parts/info/navigation.xml
2006-03-28 11:50:13 UTC (rev 1280)
@@ -0,0 +1,32 @@
+<?xml version="1.0" encoding="UTF-8"?>
+
+<!--
+ Copyright 2004 Stephen McConnell
+
+ Licensed under the Apache License, Version 2.0 (the "License");
+ you may not use this file except in compliance with the License.
+ You may obtain a copy of the License at
+
+ http://www.dpml.net/central/about/legal/
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+ implied.
+
+ See the License for the specific language governing permissions and
+ limitations under the License.
+-->
+
+<project>
+
+ <title>Component Strategy Directive Specification</title>
+
+ <body>
+
+ <menu>
+ </menu>
+
+ </body>
+
+</project>
Added: trunk/main/central/src/docs/transit/parts/navigation.xml
===================================================================
--- trunk/main/central/src/docs/transit/parts/navigation.xml 2006-03-28
05:08:20 UTC (rev 1279)
+++ trunk/main/central/src/docs/transit/parts/navigation.xml 2006-03-28
11:50:13 UTC (rev 1280)
@@ -0,0 +1,35 @@
+<?xml version="1.0" encoding="UTF-8"?>
+
+<!--
+ Copyright 2004 Stephen McConnell
+
+ Licensed under the Apache License, Version 2.0 (the "License");
+ you may not use this file except in compliance with the License.
+ You may obtain a copy of the License at
+
+ http://www.dpml.net/central/about/legal/
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+ implied.
+
+ See the License for the specific language governing permissions and
+ limitations under the License.
+-->
+
+<project>
+
+ <title>Part Directive Specification</title>
+
+ <body>
+
+ <menu>
+ <item name="Info" href="info/index.html"/>
+ <item name="Strategy" href="strategy/index.html"/>
+ <item name="Classpath" href="classpath/index.html"/>
+ </menu>
+
+ </body>
+
+</project>
Added: trunk/main/central/src/docs/transit/parts/strategy/index.xml
===================================================================
--- trunk/main/central/src/docs/transit/parts/strategy/index.xml
2006-03-28 05:08:20 UTC (rev 1279)
+++ trunk/main/central/src/docs/transit/parts/strategy/index.xml
2006-03-28 11:50:13 UTC (rev 1280)
@@ -0,0 +1,40 @@
+<?xml version="1.0" encoding="UTF-8"?>
+
+<document>
+
+ <properties>
+ <author email="mcconnell AT dpml.net">Stephen McConnell</author>
+ <title>DPML Part Directive</title>
+ </properties>
+
+ <body>
+
+ <section name="Strategy XML Directive">
+
+ <subsection name="Description">
+
+ <p>
+ </p>
+
+ <p>Example:</p>
+
+<source>
+<![CDATA[
+]]>
+</source>
+
+ </subsection>
+
+ <subsection name="Attributes">
+
+ </subsection>
+
+ <subsection name="Nested Elements">
+
+ </subsection>
+
+ </section>
+
+ </body>
+
+</document>
Added: trunk/main/central/src/docs/transit/parts/strategy/navigation.xml
===================================================================
--- trunk/main/central/src/docs/transit/parts/strategy/navigation.xml
2006-03-28 05:08:20 UTC (rev 1279)
+++ trunk/main/central/src/docs/transit/parts/strategy/navigation.xml
2006-03-28 11:50:13 UTC (rev 1280)
@@ -0,0 +1,32 @@
+<?xml version="1.0" encoding="UTF-8"?>
+
+<!--
+ Copyright 2004 Stephen McConnell
+
+ Licensed under the Apache License, Version 2.0 (the "License");
+ you may not use this file except in compliance with the License.
+ You may obtain a copy of the License at
+
+ http://www.dpml.net/central/about/legal/
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+ implied.
+
+ See the License for the specific language governing permissions and
+ limitations under the License.
+-->
+
+<project>
+
+ <title>Component Strategy Directive Specification</title>
+
+ <body>
+
+ <menu>
+ </menu>
+
+ </body>
+
+</project>
- r1280 - in trunk/main/central/src/docs/transit: . parts parts/classpath parts/info parts/strategy, mcconnell at BerliOS, 03/28/2006
Archive powered by MHonArc 2.6.24.