morciuch 2004/04/21 16:37:51
Modified: plugin project.properties project.xml
plugin/xdocs changes.xml goals.xml index.xml navigation.xml
properties.xml
Log:
Documentation updates
Revision Changes Path
1.2 +8 -0 jakarta-jetspeed/plugin/project.properties
Index: project.properties
===================================================================
RCS file: /home/cvs/jakarta-jetspeed/plugin/project.properties,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- project.properties 8 Apr 2004 19:10:41 -0000 1.1
+++ project.properties 21 Apr 2004 23:37:51 -0000 1.2
@@ -18,3 +18,11 @@
maven.xdoc.date=left
maven.xdoc.version=${pom.currentVersion}
maven.checkstyle.format = turbine
+
+# -------------------------------------------------------------------
+# UI Color Preferences
+# -------------------------------------------------------------------
+maven.ui.banner.background = #fff
+maven.ui.banner.foreground = #fff
+maven.ui.banner.border.top = #36c
+maven.ui.banner.border.bottom = #36c
1.4 +3 -3 jakarta-jetspeed/plugin/project.xml
Index: project.xml
===================================================================
RCS file: /home/cvs/jakarta-jetspeed/plugin/project.xml,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- project.xml 20 Apr 2004 00:12:00 -0000 1.3
+++ project.xml 21 Apr 2004 23:37:51 -0000 1.4
@@ -22,15 +22,15 @@
<organization>
<name>Apache Software Foundation</name>
<url>http://jakarta.apache.org/</url>
-
<logo>http://jakarta.apache.org/turbine/maven/images/jakarta-logo-blue.gif</logo>
+ <logo>http://maven.apache.org/images/apache-maven-project.png</logo>
</organization>
<inceptionYear>2002</inceptionYear>
<package>org.apache.jetspeed</package>
- <logo>http://jakarta.apache.org/turbine/maven/images/maven.jpg</logo>
+ <logo>http://portals.apache.org/jetspeed-1/images/logo.gif</logo>
<description>
Plugin for Jetspeed (http://jakarta.apache.org/jetspeed) that allows to build
custom portals
using the Jetspeed binary distributions. You only need to define your
customizations and the
- plugin will automatically it with a versioned Jetspeed binary distribution.
+ plugin will automatically merge it with a versioned Jetspeed binary
distribution.
</description>
<shortDescription>Jetspeed plugin</shortDescription>
<url/>
1.2 +20 -11 jakarta-jetspeed/plugin/xdocs/changes.xml
Index: changes.xml
===================================================================
RCS file: /home/cvs/jakarta-jetspeed/plugin/xdocs/changes.xml,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- changes.xml 8 Apr 2004 19:10:41 -0000 1.1
+++ changes.xml 21 Apr 2004 23:37:51 -0000 1.2
@@ -15,17 +15,26 @@
limitations under the License.
-->
<document>
- <properties>
- <title>Changes</title>
- <author email="[EMAIL PROTECTED]">Eric Pugh</author>
- </properties>
-
- <body>
- <release version="1.0" date="2003-01-29">
- <action dev="epugh" type="add">
+ <properties>
+ <title>Changes</title>
+ <author email="[EMAIL PROTECTED]">Eric Pugh</author>
+ </properties>
+ <body>
+ <release version="1.0" date="2003-01-29">
+ <action dev="epugh" type="add">
Initial cut of plugin
</action>
- </release>
- </body>
+ </release>
+ <release version="1.1" date="2004-04-15">
+ <action dev="mark_orciuch" type="add">
+ Enhanced for backwards compatibility with Maven Beta 9 thru RC2.
+ </action>
+ </release>
+ <release version="1.2" date="2004-04-21">
+ <action dev="mark_orciuch" type="add">
+ Documentation updates and modification to use Jetspeed binary distributions
from jetspeed/distributions folder
+ rather than jetspeeddist/distributions. Also, added hotdeploy and deploy
goals.
+ </action>
+ </release>
+ </body>
</document>
-
1.2 +143 -16 jakarta-jetspeed/plugin/xdocs/goals.xml
Index: goals.xml
===================================================================
RCS file: /home/cvs/jakarta-jetspeed/plugin/xdocs/goals.xml,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- goals.xml 8 Apr 2004 19:10:41 -0000 1.1
+++ goals.xml 21 Apr 2004 23:37:51 -0000 1.2
@@ -15,20 +15,147 @@
limitations under the License.
-->
<document>
-
- <properties>
- <title>Maven Jetspeed Plug-in Goals</title>
- <author email="[EMAIL PROTECTED]">Eric Pugh</author>
- </properties>
-
- <body>
- <goals>
- <goal>
- <name>jetspeed:overlay</name>
- <description>
<P>
- This goal should be used when you want to take your code, overlay over a
plain vanilla jetspeed
war file, and then run cactus tests against the resulting codebase. That
way your cactus tests do
not have to deal with what the current state of the production jetspeed
version.
</P>
<P>
The goal takes a vanilla Jetspeed war specified in the project.properties
as maven.jetspeed.vanilla.war=C:/portal/src/jetspeed-upstate/portal2.war
and expands it into a
working directory. Then the project is turned into a WAR file, and expanded
over the vanilla \
installation in the working directory. Lastly, the properties files are
merged in. The resulting
overlayed codebase is then re WAR'ed, and the plugin places the new war in
the orignal war location,
but with all the overlayed code and merged properties.
</P>
<P>
This is useful when running cactus tests, as you can just run:
<source>
maven war:webapp jetspeed:overlay cactus:test
</source>
</P>
- </description>
- </goal>
<goal>
<name>jetspeed:merge-properties</name>
<description>
<P>
This goal is called by jetspeed:overlay to merge in specific properties
files into the base vanilla
jetspeed installation. Currently this is pretty rigidly definied which
files are merged.
</P>
<P>
The plugin expects the files to be in
${maven.jetspeed.merge.dir}/MergeJetspeedResources.properties, and
typically the maven.jetspeed.merge.dir is in the ./src/conf
directory of your webapp. The files that are
currently merged are:
<OL>
<LI>MergeJetspeedResources.properties</LI>
<LI>MergeJetspeedSecurity.properties</LI>
<LI>MergeTurbineResources.properties</LI>
<LI>MergeTorque.properties</LI>
</OL>
These are merged into the corresponding default versions (without
the word Merge ;-) ).
</P>
</description>
</goal>
- </goals>
- </body>
+ <properties>
+ <title>Maven Jetspeed Plug-in Goals</title>
+ <author email="[EMAIL PROTECTED]">Eric Pugh</author>
+ <author email="[EMAIL PROTECTED]">Mark Orciuch</author>
+ </properties>
+ <body>
+ <section name="Overview">
+ <p>Jetspeed plugin supports two models:</p>
+ <ol>
+ <li><b>Binary distribution model</b> - advanced method
of building custom portal based on official versioned Jetspeed binary distribution
with flexible
+ properties merging and multiple target builds (i.e.
development, test, production environments).
+ </li>
+ <li><b>Local .war file model</b> - simplified method
of building custom portal based on Jetspeed .war file provided locally with limited
properties merging support</li>
+ </ol>
+ <p>Here are some advantages of using Jetspeed plugin:</p>
+ <ul>
+ <li>Keeps your custom code down to minimum</li>
+ <li>Allows for easy upgrades of your custom portal
with new releases of Jetspeed</li>
+ </ul>
+ </section>
+ <section name="Jetspeed Goals (common)">
+ <table>
+ <tr>
+ <th>Goal</th>
+ <th>Description</th>
+ </tr>
+ <tr>
+ <td>jetspeed:hotdeploy</td>
+ <td>Deploys changed resources directly to live
webapp</td>
+ </tr>
+ <tr>
+ <td>jetspeed:deploy</td>
+ <td>Builds a .war file and deploys it to
servlet container</td>
+ </tr>
+ </table>
+ </section>
+ <section name="Jetspeed Goals (binary distribution model)">
+ <table>
+ <tr>
+ <th>Goal</th>
+ <th>Description</th>
+ </tr>
+ <tr>
+ <td>
+ <a
href="#jetspeed:war">jetspeed:war</a>
+ </td>
+ <td>Generates custom portal .war file based on
Jetspeed binary distribution</td>
+ </tr>
+ <tr>
+ <td>
+ <a
href="#jetspeed:war-version-tag">jetspeed:war-version-tag</a>
+ </td>
+ <td>Updates release version tag shown in the
bottom navigation</td>
+ </tr>
+ <tr>
+ <td>
+ <a
href="#jetspeed:war-config">jetspeed:war-config</a>
+ </td>
+ <td>Override jetspeed property files and add
local registries</td>
+ </tr>
+ <tr>
+ <td>
+ <a
href="#jetspeed:generate-project">jetspeed:generate-project</a>
+ </td>
+ <td>Generates starter custom portal project
based on specific version of Jetspeed binary distribution. This will include a
project.xml file
+ with dependencies taken from the binary
distribution. While this goal would be very useful IT IS NOT IMPLEMENTED ;-)</td>
+ </tr>
+ </table>
+ <subsection name="jetspeed:war">
+ <p>This is the main goal use for building your custom
portal .war file. Before invoking this goal, you must create
+ a maven project containing your customizations to
Jetspeed. These customizations may be as simple as changing
+ few Jetspeed properties or as sophisticated as
customizing the entire look and feel of the portal and/or creating
+ custom portlets and services.</p>
+ <p>You may refer to <a
href="http://portals.apache.org/jetspeed-1/tutorial/index.html";>Jetspeed Tutorial</a>
for
+ an example of project utilizing Jetspeed plugin.</p>
+ </subsection>
+ <subsection name="jetspeed:war-version-tag">
+ <p>Currently, this goal will replace token
<b>(release)</b> in templates/vm/navigations/html/bottom.vm with current version
+ from project.xml. Invoked by <b>jetspeed:war</b>.</p>
+ </subsection>
+ <subsection name="jetspeed:war-config">
+ <p>This goal merges your custom properties with base
Jetspeed properties contained in the binary distribution. You specify
+ which property files to merge using
<b>maven.merge.properties</b> property. You may have separate property merge file
+ for each of your target environments (target
environment is specified using <b>maven.env.name</b> property). For example:</p>
+ <source>
+maven.merge.properties =
JetspeedResources,TurbineResources,JetspeedSecurity,Torque,log4j
+ </source>
+ <p>The plugin will look for the above in your project.
Each of your merge files should be named using the following convention:</p>
+ <ul>
+ <li>Filename format when ${maven.env.name} is
NOT used: [property.filename].properties.merge. For example:
"Torque.properties.merge"</li>
+ <li>Filename format when ${maven.env.name} is
used: [property.filename]-${maven.env.name}.properties.merge. For example,
"Torque-DEV.properties.merge</li>
+ </ul>
+ </subsection>
+ </section>
+ <section name="Jetspeed Goals (local .war file model)">
+ <table>
+ <tr>
+ <th>Goal</th>
+ <th>Description</th>
+ </tr>
+ <tr>
+ <td>
+ <a
href="#jetspeed:overlay">jetspeed:overlay</a>
+ </td>
+ <td>Overlays jetspeed .war file with your
customizations</td>
+ </tr>
+ <tr>
+ <td>
+ <a
href="#jetspeed:merge-properties">jetspeed:merge-properties</a>
+ </td>
+ <td>Prerequisite to <b>jetspeed:overlay</b>,
merges your property overrides with Jetspeed's properties</td>
+ </tr>
+ </table>
+ <subsection name="jetspeed:overlay">
+ <p>This goal should be used when you want to take your
code, overlay over a plain vanilla jetspeed
+ war file, and then run cactus tests against the resulting
codebase. That way your cactus tests do
+ not have to deal with what the current state of the production
jetspeed version. </p>
+ <p>The goal takes a vanilla Jetspeed war specified in
the project.properties
+ as
maven.jetspeed.vanilla.war=C:/portal/src/jetspeed-upstate/portal2.war and expands it
into a
+ working directory. Then the project is turned into a
WAR file, and expanded over the vanilla \
+ installation in the working directory. Lastly, the properties
files are merged in. The resulting
+ overlayed codebase is then re WAR'ed, and the plugin places
the new war in the orignal war location,
+ but with all the overlayed code and merged properties.</p>
+ <p>This is useful when running cactus tests, as you
can just run:
+ <source>maven war:webapp jetspeed:overlay cactus:test</source>
+ </p>
+ </subsection>
+ <subsection name="jetspeed:merge-properties">
+ <p>This goal is called by jetspeed:overlay to merge in
specific properties files into the base vanilla
+ jetspeed installation. Currently this is pretty rigidly
definied which files are merged.</p>
+ <p>The plugin expects the files to be in
${maven.jetspeed.merge.dir}/MergeJetspeedResources.properties, and
+ typically the maven.jetspeed.merge.dir is in the
./src/conf directory of your webapp. The files that are
+ currently merged are:</p>
+ <OL>
+ <LI>MergeJetspeedResources.properties</LI>
+ <LI>MergeJetspeedSecurity.properties</LI>
+ <LI>MergeTurbineResources.properties</LI>
+ <LI>MergeTorque.properties</LI>
+ </OL>
+ <p>These are merged into the corresponding default
versions (without the word Merge ;-) ).</p>
+ </subsection>
+ </section>
+ </body>
</document>
1.2 +17 -2 jakarta-jetspeed/plugin/xdocs/index.xml
Index: index.xml
===================================================================
RCS file: /home/cvs/jakarta-jetspeed/plugin/xdocs/index.xml,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- index.xml 8 Apr 2004 19:10:41 -0000 1.1
+++ index.xml 21 Apr 2004 23:37:51 -0000 1.2
@@ -14,5 +14,20 @@
See the License for the specific language governing permissions and
limitations under the License.
-->
-<document> <properties> <title>Maven Jetspeed Plugin</title> <author
email="[EMAIL PROTECTED]">Eric Pugh</author> </properties> <body> <section
name="Maven Jetspeed Plugin"> <p> A plugin that currently can build a
Jetspeed War File, or take an existing WAR file
- plus custom code and produce a merged Jetspeed WAR file ready for Cactus
testing. </p> </section> </body></document>
\ No newline at end of file
+<document>
+ <properties>
+ <title>Maven Jetspeed Plugin</title>
+ <author email="[EMAIL PROTECTED]">Eric Pugh</author>
+ <author email="[EMAIL PROTECTED]">Mark Orciuch</author>
+ </properties>
+ <body>
+ <section name="Maven Jetspeed Plugin">
+ <p>A plugin that currently can build a custom portal .war file
by merging your customizations with
+ either Jetspeed-1 binary distribution or local Jetspeed-1 .war
file. Some of the features supported:</p>
+ <ul>
+ <li>Multiple target builds</li>
+ <li>Merging of property files</li>
+ </ul>
+ </section>
+ </body>
+</document>
1.3 +11 -13 jakarta-jetspeed/plugin/xdocs/navigation.xml
Index: navigation.xml
===================================================================
RCS file: /home/cvs/jakarta-jetspeed/plugin/xdocs/navigation.xml,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- navigation.xml 9 Apr 2004 22:11:10 -0000 1.2
+++ navigation.xml 21 Apr 2004 23:37:51 -0000 1.3
@@ -15,17 +15,15 @@
limitations under the License.
-->
<project name="Maven Castor Plugin">
-
- <title>Maven Jetspeed Plugin</title>
-
- <body>
- <links>
- <item name="Maven" href="http://maven.apache.org/"/>
- <item name="Jetspeed" href="http://portals.apache.org/jetspeed-1/"/>
- </links>
- <menu name="Overview">
- <item name="Goals" href="/goals.html" />
- <item name="Properties" href="/properties.html" />
- </menu>
- </body>
+ <title>Maven Jetspeed Plugin</title>
+ <body>
+ <links>
+ <item name="Maven" href="http://maven.apache.org/"/>
+ <item name="Jetspeed-1"
href="http://portals.apache.org/jetspeed-1/"/>
+ </links>
+ <menu name="Overview">
+ <item name="Goals" href="/goals.html"/>
+ <item name="Properties" href="/properties.html"/>
+ </menu>
+ </body>
</project>
1.2 +63 -20 jakarta-jetspeed/plugin/xdocs/properties.xml
Index: properties.xml
===================================================================
RCS file: /home/cvs/jakarta-jetspeed/plugin/xdocs/properties.xml,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- properties.xml 8 Apr 2004 19:10:41 -0000 1.1
+++ properties.xml 21 Apr 2004 23:37:51 -0000 1.2
@@ -15,24 +15,67 @@
limitations under the License.
-->
<document>
-
- <properties>
- <title>Maven Jetspeed Plugin Properties</title>
- <author email="[EMAIL PROTECTED]">Eric Pugh</author>
- </properties>
-
- <body>
- <section name="Maven Jetspeed Plugin Settings">
- <table>
- <tr>
- <th>Property name</th>
- <th>Optional?</th>
- <th>Description</th>
- </tr>
- <tr>
- <td>maven.jetspeed.vanilla.war</td>
<td>yes</td>
<td>Location of the jetspeed.war file. By default
${plugin.dir}/jetspeed.war</td>
- </tr>
- </table>
- </section>
- </body>
+ <properties>
+ <title>Maven Jetspeed Plugin Properties</title>
+ <author email="[EMAIL PROTECTED]">Eric Pugh</author>
+ <author email="[EMAIL PROTECTED]">Mark Orciuch</author>
+ </properties>
+ <body>
+ <section name="Jetspeed Plugin Properties (binary distribution model)">
+ <table>
+ <tr>
+ <th>Property name</th>
+ <th>Description</th>
+ <th>Default</th>
+ <th>Required in project.properties?</th>
+ </tr>
+ <tr>
+ <td>maven.env.name</td>
+ <td>Target environment name. For example, your
portal could be built for the following environments, each with
+ different property settings: LOCAL | DEV |
TEST | PROD. You may optionally specify this property using system
+ property (for example: "maven
-Dmaven.env.name=DEV jetspeed:war).</td>
+ <td></td>
+ <td>No</td>
+ </tr>
+ <tr>
+ <td>maven.merge.properties</td>
+ <td>Comma separated list of property files to
merge. For example: JetspeedResources,JetspeedSecurity,Torque,log4j,my</td>
+ <td></td>
+ <td>No</td>
+ </tr>
+ <tr>
+ <td>jetspeed.dist.version</td>
+ <td>Version of Jetspeed binary distribution to
use. Jetspeed binary distributions are kept in remote Maven repositories.</td>
+ <td>1.5</td>
+ <td>Yes</td>
+ </tr>
+ <tr>
+ <td>war.stage.dir</td>
+ <td>Location where binary distribution is
temporarily expanded.</td>
+ <td>${basedir}/stage</td>
+ <td>Yes</td>
+ </tr>
+ <tr>
+ <td>maven.war.src</td>
+ <td>Override of Maven property which allows
for merging with expanded binary distribution.</td>
+ <td>${war.stage.dir}/webapp</td>
+ <td>Yes</td>
+ </tr>
+ </table>
+ </section>
+ <section name="Jetspeed Plugin Properties (local .war file model)">
+ <table>
+ <tr>
+ <th>Property name</th>
+ <th>Optional?</th>
+ <th>Description</th>
+ </tr>
+ <tr>
+ <td>maven.jetspeed.vanilla.war</td>
+ <td>yes</td>
+ <td>Location of the jetspeed.war file. By
default ${plugin.dir}/jetspeed.war</td>
+ </tr>
+ </table>
+ </section>
+ </body>
</document>
---------------------------------------------------------------------
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]
