Update tooling documentaiton with more details about plan files.
diff --git a/tooling-guide/images/bundle-references.png b/tooling-guide/images/bundle-references.png
new file mode 100644
index 0000000..ba5b7fc
--- /dev/null
+++ b/tooling-guide/images/bundle-references.png
Binary files differ
diff --git a/tooling-guide/images/create-par-project.png b/tooling-guide/images/create-par-project.png
new file mode 100644
index 0000000..f6cc48e
--- /dev/null
+++ b/tooling-guide/images/create-par-project.png
Binary files differ
diff --git a/tooling-guide/images/create-plan-project.png b/tooling-guide/images/create-plan-project.png
new file mode 100644
index 0000000..8beb2e9
--- /dev/null
+++ b/tooling-guide/images/create-plan-project.png
Binary files differ
diff --git a/tooling-guide/images/new-plan-project.png b/tooling-guide/images/new-plan-project.png
new file mode 100644
index 0000000..8d79050
--- /dev/null
+++ b/tooling-guide/images/new-plan-project.png
Binary files differ
diff --git a/tooling-guide/images/par-content.png b/tooling-guide/images/par-content.png
new file mode 100644
index 0000000..749657f
--- /dev/null
+++ b/tooling-guide/images/par-content.png
Binary files differ
diff --git a/tooling-guide/src/deploying.xml b/tooling-guide/src/deploying.xml
index 40f43c5..79e01b5 100644
--- a/tooling-guide/src/deploying.xml
+++ b/tooling-guide/src/deploying.xml
@@ -2,7 +2,8 @@
<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd">
<chapter id="deploying">
<title>Deploying Applications</title>
- <para>Currently the Tools support direct deployment of WTP Dynamic Web Projects, OSGi bundle and PAR projects to the
+ <para>Currently the Tools support direct deployment of WTP Dynamic Web Projects, OSGi bundle projects,
+ PDE Bundle projects, PAR projects and Plan files (contained in Plan projects) to the
@umbrella.product.name.short@ from directly within Eclipse.
</para>
<para>To deploy an application to the @umbrella.product.name@ just bring up the context menu on the configured
@@ -24,4 +25,4 @@
<para>The wait time between a change and the actual refresh can be configured in the configuration editor of the
runtime. To bring up that editor, double-click on the configured @umbrella.product.name@ instance in the Servers view.
</para>
-</chapter>
\ No newline at end of file
+</chapter>
diff --git a/tooling-guide/src/pars.xml b/tooling-guide/src/pars.xml
index 58a03b9..5513cfb 100644
--- a/tooling-guide/src/pars.xml
+++ b/tooling-guide/src/pars.xml
@@ -20,15 +20,7 @@
</menuchoice>
and press
<emphasis>Next</emphasis>
- :
- <mediaobject>
- <imageobject role="fo">
- <imagedata fileref="images/new-par-project.png" format="PNG" align="center" width="9cm" />
- </imageobject>
- <imageobject role="html">
- <imagedata fileref="images/new-par-project.png" format="PNG" align="center" />
- </imageobject>
- </mediaobject>
+ .
</para>
<para>
In the New PAR Project dialog, ensure the
@@ -79,4 +71,4 @@
<para>The PAR project is then created.
</para>
-</chapter>
\ No newline at end of file
+</chapter>
diff --git a/tooling-guide/src/plans.xml b/tooling-guide/src/plans.xml
new file mode 100644
index 0000000..fe21513
--- /dev/null
+++ b/tooling-guide/src/plans.xml
@@ -0,0 +1,94 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd">
+<chapter id="plans">
+ <title>Developing Plans</title>
+ <para>In @project.name@, applications consisting of multiple bundles can be declared using one or more Plans.
+ </para>
+
+ <para>
+ To create a Plan project, right-click in the
+ <emphasis>Package Explorer</emphasis>
+ and select
+ <menuchoice>
+ <guimenu>New</guimenu>
+ <guimenuitem>Project…</guimenuitem>
+ </menuchoice>
+ . In the dialog that opens select
+ <menuchoice>
+ <guimenu>Virgo</guimenu>
+ <guimenuitem>Plan Project</guimenuitem>
+ </menuchoice>
+ and press
+ <emphasis>Next</emphasis>
+ :
+ <mediaobject>
+ <imageobject role="fo">
+ <imagedata fileref="images/new-plan-project.png" format="PNG" align="center" width="9cm" />
+ </imageobject>
+ <imageobject role="html">
+ <imagedata fileref="images/new-plan-project.png" format="PNG" align="center" />
+ </imageobject>
+ </mediaobject>
+ </para>
+ <para>
+ In the New Plan Project dialog, enter a suitable name for the project, set the location to a suitable directory, and press
+ <emphasis>Next</emphasis>
+ </para>
+ <para>
+ In the next wizard page, you can optionally specify a Plan name to also have a Plan file created for you by the wizard.
+ </para>
+ <para>
+ When creating additional Plan files, make sure you place them within the source folder.
+ You can now add Plan files to the Virgo Runtime in Eclipse via the usual add/remove dialog or by means of drag and drop.
+ </para>
+ <section id="planBenefits">
+ <title>Benefit of using Plan files</title>
+ <para>
+ Plan projects and plan files can be used as an alternative to adding individual bundles to the test environment integrated in Eclipse.
+ The main benefits of using Plan files are:
+ <itemizedlist>
+ <listitem>
+ <para>
+ Plan files can be more easily shared with coworkers and/or committed to a source code repository
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ It may be more convenient to re-order the content of a Plan file using the Eclipse text editor than editing artefact ordering in the Server Editor
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ Plan files can be composed of other plan files
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ Items in Plan files will be picked either from the workspace or from the configured bundle repositories
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ Using Plan files in the test environment is more representative of the production deployment
+ </para>
+ </listitem>
+ </itemizedlist>
+ </para>
+ </section>
+ <section id="planPublishing">
+ <title>Discovery of Plan files in the workspace</title>
+ <para>
+ The Virgo Tools create Plan projects as special types of Java projects with an additional Virgo-specific nature.
+ Plan files must be created within the source folder(s) of Plan projects.
+ </para>
+ <para>
+ When a Plan file refers to another Plan file, the Virgo Tools will look for the referred Plan file in the same project
+ of the top-level Plan and in all the Plan projects that are directly or indirectly reachable via the project's <emphasis>Java
+ Build Path</emphasis>.
+ If more than one Plan with the same name is found in the project's <emphasis>Java Build Path</emphasis>, the Virgo Tooling will
+ pick the first found when following the <emphasis>Java Build Path</emphasis> defined class-path order.
+ Note that the Plan is identified by the value of the <emphasis>name</emphasis> attribute of the <emphasis>plan</emphasis> element
+ inside the Plan XML document and not the by the file name.
+ </para>
+ </section>
+</chapter>
diff --git a/tooling-guide/src/virgo-tooling-guide.xml b/tooling-guide/src/virgo-tooling-guide.xml
index 9244395..e97379e 100644
--- a/tooling-guide/src/virgo-tooling-guide.xml
+++ b/tooling-guide/src/virgo-tooling-guide.xml
@@ -78,6 +78,7 @@
<xi:include href="server-editor.xml" />
<xi:include href="developing.xml" />
<xi:include href="developing_with_PDE.xml" />
+ <xi:include href="plans.xml" />
<xi:include href="pars.xml" />
<xi:include href="deploying.xml" />
<xi:include href="wiki.xml" />
diff --git a/tooling-guide/src/whatsnew.xml b/tooling-guide/src/whatsnew.xml
index aae8627..fdf2501 100644
--- a/tooling-guide/src/whatsnew.xml
+++ b/tooling-guide/src/whatsnew.xml
@@ -21,6 +21,13 @@
<para>A new project wizard allows creating PDE Plug-in projects that are also Virgo Runtime projects and can be deployed on a Virgo Server
</para>
</section>
+ <section id="Plan_Project_Wizard">
+ <title>Plan Project Wizard</title>
+ <para>A new project wizard allows creating Plan projects in the workspace. Plan projects permit to deploy a plan to the Virgo Runtime within Eclipse
+ and can be seen as a possibly more convenient alternative to adding individual bundles to the Virgo Runtime and defining their activation order
+ via the Server Editor.
+ </para>
+ </section>
</section>
<section id="Server_Editor">
<title>Server Editor</title>
diff --git a/tooling-guide/src/wiki.xml b/tooling-guide/src/wiki.xml
index b5b8bf1..91c4c27 100644
--- a/tooling-guide/src/wiki.xml
+++ b/tooling-guide/src/wiki.xml
@@ -30,15 +30,7 @@
<section id="Install_Eclipse">
<title>Install Eclipse</title>
<para>If you're not installing into an existing Eclipse, you'll need one. </para>
- <itemizedlist>
- <listitem>
- <para>Eclipse Indigo 3.7.x or Indigo based suite such as SpringSource Tool Suite 2.9.x</para>
- </listitem>
- <listitem>
- <para>Eclipse Juno 3.8/4.2</para>
- </listitem>
- </itemizedlist>
- <para>Eclipse JEE Indigo recommended.</para>
+ <para>Eclipse for Java EE developers is recommended.</para>
</section>
<section id="Install_Virgo">
<title>Install Virgo</title>
@@ -266,16 +258,6 @@
<itemizedlist>
<listitem>
<para>
- <emphasis role="bold">How do I deploy a Plan with the Virgo tools?</emphasis>
- </para>
- </listitem>
- </itemizedlist>
- <para>Deploying a Plan works much the same way as deploying a Bundle or PAR from the tools. Unfortunately, the tools only handle Plan deployment correctly when the Plan refers to items already in Virgo's watched repository directories. If you try to deploy a Plan that references a project in the Eclipse workspace, the tools will fail. One workaround is to copy your workspace bundle(s) into repository/usr or some other watched repository directory. A discussion of this bug and other workarounds is available at
- <ulink url="https://bugs.eclipse.org/bugs/show_bug.cgi?id=379765">https://bugs.eclipse.org/bugs/show_bug.cgi?id=379765</ulink>
- </para>
- <itemizedlist>
- <listitem>
- <para>
<emphasis role="bold">How do I create a Web Application Bundle?</emphasis>
</para>
</listitem>
@@ -324,4 +306,4 @@
<ulink url="/wiki/Category:EclipseRT">Category:EclipseRT</ulink></rev></revisions></page></pages></query></api>
</para>
</section>
-</chapter>
\ No newline at end of file
+</chapter>
