Skip to Content.
Sympa Menu

notify-dpml - svn commit: r1391 - in development/main: central/site central/site/src/docs/products/magic/antlib central/site/src/docs/products/magic/plugins central/site/src/docs/products/magic/plugins/checkstyle central/site/src/docs/products/transit/launcher magic/spells/checkstyle/etc/deliverables/templates metro/meta/api/src/main/net/dpml/meta/info/doc-files

notify-dpml AT lists.ibiblio.org

Subject: DPML Notify

List archive

Chronological Thread  
  • From: mcconnell AT netcompartner.com
  • To: notify-dpml AT lists.ibiblio.org
  • Subject: svn commit: r1391 - in development/main: central/site central/site/src/docs/products/magic/antlib central/site/src/docs/products/magic/plugins central/site/src/docs/products/magic/plugins/checkstyle central/site/src/docs/products/transit/launcher magic/spells/checkstyle/etc/deliverables/templates metro/meta/api/src/main/net/dpml/meta/info/doc-files
  • Date: Thu, 06 Jan 2005 06:46:05 +0100

Author: mcconnell
Date: Thu Jan 6 06:46:05 2005
New Revision: 1391

Added:
development/main/central/site/src/docs/products/magic/plugins/checkstyle/

development/main/central/site/src/docs/products/magic/plugins/checkstyle/index.xml
(contents, props changed)

development/main/central/site/src/docs/products/magic/plugins/checkstyle/navigation.xml
(contents, props changed)
Modified:
development/main/central/site/build.xml
development/main/central/site/src/docs/products/magic/antlib/index.xml
development/main/central/site/src/docs/products/magic/antlib/init.xml
development/main/central/site/src/docs/products/magic/antlib/plugin.xml
development/main/central/site/src/docs/products/magic/plugins/index.xml

development/main/central/site/src/docs/products/magic/plugins/navigation.xml
development/main/central/site/src/docs/products/transit/launcher/index.xml

development/main/magic/spells/checkstyle/etc/deliverables/templates/checkstyle.template

development/main/metro/meta/api/src/main/net/dpml/meta/info/doc-files/Thumbs.db
Log:
Updates to transit and related content in the magic core tasks.

Modified: development/main/central/site/build.xml
==============================================================================
--- development/main/central/site/build.xml (original)
+++ development/main/central/site/build.xml Thu Jan 6 06:46:05 2005
@@ -49,6 +49,7 @@
token="METRO-RUNTIME-PLUGIN-URI"/>
<x:filter key="dpml-metro-main" feature="plugin"
token="METRO-PLUGIN-URI"/>
+ <x:filter key="dpml-magic-core" feature="plugin"
token="MAGIC-PLUGIN-URI"/>
<x:filter key="dpml-transit-plugin" feature="plugin"
token="TRANSIT-PLUGIN-URI"/>
<x:filter key="dpml-transit" feature="api" token="TRANSIT-DOCS-PATH"/>
<x:filter key="dpml-magic" feature="api" token="MAGIC-DOCS-PATH"/>

Modified:
development/main/central/site/src/docs/products/magic/antlib/index.xml
==============================================================================
--- development/main/central/site/src/docs/products/magic/antlib/index.xml
(original)
+++ development/main/central/site/src/docs/products/magic/antlib/index.xml
Thu Jan 6 06:46:05 2005
@@ -28,7 +28,7 @@

<p>
The following example project demonstrates the initialization of the
transit sub-system
- during which the magic build system is urn to uri mapping is
declared.
+ during which the magic build system urn-to-uri mapping is declared.
</p>
<p><i>Example build file:</i></p>

@@ -36,9 +36,9 @@
<project name="example"
xmlns:magic="antlib:net.dpml.magic">

- <transit:init>
- <plugin uri="@MAGIC-CORE-PLUGIN-URI@"/>
- </tranist:init>
+ <magic:init>
+ <plugin uri="@MAGIC-PLUGIN-URI@"/>
+ </magic:init>

</project>
]]></pre>

Modified:
development/main/central/site/src/docs/products/magic/antlib/init.xml
==============================================================================
--- development/main/central/site/src/docs/products/magic/antlib/init.xml
(original)
+++ development/main/central/site/src/docs/products/magic/antlib/init.xml
Thu Jan 6 06:46:05 2005
@@ -10,32 +10,33 @@
<section name="Initialization Task">

