7:58 p.m.
Author: chris.laprun(a)jboss.com
Date: 2008-02-14 20:58:37 -0500 (Thu, 14 Feb 2008)
New Revision: 9982
Added:
modules/portlet/trunk/docs/user-guide/en/modules/installation.xml
Modified:
modules/portlet/trunk/docs/user-guide/en/master.xml
modules/portlet/trunk/docs/user-guide/en/modules/introduction.xml
Log:
- Started documentation.
Modified: modules/portlet/trunk/docs/user-guide/en/master.xml
===================================================================
--- modules/portlet/trunk/docs/user-guide/en/master.xml 2008-02-15 01:56:01 UTC (rev
9981)
+++ modules/portlet/trunk/docs/user-guide/en/master.xml 2008-02-15 01:58:37 UTC (rev
9982)
@@ -1,8 +1,9 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.3CR3//EN"
- "../../docbook-support/support/docbook-dtd/docbookx.dtd" [
- <!ENTITY introduction SYSTEM "modules/introduction.xml">
- ]>
+ "../../docbook-support/support/docbook-dtd/docbookx.dtd" [
+ <!ENTITY introduction SYSTEM "modules/introduction.xml">
+ <!ENTITY installation SYSTEM "modules/installation.xml">
+ ]>
<book lang="en">
<bookinfo>
<title>Simple Portlet Container</title>
@@ -13,8 +14,14 @@
<surname>Viet</surname>
<email>julien(a)jboss.org</email>
</author>
+ <author>
+ <firstname>Chris</firstname>
+ <surname>Laprun</surname>
+ <email>chris.laprun(a)jboss.com</email>
+ </author>
</bookinfo>
<toc/>
<!-- Introduction --> &introduction;
+ <!-- Installation --> &installation;
</book>
Added: modules/portlet/trunk/docs/user-guide/en/modules/installation.xml
===================================================================
--- modules/portlet/trunk/docs/user-guide/en/modules/installation.xml
(rev 0)
+++ modules/portlet/trunk/docs/user-guide/en/modules/installation.xml 2008-02-15 01:58:37
UTC (rev 9982)
@@ -0,0 +1,129 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<chapter id="installation">
+ <chapterinfo>
+ <author>
+ <firstname>Julien</firstname>
+ <surname>Viet</surname>
+ <email>julien(a)jboss.org</email>
+ </author>
+ <author>
+ <firstname>Chris</firstname>
+ <surname>Laprun</surname>
+ <email>chris.laprun(a)jboss.com</email>
+ </author>
+ </chapterinfo>
+
+ <title>Installation</title>
+ <sect1>
+ <title>Downloading and installing</title>
+ <para>Two bundled versions are provided to showcase JBoss Portlet Container
in action with minimum effort. Theses
+ bundles each include a servlet container configured with the Simple Portal
demonstration portal along with
+ some JSR-286 compliant portlets. You will need to have Java 5 configured on your
machine to run the
+ demonstration portal.
+ You can download Java 5 at<ulink
url="http://java.sun.com/javase/downloads/index_jdk5.jsp">
+ http://java.sun.com/javase/downloads/index_jdk5.jsp</ulink>;. Once you have
Java installed, you are ready to
+ download one of JBoss Portlet Container bundles. The following link has the list
of downloads for JBoss Portlet
+ Container:<ulink
url="http://labs.jboss.com/portletcontainer/download">
+ http://labs.jboss.com/portal/portletcontainer/download</ulink>;. Two
bundles are currently provided: one with
+ Tomcat 6.0.16 and one with JBoss Application Server 4.2.2.GA.
+ </para>
+ <sect2>
+ <title>JBoss AS 4.2.x bundle</title>
+ <para>
+ Of note in the bundle are the following directories:
+ <itemizedlist>
+ <listitem>
+ <emphasis role="bold">bin</emphasis>
+ - Contains the startup/shutdown commands for JBoss Application Server
+ </listitem>
+ <listitem>
+ <emphasis role="bold">docs</emphasis>
+ - Contains documentation for JBoss Application Server
+ </listitem>
+ <listitem>
+ <emphasis role="bold">jbosspc-docs</emphasis>
+ - Contains documentation for JBoss Portlet Container (this document
included)
+ </listitem>
+ <listitem>
+ <emphasis role="bold">server</emphasis>
+ - Contains JBoss Application Server configuration and the
+ <filename>simple-portal.war</filename>
+ file along with several sample portlets in the
+ <filename>deploy</filename>
+ directory of the
+ <emphasis>default</emphasis>
+ configuration
+ </listitem>
+ </itemizedlist>
+ </para>
+ <para>
+ To start the demonstration portal, go to the
+ <filename>bin</filename>
+ directory and execute either
+ <filename>run.sh</filename>
+ or
+ <filename>run.bat</filename>
+ (depending on your platform).
+ </para>
+ </sect2>
+ <sect2>
+ <title>Tomcat 6.0.x bundle</title>
+ <para>
+ Of note in the bundle are the following directories:
+ <itemizedlist>
+ <listitem>
+ <emphasis role="bold">bin</emphasis>
+ - Contains the startup/shutdown commands for Tomcat
+ </listitem>
+ <listitem>
+ <emphasis role="bold">logs</emphasis>
+ - Contains the logs once the servlet container is started (the most
interesting one being one with
+ <emphasis>locahost</emphasis>
+ in its name)
+ </listitem>
+ <listitem>
+ <emphasis role="bold">jbosspc-docs</emphasis>
+ - Contains documentation for JBoss Portlet Container (this document
included)
+ </listitem>
+ <listitem>
+ <emphasis role="bold">lib</emphasis>
+ - Contains Tomcat libraries to which several support libraries for
JBoss Portlet Container have been
+ added
+ </listitem>
+ <listitem>
+ <emphasis role="bold">webapps</emphasis>
+ - Contains Tomcat default applications and the
+ <filename>simple-portal.war</filename>
+ file along with several sample portlets
+ </listitem>
+ </itemizedlist>
+ </para>
+ <para>
+ To start the demonstration portal, go to the
+ <filename>bin</filename>
+ directory and execute either
+ <filename>startup.sh</filename>
+ or
+ <filename>startup.bat</filename>
+ (depending on your platform).
+ </para>
+ </sect2>
+ </sect1>
+
+ <sect1>
+ <title>Testing Portal Container's demonstration portal</title>
+ <para>Once the servlet container is started, bring up your web browser and go
to the following URL:
+ <ulink
url="http://localhost:8080/simple-portal">http://localhost:8080/simple-portal</ulink>.
+ You should see the default page for Portlet Container's demonstration
portal:
+ <mediaobject>
+ <imageobject>
+ <imagedata align="center"
fileref="images/simple-portal.png" format="PNG"
+ scale="60" valign="middle"/>
+ </imageobject>
+ <caption>
+ <para>Default page for Portlet Container's demonstration
portal.</para>
+ </caption>
+ </mediaobject>
+ </para>
+ </sect1>
+</chapter>
Modified: modules/portlet/trunk/docs/user-guide/en/modules/introduction.xml
===================================================================
--- modules/portlet/trunk/docs/user-guide/en/modules/introduction.xml 2008-02-15 01:56:01
UTC (rev 9981)
+++ modules/portlet/trunk/docs/user-guide/en/modules/introduction.xml 2008-02-15 01:58:37
UTC (rev 9982)
@@ -6,14 +6,44 @@
<surname>Viet</surname>
<email>julien(a)jboss.org</email>
</author>
+ <author>
+ <firstname>Chris</firstname>
+ <surname>Laprun</surname>
+ <email>chris.laprun(a)jboss.com</email>
+ </author>
</chapterinfo>
<title>Introduction</title>
<sect1>
<title>Motivation</title>
- <para></para>
+ <para>JBoss Portlet Container is the next generation portlet container on
which future versions of JBoss Portal,
+ and the JBoss Portal platform will be based. It provides a standard-compliant
implementation of the JSR-286
+ Portlet 2.0 specification. It has been developed with reusability in mind so
that advanced users, who don't
+ require a full-fledged portal, can leverage the portlet management services it
provides in their own
+ applications. JBoss Portlet Container is available through the business-friendly
LGPL open source license.
+ </para>
</sect1>
<sect1>
- <title>Principles</title>
- <para></para>
+ <title>Audience</title>
+ <para>JBoss Portlet Container is targeted at developers and advanced users
who want to be able to deploy
+ portlet-based applications but don't need a full-fledged portal.
+ </para>
</sect1>
+ <sect1>
+ <title>Simple Portal: showcasing JBoss Portlet Container</title>
+ <para>A simple portal has been built on top of the base portlet container. A
JSP taglib is also provided to make
+ it easy to display portlet content in JSP pages. We also provide samples of
portlets implementing some of the
+ advanced capabilities of JSR-286.
+ </para>
+ </sect1>
+ <sect1>
+ <title>Resources</title>
+ <itemizedlist>
+ <listitem>
+ <ulink url="http://labs.jboss.com/portletcontainer/">Project
website</ulink>
+ </listitem>
+ <listitem>
+ <ulink url="http://labs.jboss.com/wiki/JBPC_Home">Project
Wiki</ulink>
+ </listitem>
+ </itemizedlist>
+ </sect1>
</chapter>