You are viewing a plain text version of this content. The canonical link for it is here.
Posted to jetspeed-dev@portals.apache.org by ta...@apache.org on 2009/02/23 23:55:07 UTC
svn commit: r747185 [6/7] - in
/portals/jetspeed-2/portal/branches/JETSPEED-2.1.3-POSTRELEASE:
components/capability/xdocs/ components/cm/xdocs/
components/deploy-tool/xdocs/ components/portal/xdocs/
components/rdbms/xdocs/ components/search/xdocs/ com...
Modified: portals/jetspeed-2/portal/branches/JETSPEED-2.1.3-POSTRELEASE/xdocs/index.xml
URL: http://svn.apache.org/viewvc/portals/jetspeed-2/portal/branches/JETSPEED-2.1.3-POSTRELEASE/xdocs/index.xml?rev=747185&r1=747184&r2=747185&view=diff
==============================================================================
--- portals/jetspeed-2/portal/branches/JETSPEED-2.1.3-POSTRELEASE/xdocs/index.xml (original)
+++ portals/jetspeed-2/portal/branches/JETSPEED-2.1.3-POSTRELEASE/xdocs/index.xml Mon Feb 23 22:54:40 2009
@@ -56,103 +56,99 @@
<a href="features.html">Features</a>
</li>
<li>
- <a href="guides/index.html">
- Getting Started
- </a>
- </li>
- <li>
- <a href="guides/guide-migration.html">
+ <a href="guide-migration.html">
Migrating Guide
</a>
</li>
<li>
- <a href="guides/guide-demo.html">
+ <a href="demo.html">
Live demo!
</a>
</li>
</ul>
</div>
- <p>
- Jetspeed-2 is the next-generation enterprise portal at
- Apache. Jetspeed-2 offers several architectural
- enhancements and improvements over Jetspeed 1.0. First,
- Jetspeed-2 is conformant to the
- <a href="http://www.jcp.org/en/jsr/detail?id=168">Java Portlet Standard</a>
- and provides a standard mechanism for the deployment
- of portlets. Second, Jetspeed-2 has matured to a more
- scalable architecture featuring multi-threaded
- functionality. Third, Jetspeed-2 is decoupled from
- several legacy open source projects. Fourth, Jetspeed-2
- is based on a component architecture.
- <br/><br/>
- </p>
- <subsection name="Jetspeed-2 Documentation">
- <p>
- Most Jetspeed-2 documentation is in the form of
- <a href="guides/index.html">documentation guides</a>
- .
- </p>
- </subsection>
- <subsection name="Jetspeed-2 Status">
<p>
- The latest 2.1.3 production release of Jetspeed-2 was released
- on December 21, 2007. Future development areas include alignment with the upcoming
- <a href="http://www.jcp.org/en/jsr/detail?id=286">Java Portlet Standard 2.0, JSR-286</a>
- new portlet applications, WSRP support, further improvement of the design and user experience.
- </p>
- </subsection>
- <subsection name="About Jetspeed-2">
- <p>
-Jetspeed is an Open Portal Platform and Enterprise Information Portal, written entirely in open source under the Apache license in Java and XML.
-Jetspeed is an open component portal architecture based on standards. All access to the portal is managed through a robust portal security policy.
-Within a Jetspeed portal, individual portlets can be aggregated to create a page. Each portlet is an independent application with
+Jetspeed is an Open Portal Platform and Enterprise Information Portal, written entirely in open source under the Apache license in Java and XML and based on open standards.
+All access to the portal is managed through a robust portal security policy. Within a Jetspeed portal, individual portlets can be aggregated to create a page. Each portlet is an independent application with
Jetspeed acting as the central hub making information from multiple sources available in an easy to use manner.
</p>
+<p>
+Version 2.1.3 is conformant to the
+ <a href="http://www.jcp.org/en/jsr/detail?id=168">Java Portlet 1.0 Standard</a>. Version 2.2 will be conformant to the
+<a href="http://www.jcp.org/en/jsr/detail?id=286">Java Portlet 2.0 Standard</a>.</p>
<p>
A portal based on Jetspeed can make applications, database information and other data sources available to end-users through a single web site.
Jetspeed provides a security infrastructure so that the information and functions made available to each user can be customized on basis of the
user or a role that the user has. The user can access the portal via a web browser, WAP-phone, pager or any other device supported by the servlet engine.
</p>
+ <p>
+
+The Jetspeed enterprise portal integrates dynamic information, people, and processes across organization boundaries. This content is aggregated using portlets from diverse sources.
+Portlets are just mini-web applications, or web-components. Jetspeed always provides secured access to the portlets. A short overview of Jetspeed <a href="feature.html">features</a>:
+<ul>
+<li>Secure Access - Security based on standards, ACLs</li>
+<li>Single Point of Entry (SSO, Federated) </li>
+<li>Enterprise Integration - (EAI, integration points)</li>
+<li>Personalization - (customizers, skins) </li>
+<li>Dynamic Web Components - (portlets based on standards)</li>
+<li>Scaleable, Component Architecture featuring multi-threading</li>
+</ul>
+</p>
+ <subsection name="Jetspeed-2 Status">
<p>
+ The latest 2.1.3 production release of Jetspeed-2 was released
+ on December 21, 2007. Future development areas include alignment with the
+ <a href="http://www.jcp.org/en/jsr/detail?id=286">Java Portlet Standard 2.0, JSR-286</a>
+ new portlet applications, WSRP support, further improvement of the design and user experience.
</p>
- <p>
- For more information, see:
+ </subsection>
+
+ <subsection name="Jetspeed Documentation">
+ <p>
+ Most of Jetspeed's documentation is in the form of guides. Depending on your role at the portal, you may want to read one of these guides:
<ul>
<li>
- <a href="developers.html">
- Jetspeed for Developers
+ <a href="usersguide/index.html">
+ Users Guide
</a>
- ?
</li>
<li>
- How do I
- <a href="getting-started.html">
- Get Started
+ <a href="adminguide/index.html">
+ Administration Guide
</a>
- ?
</li>
<li>
- Where is
- <a href="guides/index.html">
- the Documentation Guides
+ <a href="deployguide/index.html">
+ Deployment and Configuration Guide
</a>
- ?
</li>
<li>
- How
- <a href="how-to-help.html">Can I Help</a>
- ?
+ <a href="devguide/index.html">
+ Developers Guide
+ </a>
</li>
+ </ul>
+ </p>
+ </subsection>
+ <subsection name="Jetspeed Tutorials">
+ <p>
+ A great place to learn how to use Jetspeed is with the Tutorials:
+ <ul>
<li>
- What do I need to know
- <a href="j1-users.html">
- if I used Jetspeed-1
+ <a href="tutorials/maven-2/index.html">
+ Custom Build Tutorial with Maven-2
</a>
- ?
</li>
- </ul>
- </p>
+ <li>
+ <a href="tutorials/ant/index.html">
+ Custom Build Tutorial with Ant
+ </a>
+ </li>
+ </ul>
+ </p>
</subsection>
+
+
</section>
</body>
</document>
\ No newline at end of file
Modified: portals/jetspeed-2/portal/branches/JETSPEED-2.1.3-POSTRELEASE/xdocs/navigation.xml
URL: http://svn.apache.org/viewvc/portals/jetspeed-2/portal/branches/JETSPEED-2.1.3-POSTRELEASE/xdocs/navigation.xml?rev=747185&r1=747184&r2=747185&view=diff
==============================================================================
--- portals/jetspeed-2/portal/branches/JETSPEED-2.1.3-POSTRELEASE/xdocs/navigation.xml (original)
+++ portals/jetspeed-2/portal/branches/JETSPEED-2.1.3-POSTRELEASE/xdocs/navigation.xml Mon Feb 23 22:54:40 2009
@@ -19,32 +19,38 @@
<body>
<links>
<item name="Jetspeed-1" href="http://portals.apache.org/jetspeed-1" target="_nw"/>
- <item name="Jetspeed-2" href="http://portals.apache.org/jetspeed-2" target="_nw"/>
+ <item name="Jetspeed-2.2" href="http://portals.apache.org/jetspeed-2" target="_nw"/>
<item name="Bridges" href="http://portals.apache.org/bridges" target="_nw"/>
<item name="PDF Documentation" href="/jetspeed2.pdf" img="images/pdf.gif" />
</links>
<menu name="Essentials">
+ <item name="Welcome" href="index.html" />
<item name="Features" href="features.html" />
<item name="Getting Started" href="getting-started.html" />
- <item name="Jetspeed for Developers" href="developers.html" />
+ <item name="Jetspeed Online Demos" href="demo.html"/>
</menu>
- <menu name="Building">
- <item name="From Source with Maven-2" href="maven-2-build.html" />
- <item name="From Maven-2 Plugin" href="maven-2-custom.html" />
- <item name="From Source with Maven-1 (deprecated)" href="getting-started-source.html" />
- <item name="From Maven-1 Plugin (deprecated)" href="getting-started-binary.html" />
- <item name="From Eclipse" href="jetspeed-eclipse.html" />
- </menu>
<menu name="Get Jetspeed-2.1.3">
<item name="Download" href="download.html" />
+ <item name="Installer Instructions" href="getting-started-installer.html" />
<item name="Release Notes" href="release-notes.html" />
</menu>
- <menu name="Documentation">
- <item name="Documentation Guides" href="guides/index.html" />
- <item name="Jetspeed Tutorial - Maven-2 Custom Build" href="http://portals.apache.org/tutorials/jetspeed-2/" />
- <item name="Jetspeed Tutorial - Ant Custom Build (incomplete)" href="http://portals.apache.org/tutorials/jetspeed-2-ant/" />
- <item name="Jetspeed-2 API" href="http://portals.apache.org/jetspeed-2/multiproject/jetspeed-api/apidocs/index.html" />
- <item name="Jetspeed-2 Plugin" href="j2-maven-plugin.html" />
+ <menu name="Documentation Guides">
+ <item name="Users Guide" href="usersguide/index.html" />
+ <item name="Administrators Guide" href="adminguide/index.html" />
+ <item name="Deployment Guide" href="deployguide/index.html" />
+ <item name="Developers Guide" href="devguide/index.html" />
+ <item name="Migration Guide" href="guide-migration.html" />
+ </menu>
+ <menu name="APIs">
+ <item name="Jetspeed-2 Java API" href="jetspeed-api/apidocs/index.html" />
+ <item name="Jetspeed-2 AJAX API" href="devguide/guide-ajax-api.html" />
+ <item name="Jetspeed-2 Maven-2 Plugin" href="devguide/m2-build/j2-maven-plugin.html" />
+ </menu>
+ <menu name="Tutorials">
+ <item name="Jetspeed Tutorial - Maven-2 Custom Build" href="tutorials/maven-2/index.html" />
+ <item name="Jetspeed Tutorial - Ant Custom Build (incomplete)" href="tutorials/ant/index.html" />
+ <item name="Maven-1 Custom Build" href="tutorials/stepbystep/guide-building-custom-portal-maven1.html" />
+ <item name="Maven-2 Custom Build" href="tutorials/stepbystep/guide-building-custom-portal-maven2.html" />
</menu>
<menu name="About Jetspeed-2">
<item name="For Jetspeed-1 Users" href="j1-users.html" />
Added: portals/jetspeed-2/portal/branches/JETSPEED-2.1.3-POSTRELEASE/xdocs/tutorials/ant/navigation.xml
URL: http://svn.apache.org/viewvc/portals/jetspeed-2/portal/branches/JETSPEED-2.1.3-POSTRELEASE/xdocs/tutorials/ant/navigation.xml?rev=747185&view=auto
==============================================================================
--- portals/jetspeed-2/portal/branches/JETSPEED-2.1.3-POSTRELEASE/xdocs/tutorials/ant/navigation.xml (added)
+++ portals/jetspeed-2/portal/branches/JETSPEED-2.1.3-POSTRELEASE/xdocs/tutorials/ant/navigation.xml Mon Feb 23 22:54:40 2009
@@ -0,0 +1,60 @@
+<?xml version="1.0" encoding="ISO-8859-1"?>
+<!--
+ Licensed to the Apache Software Foundation (ASF) under one or more
+ contributor license agreements. See the NOTICE file distributed with
+ this work for additional information regarding copyright ownership.
+ The ASF licenses this file to You 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>
+ <body>
+ <links>
+ <item name="Jetspeed-1" href="http://portals.apache.org/jetspeed-1" target="_nw"/>
+ <item name="Jetspeed-2" href="http://portals.apache.org/jetspeed-2" target="_nw"/>
+ <item name="Bridges" href="http://portals.apache.org/bridges" target="_nw"/>
+ </links>
+ <menu name="Tutorial Overview">
+ <item name="Welcome" href="index.html" />
+ <item name="Build Commands" href="build-commands.html" />
+ <item name="Project Directory Overview" href="project-directory.html" />
+ </menu>
+ <menu name="01. Custom Portal Generation">
+ <item name="Maven First Steps" href="01/first-steps.html" />
+ <item name="Generating a Jetspeed Portal" href="01/genapp.html" />
+ <item name="Build and Deploy Custom Portal" href="01/build-it.html" />
+ <item name="Run the Custom Portal" href="01/run-it.html" />
+ </menu>
+ <menu name="02. Customizing Your Portal Design">
+ <item name="Decorators and Themes" href="02/customizing-overview.html" />
+ <item name="Page Decoration" href="02/page-decoration.html" />
+ <item name="Portlet Decoration" href="02/portlet-decoration.html" />
+ <item name="Desktop Themes" href="02/desktop-theme.html" />
+ <item name="Changing the Default Page" href="02/default-page.html" />
+ <item name="Deploying your Customizations" href="02/deploy-custom.html"/>
+ </menu>
+ <menu name="03. Portlet Application Configuration">
+ <item name="Generating a Portlet Application" href="03/portlet-app.html" />
+ <item name="Building and Deploying" href="03/built-it.html" />
+ <item name="Configuring Portal Pages" href="03/pages.html" />
+ </menu>
+ <menu name="04. Portlet Development 101">
+ <item name="Overview" href="04/overview.html" />
+ <item name="Eclipse" href="04/eclipse.html" />
+ <item name="Hello World" href="04/hello.html" />
+ <item name="Adding a Page" href="04/tutorial-psml.html" />
+ <item name="JSP and Portlet API Taglib" href="04/taglib.html" />
+ </menu>
+ <menu name="05. Jetspeed Services">
+ <item name="Services Tutorial Portlet" href="05/jetspeed-service.html" />
+ </menu>
+ </body>
+</project>
Propchange: portals/jetspeed-2/portal/branches/JETSPEED-2.1.3-POSTRELEASE/xdocs/tutorials/ant/navigation.xml
------------------------------------------------------------------------------
svn:keywords = Id
Added: portals/jetspeed-2/portal/branches/JETSPEED-2.1.3-POSTRELEASE/xdocs/tutorials/maven-2/build-commands.xml
URL: http://svn.apache.org/viewvc/portals/jetspeed-2/portal/branches/JETSPEED-2.1.3-POSTRELEASE/xdocs/tutorials/maven-2/build-commands.xml?rev=747185&view=auto
==============================================================================
--- portals/jetspeed-2/portal/branches/JETSPEED-2.1.3-POSTRELEASE/xdocs/tutorials/maven-2/build-commands.xml (added)
+++ portals/jetspeed-2/portal/branches/JETSPEED-2.1.3-POSTRELEASE/xdocs/tutorials/maven-2/build-commands.xml Mon Feb 23 22:54:40 2009
@@ -0,0 +1,139 @@
+<?xml version="1.0"?>
+<!--
+ Licensed to the Apache Software Foundation (ASF) under one or more
+ contributor license agreements. See the NOTICE file distributed with
+ this work for additional information regarding copyright ownership.
+ The ASF licenses this file to You 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>Build Commands</title>
+ <subtitle>Build Commands for Maven-2 and Jetspeed</subtitle>
+ <authors>
+ <person name="David Sean Taylor" email="taylor@apache.org" />
+ </authors>
+ </properties>
+ <body>
+ <section name="Build Commands for Maven-2 and Jetspeed">
+ <p>
+ Here is a quick summary of the current Jetspeed2 Maven2 build commands:
+ </p>
+<div>
+<table>
+<tr>
+<td>
+<strong><tt>commands</tt></strong>
+</td>
+<td>
+<strong><tt>explanation</tt></strong>
+</td>
+</tr>
+<tr>
+<td>
+<strong><tt>mvn</tt></strong>
+</td>
+<td>
+performs base build and installs J2 artifacts in the Maven2 repository, (install is the default Maven2 goal for this build)
+</td>
+</tr>
+<tr>
+<td>
+<strong><tt>mvn -P test</tt></strong>
+</td>
+<td>
+performs base build and includes execution of test cases, (includes test database setup)
+</td>
+</tr>
+<tr>
+<td>
+<strong><tt>mvn -P tomcat</tt></strong>
+</td>
+<td>
+performs base build and deploys to Tomcat app server, (includes prodution database setup).
+Other app servers will be supported in the future, (see below for details)
+</td>
+</tr>
+<tr>
+<td>
+<strong><tt>mvn clean</tt></strong>
+</td>
+<td>
+cleans all build target directories
+</td>
+</tr>
+</table>
+</div>
+<p><em>Please note that the Maven2 repositories used by default with this build are generally saturated and the Jetspeed2 Maven2 repository does not yet contain a full mirror of the artifacts required to build Jetspeed2. If you experience download or connection failures, simply restart the build by issuing your last command again to retry.</em> </p>
+
+<subsection name='Additional Profiles'>
+<p>The following profiles are optional and can be supplied when building/deploying to Tomcat </p>
+<div>
+<table>
+<tr>
+<td>
+<strong><tt>mvn -P tomcat,min</tt></strong>
+</td>
+<td>
+specified that only the administrative portlets be deployed along with a minimal set of PSML pages.
+</td>
+</tr>
+<tr>
+<td>
+<strong><tt>mvn -P tomcat,full</tt></strong>
+</td>
+<td>
+at the moment, this is the same as the default build: deploys a full J2 set of portlets and PSML pages.
+</td>
+</tr>
+<tr>
+<td>
+<strong><tt>mvn -P tomcat,nodb</tt></strong>
+</td>
+<td>
+specifies that configuration of the production database should be skipped.
+</td>
+</tr>
+<tr>
+<td>
+<strong><tt>mvn -P tomcat,hot</tt></strong>
+</td>
+<td>
+indicates that a portlet app, component, or content should be directly written to the deployed Jetspeed2 webapp.
+</td>
+</tr>
+<tr>
+<td>
+<strong><tt>mvn -P tomcat,dbpsml</tt></strong>
+</td>
+<td>
+specifies portal build and database deployment/import to include configuration of database PSML.
+</td>
+</tr>
+<tr>
+<td>
+<strong><tt>mvn -P prod</tt></strong>
+</td>
+<td>
+executes deployment to application server specified in settings.xml, (see below).
+</td>
+</tr>
+</table>
+</div>
+<p>Currently, only Tomcat 5 and Tomcat 5.5 application servers are supported by this build.
+ More platforms are to be supported in the near future.
+</p>
+</subsection>
+</section>
+</body>
+</document>
+
Propchange: portals/jetspeed-2/portal/branches/JETSPEED-2.1.3-POSTRELEASE/xdocs/tutorials/maven-2/build-commands.xml
------------------------------------------------------------------------------
svn:keywords = Id
Added: portals/jetspeed-2/portal/branches/JETSPEED-2.1.3-POSTRELEASE/xdocs/tutorials/stepbystep/guide-building-custom-portal-maven1.xml
URL: http://svn.apache.org/viewvc/portals/jetspeed-2/portal/branches/JETSPEED-2.1.3-POSTRELEASE/xdocs/tutorials/stepbystep/guide-building-custom-portal-maven1.xml?rev=747185&view=auto
==============================================================================
--- portals/jetspeed-2/portal/branches/JETSPEED-2.1.3-POSTRELEASE/xdocs/tutorials/stepbystep/guide-building-custom-portal-maven1.xml (added)
+++ portals/jetspeed-2/portal/branches/JETSPEED-2.1.3-POSTRELEASE/xdocs/tutorials/stepbystep/guide-building-custom-portal-maven1.xml Mon Feb 23 22:54:40 2009
@@ -0,0 +1,374 @@
+<?xml version="1.0"?>
+ <!--
+ Licensed to the Apache Software Foundation (ASF) under one or more
+ contributor license agreements. See the NOTICE file distributed with
+ this work for additional information regarding copyright ownership.
+ The ASF licenses this file to You 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>Building a Custom Jetspeed Portal With Maven-1</title>
+ <subtitle>For Tomcat 5 and Websphere Deployments</subtitle>
+ <authors>
+ <person name="David Sean Taylor" email="taylor@apache.org" />
+ </authors>
+ </properties>
+ <body>
+ <section name='Building a Custom Jetspeed Portal With Maven-1'>
+ <ul>
+ <li>
+ <a href="#Introduction">Introduction</a>
+ <ul>
+ <li><a href="#Purpose">Purpose</a></li>
+ <li><a href="#Software_Requirements">Software Requirements</a></li>
+ </ul>
+ </li>
+ <li>
+ <a href="#Windows_XP_Environment">Windows XP Environment</a>
+ <ul>
+ <li><a href="#Distribution_And_Coventions">Distribution and Coventions</a></li>
+ <li><a href="#Environment">Environment</a></li>
+ </ul>
+ </li>
+ <li>
+ <a href="#Maven-1_Configuration">Maven-1 configuration</a>
+ <ul>
+ <li><a href="#USER_HOME_Build.properties">USER_HOME build.properties</a></li>
+ <li><a href="#Build.properties">build.properties</a></li>
+ </ul>
+ </li>
+ <li>
+ <a href="#Database">Database</a>
+ <ul>
+ <li><a href="#MAVEN_REPO_Classpath_Variable">MAVEN_REPO Classpath variable</a></li>
+ <li><a href="#Jetspeed-2_Portal_Sources">Jetspeed-2 portal sources</a></li>
+ </ul>
+ </li>
+ <li>
+ <a href="#Building_Jet_Express">Building Jet Express</a>
+ <ul>
+ <li><a href="#Building_Jet_Express_For_Tomcat">Building Jet Express for Tomcat</a></li>
+ <li><a href="#Building_Jet_Express_For_Websphere">Building Jet Express for Websphere</a></li>
+ <li><a href="#Synchronizing_The_Portal_With_Latest_Verion_Of
+ Jetspeed-2">Synchronizing the Portal with latest verion of
+ Jetspeed-2</a></li>
+ </ul>
+ </li>
+ <li><a href="#Revision_History">Revision History</a></li>
+ </ul>
+ </section>
+ <section name='Introduction'>
+ <p>
+ This document is a step by step guide to building a custom Apache
+ Portals Jetspeed-2 portal with Maven-1. The Maven-1 project
+ provided with this document will:
+ <ol>
+ <li>Build a custom portal</li>
+ <li>Build a custom portlet application</li>
+ <li>Populate the database</li>
+ <li>Create distributable deployment archives for Websphere
+ 6.1 and Tomcat 5</li>
+ </ol>
+ </p>
+ <p>
+ This document is for Maven-1 build systems. To build with Maven-2, see
+ the accompanying document "Building Custom a Jetspeed Portal with
+ Maven-2"
+ </p>
+ <p>
+ For documentation on deploying the WAR and EAR files created here, see
+ the document "Deploying Jetspeed to Websphere"
+ </p>
+ <subsection name='Purpose'>
+ <p>
+ This document will teach you how to build and configure a custom Jetspeed Portal and create deployable archives for Websphere 6.1 and Tomcat 5. The complete source code, projects and deployment environment are described in this document. Deployments are based upon the J2EE standard "Web Application" and "Enterprise Application" deployment. The build is based on the Apache Portals Jetspeed-2 "Maven-1 Custom Build".
+ </p>
+ <p>
+ Jetspeed is an open source project, thus all source code is freely available from Apache. See the website for more details: <a href="http://portals.apache.org/jetspeed-2/">http://portals.apache.org/jetspeed-2/</a>
+ </p>
+ <p>
+ This document assumes that the user is familiar with open source Java development. In particular the Apache Software Foundation (ASF) and the essential Apache open source projects:
+ <ol>
+ <li>Apache Portals http://portals.apache.org and subprojects:
+ <ol>
+ <li>Jetspeed-2</li>
+ <li>Bridges</li>
+ <li>Pluto</li>
+ </ol>
+ </li>
+ <li>Ant (<a href="http://ant.apache.org">http://ant.apache.org</a>)</li>
+ <li>Maven-1 (<a href="http://maven.apache.org">http://maven.apache.org</a>)</li>
+ <li>Apache Tomcat Web Server (<a href="http://tomcat.apache.org">http://tomcat.apache.org</a>)</li>
+ <li>IBM Websphere Application Server</li>
+ </ol>
+ </p>
+ </subsection>
+ <subsection name='Software Requirements'>
+ The distribution assumes the following software products installed:
+ <table>
+ <tr>
+ <td>Product</td>
+ <td>Version</td>
+ </tr>
+ <tr>
+ <td>Ant</td>
+ <td>1.6.5 or higher</td>
+ </tr>
+ <tr>
+ <td>Eclipse</td>
+ <td>3.1.1 or higher</td>
+ </tr>
+ <tr>
+ <td>Maven</td>
+ <td>1.0.2 or higher</td>
+ </tr>
+ <tr>
+ <td>Sun JDK</td>
+ <td>1.4.2 or 1.5</td>
+ </tr>
+ <tr>
+ <td>Tomcat</td>
+ <td>5.5.12 (with Java 1.4 compatibility) or higher</td>
+ </tr>
+ <tr>
+ <td>IBM Websphere</td>
+ <td>6.1.0.2 or higher</td>
+ </tr>
+ </table>
+ </subsection>
+ </section>
+ <section name='Windows XP Environment'>
+ <p>
+ This section shows how to configure under Windows XP for development, demo, testing and production environments. Since we are working with Java, the environment for Linux will not be much different although components like Eclipse and MySQL require Linux specific versions and setup.
+ </p>
+ <p>
+ When using properties files under Windows, please remember that Java requires you to use either the forward slash /, or double back slash \\ for file system paths. You cannot use a single back slash \. Using the back slash does not work with Java, since it is the escape sequence-character.
+ </p>
+ <p>WRONG!!!!</p>
+ <p>
+ <code>
+ my.files = \path\to\my\files\
+ </code>
+ </p>
+ <p>RIGHT :)</p>
+ <p>
+ <code>
+ my.files = /path/to/my/files/
+ </code>
+ </p>
+ <p>
+ It is strongly recommended to always use forward slashes, whether on Windows or Linux.
+ </p>
+ <subsection name='Distribution and Conventions'>
+ <p>
+ It is strongly recommended that all developers on the project use the same root directory for all project source and supporting files.
+ </p>
+ <p>
+ The distribution is a complete environment for software development, unit testing, system testing, and deploying to a production environment.
+ </p>
+ </subsection>
+ <subsection name='Environment'>
+ <p>
+ The system path will need to include Java, Maven and Ant.
+ </p>
+ <p>
+ Under Windows XP, the Environment Variables and the System Path is modified by going to the
+ <i>Start Menu -> Settings -> Control Panel -> System -> Advanced -> Environment Variables</i>.
+ </p>
+ <p>
+ Note: You need administrative privileges to be allowed to modify system environment variables.
+ </p>
+ <p>
+ With these settings configured, you then have to make your system Windows PATH variable based on the home directories:
+ </p>
+ <p>
+ <code>
+ PATH=%JAVA_HOME%\bin;%ANT_HOME%\bin;%MAVEN_HOME%\bin;C:\winnt\system32...
+ </code>
+ </p>
+ <p>
+ Note: make sure to put the new path elements in front of the existing path definition!
+ </p>
+ </subsection>
+ </section>
+ <section name='Maven-1 configuration'>
+ <p>
+ The build environment uses the Maven project management tool (<a href="http://maven.apache.org">http://maven.apache.org</a>). One thing that Maven does well is managing Java jar files and maintaining versions of those files. Maven stores all jar files for almost every known open source project on the planet in a set of distributed repositories on the internet. Maven project descriptors reference specific versions of the jars, and the jars are downloaded to a local repository in order to build the system. By default Maven puts the repository under your Home directory which on Windows XP usually is found under the "Documents and Settings" directory.
+ </p>
+ <p>
+ Maven's behavior is for the most part customized through one <i>project.properties</i> and/or one or two <i>build.properties</i> files for each project.
+ </p>
+ <p>
+ Specific project properties are usually defined in a <i>project.properties</i> file within the project directory. User overrides of default and project properties can be defined in a <i>build.properties</i> file within the same project directory as well as in the user home directory. Properties defined in the <i>build.properties</i> in the user home directory will overrule any other property definitions.
+ </p>
+ <p>
+ Our project development environment is fully contained within one root project directory. In order to be able to have Maven not put its repository under the user home directory, we do need to specify a few properties in the user home <i>build.properties.</i>
+ </p>
+ <subsection name='USER_HOME build.properties'>
+ <p>
+ The distribution contains a <i>build.properties</i> file under the etc directory which can be copied by every developer to its own home directory.
+ </p>
+ <p>
+ It defines the following general Maven-1 settings:
+ <ul>
+ <li><i>maven.home.local:</i> the local maven repository (OPTIONAL)</li>
+ <li><i>maven.repo.remote:</i> the remote repositories used by the Jet Express project(s)</li>
+ <li><i>maven.proxy.*:</i> any proxy server configuration</li>
+ </ul>
+ </p>
+ </subsection>
+ <subsection name='build.properties'>
+ <p>
+ The build supports both Tomcat 5 and WebSphere 6.1. Because each server requires slightly different handling, there are two sets of property files. To switch between the two, run one of the two batch files:
+ <ol>
+ <li>switchToTomcat.bat</li>
+ <li>switchToWebsphere.bat</li>
+ </ol>
+ </p>
+ </subsection>
+ <subsection name='Database'>
+ <p>
+ The build requires a database installed on the local network. For the examples here, we will use an Oracle database although you can select other databases such as DB2 or MySQL.
+ </p>
+ <p>
+ The database properties are defined in <i>build.properties.tomcat</i> and <i>build.properties.was</i>. He is an example of using Oracle configuration parameters and MySQL commented out:
+ </p>
+ <p>
+ <source>
+# -------------------------------------------------------------------------
+# MySQL Database Setup
+# -------------------------------------------------------------------------
+org.apache.jetspeed.production.database.default.name=mysql
+org.apache.jetspeed.production.database.url = jdbc:mysql://localhost/express
+org.apache.jetspeed.production.database.driver = com.mysql.jdbc.Driver
+org.apache.jetspeed.production.database.user = express
+org.apache.jetspeed.production.database.password = xxxx
+org.apache.jetspeed.production.jdbc.drivers.path=${express.home}/drivers/mysql-connector-java-3.1.7-bin.jar
+
+# -------------------------------------------------------------------------
+# Oracle Database Setup
+# -------------------------------------------------------------------------
+org.apache.jetspeed.production.database.default.name=oracle
+org.apache.jetspeed.production.database.url = jdbc:oracle:thin:@svn.bluesunrise.com:1521:XE
+org.apache.jetspeed.production.database.driver = oracle.jdbc.driver.OracleDriver
+org.apache.jetspeed.production.database.user = fmr
+org.apache.jetspeed.production.database.password = xxxx
+org.apache.jetspeed.production.jdbc.drivers.path=etc/drivers/ojdbc14.jar
+ </source>
+ </p>
+ </subsection>
+ <subsection name='MAVEN_REPO Classpath variable'>
+ <p>
+ To have Eclipse use the local Maven repository which will contain all the jars needed for jetspeed-2, the portal and portlets, the MAVEN_REPO Classpath variable needs to be defined.
+ </p>
+ <p>
+ Open the <i>Windows -> Preferences</i> dialog and select the <i>Java -> Build Path -> Classpath</i> Variables node from the Preferences tree. Then use the <i>New...</i> button to add a new MAVEN_REPO variable pointing at your Maven home repository folder.
+ </p>
+ </subsection>
+ <subsection name='Jetspeed-2 portal sources'>
+ <p>
+ For building the portal, the Jetspeed-2 portal sources are not needed, but for debugging purposes, it can be helpful to have them checked out when trying to debug.
+The Jetspeed-2 sources, as well as those for the embedded pluto portlet container and portals bridges, can all be checked out from the <i>svn.apache.org/repos/asf/portals</i> repository root, similar to how the Jet Express sources are checked out.
+ </p>
+ </subsection>
+ </section>
+ <section name='Building Jet Express'>
+ <p>
+ The Jet Express portal project is a Maven based project. It builds the entire portal as well as the example portlet application. The main Jet Express project controls the entire build.
+ </p>
+ <subsection name='Building Jet Express for Tomcat'>
+ <p>
+ <code>maven clean tomcat-all</code>
+ </p>
+ <p>
+ This will clean, build and deploy the portal as well as deploy the example portlet application.
+ Note: make sure to first once execute:
+ </p>
+ <p>
+ <code>
+ switchToTomcat.bat
+ </code>
+ </p>
+ </subsection>
+ <subsection name='Building Jet Express for Websphere'>
+ <p>
+ To build WAR files:
+ </p>
+ <p>
+ <code>maven clean was-war-all</code>
+ </p>
+ <p>
+ To build EAR files:
+ </p>
+ <p>
+ <code>maven clean was-ear-all</code>
+ </p>
+ <p>
+ This will clean, build and deploy the portal as well as deploy the example portlet application.
+ Note: make sure to first once execute:
+ </p>
+ <p>
+ <code>switchToWebsphere.bat</code>
+ </p>
+ </subsection>
+ <subsection name='Synchronizing the Portal with the latest version of Jetspeed-2'>
+ <p>
+ Because the portal uses jetspeed-2 jars stored in the local maven repository, newer version of jetspeed-2 jars will not automatically be downloaded from the remote bluesunrise maven repository.
+ </p>
+ <p>
+ To synchronize with the latest available jetspeed-2 build, the sync-j2.cmd batch file needs to be executed which will clear out the jetspeed-2 jars from the local maven repository and upgrade to the latest jetspeed-2 maven plugin:
+ </p>
+ <p>
+ <code>$WS_HOME\workspace\jetexpress>sync-j2.cmd</code>
+ </p>
+ <p>
+ A following (full) portal build will then automatically download and use the latest jetspeed-2 jars.
+ </p>
+ </subsection>
+ </section>
+ <section name='Revision History'>
+ <table>
+ <tr>
+ <td>Revision</td>
+ <td>Date</td>
+ <td>Author</td>
+ <td>Comments</td>
+ </tr>
+ <tr>
+ <td>0.1</td>
+ <td>2005-01-01</td>
+ <td>David Sean Taylor</td>
+ <td>Initial draft</td>
+ </tr>
+ <tr>
+ <td>0.2</td>
+ <td>2006-01-10</td>
+ <td>Ate Douma</td>
+ <td>Further refinements and clean out of unused sections</td>
+ </tr>
+ <tr>
+ <td>0.3</td>
+ <td>2006-01-10</td>
+ <td>David Sean Taylor</td>
+ <td>Express refinements</td>
+ </tr>
+ <tr>
+ <td>0.4</td>
+ <td>2006-10-16</td>
+ <td>David Sean Taylor</td>
+ <td>Websphere 6.1 testing</td>
+ </tr>
+ </table>
+ </section>
+ </body>
+</document>
+
Propchange: portals/jetspeed-2/portal/branches/JETSPEED-2.1.3-POSTRELEASE/xdocs/tutorials/stepbystep/guide-building-custom-portal-maven1.xml
------------------------------------------------------------------------------
svn:eol-style = native
Propchange: portals/jetspeed-2/portal/branches/JETSPEED-2.1.3-POSTRELEASE/xdocs/tutorials/stepbystep/guide-building-custom-portal-maven1.xml
------------------------------------------------------------------------------
svn:keywords = Id
Added: portals/jetspeed-2/portal/branches/JETSPEED-2.1.3-POSTRELEASE/xdocs/tutorials/stepbystep/guide-building-custom-portal-maven2.xml
URL: http://svn.apache.org/viewvc/portals/jetspeed-2/portal/branches/JETSPEED-2.1.3-POSTRELEASE/xdocs/tutorials/stepbystep/guide-building-custom-portal-maven2.xml?rev=747185&view=auto
==============================================================================
--- portals/jetspeed-2/portal/branches/JETSPEED-2.1.3-POSTRELEASE/xdocs/tutorials/stepbystep/guide-building-custom-portal-maven2.xml (added)
+++ portals/jetspeed-2/portal/branches/JETSPEED-2.1.3-POSTRELEASE/xdocs/tutorials/stepbystep/guide-building-custom-portal-maven2.xml Mon Feb 23 22:54:40 2009
@@ -0,0 +1,455 @@
+<?xml version="1.0"?>
+ <!--
+ Licensed to the Apache Software Foundation (ASF) under one or more
+ contributor license agreements. See the NOTICE file distributed with
+ this work for additional information regarding copyright ownership.
+ The ASF licenses this file to You 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>Building a Custom Jetspeed Portal With Maven-2</title>
+ <subtitle>For Tomcat 5 and Websphere Deployments</subtitle>
+ <authors>
+ <person name="David Sean Taylor" email="taylor@apache.org" />
+ </authors>
+ </properties>
+ <body>
+ <section name='Building a Custom Jetspeed Portal With Maven-2'>
+ <ul>
+ <li>
+ <a href="#Introduction">Introduction</a>
+ <ul>
+ <li><a href="#Purpose">Purpose</a></li>
+ <li><a href="#Software_Requirements">Software Requirements</a></li>
+ <li><a href="#The_Jet_Express_Custom_Portal_Project">The Jet Express Custom Portal Project</a></li>
+ <li><a href="#Environment">Environment</a></li>
+ </ul>
+ </li>
+ <li>
+ <a href="#Building_With_Maven-2">Building with Maven-2</a>
+ <ul>
+ <li><a href="#The_Maven-2_Repository">The Maven-2 Repository</a></li>
+ <li><a href="#The_Portal_Archetype_-_Creating_Your_Custom_Project">The Portal Archetype - Creating your Custom Project</a></li>
+ <li><a href="#The_Jet_Express_Custom_Portal">The Jet Express Custom Portal</a>
+ <ul>
+ <li>Step One: create the custom portal project</li>
+ <li>Step Two: create a portlet application project</li>
+ <li>Step Three: create the eclipse project files</li>
+ <li>Step Four: create the default PSML pages</li>
+ <li>Step Five: create the custom decorators</li>
+ <li>Step Six: add your new portlet application (Jet Express 2) to build</li>
+ <li>Step Seven: deploy your portal and portlet application</li>
+ <li>Optional Step: enable automated EAR build</li>
+ </ul>
+ </li>
+ <li><a href="#Redeploying_The_Portlet_Application">Redeploying the Portlet Application</a></li>
+ </ul>
+ </li>
+ <li><a href="#Revision_History">Revision History</a></li>
+ </ul>
+ </section>
+ <section name='Introduction' id="introduction">
+ <p>
+ This document is a step by step guide to building a custom Apache Portals Jetspeed-2 portal with Maven-2.
+ The Maven-2 project provided with this document will:
+ <ol>
+ <li>Build a custom portal</li>
+ <li>Build a custom portlet application</li>
+ <li>Populate the database</li>
+ <li>Create distributable deployment archives for Websphere
+ 6.1 and Tomcat 5</li>
+ </ol>
+ </p>
+ <p>
+ This document is for Maven-2 build systems. To build with Maven-2, see
+ the accompanying document "Building Custom a Jetspeed Portal with
+ Maven-1"
+ </p>
+ <p>
+ For documentation on deploying the WAR and EAR files created here, see
+ the document "Deploying Jetspeed to Websphere"
+ </p>
+ <subsection name='Purpose' id="intro-purpose">
+ <p>
+ This document will teach you how to build and configure a custom Jetspeed Portal and create deployable archives for Websphere 6.1 and Tomcat 5. The complete source code, projects and deployment environment are described in this document. Deployments are based upon the J2EE standard "Web Application" and "Enterprise Application" deployment. The build is based on the Apache Portals Jetspeed-2 "Maven-2 Custom Build".
+ </p>
+ <p>
+ Jetspeed is an open source project, thus all source code is freely available from Apache. See the website for more details: <a href="http://portals.apache.org/jetspeed-2/">http://portals.apache.org/jetspeed-2/</a>
+ </p>
+ <p>
+ This document assumes that the user is familiar with open source Java development. In particular the Apache Software Foundation (ASF) and the essential Apache open source projects:
+ <ol>
+ <li>Apache Portals <a href="http://portals.apache.org">http://portals.apache.org</a> and subprojects:
+ <ol>
+ <li>Jetspeed-2</li>
+ <li>Bridges</li>
+ <li>Pluto</li>
+ </ol>
+ </li>
+ <li>Ant (<a href="http://ant.apache.org">http://ant.apache.org</a>)</li>
+ <li>Maven-2 (<a href="http://maven.apache.org">http://maven.apache.org</a>)</li>
+ <li>Apache Tomcat Web Server (<a href="http://tomcat.apache.org">http://tomcat.apache.org</a>)</li>
+ <li>IBM Websphere Application Server</li>
+ </ol>
+ </p>
+ </subsection>
+ <subsection name='Software Requirements' id="intro-software-req">
+ The distribution assumes the following software products installed:
+ <table>
+ <tr>
+ <td>Product</td>
+ <td>Version</td>
+ </tr>
+ <tr>
+ <td>Ant</td>
+ <td>1.6.5 or higher</td>
+ </tr>
+ <tr>
+ <td>Eclipse</td>
+ <td>3.1.1 or higher</td>
+ </tr>
+ <tr>
+ <td>Maven</td>
+ <td>2.0.4 or higher</td>
+ </tr>
+ <tr>
+ <td>Sun JDK</td>
+ <td>1.4.2 or 1.5</td>
+ </tr>
+ <tr>
+ <td>Tomcat</td>
+ <td>5.5.12 (with Java 1.4 compatibility) or higher</td>
+ </tr>
+ <tr>
+ <td>IBM Websphere</td>
+ <td>6.1.0.2 or higher</td>
+ </tr>
+ </table>
+ </subsection>
+ <subsection name='The Jet Express Custom Portal Project' id="intro-jetexpress">
+ <p>
+ The example project accompanying this document is called Jet Express. It is a custom Jetspeed portal project. Custom projects are how you build a customized version of Jetspeed. With a custom project, you can override:
+ <ul>
+ <li>Spring configuration of your portal</li>
+ <li>Database connection</li>
+ <li>Portal decorations and layouts</li>
+ <li>Version of Jetspeed to integrate with</li>
+ <li>The context name of the portal</li>
+ </ul>
+ </p>
+ <p>
+ Here is what the customized portal will look like after it is built:
+ <br/>
+ <img src="images/custom-portal-build.png"/>
+ </p>
+ <p>
+ As you can see, it doesnât look like the default Jetspeed portal that you can download from Apache. Custom builds are best for developers to integrate their own portlet applications and portal features into a customized build environment.
+ </p>
+ <p>
+ The Jet Express project contains the following sub project builds:
+ <ul>
+ <li>The Portal build â builds a customized version of Jetspeed using the Portal Archetype.</li>
+ <li>The Express Demo build â builds a demo portlet application</li>
+ </ul>
+ </p>
+ <p>
+ With this build environment, you will be able to build both a portal and a portlet application. By following the examples in this document, the goal is to teach you how to create your own custom portal with a similar custom build project as Jet Express.
+ </p>
+ </subsection>
+ <subsection name='Environment'>
+ <p>
+ The system path will need to include Java, Maven and Ant.
+ </p>
+ <p>
+ Under Windows XP, the Environment Variables and the System Path is modified by going to the <i>Start Menu -> Settings -> Control Panel -> System -> Advanced -> Environment</i> Variables.
+ </p>
+ <p>
+ Note: You need administrative privileges to be allowed to modify system environment variables.
+ </p>
+ <p>
+ With these settings configured, you then have to make your system Windows PATH variable based on the executable directories for:
+ <ol>
+ <li>Maven</li>
+ <li>Ant</li>
+ <li>Java</li>
+ </ol>
+ Make sure you can go to a command line and type:
+ </p>
+ <p>
+ <source>mvn -v</source>
+ </p>
+ <p>
+ This command should display the current version of Maven-2.
+ </p>
+ </subsection>
+ </section>
+ <section name='Building with Maven-2' id="maven2">
+ <p>
+ The build environment uses the Maven-2 project management tool (<a href="http://maven.apache.org">http://maven.apache.org</a>). One thing that Maven does well is managing Java jar files and maintaining versions of those files. Maven stores all jar files for almost every known open source project on the planet in a set of distributed repositories on the internet. Maven project descriptors reference specific versions of the jars, and the jars are downloaded to a local repository in order to build the system.
+ </p>
+ <subsection name='The Maven-2 Repository' id="maven2-repo">
+ <p>
+ By default Maven looks for the local repository in a directory named ".m2" found under your Home directory which on Windows XP usually is found under the "Documents and Settings" directory.
+ </p>
+ <p>
+ We have provided a distribution of the entire Maven-2 repository required to build your custom portal. Simply unzip the <i>repository.zip</i> file into your <code>$HOME/.m2/repository</code> directory. You are now ready to start building with Maven and Jetspeed.
+ </p>
+ </subsection>
+ <subsection name='The Portal Archetype - Creating your Custom Project' id="maven2-custom-proj">
+ <p>
+ The first step is to create a new portal project. In our example, we create a new custom Jetspeed project named "jetexpress-2". Archetypes are Maven templates for creating other Maven kinds of projects. Jetspeed provides several archetypes:
+ <ul>
+ <li><i>Portal</i> archetype -creates a Jetspeed custom portal project</li>
+ <li><i>Application</i> archetype - creates a portlet application project</li>
+ <li><i>Component</i> archetype - create a general <a href="http://www.springsource.org">Spring</a> component project</li>
+ <li><i>Shared Jetspeed component</i> archetype - create a Jetspeed shared component project</li>
+ </ul>
+ </p>
+ <p>
+ From the directory above where you want to create the project, issued this command:
+ </p>
+ <p>
+ <source>
+ mvn archetype:create
+ -DarchetypeGroupId=org.apache.portals.jetspeed-2
+ -DarchetypeArtifactId=portal-archetype -DarchetypeVersion=2.1-dev
+ -DgroupId=bluesunrise
+ -DartifactId=jetexpress-2
+ -Dversion=1.0
+ </source>
+ </p>
+ <p>
+ This command will create a new subdirectory named "jetexpress-2". Under that subdirectory, you will find the shell for a complete Jetspeed portal custom project.
+ </p>
+ <p>
+ Note that this and other archetypes can issue many harmless warnings while expanding. Please ignore the warnings unless the expansion of the archetype template fails. When complete, the portal archetype expansion will contain the following structure within a directory named as the specified artifactId relative to the current working directory:
+ <ul>
+ <li><i><artifactId>/applications</i> - conventional subdirectory for portal application war modules.</li>
+ <li><i><artifactId>/app-servers</i> - contains portal deployment builds and resources.</li>
+ <li><i><artifactId>/components</i> - conventional subdirectory for portal component jar modules.</li>
+ <li><i><artifactId>/etc/assembly</i> - custom portal application component Spring assemblies.</li>
+ <li><i><artifactId>/conf</i> - portal application context configuration files.</li>
+ <li><i><artifactId>/etc/decorations</i> - custom decorations in images, layout, and portlet subdirectories.</li>
+ <li><i><artifactId>/etc/pages</i> - custom portal PSML pages augment/override minimal defaults, (e.g. <i>/Administrative/**, /default-page.psml, /myaccount.psml, /page.security, and /system/**</i>).</li>
+ <li><i><artifactId>/etc/schema</i> - Jetspeed-2 database schema definitions.</li>
+ <li><i><artifactId>/etc/sql</i> - Jetspeed-2 base database configuration scripts.</li>
+ <li><i><artifactId>/etc/templates</i> - custom overrides for Jetspeed-2 layout portlet templates.</li>
+ <li><i><artifactId>/etc/webapp</i> - custom content resources to be packaged with portal application.</li>
+ <li><i><artifactId>/portal</i> - portal application war build scripts and webapp resource overrides.</li>
+ <li><i><artifactId>/src</i> - these directories are an artifact of archetype expansion and should be deleted.</li>
+ </ul>
+ </p>
+ <p>
+ The archetype also contains a <i>settings.xml.sample</i> that is a subset of the Jetspeed-2 source build parameters. If one has not previously configured the <i>~/.m2/settings.xml</i> file as described above, this sample can be used to do so without J2 test configurations.
+ </p>
+ <p>
+ The first step in using the Maven2 build is to either:
+ <ol>
+ <li>copy the <i>settings.xml.sample</i> to <i>~/.m2/settings.xml</i>, or</li>
+ <li>incorporate the settings in this file into your existing Maven2 configuration by copying <i>settings.xml.sample</i> to <i>settings.xml</i></li>
+ </ol>
+ </p>
+ <p>
+ For our example, we are going to copy over pre-configured resources, including the <i>settings.xml</i> on top of our project to make the tutorial more useful.
+ </p>
+ </subsection>
+ <subsection name='The Jet Express Custom Portal' id="maven2-express-custom">
+ <p>
+ The Jet Express project has already been created for you. We ran the <i>archetype:create</i> command, then created all the resources and portlets to make up our custom portal. Lets go through the steps we went through, so that you can apply these same steps to your custom build.
+ </p>
+ <p>
+ NOTE: the steps below are not necessary with the training material
+ </p>
+ <h3>Step One: create the custom portal project</h3>
+ <p>
+ Create your portal application by running <i>archetype:create</i> for example:
+ </p>
+ <p>
+ <source>mvn archetype:create
+ -DarchetypeGroupId=org.apache.portals.jetspeed-2
+ -DarchetypeArtifactId=portal-archetype -DarchetypeVersion=2.1-dev
+ -DgroupId=bluesunrise
+ -DartifactId=jetexpress-2
+ -Dversion=1.0
+ </source>
+ </p>
+ <p>
+ This command will create a new subdirectory named "jetexpress-2". Under that subdirectory, you will find the shell for a complete Jetspeed portal custom project.
+ </p>
+ <h3>Step Two: create a portlet application project</h3>
+ <p>
+ Jetspeed also have an archetype for creating a portlet application:
+ </p>
+ <p>
+ <source>mvn archetype:create
+ -DarchetypeGroupId=org.apache.portals.jetspeed-2
+ -DarchetypeArtifactId=application-archetype
+ -DarchetypeVersion=2.1-dev
+ -DgroupId=bluesunrise
+ -DartifactId=express-demo2
+ -Dversion=1.0
+ </source>
+ </p>
+ <p>
+ The training material comes with a full express-demo2 portlet application. We have already written the portlets.
+ </p>
+ <h3>Step Three: create the eclipse project files</h3>
+ <p>
+ Maven can create the eclipse project files for you:
+ </p>
+ <p>
+ <source>mvn eclipse:eclipse</source>
+ </p>
+ <h3>Step Four: create the default PSML pages</h3>
+ <p>
+ PSML pages go in the portal/src/webapp/WEB-INF/pages directory by default:
+ <img src="images/webinf-structure-psml.png"/>
+ </p>
+ <p>
+ Usually each portal has a set of default PSML pages. The users will create their own pages as they use the system.
+ </p>
+ <h3>Step Five: create the custom decorators</h3>
+ <p>
+ Decorators go in the <i>portal/src/webapp/decorators</i> directory by default:
+ <img src="images/webinf-structure-decorators.png"/>
+ </p>
+ <p>
+ Here we have two kinds of decorators: page (layout) and portlet decorators. We have defined one of each. The page decorator defines the skin for the pages in our portal. The portlet decorator defines the default skin for the portlets.
+ </p>
+ <h3>Step Six: add your new portlet application (Jet Express 2) to the build</h3>
+ <p>
+ We need to edit a few files to help automate the Maven build so that it automatically deploys the Jet Express 2 portlet applications. Edit the <i>applications/pom.xml</i> file:
+ </p>
+ <p>
+ <source><![CDATA[
+<modules>
+ <module>express-demo2</module>
+</modules>]]>
+ </source>
+ </p>
+ <p>
+ Edit the root <i>pom.xml</i> file:
+ </p>
+ <p>
+ <source>
+ <![CDATA[
+<dependencyManagement>
+ <dependencies>
+ ...
+ <dependency>
+ <groupId>${pom.groupId}</groupId>
+ <artifactId>express-demo2</artifactId>
+ <type>war</type>
+ <version>${pom.version}</version>
+ </dependency>]]>
+ </source>
+ </p>
+ <p>
+ Finally, for deployment, add your new portlet application to the <i>app-servers</i> POM found under <i>app-servers/pom.xml</i>:
+ </p>
+ <p>
+ <source>
+ <![CDATA[
+<!-- custom portlet app -->
+<dependency>
+ <groupId>${pom.groupId}</groupId>
+ <artifactId>express-demo2</artifactId>
+ <type>war</type>
+ <version>${pom.version}</version>
+</dependency>]]>
+ </source>
+ </p>
+ <p>
+ To hot deploy your custom portlet application to Tomcat, add it to the <i>app-servers</i> Ant script for Tomcat:
+ </p>
+ <p>
+ <source><![CDATA[
+<target name="hot-deploy-apps">
+...
+ <antcall target="hot-deploy-war">
+ <param name="org.apache.jetspeed.deploy.groupid" value="${portal.groupid}"/>
+ <param name="org.apache.jetspeed.deploy.artifactid" value="express-demo2"/>
+ <param name="org.apache.jetspeed.deploy.version" value="${portal.version}"/>
+ </antcall>]]>
+ </source>
+ </p>
+ <h3>Step Seven: deploy your portal and portlet application</h3>
+ <p>
+ Now you are ready to deploy your new portal and portlet application. In this example, we will deploy to Tomcat:
+ </p>
+ <p>
+ <code>mvn âP tomcat</code>
+ </p>
+ <p>
+ Startup Tomcat, and go to:
+ </p>
+ <p>
+ <code>http://localhost:8080/jetexpress-2</code>
+ </p>
+ <p>
+ <img src="images/startupscreen.png"/>
+ </p>
+ <h3>Optional Step: enable automated EAR build</h3>
+ <p>
+ By default, only WAR files are generated. To generate an EAR file, edit the root <i>pom.xml</i> and uncomment this line:
+ </p>
+ <p>
+ <source>
+ <!-- Build Enterprise APP -->
+ <module>enterprise</module>
+ </source>
+ </p>
+ <p>
+ The EAR file will be generated into the <i>enterprise/target</i> directory.
+ </p>
+ <p>
+ You can deploy the generated EAR file as is into Websphere. We have tested this EAR with Websphere 6.1. Please read the accompanying document,
+ "Deploying Jetspeed to Websphere.doc" for more information.
+ </p>
+ </subsection>
+ <subsection name='Redeploying the Portlet Application' id="maven2-redeploy-app">
+ <p>
+ For fast servlet and portlet development, nothing seems to beat developing with Tomcat.
+ Say you make a change to a Java class in the Express Demo portlet application. To build and redeploy:
+ </p>
+ <p>
+ <source>
+ cd applications
+ cd express-demo2
+ mvn
+ copy target\express-demo2-1.0.war \JetspeedTraining\tomcat5\webapps\express-demo2.war
+ </source>
+ </p>
+ <p>
+ Wait a few seconds, and your changes should be deployed by Tomcat.
+ </p>
+ </subsection>
+ </section>
+ <section name='Revision History' id="rev">
+ <table>
+ <tr>
+ <td>Revision</td>
+ <td>Date</td>
+ <td>Author</td>
+ <td>Comments</td>
+ </tr>
+ <tr>
+ <td>0.1</td>
+ <td>2006-10-24</td>
+ <td>David Sean Taylor</td>
+ <td>Initial draft</td>
+ </tr>
+ </table>
+ </section>
+ </body>
+</document>
+
Propchange: portals/jetspeed-2/portal/branches/JETSPEED-2.1.3-POSTRELEASE/xdocs/tutorials/stepbystep/guide-building-custom-portal-maven2.xml
------------------------------------------------------------------------------
svn:eol-style = native
Propchange: portals/jetspeed-2/portal/branches/JETSPEED-2.1.3-POSTRELEASE/xdocs/tutorials/stepbystep/guide-building-custom-portal-maven2.xml
------------------------------------------------------------------------------
svn:keywords = Id
Added: portals/jetspeed-2/portal/branches/JETSPEED-2.1.3-POSTRELEASE/xdocs/tutorials/stepbystep/images/startupscreen.png
URL: http://svn.apache.org/viewvc/portals/jetspeed-2/portal/branches/JETSPEED-2.1.3-POSTRELEASE/xdocs/tutorials/stepbystep/images/startupscreen.png?rev=747185&view=auto
==============================================================================
Binary file - no diff available.
Propchange: portals/jetspeed-2/portal/branches/JETSPEED-2.1.3-POSTRELEASE/xdocs/tutorials/stepbystep/images/startupscreen.png
------------------------------------------------------------------------------
svn:mime-type = image/png
Added: portals/jetspeed-2/portal/branches/JETSPEED-2.1.3-POSTRELEASE/xdocs/tutorials/stepbystep/images/webinf-structure-decorators.png
URL: http://svn.apache.org/viewvc/portals/jetspeed-2/portal/branches/JETSPEED-2.1.3-POSTRELEASE/xdocs/tutorials/stepbystep/images/webinf-structure-decorators.png?rev=747185&view=auto
==============================================================================
Binary file - no diff available.
Propchange: portals/jetspeed-2/portal/branches/JETSPEED-2.1.3-POSTRELEASE/xdocs/tutorials/stepbystep/images/webinf-structure-decorators.png
------------------------------------------------------------------------------
svn:mime-type = image/png
Added: portals/jetspeed-2/portal/branches/JETSPEED-2.1.3-POSTRELEASE/xdocs/tutorials/stepbystep/images/webinf-structure-psml.png
URL: http://svn.apache.org/viewvc/portals/jetspeed-2/portal/branches/JETSPEED-2.1.3-POSTRELEASE/xdocs/tutorials/stepbystep/images/webinf-structure-psml.png?rev=747185&view=auto
==============================================================================
Binary file - no diff available.
Propchange: portals/jetspeed-2/portal/branches/JETSPEED-2.1.3-POSTRELEASE/xdocs/tutorials/stepbystep/images/webinf-structure-psml.png
------------------------------------------------------------------------------
svn:mime-type = image/png
Added: portals/jetspeed-2/portal/branches/JETSPEED-2.1.3-POSTRELEASE/xdocs/usersguide/aboutuserguide.xml
URL: http://svn.apache.org/viewvc/portals/jetspeed-2/portal/branches/JETSPEED-2.1.3-POSTRELEASE/xdocs/usersguide/aboutuserguide.xml?rev=747185&view=auto
==============================================================================
--- portals/jetspeed-2/portal/branches/JETSPEED-2.1.3-POSTRELEASE/xdocs/usersguide/aboutuserguide.xml (added)
+++ portals/jetspeed-2/portal/branches/JETSPEED-2.1.3-POSTRELEASE/xdocs/usersguide/aboutuserguide.xml Mon Feb 23 22:54:40 2009
@@ -0,0 +1,90 @@
+<?xml version="1.0" encoding="ISO-8859-1"?>
+<!--
+ Licensed to the Apache Software Foundation (ASF) under one or more
+ contributor license agreements. See the NOTICE file distributed with
+ this work for additional information regarding copyright ownership.
+ The ASF licenses this file to You 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>About Jetspeed Users Guide</title>
+ <subtitle>Guide to Using Jetspeed</subtitle>
+ <authors>
+ <person name="David Sean Taylor" email="taylor@apache.org" />
+ <person name="Jody McAlister" email="jmcalister@onehippo.com" />
+ </authors>
+ </properties>
+ <body>
+ <p>
+ TODO : More details for Admin, Deployer and Developer guides.
+ </p>
+ <section name="About this guide">
+ <p>
+ This User guide is designed for people who are new to Jetspeed or as a reference for navigating
+ through the Jetspeed interface while logged in as a regular user. This guide is meant to be
+ a foundation for those who wish to continue with the Admin guide, Deployers guide and
+ Developers guide. Some concepts, such as security, may cross several guides but will be
+ structured for the Role of that particular guide.
+ </p>
+ <p>
+ After reading this guide, the user will be able to:
+ <ul>
+ <li>Create a new user</li>
+ <li>Login to Jetspeed</li>
+ <li>Request a forgotten password</li>
+ <li>Change the language used in Jetspeed</li>
+ <li>Minimize, maximize and restore portlet windows</li>
+ <li>Edit a portlet's preferences</li>
+ <li>Add, move and remove portlets</li>
+ <li>Change the decorators of Jetspeed</li>
+ <li>Change the decorators of individual portlets</li>
+ <li>Create and delete tabs</li>
+ <li>Create and delete folders</li>
+ <li>Navigate through menu's and pages</li>
+ <li>Use breadcrumbs to navigate folders</li>
+ <li>Switch between Jetpeed desktop and portal</li>
+ <li>Use Jetspeed desktop</li>
+ <li>Logout of Jetspeed</li>
+ </ul>
+ </p>
+ <subsection name="User Guide">
+ <p>
+ The User guide will not cover aspects relating to the Admin guide, Deployers guide or Developers
+ guide. The User guide will focus on introducing the user to the means to log into the portal, navigate
+ within the portal and customize the look and feel of the portal. A definitions page is included
+ for important words or concepts that will make the guide more understandable for those unfamiliar with
+ Portal's or Jetspeed.
+ </p>
+ </subsection>
+ <subsection name="Admin Guide">
+ <p>
+ The Admin guide will not cover topics addressed in the User guide. This guide will be focused on any
+ configuration and managment options that can be altered while Jetspeed is running. The administrator
+ will have full access to configuring users, groups and roles through the administrative portlets.
+ </p>
+ </subsection>
+ <subsection name="Deployers Guide">
+ <p>
+ The Deployers guide will not cover topics addressed in the User or Admin guide. This guide will address
+ Administrative and Configuration tasks that can not occur while Jetspeed is running. A section of this guide
+ will be dedicated to deploying Jetspeed on Websphere.
+ </p>
+ </subsection>
+ <subsection name="Developers Guide">
+ <p>
+ The Developers guide will not cover topics addressed in the User, Admin or Deployers guide.
+ </p>
+ </subsection>
+ </section>
+ </body>
+</document>
\ No newline at end of file
Propchange: portals/jetspeed-2/portal/branches/JETSPEED-2.1.3-POSTRELEASE/xdocs/usersguide/aboutuserguide.xml
------------------------------------------------------------------------------
svn:eol-style = native
Propchange: portals/jetspeed-2/portal/branches/JETSPEED-2.1.3-POSTRELEASE/xdocs/usersguide/aboutuserguide.xml
------------------------------------------------------------------------------
svn:keywords = Id
Added: portals/jetspeed-2/portal/branches/JETSPEED-2.1.3-POSTRELEASE/xdocs/usersguide/decorators.xml
URL: http://svn.apache.org/viewvc/portals/jetspeed-2/portal/branches/JETSPEED-2.1.3-POSTRELEASE/xdocs/usersguide/decorators.xml?rev=747185&view=auto
==============================================================================
--- portals/jetspeed-2/portal/branches/JETSPEED-2.1.3-POSTRELEASE/xdocs/usersguide/decorators.xml (added)
+++ portals/jetspeed-2/portal/branches/JETSPEED-2.1.3-POSTRELEASE/xdocs/usersguide/decorators.xml Mon Feb 23 22:54:40 2009
@@ -0,0 +1,89 @@
+<?xml version="1.0" encoding="ISO-8859-1"?>
+<!--
+ Licensed to the Apache Software Foundation (ASF) under one or more
+ contributor license agreements. See the NOTICE file distributed with
+ this work for additional information regarding copyright ownership.
+ The ASF licenses this file to You 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>Jetspeed Users Guide - Decorators</title>
+ <subtitle>Guide to Using Jetspeed</subtitle>
+ <authors>
+ <person name="David Sean Taylor" email="taylor@apache.org" />
+ <person name="Jody McAlister" email="jmcalister@onehippo.com" />
+ </authors>
+ </properties>
+ <body>
+ <section name="Decorators">
+ <ul>
+ <li>The portal design, or skins, are known in Jetspeed as decorators. With decorators, you can customize the portal experience to the branding of your organization.</li>
+ <li>There are two different types of decorators: Page Decorator and Portlet Decorator</li>
+ <ul>
+ <li>Page Decorators decorate the entire page</li>
+ <li>Portlet Decorators decorator individual portlets</li>
+ </ul>
+ </ul>
+ <subsection name="Page Decorators">
+ <ul>
+ <li>Each Jetspeed page can be associated with a different page decoration. That said, it is recommended that you set page decorations at the folder, even root folder level.</li>
+ <li>Decorations inherit.</li>
+ <li>Page decorators control important aspects of a page:</li>
+ <ul>
+ <li>The colors, images, CSS styles that skin the page.</li>
+ <li>The meta information of a page such as title.</li>
+ <li>The branding of the page, corporate images, colors.</li>
+ <li>Action buttons displayed.</li>
+ <li>Menus and navigational elements.</li>
+ </ul>
+ <p>
+ </p>
+ </ul>
+ </subsection>
+ <subsection name="Portlet Decorators">
+ <ul>
+ <li>Each Jetspeed portlet window on a page can be associated with a different portlet decoration.</li>
+ <li>Portlet decorations control some important aspect of a portlet window:</li>
+ <ul>
+ <li>The colors, images, CSS styles that skin this window.</li>
+ <li>The title portion of the portlet.</li>
+ <li>The borders of the window.</li>
+ <li>Action buttons displayed.</li>
+ </ul>
+ </ul>
+ </subsection>
+ <p>In the upper right hand corner of the Jetspeed Portal Window, you will see a Logout link followed by two icons. the first icon is the edit icon, which in this case
+ is our means to access the customization options for the entire portal window. Click on the pencil (edit) icon <img src="images/customize.png"/> and you should now see a
+ page similar to the one below.<br/>
+ <img src="images/newcustomizewindow.png"/>
+ The Page/Folder Customizer section has three options for us to configure. Theme will set the decorator for the portal window's tabs, menu and window itself. Layout will
+ allow us to change the amount of columns in our Jetspeed window. The portlet theme is a global setting for all portlets contained in the portal window. This global setting
+ can be overridden by individual portlets within the window. If you do not set the individual portlet decorators they will inherit the Portlet Theme from this section. Tigris is the default
+ decorator for a standard jetspeed installation.
+ </p>
+ <p>
+ Notice the Theme drop down menu does not require pushing a change button to make your selection become active. Once you choose an option from the dropdown menu, Jetspeed will render the window
+ with your choice.
+ </p>
+ <p>
+ Layout allows you to choose multiple column layouts or a single column for the entire window. Jetspeed will remember the locations of portlets when altering this layout. Changing the Layout to put
+ all the portlets into one column and changing back to Two Columns will return the portlets back to their original columns. Add layout will insert layout options within the window with the portlet. This allows
+ you to setup multiple columns within one column. You will also notice arrow icons and an X icon. These will be discussed in the Portlets section of Customizing but are moving and removing portlets.
+ </p>
+ <p>
+ Portlet Theme will set the decorator for all the portlets in the window. If you have set individual decorators on your portlets, this will reset all portlets in the window to the Portlet Theme you have chosen. You must
+ reset individual portlets after choosing this option if you wish them to have a different decorator.
+ </p>
+ </section>
+ </body>
+</document>
\ No newline at end of file
Propchange: portals/jetspeed-2/portal/branches/JETSPEED-2.1.3-POSTRELEASE/xdocs/usersguide/decorators.xml
------------------------------------------------------------------------------
svn:eol-style = native
Propchange: portals/jetspeed-2/portal/branches/JETSPEED-2.1.3-POSTRELEASE/xdocs/usersguide/decorators.xml
------------------------------------------------------------------------------
svn:keywords = Id
Added: portals/jetspeed-2/portal/branches/JETSPEED-2.1.3-POSTRELEASE/xdocs/usersguide/definitions.xml
URL: http://svn.apache.org/viewvc/portals/jetspeed-2/portal/branches/JETSPEED-2.1.3-POSTRELEASE/xdocs/usersguide/definitions.xml?rev=747185&view=auto
==============================================================================
--- portals/jetspeed-2/portal/branches/JETSPEED-2.1.3-POSTRELEASE/xdocs/usersguide/definitions.xml (added)
+++ portals/jetspeed-2/portal/branches/JETSPEED-2.1.3-POSTRELEASE/xdocs/usersguide/definitions.xml Mon Feb 23 22:54:40 2009
@@ -0,0 +1,101 @@
+<?xml version="1.0" encoding="ISO-8859-1"?>
+<!--
+ Licensed to the Apache Software Foundation (ASF) under one or more
+ contributor license agreements. See the NOTICE file distributed with
+ this work for additional information regarding copyright ownership.
+ The ASF licenses this file to You 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>Jetspeed Users Guide Definitions</title>
+ <subtitle>Guide to Using Jetspeed</subtitle>
+ <authors>
+ <person name="David Sean Taylor" email="taylor@apache.org" />
+ <person name="Jody McAlister" email="jmcalister@onehippo.com" />
+ </authors>
+ </properties>
+ <body>
+ <section name="Definitions">
+ <p>
+ Definitions and concepts mentioned in User Guide are listed here for reference.
+ </p>
+ <subsection name="Decorator">
+ <p>
+ The portal design, or skins, are known in Jetspeed as decorators. They can also be referred to as Themes.<br/>
+ <img src="images/decoratordiagram.png"/>
+ </p>
+ </subsection>
+ <subsection name="Portal">
+ <p>
+ "A portal is a web based application that
+ commonly-provides personalization, single
+ sign on, content aggregation from different
+ sources and hosts the presentation layer of
+ Information Systems. Aggregation is the action
+ of integrating content from different
+ sources within a web page. A portal may have
+ sophisticated personalization features to
+ provide customized content to users. Portal
+ pages may have different set of portlets
+ creating content for different users." JSR-168:PLT.2.1
+ </p>
+ <p>
+ A portal based on Jetspeed can make applications, database information
+ and other data sources available to end-users through a single web site.
+ Jetspeed provides a security infrastructure so that the information and
+ functions made available to each user can be customized on basis of the
+ user or a role that the user has. The user can access the portal via a
+ web browser, WAP-phone, pager or any other device supported by the
+ servlet engine.
+ </p>
+ </subsection>
+ <subsection name="Portlet">
+ <p>
+ "A portlet is a Java technology based web component, managed by a
+ portlet container, that processes requests and generates dynamic content.
+ Portlets are used by portals as pluggable user interface components that
+ provide a presentation layer to Information Systems." JSR-168:PLT.2.2
+ </p>
+ </subsection>
+ <subsection name="Portlet Window Diagram">
+ <p>
+ <img src="images/portletwindowdiagram.png"/>
+ </p>
+ </subsection>
+ <subsection name="Roles">
+ <p>
+ Roles are the persona users can take on when interacting with the system. This allows
+ the system to define behaviors by role, not by individual users.
+ </p>
+ </subsection>
+ <subsection name="Tiled Window">
+ <p>
+ A tiled window in Jetspeed is a window that does not overlap any other windows.
+ </p>
+ </subsection>
+ A tiled window in Jetspeed is a window that does not overlap any other windows
+ <subsection name="Window States">
+ <p>
+ Window States indicate the amount of the portal page
+ space that will be assigned to the generated
+ content of a portlet.
+ <ul>
+ <li>Normal - indicates the portlet may be sharing the rendering of the page.</li>
+ <li>Minimized - the portlet should only render minimal or no output at all.</li>
+ <li>Maximized - indicates the portlet that the portlet may be the only portlet being rendered. A portlet may generate richer content in this state.</li>
+ </ul>
+ </p>
+ </subsection>
+ </section>
+ </body>
+</document>
\ No newline at end of file
Propchange: portals/jetspeed-2/portal/branches/JETSPEED-2.1.3-POSTRELEASE/xdocs/usersguide/definitions.xml
------------------------------------------------------------------------------
svn:eol-style = native
Propchange: portals/jetspeed-2/portal/branches/JETSPEED-2.1.3-POSTRELEASE/xdocs/usersguide/definitions.xml
------------------------------------------------------------------------------
svn:keywords = Id
Added: portals/jetspeed-2/portal/branches/JETSPEED-2.1.3-POSTRELEASE/xdocs/usersguide/desktop.xml
URL: http://svn.apache.org/viewvc/portals/jetspeed-2/portal/branches/JETSPEED-2.1.3-POSTRELEASE/xdocs/usersguide/desktop.xml?rev=747185&view=auto
==============================================================================
--- portals/jetspeed-2/portal/branches/JETSPEED-2.1.3-POSTRELEASE/xdocs/usersguide/desktop.xml (added)
+++ portals/jetspeed-2/portal/branches/JETSPEED-2.1.3-POSTRELEASE/xdocs/usersguide/desktop.xml Mon Feb 23 22:54:40 2009
@@ -0,0 +1,76 @@
+<?xml version="1.0" encoding="ISO-8859-1"?>
+<!--
+ Licensed to the Apache Software Foundation (ASF) under one or more
+ contributor license agreements. See the NOTICE file distributed with
+ this work for additional information regarding copyright ownership.
+ The ASF licenses this file to You 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>Jetspeed Users Guide</title>
+ <subtitle>Guide to Using Jetspeed</subtitle>
+ <authors>
+ <person name="David Sean Taylor" email="taylor@apache.org" />
+ <person name="Jody McAlister" email="jmcalister@onehippo.com" />
+ </authors>
+ </properties>
+ <body>
+ <section name="Desktop">
+ <p>
+ Jetspeed Desktop and Jetspeed Portal run concurrently when Jetspeed has been started. Switching back and forth between the two is
+ as easy as changing the URL in your web browser. Our example has been using http://localhost:8080/jetspeed/portal as the url for access to the portal.
+ Change the url to http://localhost:8080/jetspeed/desktop and hit enter. You will now be in Jetspeed Desktop and currently logged in if
+ you were logged in before changing the url.
+ </p>
+ <p>
+ Jetspeed desktop uses Web 2.0 technology. Unlike Jetspeed portal, updates to the screen only occur where required. Jetspeed
+ portal must render the entire screen when changes are made to any portlet.
+ </p>
+ <p>
+ Updating portions of the screen are not the only differences between the two. Users can drag and drop portlets to a new location without entering edit mode.
+ Click and hold the mouse button on the title bar of any portlet to have the ability to move the portlet anywhere in allowable areas for portlets.
+ The portlets will adjust automatically as you move them.
+ </p>
+ <p>
+ A new icon is now next to the minimize and maximize options. This custom icon has the edit and help buttons included, as well as other
+ options. View, which is the normal portlet mode is now an option when you are in help and edit modes. Several options are available through this icon:
+ <ul>
+ <li>Portlet preferences</li>
+ <li>Tiling and untiling of portlet windows</li>
+ <li>Height options of variable and fit in window</li>
+ <li>Help</li>
+ </ul>
+ </p>
+ <p>
+ Portlet preferences are available through the edit option as they were in Jetspeed Portal.
+ </p>
+ <p>
+ A tiled window in Jetspeed is a window that does not overlap any other windows. Tiling the portlet will move the portlet window into the layout structure with the other portlets, the default option. Untiling the portlet will move the
+ portlet to the front, or on top, of the other portlets. Clicking and holding the mouse on the title bar will allow you to place the portlet anywhere within your browser window
+ without restrictions.
+ </p>
+ <p>
+ Depending on the height of the window, whether it has been modified or not, you will have the option of Fit Content or Variable under the height option. Fit Content
+ will resize the portlet around all data within that portlet window. Variable, the default option, gives you a scrollable window if the content exceeds the current window size.
+ You may also adjust the height of the portlet while in Fit Content mode or Variable mode using the resize arrow located at the bottom right of the portlet window.
+ </p>
+ <p>
+ Adding Portlets no longer require you enter edit mode of the portal window. A plus icon now appears standard in the portal window and will
+ bring you directly to the Portlet Selector. Clicking on the arrow or [GoBack] will bring you back to the normal Portal Window
+ </p>
+ <p>
+ The help page is available through the help option as it was in Jetspeed Portal.
+ </p>
+ </section>
+ </body>
+</document>
\ No newline at end of file
Propchange: portals/jetspeed-2/portal/branches/JETSPEED-2.1.3-POSTRELEASE/xdocs/usersguide/desktop.xml
------------------------------------------------------------------------------
svn:eol-style = native
Propchange: portals/jetspeed-2/portal/branches/JETSPEED-2.1.3-POSTRELEASE/xdocs/usersguide/desktop.xml
------------------------------------------------------------------------------
svn:keywords = Id
---------------------------------------------------------------------
To unsubscribe, e-mail: jetspeed-dev-unsubscribe@portals.apache.org
For additional commands, e-mail: jetspeed-dev-help@portals.apache.org