<p>
- The init task is used to establish the transit initial context
- and from this a small number of properties that can be used in
- a build file.
+ The init task is used to establish the transit initial context,
+ component helper, and an optionally an initial set of plugins to
+ be loaded.
</p>

- <p><i>Example build file:</i></p>
+ <p><i>Example template file:</i></p>

<source><![CDATA[
<project name="example"
xmlns:magic="antlib:net.dpml.magic">

- <magic:init/>
-
- <echo message="Home: ${dpml.home}"/>
- <echo message="Cache: ${dpml.cache}"/>
- <echo message="Docs: ${dpml.docs}"/>
+ <magic:init>
+ <plugin uri="@MAGIC-PLUGIN-URI@"/>
+ </magic:init>

</project>
]]></source>

<p><i>Output:</i></p>
<pre><![CDATA[
- [echo] Home: C:\system\dpml
- [echo] Cache: C:\system\dpml\main
- [echo] Docs: C:\system\dpml\docs
-]]></pre>
+Buildfile: build.xml
+ [transit] home: D:\dpml
+
+Assigning Transit component helper.
+
+default:
+installing plugin: plugin:dpml/magic/dpml-magic-core]]></pre>

</section>
</body>

Modified:
development/main/central/site/src/docs/products/magic/antlib/plugin.xml
==============================================================================
--- development/main/central/site/src/docs/products/magic/antlib/plugin.xml
(original)
+++ development/main/central/site/src/docs/products/magic/antlib/plugin.xml
Thu Jan 6 06:46:05 2005
@@ -18,12 +18,10 @@
<p><i>Example of a request to load an antlib.</i></p>

<source><![CDATA[
- <magic:plugin uri="artifact:meta:dpml/magic/dpml-magic-core#SNAPSHOT">
- <antlib resource="net/dpml/magic/antlib.xml"
urn="plugin:dpml/magic/dpml-magic-core"/>
- </magic:plugin>
+ <magic:plugin uri="artifact:meta:dpml/magic/dpml-magic-core#SNAPSHOT"/>
]]></source>

- <p><i>Example of a request to load and register a task
definition.</i></p>
+ <p><i>Example of a request to load and register a single task
definition.</i></p>

