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 zh...@apache.org on 2006/01/30 18:18:23 UTC
svn commit: r373550 - in /portals/pluto/trunk/pluto-container: pom.xml
src/site/apt/ src/site/site.xml src/site/xdoc/ src/site/xdoc/embed.xml
src/site/xdoc/getting-started.xml
Author: zheng
Date: Mon Jan 30 09:18:15 2006
New Revision: 373550
URL: http://svn.apache.org/viewcvs?rev=373550&view=rev
Log:
Migrate APT to xdoc
Added:
portals/pluto/trunk/pluto-container/src/site/xdoc/
portals/pluto/trunk/pluto-container/src/site/xdoc/embed.xml
portals/pluto/trunk/pluto-container/src/site/xdoc/getting-started.xml
Removed:
portals/pluto/trunk/pluto-container/src/site/apt/
Modified:
portals/pluto/trunk/pluto-container/pom.xml
portals/pluto/trunk/pluto-container/src/site/site.xml
Modified: portals/pluto/trunk/pluto-container/pom.xml
URL: http://svn.apache.org/viewcvs/portals/pluto/trunk/pluto-container/pom.xml?rev=373550&r1=373549&r2=373550&view=diff
==============================================================================
--- portals/pluto/trunk/pluto-container/pom.xml (original)
+++ portals/pluto/trunk/pluto-container/pom.xml Mon Jan 30 09:18:15 2006
@@ -1,27 +1,33 @@
-<project>
+<?xml version="1.0" encoding="UTF-8"?>
+
+<project xmlns="http://maven.apache.org/POM/4.0.0"
+ xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+ xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd">
+
+ <parent>
+ <groupId>org.apache.pluto</groupId>
+ <artifactId>pluto</artifactId>
+ <version>1.1.0-SNAPSHOT</version>
+ </parent>
+
<modelVersion>4.0.0</modelVersion>
<groupId>org.apache.pluto</groupId>
<artifactId>pluto-container</artifactId>
<packaging>jar</packaging>
<name>Pluto Portlet Container</name>
- <url>http://portals.apache.org/pluto</url>
<description>The pluto portlet container.</description>
- <parent>
- <groupId>org.apache.pluto</groupId>
- <artifactId>pluto</artifactId>
- <version>1.1.0-SNAPSHOT</version>
- </parent>
+
+
<dependencies>
-
- <!-- ===== ======================= ===== -->
- <!-- ===== Pluto Support Libraries ===== -->
- <!-- ===== ======================= ===== -->
+ <!-- ===== ======================= ===== -->
+ <!-- ===== Pluto Support Libraries ===== -->
+ <!-- ===== ======================= ===== -->
<dependency>
<groupId>org.apache.pluto</groupId>
- <artifactId>pluto-descriptor-api</artifactId>
- <version>${pom.version}</version>
- <scope>compile</scope>
+ <artifactId>pluto-descriptor-api</artifactId>
+ <version>${pom.version}</version>
+ <scope>compile</scope>
</dependency>
<dependency>
@@ -31,30 +37,30 @@
<scope>runtime</scope>
</dependency>
- <!-- ===== ======================= ===== -->
- <!-- ===== Other Support Libraries ===== -->
- <!-- ===== ======================= ===== -->
+ <!-- ===== ======================= ===== -->
+ <!-- ===== Other Support Libraries ===== -->
+ <!-- ===== ======================= ===== -->
<dependency>
<groupId>commons-logging</groupId>
- <artifactId>commons-logging</artifactId>
- <version>1.0.4</version>
- <scope>compile</scope>
+ <artifactId>commons-logging</artifactId>
+ <version>1.0.4</version>
+ <scope>compile</scope>
<exclusions>
<exclusion>
<groupId>avalon-framework</groupId>
<artifactId>avalon-framework</artifactId>
</exclusion>
<exclusion>
- <groupId>log4j</groupId>
- <artifactId>log4j</artifactId>
+ <groupId>log4j</groupId>
+ <artifactId>log4j</artifactId>
</exclusion>
<exclusion>
- <groupId>logkit</groupId>
- <artifactId>logkit</artifactId>
+ <groupId>logkit</groupId>
+ <artifactId>logkit</artifactId>
</exclusion>
</exclusions>
</dependency>
-
+
<!-- ===== ======================= ===== -->
<!-- ===== Specification Libraries ===== -->
<!-- ===== ======================= ===== -->
Modified: 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=373550&r1=373549&r2=373550&view=diff
==============================================================================
--- portals/pluto/trunk/pluto-container/src/site/site.xml (original)
+++ portals/pluto/trunk/pluto-container/src/site/site.xml Mon Jan 30 09:18:15 2006
@@ -1,5 +1,23 @@
-<?xml version="1.0" encoding="ISO-8859-1"?>
-<project name="Maven">
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+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.
+-->
+
+<project name="Pluto Portlet Container">
+
<bannerLeft>
<name>Pluto</name>
<src>http://portals.apache.org/pluto/images/pluto.png</src>
@@ -8,18 +26,24 @@
<bannerRight>
<src>http://portals.apache.org/pluto/images/banner.png</src>
</bannerRight>
+
<body>
+
<links>
- <item name="Pluto Home" href="http://portals.apache.org/pluto"/>
+ <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"/>
+ <item name="JSR 286" href="http://jcp.org/en/jsr/detail?id=286"/>
+ <item name="Chinese Translation" href="http://people.apache.org/~zheng/pluto/chinese/"/>
</links>
-
- <menu name="Portlet Container">
+
+ <menu name="Portlet Container">
<item name="Getting Started" href="/getting-started.html"/>
<item name="Embedding Pluto" href="/embed.html"/>
- </menu>
-
+ </menu>
+
${reports}
+
</body>
+
</project>
+
Added: portals/pluto/trunk/pluto-container/src/site/xdoc/embed.xml
URL: http://svn.apache.org/viewcvs/portals/pluto/trunk/pluto-container/src/site/xdoc/embed.xml?rev=373550&view=auto
==============================================================================
--- portals/pluto/trunk/pluto-container/src/site/xdoc/embed.xml (added)
+++ portals/pluto/trunk/pluto-container/src/site/xdoc/embed.xml Mon Jan 30 09:18:15 2006
@@ -0,0 +1,89 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+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>Embedding the Pluto Container</title>
+ <author email="ddewolf@apache.org">David DeWolf</author>
+ </properties>
+
+ <body>
+
+ <section name="Embedding the Pluto Container">
+
+ <p>
+ This document is currently <b>very</b> breif. Please feel free to submit
+ patches.
+ </p>
+
+ <subsection name="Steps for Embedding Pluto">
+ <p>
+ <b>Step 1:</b> Implement <code>org.apache.pluto.PortletContainerServices</code>
+ </p>
+ <p>
+ <b>Step 2:</b> Manage the Portlet Container Lifecycle:
+ <ul>
+ <li>
+ Create an instance of the container:
+ <source><![CDATA[
+//
+// 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);
+ ]]></source>
+ </li>
+ <li>Destroy the Container during Shutdown.</li>
+ </ul>
+ </p>
+ <p>
+ <b>Step 3:</b> Invoke the Container as necessary:
+ <source><![CDATA[
+// 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);
+ ]]></source>
+ </p>
+
+ </subsection>
+
+ </section>
+
+ </body>
+
+</document>
+
Added: portals/pluto/trunk/pluto-container/src/site/xdoc/getting-started.xml
URL: http://svn.apache.org/viewcvs/portals/pluto/trunk/pluto-container/src/site/xdoc/getting-started.xml?rev=373550&view=auto
==============================================================================
--- portals/pluto/trunk/pluto-container/src/site/xdoc/getting-started.xml (added)
+++ portals/pluto/trunk/pluto-container/src/site/xdoc/getting-started.xml Mon Jan 30 09:18:15 2006
@@ -0,0 +1,46 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+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>Getting Started</title>
+ <author email="ddewolf@apache.org">David DeWolf</author>
+ </properties>
+
+ <body>
+
+ <section name="Getting Started">
+ <p>
+ 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
+ <a href="../pluto-portal-driver/index.html">Pluto Portal Driver</a>.
+ </p>
+ <p>
+ If you are looking for information on how to embed pluto in your portal
+ or web application, please see the <a href="embed.html">embedding pluto</a>
+ documentation for Pluto 1.1.
+ </p>
+ </section>
+
+ </body>
+
+</document>
+