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 2005/11/03 19:28:51 UTC
svn commit: r330601 - in /portals/pluto/trunk/pluto-container: pom.xml
src/site/ src/site/apt/ src/site/apt/.getting-started.apt.swp
src/site/apt/embed.apt src/site/apt/getting-started.apt src/site/site.xml
Author: ddewolf
Date: Thu Nov 3 10:28:43 2005
New Revision: 330601
URL: http://svn.apache.org/viewcvs?rev=330601&view=rev
Log:
Adding site documentation for 1.1 container subproject
Added:
portals/pluto/trunk/pluto-container/src/site/
portals/pluto/trunk/pluto-container/src/site/apt/
portals/pluto/trunk/pluto-container/src/site/apt/.getting-started.apt.swp (with props)
portals/pluto/trunk/pluto-container/src/site/apt/embed.apt
portals/pluto/trunk/pluto-container/src/site/apt/getting-started.apt
portals/pluto/trunk/pluto-container/src/site/site.xml
Modified:
portals/pluto/trunk/pluto-container/pom.xml
Modified: portals/pluto/trunk/pluto-container/pom.xml
URL: http://svn.apache.org/viewcvs/portals/pluto/trunk/pluto-container/pom.xml?rev=330601&r1=330600&r2=330601&view=diff
==============================================================================
--- portals/pluto/trunk/pluto-container/pom.xml (original)
+++ portals/pluto/trunk/pluto-container/pom.xml Thu Nov 3 10:28:43 2005
@@ -5,6 +5,11 @@
<packaging>jar</packaging>
<name>Pluto Portlet Container</name>
<url>http://portals.apache.org/pluto</url>
+ <description>
+ The Pluto Portlet Container is the reference implementation of the
+ Java Portlet Specification. The container aims to be lightweight,
+ flexible, and easy to embed.
+ </description>
<parent>
<groupId>org.apache.pluto</groupId>
<artifactId>pluto</artifactId>
Added: portals/pluto/trunk/pluto-container/src/site/apt/.getting-started.apt.swp
URL: http://svn.apache.org/viewcvs/portals/pluto/trunk/pluto-container/src/site/apt/.getting-started.apt.swp?rev=330601&view=auto
==============================================================================
Binary file - no diff available.
Propchange: portals/pluto/trunk/pluto-container/src/site/apt/.getting-started.apt.swp
------------------------------------------------------------------------------
svn:mime-type = application/octet-stream
Added: portals/pluto/trunk/pluto-container/src/site/apt/embed.apt
URL: http://svn.apache.org/viewcvs/portals/pluto/trunk/pluto-container/src/site/apt/embed.apt?rev=330601&view=auto
==============================================================================
--- portals/pluto/trunk/pluto-container/src/site/apt/embed.apt (added)
+++ portals/pluto/trunk/pluto-container/src/site/apt/embed.apt Thu Nov 3 10:28:43 2005
@@ -0,0 +1,58 @@
+ ------
+ Embedding the Pluto Container
+ ------
+ David H. DeWolf
+ ------
+ 03 Nov 2005
+ ------
+
+Embedding the Pluto Container
+
+ This document is currently *very* breif. Please feel free
+ to submit patches.
+
+* Steps for Embedding Pluto
+
+ * Implement org.apache.pluto.PortletContainerServices
+
+ * Manage the Portlet Container Lifecycle
+
+ * Create an instance of the container
+
+---------------------------
+//
+// Step 1) Create and instance of the PortletContainerService
+//
+PortletContainerServices impl = . . .
+
+//
+// Step 2) Request a new container from the container factory
+//
+PortletContainerFactory factory =
+ PortletContainerFactory.getInstance();
+
+PortletContainer container = factory.createContainer(
+ "My Container Name", impl
+);
+
+//
+// Step 3) Initialize the Container with the embedding
+// application's ServletContext
+//
+container.init(ctx);
+--------------------------
+
+ * Destroy the Container during Shutdown
+
+ * Invoke the Container as necessary
+
+--------------------------
+// Load a portlet
+container.doLoad(portletWindow, request, response);
+// Process a Portlet Action
+container.doAction(portletWindow, request, response);
+// Render a portlet
+container.doRender(portletWindow, request, response);
+--------------------------
+
+
Added: portals/pluto/trunk/pluto-container/src/site/apt/getting-started.apt
URL: http://svn.apache.org/viewcvs/portals/pluto/trunk/pluto-container/src/site/apt/getting-started.apt?rev=330601&view=auto
==============================================================================
--- portals/pluto/trunk/pluto-container/src/site/apt/getting-started.apt (added)
+++ portals/pluto/trunk/pluto-container/src/site/apt/getting-started.apt Thu Nov 3 10:28:43 2005
@@ -0,0 +1,19 @@
+ ------
+ Getting Started
+ ------
+ David H. DeWolf
+ ------
+ 03 Nov 2005
+ ------
+
+Getting Started
+
+ The Pluto Portlet Container is not designed for use by end users.
+ The container is meant to be embeded within portal and web applications
+ to provide Java Portlet Specification compliance. If you are a
+ user looking to develop, test, or deploy portlets, please see
+ the {{{../pluto-portal/index.html}Pluto Portal}}.
+
+ If you are looking for information on how to embed pluto in your
+ portal or web application, please see the {{{embed.html}embedding pluto}}
+ documentation for Pluto 1.1.
Added: portals/pluto/trunk/pluto-container/src/site/site.xml
URL: http://svn.apache.org/viewcvs/portals/pluto/trunk/pluto-container/src/site/site.xml?rev=330601&view=auto
==============================================================================
--- portals/pluto/trunk/pluto-container/src/site/site.xml (added)
+++ portals/pluto/trunk/pluto-container/src/site/site.xml Thu Nov 3 10:28:43 2005
@@ -0,0 +1,25 @@
+<?xml version="1.0" encoding="ISO-8859-1"?>
+<project name="Maven">
+ <bannerLeft>
+ <name>Pluto</name>
+ <src>http://portals.apache.org/pluto/images/apache-portals.gif</src>
+ <href>http://portals.apache.org/pluto</href>
+ </bannerLeft>
+ <bannerRight>
+ <src>http://portals.apache.org/pluto/images/pluto.png</src>
+ </bannerRight>
+ <body>
+ <links>
+ <item name="Pluto Home" href="http://portals.apache.org/pluto"/>
+ <item name="JSR 168" href="http://jcp.org/en/jsr/detail?id=168"/>
+ <item name="Chinese Translation" href="http://heavyz.sourceforge.net/pluto_zh/pluto-container"/>
+ </links>
+
+ <menu name="Portlet Container">
+ <item name="Getting Started" href="/getting-started.html"/>
+ <item name="Embedding Pluto" href="/embed.html"/>
+ </menu>
+
+ ${reports}
+ </body>
+</project>