<source><![CDATA[
<magic:plugin uri="${spec}">

Added:
development/main/central/site/src/docs/products/magic/plugins/checkstyle/index.xml
==============================================================================
--- (empty file)
+++
development/main/central/site/src/docs/products/magic/plugins/checkstyle/index.xml
Thu Jan 6 06:46:05 2005
@@ -0,0 +1,125 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<document>
+
+ <properties>
+ <author email="mcconnell AT dpml.net">Stephen McConnell</author>
+ <title>DPML Magic</title>
+ </properties>
+
+ <body>
+ <section name="Checkstyle Task">
+
+ <subsection name="Overview">
+
+ <p>
+ The checkstyle task provides support for the integration of checkstyle
+ code style validation and reporting into the Magic development
environment.
+ The task allows the selection of a style format using Transit uris and
+ and postprocessing of XML based report output using Magic's Style Task.
+ </p>
+
+ </subsection>
+
+ <subsection name="Example">
+
+ <p>
+ The following example buildfile applies checkstyle checks against the
+ project src path (typically target/build/src or the aggregated set of
+ target/build/src directories in the case of a module). In the case of
+ module projects the source path is prepared taking into account all
+ projects within the same group. Output in generated into the target
+ directory and is subsequently post processed into a checkstyle report
+ directory as an html report.
+ </p>
+
+<source><![CDATA[
+<project name="demo" default="demo" basedir="."
+ xmlns:magic="antlib:net.dpml.magic">
+
+ <magic:import uri="artifact:template:dpml/magic/standard"/>
+ <magic:import uri="artifact:template:dpml/magic/checkstyle"/>
+
+ <target name="demo" depends="checkstyle"/>
+
+</project>
+]]></source>
+
+ <p>
+ Output from the above project is shown below.
+ </p>
+
+<pre>init:
+ [x:init] loading: artifact:meta:dpml/magic/dpml-magic-checkstyle#SNAPSHOT
+
+prepare:
+
+checkstyle:
+ [style] Processing D:\demo\target\checkstyle\checkstyle_errors.xml to
+D:\demo\target\reports\checkstyle\checkstyle_report.html
+ [style] Loading stylesheet
D:\dpml\main\dpml\magic\xsls\checkstyle-frames.xsl
+</pre>
+
+ </subsection>
+
+ <subsection name="Properties">
+
+ <p>
+ The following optional properties may be used to override default
behaviour.
+ </p>
+
+ <table>
+ <tr><th>Property</th><th>Default</th><th>Description</th></tr>
+ <tr>
+ <td>${project.checkstyle.dest}</td>
+ <td>target/checkstyle</td>
+ <td>The destination directory for temporary data.</td>
+ </tr>
+ <tr>
+ <td>${project.checkstyle.format}</td>
+ <td>artifact:format:dpml/magic/dpml</td>
+ <td>The transit uri of the checkstyle format rules
specification.</td>
+ </tr>
+ <tr>
+ <td>${project.checkstyle.reports}</td>
+ <td>target/reports/checkstyle</td>
+ <td>Destination directory for html report content.</td>
+ </tr>
+ </table>
+
+ </subsection>
+
+ <subsection name="Attributes">
+
+ <p>
+ The checkstyle task is a direct extension of the standard checkstyle
ant task
+ with the addition of a single attribute value against which the
checkstyle format
+ specification may be declared as a transit artifact uri.
+ </p>
+
+ <table>
+ <tr><th>Attribute</th><th>Default</th><th>Description</th></tr>
+ <tr>
+ <td>uri</td>
+ <td>${project.checkstyle.format}</td>
+ <td>A transit artifact uri referencing a checkstyle format rule
sheet.</td>
+ </tr>
+ </table>
+
+ </subsection>
+
+ <subsection name="Style Notes">
+
+ <p>
+ The default formatting rules correspond to the
+ <a href="/about/community/process/code.html">DPML standard code
format</a>
+ specification and is required for all contributions to the DPML.
Alternative
+ code formats include a format approximating the Sun coding guidlines.
+ </p>
+
+ </subsection>
+
+ </section>
+ </body>
+
+</document>
+

Added:
development/main/central/site/src/docs/products/magic/plugins/checkstyle/navigation.xml
==============================================================================
--- (empty file)
+++
development/main/central/site/src/docs/products/magic/plugins/checkstyle/navigation.xml
Thu Jan 6 06:46:05 2005
@@ -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>Magic</title>
+
+ <body>
+
+ <menu>
+ </menu>
+
+ </body>
+
+</project>

Modified:
development/main/central/site/src/docs/products/magic/plugins/index.xml
==============================================================================
--- development/main/central/site/src/docs/products/magic/plugins/index.xml
(original)
+++ development/main/central/site/src/docs/products/magic/plugins/index.xml
Thu Jan 6 06:46:05 2005
@@ -9,6 +9,13 @@
<body>
<section name="Plugins">

+ <p>
+ Task extensions (commonly referred to a spells) can
+ be loaded and executed dynamically using the underlying Transit
+ repository technology. This allows the packaging of tasks as self
+ contained plugins that are loadable directly from remote repositories
+ without user intervention.
+ </p>

</section>
</body>

Modified:
development/main/central/site/src/docs/products/magic/plugins/navigation.xml
==============================================================================
---
development/main/central/site/src/docs/products/magic/plugins/navigation.xml
(original)
+++
development/main/central/site/src/docs/products/magic/plugins/navigation.xml
Thu Jan 6 06:46:05 2005
@@ -25,6 +25,7 @@
<body>

<menu>
+ <item name="Checkstyle" href="checkstyle/index.html"/>
</menu>

</body>

Modified:
development/main/central/site/src/docs/products/transit/launcher/index.xml
==============================================================================
---
development/main/central/site/src/docs/products/transit/launcher/index.xml
(original)
+++
development/main/central/site/src/docs/products/transit/launcher/index.xml
Thu Jan 6 06:46:05 2005
@@ -27,7 +27,7 @@
<body>
<section name="Transit Application Launcher">

- <source>@METRO-PLUGIN-URI@</source>
+ <source>@TRANSIT-PLUGIN-URI@</source>

<subsection name="Overview">

@@ -46,6 +46,33 @@
<source>$ transit [-load uri] [arg1 arg2 arg3 ...]</source>
</subsection>

+ <subsection name="Bootstrap CLI Options">
+
+ <p>
+ The <code>-Xbootstrap</code> cli option is recognized by the Transit
Main class
+ and is used to establish the application launcher plugin uri.
+ </p>
+
+ <table>
+ <tr>
+ <th width="100">Option</th>
+ <th>Argument Type</th>
+ <th>Description</th>
+ </tr>
+ <tr>
+ <td>-Xbootstrap</td>
+ <td>URI</td>
+ <td>
+ The uri of the application launcher to be used. This value is
normally
+ set by the transit commandline script. The value declared under
the script
+ is the artifact uri <code>"@TRANSIT-PLUGIN-URI@"</code>. The
loaded plugin is required
+ to handle the cli options described below.
+ </td>
+ </tr>
+ </table>
+
+ </subsection>
+
<subsection name="Standard CLI Options">

<p>
@@ -72,7 +99,7 @@
</tr>
<tr>
<td>-lang</td>
- <td><code>language code</code></td>
+ <td>language code</td>
<td>A two-letter language code to provide hooks for I18N.</td>
</tr>
<!--
@@ -94,7 +121,7 @@
method. A shutdown hook is added to the newly loaded plugin
to
enable clean shutdown together with the transit instance.
<br/><br/>For example, Metro is started via:
- <br/><code>transit -load
artifact:meta:dpml/metro/tools/dpml-metro-main#SNAPSHOT</code>
+ <br/><code>transit -load @METRO-PLUGIN-URI@</code>
</td>
</tr>
</table>

Modified:
development/main/magic/spells/checkstyle/etc/deliverables/templates/checkstyle.template
==============================================================================
---
development/main/magic/spells/checkstyle/etc/deliverables/templates/checkstyle.template
(original)
+++
development/main/magic/spells/checkstyle/etc/deliverables/templates/checkstyle.template
Thu Jan 6 06:46:05 2005
@@ -22,18 +22,20 @@
xmlns:magic="antlib:net.dpml.magic" >

<target name="checkstyle" depends="prepare"
unless="project.checkstyle.disable" >
+ <property name="project.checkstyle.dest" value="target/checkstyle"/>
<property name="project.checkstyle.format"
value="artifact:format:dpml/magic/dpml"/>
+ <property name="project.checkstyle.reports"
value="target/reports/checkstyle"/>
<magic:plugin uri="@PLUGIN-URI@"/>
- <mkdir dir="target/checkstyle"/>
+ <mkdir dir="${project.checkstyle.dest}"/>
<checkstyle xmlns="plugin:dpml/magic/dpml-magic-checkstyle"
uri="${project.checkstyle.format}">
- <formatter type="xml"
toFile="target/checkstyle/checkstyle_errors.xml"/>
+ <formatter type="xml"
toFile="${project.checkstyle.dest}/checkstyle_errors.xml"/>
</checkstyle>
- <mkdir dir="target/reports/checkstyle"/>
+ <mkdir dir="${project.checkstyle.reports}"/>
<magic:plugin uri="@STYLE-PLUGIN-URI@"/>
<style xmlns="plugin:dpml/magic/dpml-magic-style"
- in="target/checkstyle/checkstyle_errors.xml"
- out="target/reports/checkstyle/checkstyle_report.html"
+ in="${project.checkstyle.dest}/checkstyle_errors.xml"
+ out="${project.checkstyle.reports}/checkstyle_report.html"
style="artifact:xsl:dpml/magic/checkstyle-frames"/>
</target>


Modified:
development/main/metro/meta/api/src/main/net/dpml/meta/info/doc-files/Thumbs.db
==============================================================================
Binary files. No diff available.



  • svn commit: r1391 - in development/main: central/site central/site/src/docs/products/magic/antlib central/site/src/docs/products/magic/plugins central/site/src/docs/products/magic/plugins/checkstyle central/site/src/docs/products/transit/launcher magic/spells/checkstyle/etc/deliverables/templates metro/meta/api/src/main/net/dpml/meta/info/doc-files, mcconnell, 01/06/2005

Archive powered by MHonArc 2.6.24.

Top of Page