You are viewing a plain text version of this content. The canonical link for it is here.
Posted to pluto-scm@portals.apache.org by dd...@apache.org on 2004/09/09 13:55:18 UTC
svn commit: rev 43592 - portals/pluto/trunk/xdocs
Author: ddewolf
Date: Thu Sep 9 04:55:18 2004
New Revision: 43592
Modified:
portals/pluto/trunk/xdocs/changes.xml
portals/pluto/trunk/xdocs/index.xml
portals/pluto/trunk/xdocs/install.xml
portals/pluto/trunk/xdocs/intent.xml
portals/pluto/trunk/xdocs/navigation.xml
portals/pluto/trunk/xdocs/powered_by_pluto.xml
portals/pluto/trunk/xdocs/roadmap.xml
Log:
Preparing for release. Reorganizing and adding documentation.
Modified: portals/pluto/trunk/xdocs/changes.xml
==============================================================================
--- portals/pluto/trunk/xdocs/changes.xml (original)
+++ portals/pluto/trunk/xdocs/changes.xml Thu Sep 9 04:55:18 2004
@@ -4,7 +4,27 @@
</properties>
<body>
- <release version="1.0.1" date="Not Yet Released">
+ <release version="1.0.1" date="TBD" description="Not Yet Released">
+ <action dev="ddewolf" type="fix">
+ Updating Pluto JavaDocs.
+ (<A href="http://nagoya.apache.org/jira/browse/PLUTO-28">PLUTO-46</A>)
+ </action>
+ <action dev="ddewolf" type="fix">
+ Support role mapping in portlet.xml
+ (<A href="http://nagoya.apache.org/jira/browse/PLUTO-46">PLUTO-46</A>)
+ </action>
+ <action dev="ddewolf" type="fix">
+ Support multiple resource-ref entried in portlet app web.xml
+ (<A href="http://nagoya.apache.org/jira/browse/PLUTO-48">PLUTO-48</A>)
+ </action>
+ <action dev="ddewolf" type="fix">
+ Removed fullDeployment dependency from pluto deployer.
+ (<A href="http://nagoya.apache.org/jira/browse/PLUTO-49">PLUTO-49</A>)
+ </action>
+ <action dev="ddewolf" type="fix">
+ Implement Mime Type Matching.
+ (<A href="http://nagoya.apache.org/jira/browse/PLUTO-55">PLUTO-55</A>)
+ </action>
<action dev="cziegeler" type="fix">
Add handling of mime-mappings in web application definition.
</action>
@@ -13,7 +33,7 @@
</action>
</release>
- <release version="1.0" date="in CVS">
+ <release version="1.0" date="2003" description="Initial CVS Import">
<action dev="cziegeler" type="update">
Updating to the new ASF License 2.0.
</action>
Modified: portals/pluto/trunk/xdocs/index.xml
==============================================================================
--- portals/pluto/trunk/xdocs/index.xml (original)
+++ portals/pluto/trunk/xdocs/index.xml Thu Sep 9 04:55:18 2004
@@ -70,31 +70,12 @@
<section name="Pluto Versions">
<p>Pluto Versions</p>
<table>
-<tr><th>Portlet Spec</th><th>Pluto Version</th></tr>
-<tr><td>1.0</td><td>1.0</td></tr>
+<tr><th>Portlet Spec</th><th>Pluto Version</th><th>Status</th></tr>
+<tr><td>1.0</td><td>1.0.0</td><td>Never Released, built from initial CVS Head</td></tr>
+<tr><td>1.0.</td><td>1.0.1</td><td>In Development</td></tr>
</table>
</section>
-<section name="Compilation / Installation">
-<p><b><i>Installation Procedure:</i></b>
-<!-- <li>Download the source code of Apache Pluto
- <a href="http://jakarta.apache.org/site/sourceindex.cgi">here</a></li> -->
- <ul>
- <li><a href="install.html">Installing Pluto</a></li>
- </ul>
-</p>
-
-<p><b><i>Prereq's:</i></b>
- <ul>
- <li>The Pluto Project requires at least Apache Tomcat 4.1.27 and Java 1.3.1.
-Some <a href="http://nagoya.apache.org/wiki/apachewiki.cgi?PlutoProjectPages/WorkingConfigurations">other configurations</a> have been tested successfully as well.
-</li>
- <li>To build you will need to have Apache Maven 1.0-beta-10</li>
- </ul>
-</p>
-
-
-</section>
</body>
</document>
Modified: portals/pluto/trunk/xdocs/install.xml
==============================================================================
--- portals/pluto/trunk/xdocs/install.xml (original)
+++ portals/pluto/trunk/xdocs/install.xml Thu Sep 9 04:55:18 2004
@@ -18,107 +18,102 @@
<document>
<properties>
<author email="unknown">Jean-Baptiste Joret</author>
- <author email="david.AT.daviddewolf.DOT.com">David H. DeWolf</author>
+ <author email="ddewolf.AT.apache.DOT.org">David H. DeWolf</author>
<author email="nl.AT.essential.DOT.com.DOT.au">Nick Lothian</author>
<title>Pluto Project</title>
</properties>
<body>
-<section name="Installation">
-<subsection name="Prerequisites">
-<p>It is expected that the user is familiar with the <a href="http://maven.apache.org">Apache
- Maven</a> project tool.</p>
-</subsection>
-<subsection name="Requirements">
-<ul>
- <li><a href="http://maven.apache.org/start/download.html">Maven 1.0</a>
- or higher</li>
- <li>Java 1.3 or higher</li>
- <li>Servlet 2.3:<br/>
- Tomcat 4.1.18-LE w/JDK 1.4<br/>
- <b>or</b> <br/>
- Tomcat 4.1.24 w/ JDK 1.3</li>
-</ul>
-</subsection>
-<subsection name="Get Maven Ready">
-<p>If you have not already done so, download and install Maven.</p>
-<p>2. build.properties settings:</p>
-<p>Please set these values in your <code>build.properties</code>
- file:</p>
-<table width="650" border="1" cellspacing="0" cellpadding="3">
- <tr>
- <th width="134">property</th>
- <th width="229">example</th>
- <th width="261">what is it?</th>
- </tr>
- <tr>
- <td width="134">maven.tomcat.home</td>
- <td width="229">/tomcat</td>
- <td width="261">location of the Tomcat install where you want to deploy Pluto</td>
- </tr>
- <tr>
- <td width="134">maven.tomcat.version.major</td>
- <td width="229">4</td>
- <td width="261">Major version number (4 or 5) of the Tomcat install where you want to deploy Pluto</td>
- </tr>
-</table>
-<p>You can copy the <code>build.properties.sample</code> file and name it
- <code>build.properties</code> and use this is a starting point.</p>
-</subsection>
-<subsection name="Building and deploying">
-<ul>
- <li>change your directory to root of the Pluto project.</li>
- <li>maven fullDeployment</li>
- <li>This will take care of everything for you including copying shared jars,
- and deploy the base Pluto portal along with the Portlet Test Suite</li>
-</ul>
-</subsection>
-<subsection name="Start Tomcat">
-<p>Run Tomcat, go to http://localhost:8080/pluto/portal.</p>
-</subsection>
+<section name="Installation Guide">
+<P>This install guide covers the following types of installations:
+<ul><li><A href="#Installing_Distributions">Installing Distributions</A></li>
+ <li><A href="#Installing_Portlets">Installing Portlets</A></li></ul>
+</P>
</section>
-<section name="What if I just want the Pluto container jar (like for Jetspeed 2)?">
-<ol>
- <li>cd to /container directory</li>
- <li>maven jar:install</li>
-</ol>
-<p>This will create the container jar in /container/target and also copy into
- you maven repository.</p>
- </section>
-
-<section name="What if I just want to deploy the Pluto portal without the test suite?">
-<ol>
- <li>Follow all the steps from "<i>What if I just want the Pluto container
- jar (like for Jetspeed 2)?</i>"</li>
- <li>cd to the /portal directory.</li>
- <li>maven (with no goal)</li>
-</ol>
-<p>This will invoke the default maven goal for the /portal sub-project, deployPlutoToTomcat.
- This will build and deploy the Pluto portal minus the test suite into
- tomcat.</p>
-</section>
+<section name="Installing Distributions">
-<section name="What if I decide I want to deploy the test suite portlets after I deploy the Pluto portal by itself?">
-<ol>
- <li>Follow all the steps from "<i>What if I decide I want to deploy the
- test suite portlets after I deploy JUST the Pluto portal?</i>"</li>
- <li>cd to the /testsuite directory.</li>
- <li>maven (with no goal)</li>
-</ol>
-<p>This will invoke the default maven goal for the /testsute sub-project, deployTestsuite.
- This will build and deploy the test suite portlets into your already deployed
- Pluto portal.</p>
+<subsection name="Binary Distribution">
+<P>The binary distribution of Pluto is packaged with Tomcat
+ (currently version 5.0.28). Pluto leverages Tomcat to
+ provide the web container in which the Pluto portlet
+ container executes. The binary distribution includes
+ the Pluto Portlet Container, The Portal Driver, and
+ Pluto Testsuite.</P>
+<P>To install the binary distribution:
+ <ul>
+ <li><A href="download.html">Download</A>
+ the current binary distribution of Pluto</li>
+ <li>Extract the binary distribution to a directory
+ from here forward refered to as "<PLUTO_HOME>".</li>
+ <li>Startup the server by using the appropriate tomcat
+ startup script located at <PLUTO_HOME>/bin.
+ For *nix use startup.sh; for windows use startup.bat.</li>
+ <li>Point your browser to
+ <A href="http://localhost:8080/pluto/portal">The Pluto Driver</A>
+ and your ready to go!</li>
+ </ul>
+</P>
+</subsection>
+
+<subsection name="Library Distributions">
+<P>The pluto library distributions are packaged to allow
+ integration with an external portal server.</P>
+<P>To install the library distributions to your portal server:
+ <ul>Ensure that the pluto-x.x.x.jar is loaded by a classloader
+ to which both the portal and portlet application web apps
+ have access.</ul></P>
+
+</subsection>
+
+<subsection name="Source Distribution">
+<P>Installing the source distribution requires the most effort,
+ and is recomended only for those individuals who are interested
+ in modifying the container. The source distribution is
+ basically a snapshot of the source code repository at a given
+ time. Because of this, please see the build instructions, which
+ will provide information about how to build Pluto from scratch.
+ </P>
+<P>To install the source distribution into tomcat:
+ <ul>
+ <li>Install Java 1.3 or greater</li>
+ <li>Install Maven 1.0 or greater</li>
+ <li>Install Tomcat 4.x or Tomcat 5.x to
+ a directory from here forward refered to as
+ <TOMCAT_HOME></li>
+ <li>Edit your <PLUTO_HOME>/build.properties to include
+ the following properties:
+ <table><tr><th>Property</th><th>Value</th><th>Example(s)</th></tr>
+ <tr><td>maven.tomcat.home</td>
+ <td>Tomcat Installation Directory</td>
+ <td><code>\\usr\\local\\jakarta-tomcat.5.0.27</code>,
+ <code>c:\\jakarta-tomcat.5.0.27</code></td></tr>
+ <tr><td>maven.tomcat.version.major</td>
+ <td>Tomcat Major Version Number</td>
+ <td>5</td></tr>
+ </table></li>
+ <li>From <PLUTO_HOME> issue the command:
+ <code>'maven fullDeployment'</code></li>
+ <li>Startup the server by using the appropriate tomcat
+ startup script located at <PLUTO_HOME>/bin.
+ For *nix use startup.sh; for windows use startup.bat.</li>
+ <li>Point your browser to
+ <A href="http://localhost:8080/pluto/portal">The Pluto Driver</A>
+ and your ready to go!</li>
+ </ul>
+</P>
+</subsection>
</section>
-<section name="Install Portlets">
- <p>
- <ul>To install portlets after you successfully installed Pluto,
+<section name="Installing Portlets">
+<P><FONT color="red">
+ Currently, to automate the deployment/installation of portlets
+ you must utilize the source distribution of pluto.</FONT></P>
+<P>To install portlets after you successfully installed Pluto,
invoke Maven to deploy the portlet's war by executing:
- <code>maven deploy -Ddeploy=FULL_PATH_TO_YOUR_PORTLET_WAR</code>
- </ul>
- </p>
+ <code>maven deploy -Ddeploy=FULL_PATH_TO_YOUR_PORTLET_WAR</code>
+</P>
</section>
</body>
Modified: portals/pluto/trunk/xdocs/intent.xml
==============================================================================
--- portals/pluto/trunk/xdocs/intent.xml (original)
+++ portals/pluto/trunk/xdocs/intent.xml Thu Sep 9 04:55:18 2004
@@ -34,7 +34,7 @@
<p>
The following document attempts to clarify the development
- priorities of Jakarta Pluto Project.
+ priorities of the Apache Pluto project.
</p>
<p>
Modified: portals/pluto/trunk/xdocs/navigation.xml
==============================================================================
--- portals/pluto/trunk/xdocs/navigation.xml (original)
+++ portals/pluto/trunk/xdocs/navigation.xml Thu Sep 9 04:55:18 2004
@@ -15,53 +15,55 @@
See the License for the specific language governing permissions and
limitations under the License.
-->
-<project name="Jakarta Pluto Site" href="http://jakarta.apache.org/pluto">
+<project name="Apache Pluto" href="http://portals.apache.org/pluto">
<title>The Jakarta Pluto Site</title>
<logo href="/images/pluto.png">Pluto, an Apache Portals project.</logo>
- <body>
- <links>
- <item name="JSR 168" href="http://jcp.org/en/jsr/detail?id=168"/>
- </links>
- <menu name="Essentials">
- <item name="Overview" href="/index.html"/>
- <!-- Not yet present
- <item name="Features" href="/features.html"/>
- -->
- <item name="License" href="/license.html"/>
- <item name="Installation" href="/install.html"/>
- <item name="FAQ" href="/faq.html"/>
- <item name="Powered By Pluto" href="/powered_by_pluto.html"/>
- <item name="Resources" href="/resources.html"/>
- <item name="Roadmap" href="/roadmap.html"/>
- <item name="Changes" href="/changes-report.html"/>
- </menu>
-
- <!--
- No Downloads exist yet :)
- <menu name="Downloads">
- </menu>
- -->
- <menu name="Documentation">
- <item name="Installation Guide" href="/install.html"/>
- <item name="Integration Guide" href="/Howto_use_the_Pluto_container.html"/>
- <item name="User Guide" href="/Howto_use_the_Pluto_portal.html"/>
- <item name="Architecture" href="/arch.html"/>
- </menu>
-
- <menu name="Community">
- <item name="Development Intent" href="/intent.html"/>
- <item name="News and Status" href="/news.html"/>
- <item name="Wiki" href="/wiki.html"/>
- </menu>
-
- <menu name="SubProjects">
- <item name="Pluto Container" href="/multiproject/pluto/index.html"/>
- <item name="Portal Driver" href="/multiproject/pluto-portal/index.html"/>
- <item name="Test Suite" href="/multiproject/testsuite/index.html"/>
- </menu>
+<body>
+ <links>
+ <item name="JSR 168" href="http://jcp.org/en/jsr/detail?id=168"/>
+ </links>
+
+<menu name="About Pluto">
+ <item name="Overview" href="/index.html"/>
+ <item name="Mission" href="/intent.html"/>
+ <item name="News and Status" href="/news.html"/>
+ <item name="Change Log" href="/changes-report.html"/>
+ <item name="Roadmap" href="/roadmap.html"/>
+ <item name="Powered By Pluto" href="/powered_by_pluto.html"/>
+ <item name="License" href="/license.html"/>
+</menu>
+
+<menu name="Getting Started">
+ <item name="Download" href="download.html"/>
+ <item name="Installation Guide" href="/install.html"/>
+
+ <item name="User Guide" href="/userguide/index.html" collapse="true">
+ <item name="Portal Driver User Guide" href="/userguide/portal.html"/>
+ <item name="TestSuite User Guide" href="/userguide/testsuite.html"/>
+ </item>
+
+ <item name="Developer Guide" href="/developer/index.html" collapse="true">
+ <item name="Obtaining The Source" href="/developer/subversion.html"/>
+ <item name="Building From Source" href="/developer/build_source.html"/>
+ <item name="Integration Guide" href="/developer/integrate.html"/>
+ <item name="Architecture" href="/developer/arch.html"/>
+ </item>
+ <item name="FAQ" href="/faq.html"/>
+ <item name="Resources" href="/resources.html"/>
+</menu>
+
+<menu name="Community">
+ <item name="Wiki" href="/wiki.html"/>
+</menu>
+
+<menu name="SubProjects">
+ <item name="Pluto Container" href="/multiproject/pluto/index.html"/>
+ <item name="Portal Driver" href="/multiproject/pluto-portal/index.html"/>
+ <item name="Test Suite" href="/multiproject/testsuite/index.html"/>
+</menu>
- </body>
+</body>
</project>
Modified: portals/pluto/trunk/xdocs/powered_by_pluto.xml
==============================================================================
--- portals/pluto/trunk/xdocs/powered_by_pluto.xml (original)
+++ portals/pluto/trunk/xdocs/powered_by_pluto.xml Thu Sep 9 04:55:18 2004
@@ -28,16 +28,23 @@
container:
<table>
- <tr><th>Portal</th><th>Website</th><th>License</th></tr>
+ <tr><th>Portal</th><th>Website</th><th>License</th><th>Status</th></tr>
<tr><td>Jetspeed</td>
<td><a href="http://portals.apache.org/jetspeed-1">http://portals.apache.org/jetspeed-1</a></td>
- <td>Apache 2.0</td></tr>
+ <td>Apache 2.0</td>
+ <td></td></tr>
<tr><td>Cocoon</td>
<td><a href="http://cocoon.apache.org">http://cocoon.apache.org</a></td>
- <td>Apache 2.0</td></tr>
+ <td>Apache 2.0</td>
+ <td></td></tr>
<tr><td>uPortal</td>
<td><a href="http://www.uportal.org">http://www.uportal.org</a></td>
- <td>JA-SIG</td></tr>
+ <td>JA-SIG</td>
+ <td></td></tr>
+ <tr><td>Jahia</td>
+ <td><a href="http://www.jahia.org">http://www.jahia.org</a></td>
+ <td><a href="http://www.collaborativesource.org">Proprietary</a></td>
+ <td>(http://www.jahia.org/cvs), branch JAHIA_PLUTO_BRANCH</td></tr>
</table>
</p>
</section>
Modified: portals/pluto/trunk/xdocs/roadmap.xml
==============================================================================
--- portals/pluto/trunk/xdocs/roadmap.xml (original)
+++ portals/pluto/trunk/xdocs/roadmap.xml Thu Sep 9 04:55:18 2004
@@ -22,55 +22,46 @@
</properties>
<body>
- <section name="Roadmap">
- <p>Pluto is currently part of the Apache Incubator.
- We are currently working to define a roadmap.
+<section name="Roadmap">
+ <p>
+ Interested in getting involved? Looking for a place to start?
+ This document is inteded to assist you in figuring out what to do.
</p>
- <p>Please see the "todo" list if you would like to get
- involved.</p>
- </section>
- <section name="To Do List">
- <subsection name="Current">
- <p>
- <ul>
- <li>Define Roadmap</li>
- <li>Create Letter of Intent concerning the primary focus of
- development. (See
- <a href="http://nagoya.apache.org/eyebrowse/BrowseList?listName=pluto-user@jakarta.apache.org&by=thread&from=650304">
- this thread</a> for some starting points)</li>
- <li>Flush out the faq doc</li>
- <li>Provide automatic extract of the pluto web pages out of the CVS</li>
- <li>Support custom portlet modes and window states</li>
- <li>User profile attribute support</li>
- <li>Enable PortletURL.setSecure</li>
- <li>Write howto guide about using the pluto container (is already started
- by Stefan Hepper and Stephan Hesmer)</li>
- <li>Write howto guide for deploying portlets with the pluto portal driver</li>
- </ul>
- </p>
- </subsection>
+ <subsection name="Where We're Headed">
+ <p>
+ Having recently graduated from the incubator, the first
+ goal of our community is the release a binary version of
+ the Pluto Container. This binary release will be based
+ upon the initial Pluto contribution which was donated by
+ IBM.
+ </p>
- <subsection name="Future">
- <p>
- <ul>
- </ul>
- </p>
- </subsection>
+ <p>
+ Several people have suggested a revolutionary approach to
+ Pluto's implementation. The suggestion centers around the
+ complexity of the current implementation and a desire to
+ make Pluto more "container like". In the future, a
+ second generation of pluto may be implemented to simplify
+ Pluto's implemetation and to use more standard design
+ patterns. IoC has been mentioned as a possible container
+ design.
+ </p>
+ </subsection>
- <subsection name="Complete">
- <p>
+ <subsection name="To Do List">
+ <p>
<ul>
- <li>Mavenize build</li>
- <li>Enable setTitle</li>
- <li>Provide support for jdk 1.4</li>
- <li>Provide support for Tomcat 5</li>
- <li>Document How to use the Pluto Portal</li>
- <li>Change logging to commons logging</li>
- <li>Document "How To Integrate Pluto Into Your Portal"</li>
+ <li>JavaDoc, JavaDoc, JavaDoc</li>
+ <li>Documentation, Documentation, Documentation</li>
+ <li>Flush out the FAQ documentation.</li>
+ <li>Support custom portlet modes and window states.</li>
+ <li>Support User profile attributes.</li>
+ <li>Enable PortletURL.setSecure</li>
+ <li>Create Windows Installer</li>
</ul>
- </p>
- </subsection>
+ </p>
+ </subsection>
</section>
</body>