notify-dpml AT lists.ibiblio.org

Subject: DPML Notify

List archive

svn commit: r1467 - development/main/central/site/src/docs/products/magic/plugins/eclipse

From: andreas.ronge AT jayway.se
To: notify-dpml AT lists.ibiblio.org
Subject: svn commit: r1467 - development/main/central/site/src/docs/products/magic/plugins/eclipse
Date: Thu, 13 Jan 2005 10:12:15 +0100

Author: andreas.ronge AT jayway.se
Date: Thu Jan 13 10:12:15 2005
New Revision: 1467

Modified:

development/main/central/site/src/docs/products/magic/plugins/eclipse/index.xml
Log:
fixed documentation for eclipse spell

Modified:
development/main/central/site/src/docs/products/magic/plugins/eclipse/index.xml
==============================================================================
---
development/main/central/site/src/docs/products/magic/plugins/eclipse/index.xml
(original)
+++
development/main/central/site/src/docs/products/magic/plugins/eclipse/index.xml
Thu Jan 13 10:12:15 2005
@@ -1,87 +1,105 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<document>
-
- <properties>
- <title>Magic Eclipse Plugin</title>
- </properties>
-
- <body>
- <section name="Eclipse">
-
- <subsection name="Overview">
- <p>
- The plugin registers the "eclipse" target and enables you to issue
- <code>ant eclipse</code>. The generated files establish an Eclipse
project
- that contains the definitions for the index.xml file in scope (the
current directory
- or the first parent dir with an index.xml by default).
- For every project in the index.xml, the corresponding source folders
(src/test, src/main)
- are added to the Eclipse project.
- All resources of type .jar are added to the Eclipse project with their
local path,
- down from the Eclipse MAGIC_CACHE variable that points out the
location of ${dpml.cache}
- (has to be defined manually in Eclipse).
- </p>
-
- <p>
- Generated files/dirs:
- Project description
- - <code>target/eclipse/.project </code> (should be copied into current
dir)
- - <code>target/eclipse/.classpath</code> (should be copied into
current dir)
- For building with magic from within Eclipse
- - <code>./.externalToolBuilders</code> directory is generated
- </p>
- <p>
- The Eclipse 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">
-
-
-<source><![CDATA[
-<?xml version="1.0" encoding="UTF-8" ?>
-
-<project name="orchard-management" default="default" basedir="."
- xmlns:magic="antlib:net.dpml.magic" >
-
- <magic:import uri="artifact:template:dpml/magic/reactor"/>
- <magic:import uri="artifact:template:dpml/magic/eclipse"/>
-
-
-</project>
-]]></source>
-
-
-
- </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>
- </table>
-
- </subsection>
-
- <subsection name="Attributes">
-
- <p>
- </p>
-
- <table>
- <tr><th>Attribute</th><th>Default</th><th>Description</th></tr>
- </table>
-
- </subsection>
- </section>
- </body>
-
-</document>
-
+<?xml version="1.0" encoding="UTF-8"?>
+<document>
+
+ <properties>
+ <title>Magic Eclipse Plugin</title>
+ </properties>
+
+ <body>
+ <section name="Eclipse">
+
+ <subsection name="Overview">
+ <p>
+ The plugin registers the "eclipse" target and enables you to issue
+ <code>ant eclipse</code>. The generated files establish an Eclipse
project
+ that contains the definitions for the index.xml file in scope (the
current directory
+ or the first parent dir with an index.xml by default).
+ All resources of type .jar are added to the Eclipse project with their
local path,
+ down from the Eclipse MAGIC_CACHE variable that points out the
location of ${dpml.cache}
+ (has to be defined manually in Eclipse).
+ </p>
+
+ <p>
+ Generated files/dirs:
+ Project description
+ - <code>target/eclipse/.project </code> (should be copied into current
dir)
+ - <code>target/eclipse/.classpath</code> (should be copied into
current dir)
+ </p>
+ </subsection>
+
+ <subsection name="Example">
+
+
+<source><![CDATA[
+<?xml version="1.0" encoding="UTF-8" ?>
+
+<project name="orchard-management" default="default" basedir="."
+ xmlns:magic="antlib:net.dpml.magic" >
+
+ <property file="build.properties" />
+ <magic:import uri="artifact:template:dpml/magic/reactor"/>
+ <magic:import uri="artifact:template:dpml/magic/eclipse"/>
+
+
+</project>
+]]></source>
+
+
+
+ </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.eclipse.project.uri</td>
+ <td>the artifact URI for the .project template file (must be
an artifact)</td>
+ </tr>
+
+ <tr>
+ <td>project.eclipse.classpath.uri</td>
+ <td>the URI for the .classpath template file</td>
+ </tr>
+
+ <tr>
+ <td>project.eclipse.project.name</td>
+ <td>name of the generated eclipse project</td>
+ </tr>
+
+ <tr>
+ <td>project.eclipse.project.keys</td>
+ <td>which project keys the task should look for dependent
resources</td>
+ </tr>
+
+ <tr>
+ <td>project.eclipse.disable</td>
+ <td>if defined then the eclipse task will not be executed</td>
+ </tr>
+ </table>
+
+ <p>
+ The file at the project.eclipse.project.uri location can contain the
+ ant filter token <code>@PROJECT_NAME@</code>.
+ </p>
+ </subsection>
+
+ <subsection name="Attributes">
+
+ <p>
+ </p>
+
+ <table>
+ <tr><th>Attribute</th><th>Default</th><th>Description</th></tr>
+ </table>
+
+ </subsection>
+ </section>
+ </body>
+
+</document>
+

svn commit: r1467 - development/main/central/site/src/docs/products/magic/plugins/eclipse, andreas . ronge, 01/13/2005