taylor 2004/05/17 14:32:50
Modified: plugin/xdocs navigation.xml
Added: plugin/xdocs sample-usage.xml
Log:
added Sample Usage documentation section to the Jetspeed Plugin
PR:
Obtained from:
Submitted by:
Reviewed by:
CVS: ----------------------------------------------------------------------
CVS: PR:
CVS: If this change addresses a PR in the problem report tracking
CVS: database, then enter the PR number(s) here.
CVS: Obtained from:
CVS: If this change has been taken from another system, such as NCSA,
CVS: then name the system in this line, otherwise delete it.
CVS: Submitted by:
CVS: If this code has been contributed to Apache by someone else; i.e.,
CVS: they sent us a patch or a new module, then include their name/email
CVS: address here. If this is your work then delete this line.
CVS: Reviewed by:
CVS: If we are doing pre-commit code reviews and someone else has
CVS: reviewed your changes, include their name(s) here.
CVS: If you have not had it reviewed then delete this line.
Revision Changes Path
1.4 +1 -0 jakarta-jetspeed/plugin/xdocs/navigation.xml
Index: navigation.xml
===================================================================
RCS file: /home/cvs/jakarta-jetspeed/plugin/xdocs/navigation.xml,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- navigation.xml 21 Apr 2004 23:37:51 -0000 1.3
+++ navigation.xml 17 May 2004 21:32:50 -0000 1.4
@@ -24,6 +24,7 @@
<menu name="Overview">
<item name="Goals" href="/goals.html"/>
<item name="Properties" href="/properties.html"/>
+ <item name="Usage" href="/sample-usage.html"/>
</menu>
</body>
</project>
1.1 jakarta-jetspeed/plugin/xdocs/sample-usage.xml
Index: sample-usage.xml
===================================================================
<?xml version="1.0"?>
<!--
Copyright 2004 The Apache Software Foundation
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.apache.org/licenses/LICENSE-2.0
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.
-->
<document>
<properties>
<title>Maven Jetspeed Plug-in Sample Usage</title>
<author email="[EMAIL PROTECTED]">David Sean Taylor</author>
</properties>
<body>
<section name="Sample Usage">
<p>If you are creating your own Jetspeed portal, you may want
to try following the steps outlined below and see how it works out for you.
The example assumes you are creating a Jetspeed portal
named "MyPortal".
NOTE: you must build Jetspeed's WAR target, or download it
(1.5 or greater), before continuing.</p>
<ol>
<li><b>mkdir MyPortal</b> - create the directory to
hold the MyPortal project.
</li>
<li><b>cd MyPortal</b>
</li>
<li>
<b>maven jetpeed:genapp</b>
You will then be prompted to enter several
parameters to help the application generator create your portal.
<source>
<![CDATA[
Enter a project template to use: [default]
Please specify an id for your application: [app]
MyPortal
Please specify a name for your application: [Example Application]
My Personal Portal
Please specify the package for your application: [default.example.app]
org.me.me.me.portal
]]>
</source>
<table>
<tr>
<th>Parameter</th>
<th>Description</th>
</tr>
<tr>
<td>Project Template</td>
<td>A Maven template for creating Maven projects. Only the default template is
currently supplied with the Jetspeed plugin.
If you don't have your own template, simply leave this parameter blank and press
enter.
</td>
</tr>
<tr>
<td>
Id for application
</td>
<td>
The identifier for your application. Note that this identifier will also be used for
your web application name.
Your portal will be addressable by this name. For example:
<b>http://localhost:8080/MyPortal</b>
</td>
</tr>
<tr>
<td>
Name for application
</td>
<td>
A more descriptive name of your application.
</td>
</tr>
<tr>
<td>
package
</td>
<td>
The root package for your application, such as <b>com.me.portal</b>.
The root package is used by Maven for tasks such as generated java docs.
</td>
</tr>
</table>
</li>
<li>
Modify your project.properties in the root of your
application, adding these lines:
<source>
<![CDATA[
# use default Maven style project settings
war.src = ${basedir}/src/webapp
war.stage.dir = ${basedir}/stage
maven.war.src = ${war.stage.dir}/webapp
# location of the Jetspeed war file
# NOTE: you must build this WAR file first
maven.jetspeed.vanilla.war = ${basedir}/../jakarta-jetspeed/target/jetspeed.war
#
# these property could also go in your $HOME/build.properties
#
# the catalina version (4 or 5)
catalina.version=5
# location of the catalina/tomcat
maven.war.appserver.home = /projects/apache/catalina
catalina.context.dir=${maven.war.appserver.home}/conf/Catalina/localhost
# the remote maven repo
maven.repo.remote = http://www.bluesunrise.com/maven/, http://www.ibiblio.org/maven/
]]>
</source>
</li>
<li>
Add these lines as needed:
<source>
<![CDATA[
# upgrade to latest version
jetspeed.dist.version = 1.6-dev
# merge over the Jetspeed configuration files
# you must provide a corresponding file with the prefix ".merge"
# For example: "JetspeedResources.properties.merge"
maven.merge.properties = JetspeedResources,JetspeedSecurity,TurbineResources,Torque
]]>
</source>
</li>
<li><b>maven jetspeed:deploy</b> - Deploy the web
application</li>
<li>Run the application, start Tomcat, go to <a
href='http://localhost:8080/MyPortal'>http://localhost:8080/MyPortal</a></li>
<li><b>maven jetspeed:hotdeploy</b> - to incrementally deploy
the application during development only.
If you change any Java classes, or any properties files that
are only read on application startup, you may need to restart Tomcat</li>
</ol>
</section>
</body>
</document>
---------------------------------------------------------------------
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]
