notify-dpml AT lists.ibiblio.org

Subject: DPML Notify

List archive

svn commit: r1176 - development/main/central/site/src/docs/products/magic/antlib

From: mcconnell AT netcompartner.com
To: notify-dpml AT lists.ibiblio.org
Subject: svn commit: r1176 - development/main/central/site/src/docs/products/magic/antlib
Date: Mon, 13 Dec 2004 22:41:13 +0100

Author: mcconnell
Date: Mon Dec 13 22:41:13 2004
New Revision: 1176

Added:
development/main/central/site/src/docs/products/magic/antlib/
development/main/central/site/src/docs/products/magic/antlib/index.xml
(contents, props changed)
development/main/central/site/src/docs/products/magic/antlib/init.xml
(contents, props changed)

development/main/central/site/src/docs/products/magic/antlib/navigation.xml
(contents, props changed)
development/main/central/site/src/docs/products/magic/antlib/plugin.xml
(contents, props changed)
Log:
Start on moving docs related to transit task to magic antlib.

Added: development/main/central/site/src/docs/products/magic/antlib/index.xml
==============================================================================
--- (empty file)
+++ development/main/central/site/src/docs/products/magic/antlib/index.xml
Mon Dec 13 22:41:13 2004
@@ -0,0 +1,51 @@
+<?xml version="1.0" encoding="ISO-8859-1"?>
+
+<document>
+ <properties>
+ <author email="mcconnell AT dpml.net">Stephen McConnell</author>
+ <title>DPML Magic</title>
+ </properties>
+
+ <body>
+ <section name="Magic Antlib">
+
+ <subsection name="Namespace">
+
+<source>antlib:net.dpml.transit</source>
+
+ </subsection>
+
+ <subsection name="Description">
+
+ <p>
+ The Magic antlib provides two ant tasks that deliver the bootstrap
functionality
+ needed to load the full Magic system. The antlib includes an init
and the plugin task.
+ The init task is used to established a number of transit related ant
properties, a build
+ listener, and a component helper. The plugin task is used to load
antlibs, taskdefs,
+ typedefs and build listeners using classloaders established relative
to resources
+ managed by the transit system.
+ </p>
+
+ <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.
+ </p>
+ <p><i>Example build file:</i></p>
+
+<pre><![CDATA[
+<project name="example"
+ xmlns:transit="antlib:net.dpml.transit">
+
+ <transit:init>
+ <plugin uri="@MAGIC-CORE-PLUGIN-URI@"/>
+ </tranist:init>
+
+</project>
+]]></pre>
+
+ </subsection>
+
+ </section>
+ </body>
+</document>
+

Added: development/main/central/site/src/docs/products/magic/antlib/init.xml
==============================================================================
--- (empty file)
+++ development/main/central/site/src/docs/products/magic/antlib/init.xml
Mon Dec 13 22:41:13 2004
@@ -0,0 +1,45 @@
+<?xml version="1.0" encoding="ISO-8859-1"?>
+
+<document>
+ <properties>
+ <author email="mcconnell AT dpml.net">Stephen McConnell</author>
+ <title>DPML Magic</title>
+ </properties>
+
+ <body>
+ <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.
+ </p>
+
+ <p><i>Example build file:</i></p>
+
+<source><![CDATA[
+<project name="example"
+ xmlns:transit="antlib:net.dpml.transit">
+
+ <transit:init/>
+
+ <echo message="Home: ${dpml.home}"/>
+ <echo message="Cache: ${dpml.cache}"/>
+ <echo message="Templates: ${dpml.templates}"/>
+ <echo message="Docs: ${dpml.docs}"/>
+
+</project>
+]]></source>
+
+ <p><i>Output:</i></p>
+<pre><![CDATA[
+ [echo] Home: C:\system\dpml
+ [echo] Cache: C:\system\dpml\main
+ [echo] Templates: C:\system\dpml\templates
+ [echo] Docs: C:\system\dpml\docs
+]]></pre>
+
+ </section>
+ </body>
+</document>
+

Added:
development/main/central/site/src/docs/products/magic/antlib/navigation.xml
==============================================================================
--- (empty file)
+++
development/main/central/site/src/docs/products/magic/antlib/navigation.xml
Mon Dec 13 22:41:13 2004
@@ -0,0 +1,34 @@
+<?xml version="1.0" encoding="UTF-8"?>
+
+
+
+<project>
+
+ <title>Magic</title>
+
+ <body>
+
+ <menu>
+ <item name="Init" href="init.html"/>
+ <item name="Plugin" href="plugin.html"/>
+ </menu>
+
+ </body>
+
+</project>

Added: development/main/central/site/src/docs/products/magic/antlib/plugin.xml
==============================================================================
--- (empty file)
+++ development/main/central/site/src/docs/products/magic/antlib/plugin.xml
Mon Dec 13 22:41:13 2004
@@ -0,0 +1,39 @@
+<?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="Plugin Task">
+
+ <p>
+ The plugin task locates plugin meta-data, and from that data, creates
+ a classloader, loads the plugin from the repository, and declares to
ant
+ any tasks, taskdefs, and/or listeners that the user declares.
+ </p>
+
+ <p><i>Example of a request to load an antlib.</i></p>
+
+<source><![CDATA[
+ <transit:plugin uri="artifact:meta:dpml/magic/dpml-magic-core#SNAPSHOT">
+ <antlib resource="net/dpml/magic/antlib.xml"
urn="antlib:net.dpml.magic"/>
+ </transit:plugin>
+]]></source>
+
+ <p><i>Example of a request to load and register a task
definition.</i></p>
+
+<source><![CDATA[
+ <transit:plugin uri="${spec}">
+ <task class="net.dpml.magic.doc.DocTask" name="docs"/>
+ </transit:plugin>
+ <docs/>
+]]></source>
+
+ </section>
+ </body>
+
+</document>
+

svn commit: r1176 - development/main/central/site/src/docs/products/magic/antlib, mcconnell, 12/13/2004