Modified: portals/site-live/pluto/v101/userguide/portal.html URL: http://svn.apache.org/viewvc/portals/site-live/pluto/v101/userguide/portal.html?rev=1858149&r1=1858148&r2=1858149&view=diff ============================================================================== --- portals/site-live/pluto/v101/userguide/portal.html (original) +++ portals/site-live/pluto/v101/userguide/portal.html Thu Apr 25 17:29:43 2019 @@ -1,270 +1,144 @@ -<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd";> - - - - - - - - - - - -<html xmlns="http://www.w3.org/1999/xhtml";> - <head> - <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /> - <title>Pluto - User Guide: Pluto Portal Driver</title> - <style type="text/css" media="all"> - @import url("../../css/maven-base.css"); - @import url("../../css/maven-theme.css"); - @import url("../../css/site.css"); - </style> - <link rel="stylesheet" href="../../css/print.css" type="text/css" media="print" /> - </head> - <body class="composite"> - <div id="banner"> - <a href="http://portals.apache.org/pluto/"; id="bannerLeft"> - - <img src="http://portals.apache.org/pluto/images/apache-portals.gif"; alt="" /> - - </a> - <span id="bannerRight"> - - <img src="http://portals.apache.org/pluto/images/banner.png"; alt="" /> - - </span> - <div class="clear"> - <hr/> - </div> - </div> - <div id="breadcrumbs"> - - - - - - - - - <div class="xleft"> - Last Published: 2018-06-22 - | - <a href="http://portals.apache.org/pluto"; class="externalLink">Home</a> - </div> - <div class="xright"> <a href="../../portlet-3.0-apidocs/index.html">Portlet 3.0 API</a> - | - <a href="../../portlet-2.0-apidocs/index.html">Portlet 2.0 API</a> - | - <a href="../../portlet-1.0-apidocs/index.html">Portlet 1.0 API</a> - | - <a href="http://jcp.org/en/jsr/detail?id=362"; class="externalLink">JSR 362 JCP Page</a> - | - <a href="http://jcp.org/en/jsr/detail?id=286"; class="externalLink">JSR 286 JCP Page</a> - | - <a href="http://jcp.org/en/jsr/detail?id=168"; class="externalLink">JSR 168 JCP Page</a> - - - - - - - - - </div> - <div class="clear"> - <hr/> - </div> - </div> - <div id="leftColumn"> - <div id="navcolumn"> - - - - - - - - - <h5>The Pluto Project</h5> - <ul> - - <li class="none"> - <a href="../../index.html">About Pluto</a> - </li> - - <li class="none"> - <a href="../../mission.html">Mission</a> - </li> - - <li class="none"> - <a href="../../download.html">Download</a> - </li> - - <li class="none"> - <a href="../../news.html">News</a> - </li> - - <li class="none"> - <a href="../../security.html">Security</a> - </li> - - <li class="none"> - <a href="../../status.html">Status</a> - </li> - - <li class="none"> - <a href="../../architecture.html">Architecture</a> - </li> - - <li class="none"> - <a href="../../resources.html">Resources</a> - </li> - - <li class="none"> - <a href="../../faq.html">FAQ</a> - </li> - - <li class="none"> - <a href="http://wiki.apache.org/portals/Pluto"; class="externalLink">Wiki</a> - </li> - - <li class="none"> - <a href="https://issues.apache.org/jira/browse/PLUTO"; class="externalLink">Issue Tracker (JIRA)</a> - </li> - - <li class="none"> - <a href="../../helping.html">Get Involved</a> - </li> - </ul> - <h5>Pluto 3.0</h5> - <ul> - - <li class="none"> - <a href="../../v301/getting-started.html">Getting Started</a> - </li> - - <li class="none"> - <a href="../../v301/deploying.html">Deploying Portlets</a> - </li> - - <li class="none"> - <a href="../../v301/portlet-api.html">Portlet Concepts</a> - </li> - - <li class="none"> - <a href="../../v301/v3Features.html">Version 3 Features</a> - </li> - - <li class="none"> - <a href="../../v301/tck.html">Using the TCK</a> - </li> - - <li class="none"> - <a href="../../v301/release-notes.html">Release Notes</a> - </li> - </ul> - <h5>Pluto 2.0</h5> - <ul> - - <li class="none"> - <a href="../../v20/getting-started.html">Getting Started</a> - </li> - - <li class="none"> - <a href="../../v20/deploying.html">Deploying</a> - </li> - - <li class="none"> - <a href="../../v20/embedding.html">Embedding</a> - </li> - - <li class="none"> - <a href="../../v20/release-notes.html">Release Notes</a> - </li> - - <li class="none"> - <a href="../../v20/app-servers.html">App Servers</a> - </li> - - <li class="none"> - <a href="../../v20/powered.html">Powered By Pluto</a> - </li> - </ul> - <h5>Pluto 1.1</h5> - <ul> - - <li class="none"> - <a href="../../v11/getting-started.html">Getting Started</a> - </li> - - <li class="none"> - <a href="../../v11/deploying.html">Deploying</a> - </li> - - <li class="none"> - <a href="../../v11/release-notes.html">Release Notes</a> - </li> - </ul> - <h5>Subprojects</h5> - <ul> - - <li class="none"> - <a href="../../subprojects/subprojects.html">Overview</a> - </li> - </ul> - <h5>Project Info</h5> - <ul> - - <li class="none"> - <a href="../../project-summary.html">Project Summary</a> - </li> - - <li class="none"> - <a href="../../team-list.html">Project Team</a> - </li> - - <li class="none"> - <a href="../../license.html">Project License</a> - </li> - - <li class="none"> - <a href="../../mail-lists.html">Mailing Lists</a> - </li> - - <li class="none"> - <a href="../../source-repository.html">Source Repository</a> - </li> - - <li class="none"> - <a href="../../issue-tracking.html">Issue Tracking</a> - </li> - </ul> - <a href="http://maven.apache.org/"; title="Built by Maven" class="poweredBy"> - <img alt="Built by Maven" src="../../images/logos/maven-feather.png"></img> - </a> - - - - - - - - - </div> - </div> - <div id="bodyColumn"> - <div id="contentBox"> - <div class="section"><h2><a name="User_Guide:_Pluto_1.0.1_Portal_Driver"></a>User Guide: Pluto 1.0.1 Portal Driver</h2> -<p><ul><li><A href="#Limitations">Limitations</A></li> -<li><A href="#Configuration">Configuration</A></li> -<li><A href="#Defining_the_Portal_Layout">Defining the Portal Layout</A></li> -<li><A href="#Advanced_Customization">Advanced Customization</A></li> -<li><A href="#Internationalization">Internationalization</A></li> -<li><A href="#Further_Information">Further Information</A></li> -</ul> -</p> +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd";> +<!-- Generated by Apache Maven Doxia Site Renderer 1.8.1 from src/site/xdoc/v101/userguide/portal.xml at 2019-04-25 --> +<html xmlns="http://www.w3.org/1999/xhtml"; xml:lang="en" lang="en"> + <head> + <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /> + <title>Pluto – User Guide: Pluto Portal Driver</title> + <style type="text/css" media="all"> + @import url("../../css/maven-base.css"); + @import url("../../css/maven-theme.css"); + @import url("../../css/site.css"); + </style> + <link rel="stylesheet" href="../../css/print.css" type="text/css" media="print" /> + <meta http-equiv="Content-Language" content="en" /> + + </head> + <body class="composite"> + <div id="banner"> +<a href="http://portals.apache.org/pluto/"; id="bannerLeft"><img src="http://portals.apache.org/pluto/images/apache-portals.gif"; alt="Pluto"/></a> +<div id="bannerRight"> +<img src="http://portals.apache.org/pluto/images/banner.png"; alt=""/></div> + <div class="clear"> + <hr/> + </div> + </div> + <div id="breadcrumbs"> + <div class="xleft"> + <span id="publishDate">Last Published: 2019-04-25</span> + | <a href="http://portals.apache.org/pluto"; class="externalLink" title="Home">Home</a> > +User Guide: Pluto Portal Driver + </div> + <div class="xright"><a href="../../portlet-3.0-apidocs/index.html" title="Portlet 3.0 API">Portlet 3.0 API</a> | +<a href="../../portlet-2.0-apidocs/index.html" title="Portlet 2.0 API">Portlet 2.0 API</a> | +<a href="../../portlet-1.0-apidocs/index.html" title="Portlet 1.0 API">Portlet 1.0 API</a> | +<a href="http://jcp.org/en/jsr/detail?id=362"; class="externalLink" title="JSR 362 JCP Page">JSR 362 JCP Page</a> | +<a href="http://jcp.org/en/jsr/detail?id=286"; class="externalLink" title="JSR 286 JCP Page">JSR 286 JCP Page</a> | +<a href="http://jcp.org/en/jsr/detail?id=168"; class="externalLink" title="JSR 168 JCP Page">JSR 168 JCP Page</a> </div> + <div class="clear"> + <hr/> + </div> + </div> + <div id="leftColumn"> + <div id="navcolumn"> + <h5>The Pluto Project</h5> + <ul> + <li class="none"><a href="../../index.html" title="About Pluto">About Pluto</a></li> + <li class="none"><a href="../../mission.html" title="Mission">Mission</a></li> + <li class="none"><a href="../../download.html" title="Download">Download</a></li> + <li class="none"><a href="../../news.html" title="News">News</a></li> + <li class="none"><a href="../../security.html" title="Security">Security</a></li> + <li class="none"><a href="../../status.html" title="Status">Status</a></li> + <li class="none"><a href="../../architecture.html" title="Architecture">Architecture</a></li> + <li class="none"><a href="../../resources.html" title="Resources">Resources</a></li> + <li class="none"><a href="../../faq.html" title="FAQ">FAQ</a></li> + <li class="none"><a href="http://wiki.apache.org/portals/Pluto"; class="externalLink" title="Wiki">Wiki</a></li> + <li class="none"><a href="https://issues.apache.org/jira/browse/PLUTO"; class="externalLink" title="Issue Tracker (JIRA)">Issue Tracker (JIRA)</a></li> + <li class="none"><a href="../../helping.html" title="Get Involved">Get Involved</a></li> + </ul> + <h5>Pluto 3.1</h5> + <ul> + <li class="none"><a href="../../v310/mvcbean-portlets.html" title="MVCBean Portlets">MVCBean Portlets</a></li> + <li class="none"><a href="../../v310/getting-started.html" title="Getting Started">Getting Started</a></li> + <li class="none"><a href="../../v310/maven-archetypes.html" title="Maven Archetypes">Maven Archetypes</a></li> + <li class="none"><a href="../../v310/deploying.html" title="Deploying Portlets">Deploying Portlets</a></li> + <li class="none"><a href="../../v310/portlet-api.html" title="Portlet Concepts">Portlet Concepts</a></li> + <li class="none"><a href="../../v310/v3Features.html" title="Version 3 Features">Version 3 Features</a></li> + <li class="none"><a href="../../v310/tck.html" title="Using the TCK">Using the TCK</a></li> + <li class="none"><a href="../../v310/release-notes.html" title="Release Notes">Release Notes</a></li> + </ul> + <h5>Pluto 3.0</h5> + <ul> + <li class="none"><a href="../../v301/getting-started.html" title="Getting Started">Getting Started</a></li> + <li class="none"><a href="../../v301/deploying.html" title="Deploying Portlets">Deploying Portlets</a></li> + <li class="none"><a href="../../v301/portlet-api.html" title="Portlet Concepts">Portlet Concepts</a></li> + <li class="none"><a href="../../v301/v3Features.html" title="Version 3 Features">Version 3 Features</a></li> + <li class="none"><a href="../../v301/tck.html" title="Using the TCK">Using the TCK</a></li> + <li class="none"><a href="../../v301/release-notes.html" title="Release Notes">Release Notes</a></li> + </ul> + <h5>Pluto 2.0</h5> + <ul> + <li class="none"><a href="../../v20/getting-started.html" title="Getting Started">Getting Started</a></li> + <li class="none"><a href="../../v20/deploying.html" title="Deploying">Deploying</a></li> + <li class="none"><a href="../../v20/embedding.html" title="Embedding">Embedding</a></li> + <li class="none"><a href="../../v20/release-notes.html" title="Release Notes">Release Notes</a></li> + <li class="none"><a href="../../v20/app-servers.html" title="App Servers">App Servers</a></li> + <li class="none"><a href="../../v20/powered.html" title="Powered By Pluto">Powered By Pluto</a></li> + </ul> + <h5>Pluto 1.1</h5> + <ul> + <li class="none"><a href="../../v11/getting-started.html" title="Getting Started">Getting Started</a></li> + <li class="none"><a href="../../v11/deploying.html" title="Deploying">Deploying</a></li> + <li class="none"><a href="../../v11/release-notes.html" title="Release Notes">Release Notes</a></li> + </ul> + <h5>Subprojects</h5> + <ul> + <li class="none"><a href="../../subprojects/subprojects.html" title="Overview">Overview</a></li> + </ul> + <h5>Project Info</h5> + <ul> + <li class="none"><a href="../../project-summary.html" title="Project Summary">Project Summary</a></li> + <li class="none"><a href="../../team-list.html" title="Project Team">Project Team</a></li> + <li class="none"><a href="../../license.html" title="Project License">Project License</a></li> + <li class="none"><a href="../../mail-lists.html" title="Mailing Lists">Mailing Lists</a></li> + <li class="none"><a href="../../source-repository.html" title="Source Repository">Source Repository</a></li> + <li class="none"><a href="../../issue-tracking.html" title="Issue Tracking">Issue Tracking</a></li> + </ul> + <a href="http://maven.apache.org/"; title="Built by Maven" class="poweredBy"> + <img class="poweredBy" alt="Built by Maven" src="../../images/logos/maven-feather.png" /> + </a> + </div> + </div> + <div id="bodyColumn"> + <div id="contentBox"> + + +<div class="section"> +<h2><a name="User_Guide:_Pluto_1.0.1_Portal_Driver"></a>User Guide: Pluto 1.0.1 Portal Driver</h2> + +<p> + </p> +<ul> + +<li>Limitations</li> + +<li>Configuration</li> + +<li>Defining the Portal Layout</li> + +<li>Advanced Customization</li> + +<li>Internationalization</li> + +<li>Further Information</li> + </ul> + </div> -<div class="section"><h2><a name="Limitations"></a>Limitations</h2> + + + +<div class="section"> +<h2><a name="Limitations"></a>Limitations</h2> + <p> The Pluto Portal is intended to provide an example implementation of how to integrate Pluto into a portal. Additionally, it may be used for @@ -272,134 +146,232 @@ flexibility a true portal supplies. The portal is not designed for maximum performance, but rather simplicity. </p> + + <p> To learn how to embed Pluto in your own portal, see the "<a href="../developer/integrate.html">Integration Guide</a>" document.</p> </div> -<div class="section"><h2><a name="Configuration"></a>Configuration</h2> -<div class="section"><h3><a name="Default_Configuration"></a>Default Configuration</h3> + + +<div class="section"> +<h2><a name="Configuration"></a>Configuration</h2> + +<div class="section"> +<h3><a name="Default_Configuration"></a>Default Configuration</h3> + <p> Upon installation of the binary distribution of Pluto 1.0.1, the portal - driver is made available at <code>http://localhost:8080/pluto/portal</code>. + driver is made available at <tt>http://localhost:8080/pluto/portal</tt>. The default installation is configured with a portal page which contains two instances of the testsuite portlet and an administration. portlet for installing custom portlets and viewing the repositories. This configuration is also the default for installations completed from the source distribution (or Subversion repository) and deployed using the Pluto deploy tool. </p> -<p><table class="bodyTable"><caption><B>Default Configuration for Binary Distributions:</B></caption><tr class="a"><th>Configuration</th> + +<p> + </p><caption>Default Configuration for Binary Distributions:</caption> +<table border="0" class="bodyTable"> + + +<tr class="a"> +<th>Configuration</th> + <th>Platform</th> + <th>Value</th> -<th>Description</th> -</tr> -<tr class="b"><td>Installation Directory</td> +<th>Description</th></tr> + +<tr class="b"> +<td>Installation Directory</td> + <td>All</td> + <td><PLUTO_HOME></td> -<td>The directory to which you unarchived the distribution</td> -</tr> -<tr class="a"><td>Startup Scripts</td> + +<td>The directory to which you unarchived the distribution</td></tr> + +<tr class="a"> +<td>Startup Scripts</td> + <td>*nix</td> + <td><PLUTO_HOME>/bin/startup.sh</td> -<td>The script used to startup the portal driver</td> -</tr> -<tr class="b"><td>Startup Scripts</td> + +<td>The script used to startup the portal driver</td></tr> + +<tr class="b"> +<td>Startup Scripts</td> + <td>Windows</td> + <td><PLUTO_HOME>/bin/startup.bat</td> -<td>The script used to startup the portal driver</td> -</tr> -<tr class="a"><td>Context Configuration</td> + +<td>The script used to startup the portal driver</td></tr> + +<tr class="a"> +<td>Context Configuration</td> + <td>All</td> + <td><PLUTO_HOME>/conf/Catalina/localhost/pluto.xml</td> -<td>The Tomcat Context Configuration file</td> -</tr> -</table> -</p> -<p><table class="bodyTable"><caption><B>Default Configuration for Source Distributions:</B></caption><tr class="b"><th>Configuration</th> + +<td>The Tomcat Context Configuration file</td></tr> + </table> + + + +<p> + </p><caption>Default Configuration for Source Distributions:</caption> +<table border="0" class="bodyTable"> + + +<tr class="a"> +<th>Configuration</th> + <th>Platform</th> + <th>Value</th> -<th>Description</th> -</tr> -<tr class="a"><td>Installation Directory</td> +<th>Description</th></tr> + +<tr class="b"> +<td>Installation Directory</td> + <td>All</td> + <td>${maven.tomcat.home}</td> -<td>The tomcat installation directory to which pluto has been installed</td> -</tr> -<tr class="b"><td>Startup Scipts</td> + +<td>The tomcat installation directory to which pluto has been installed</td></tr> + +<tr class="a"> +<td>Startup Scipts</td> + <td>*nix</td> + <td>${maven.tomcat.home}/bin/startup.sh</td> -<td>The script used to startup the portal driver</td> -</tr> -<tr class="a"><td>Startup Scipts</td> + +<td>The script used to startup the portal driver</td></tr> + +<tr class="b"> +<td>Startup Scipts</td> + <td>Windows</td> + <td>${maven.tomcat.home}/bin/startup.bat</td> -<td>The script used to startup the portal driver</td> -</tr> -<tr class="b"><td>Context Configuration</td> + +<td>The script used to startup the portal driver</td></tr> + +<tr class="a"> +<td>Context Configuration</td> + <td>Tomcat 5.5</td> + <td>${maven.tomcat.home}/conf/Catalina/localhost/pluto.xml</td> -<td>The Tomcat Context Configuration file</td> -</tr> -</table> -</p> + +<td>The Tomcat Context Configuration file</td></tr> + </table> + + + <p>When the Pluto Portal is first installed, it is made available at the address http://localhost:8080/pluto/portal/.</p> + + <p>This location can be customized, using standard Tomcat functionality. To modify the <i>pluto</i> part of the location, alter the path mapping in pluto's context configuration file <i>pluto.xml</i></p> + + <p>Under Tomcat 5.5, pluto.xml will be located in the ${TOMCAT_HOME}/conf/Catalina/ directory. </p> + + <p>In order to modify the context Pluto is running under, modify the <i>path</i> attribute:</p> -<p><b>Before:</b><div class="source"><pre> + +<p> + <b>Before:</b> + </p> +<div class="source"> +<pre> <Context path="/pluto" docBase="pluto" crossContext="true"> </Context> - </pre> -</div> -</p> -<p><b>After:</b><div class="source"><pre> + </pre></div> + + +<p><b>After:</b> + </p> +<div class="source"> +<pre> <Context path="/newlocation" docBase="pluto" crossContext="true"> </Context> - </pre> -</div> -</p> + </pre></div> + + + <p>You might also need to modify host.name and portletcontainer.uniquename in ${TOMCAT_HOME}/webapps/pluto/WEB-INF/config/services/ConfigService.properties. </p> + + <p>After this modification (and restarting Tomcat), the Pluto Portal will be available at the address http://servername/newlocation/portal/. Further information on customizing the context configuration is available for <a class="externalLink" href="http://jakarta.apache.org/tomcat/tomcat-5.5-doc/config/context.html";>Tomcat 5.5</a>. </p> + + <p>To modify the <i>portal</i> part of the location, alter the <i>url-pattern</i> for the <i>pluto</i> servlet. This mapping can be found in the <i>web.xml</i> configuration file for the Pluto web application.</p> -<p><b>Before:</b><div class="source"><pre> + +<p> + <b>Before:</b> + </p> +<div class="source"> +<pre> <servlet-mapping> <servlet-name>pluto</servlet-name> <url-pattern>/portal/*</url-pattern> </servlet-mapping> - </pre> -</div> -</p> -<p><b>After:</b><div class="source"><pre> + </pre></div> + + +<p> + <b>After:</b> + </p> +<div class="source"> +<pre> <servlet-mapping> <servlet-name>pluto</servlet-name> <url-pattern>/app/*</url-pattern> </servlet-mapping> - </pre> -</div> -</p> + </pre></div> + + + <p>You will also need to modify servlet.insecure in ${TOMCAT_HOME}/webapps/pluto/WEB-INF/config/services/ConfigService.properties. </p> + + <p>After these modifications (and restarting Tomcat), the Pluto Portal will be available at the address http://servername/newlocation/app/ (assuming that the previous modification was also applied). </p> -</div> -<div class="section"><h3><a name="Registering_Portlets_for_use"></a>Registering Portlets for use</h3> + </div> + + +<div class="section"> +<h3><a name="Registering_Portlets_for_use"></a>Registering Portlets for use</h3> + <p>In order to use a Portlet in the Pluto Portal it needs to be registered. The Pluto Portal keeps page registrations in a file named <i>portletentityregistry.xml</i> in the directory ${TOMCAT_HOME}/webapps/pluto/data.</p> + + <p>By default, this file looks like this: - <div class="source"><pre> + </p> +<div class="source"> +<pre> <?xml version="1.0" encoding="UTF-8"?> <portlet-entity-registry> <application id="3"> @@ -425,20 +397,28 @@ </portlet> </application> </portlet-entity-registry> - </pre> -</div> -</p> + </pre></div> + + <p>Each <application> tag defines one application (corresponding to one web-app on the portal container), which can contain multiple <portlet> tags. The "id" attribute in this tag identifies the application, and it does not need to be numeric.</p> + + <p>The <definition-id> tag within the <application> refers to the name of the web-app that contains the portlets in this application.</p> + + <p>Each <portlet> tag defines one portlet. The "id" attribute in this tag identifies the portlet. Note that the application id concatenated with the portlet id will be mapped to the "value" attribute in the <proprety> tag in pageregistry.xml (which is explained later).</p> + + <p>Each <preferences> tag within the <portlet> tag defines name/value pairs for the PorletPreferences.</p> + + <p>In the example above two Portlet applications are made available to the portal with the ids of "3" and "4". Both happen to point to the same webapp (<tt><definition-id>testsuite</definition-id></tt>). Both applications define a single Portlet each. Application id 3 uses the Portlet <i>TestPortlet1</i> @@ -447,6 +427,8 @@ Note that prefixing the name of the Portlet with the name of web application (<i><b>testsuite</b>.TestPortlet1</i>) is required. </p> + + <p> Since Pluto 1.0.1-rc2, another configuration file, portletcontexts.txt, has been included in the Pluto portal. The Portlet Contexts file ($PLUTO_HOME/WEB-INF/data/portletcontexts.txt) @@ -457,18 +439,28 @@ $TOMCAT_HOME/conf/Catalina/localhost (or another 'conf' subdirectory). </p> + + <p>The Portlets themselves are defined in the portlet.xml configuration file within the testsuite web application. In that file there are two Portlets defined, <i>TestPortlet1</i> and <i>TestPortlet2</i>, both of which point to the same portlet class (<tt>org.apache.pluto.portalImpl.portlet.TestPortlet</tt>). See the javax.portlet specification (JSR-168) for futher details on using the portlet.xml file. </p> -</div> -<div class="section"><h3><a name="Defining_the_Portal_Layout"></a>Defining the Portal Layout</h3> + </div> + + +<div class="section"> +<h3><a name="Defining_the_Portal_Layout"></a>Defining the Portal Layout</h3> + <p>Once the Portlets available have been defined the Portal layout needs to be defined. In the Pluto Portal the file <i>pageregistry.xml</i> in the directory ${TOMCAT_HOME}/webapps/pluto/data defines this layout.</p> + + <p>When Pluto is first installed, pageregistry.xml looks like this: - <div class="source"><pre> + </p> +<div class="source"> +<pre> <?xml version="1.0"?> <portal> <fragment name="navigation" class="org.apache.pluto.portalImpl.aggregation.navigation.TabNavigation"> @@ -494,28 +486,48 @@ </fragment> </fragment> </portal> - </pre> -</div> -</p> + </pre></div> + + + <p>This configuration results in the Portal being displayed (from the url http://servername/pluto/portal/test/) as Figure 1 shows.</p> -<div align="center"><p><a href="../../images/v101/default_portal_layout.jpg"><img src="../../images/v101/default_portal_layout.jpg" alt="Default Portal Layout" /></a></p> -<p><i><b><font size="-1">Figure 1. Default Portal Layout. Click on the picture to enlarge it</font></b></i></p> -</div><p>Working from the top of pageregistry.xml down, the first important section we come to is: - <div class="source"><pre> + + +<div align="center"> + +<p> + <a href="../../images/v101/default_portal_layout.jpg"> + <img src="../../images/v101/default_portal_layout.jpg" alt="Default Portal Layout" width="500" /></a> + </p> + +<p> + <i><b><font size="-1">Figure 1. Default Portal Layout. Click on the picture to enlarge it</font></b></i> + </p> + </div> + + +<p>Working from the top of pageregistry.xml down, the first important section we come to is: + </p> +<div class="source"> +<pre> <fragment name="navigation" class="org.apache.pluto.portalImpl.aggregation.navigation.TabNavigation"> </fragment> - </pre> -</div> -</p> + </pre></div> + + <p>This section tells the Portal to add a navigation menu to the user interface. Each fragment of type <i>page</i> will be displayed in the navigation menu, provided the fragment has a <navigation> sub-element. Removing the <tt><fragment name="navigation" ...></fragment></tt> section will result in no navigation menu being displayed. </p> + + <p> The next section is: - <div class="source"><pre> + </p> +<div class="source"> +<pre> <fragment name="test" type="page"> <navigation> <title>Test</title> @@ -524,22 +536,27 @@ ... ... </fragment> - </pre> -</div> -</p> + </pre></div> + + <p> This section defines a Portal "page", which is simply a container for one or more Portlets. The <i>name</i> attribute must be unique within the pageregistry.xml file (if this constraint is not met an error message <i>Fragment with this name <duplicated name> already exists in the pageregistry.xml.</i> will be written to your log and your Pluto web application will fail to load). </p> + <p> The navigation subsection is used by the navigation menu (discussed previously). The <title>...</title> defines the label that will be shown in the navigation menu. The <description>...</description>element is not used. </p> + + <p>Inside the <tt><fragment type="page" .... ></fragment></tt> elements we find - <div class="source"><pre> + </p> +<div class="source"> +<pre> <fragment name="row" type="row"> <fragment name="col1" type="column"> @@ -552,15 +569,18 @@ </fragment> </fragment> - </pre> -</div> -</p> + </pre></div> + + <p>This defines the layout of the Portal "page". In this case two Portlets will be laid out in two columns, nested inside a single row. </p> + <p>The configuration below will give the page a layout of two rows, with a Portlet in each. Note that the names of all fragments need to be unique. - <div class="source"><pre> + </p> +<div class="source"> +<pre> <fragment name="row1" type="row"> <fragment name="col1" type="column"> <fragment name="p1" type="portlet"> @@ -575,97 +595,118 @@ </fragment> </fragment> </fragment> - </pre> -</div> -</p> + </pre></div> + + <p>The section - <div class="source"><pre> + </p> +<div class="source"> +<pre> <fragment name="p1" type="portlet"> <property name="portlet" value="3.1"/> </fragment> - </pre> -</div> -</p> + </pre></div> + + <p>defines which portlet to display. <tt><property name="portlet" value="3.1"/></tt> tells the Portal to lookup the Portlet "3.1" and display it in this location. The value "3.1" means refers to the ids given in <i>portletentityregistry.xml</i> (discussed previously). In this case, it mean application id "3", portlet id "1". </p> -</div> -</div> -<div class="section"><h2><a name="Advanced_Customization"></a>Advanced Customization</h2> -<div class="section"><h3><a name="JSP_Templates"></a>JSP Templates</h3> + </div> + </div> + + +<div class="section"> +<h2><a name="Advanced_Customization"></a>Advanced Customization</h2> + +<div class="section"> +<h3><a name="JSP_Templates"></a>JSP Templates</h3> + <p>It is possible to customize the JSP templates Pluto uses. This is beyond the scope of this document, but a brief outline follows to get you started.</p> + + <p>By default, Pluto uses JSP templates from the directory ${TOMCAT_HOME}/webapps/pluto/WEB-INF/aggregation directory. This can be overridden by adding a line like - <div class="source"><pre> + </p> +<div class="source"> +<pre> aggregation.base.dir=/WEB-INF/templates/ - </pre> -</div> - + </pre></div> to the file ${TOMCAT_HOME}/webapps/pluto/WEB-INF/config/services/ConfigService.properties. - </p> + + <p>The following JSP files are used by the Portal: - <ul><li>Banner.jsp - The blue title bar which says "Pluto - Reference Implementation". Only called from RootFragment.jsp</li> + </p> +<ul> + +<li>Banner.jsp - The blue title bar which says "Pluto - Reference Implementation". Only called from RootFragment.jsp</li> + <li>ColumnFragment.jsp - Called for each column fragment.</li> + <li>Head.jsp - The HTML header. Only called from RootFragment.jsp</li> + <li>PageFragment.jsp - Called for each Portal page displayed.</li> + <li>PortletFragmentFooter.jsp - The footer of each Portlet.</li> + <li>PortletFragmentHeader.jsp - The header of each Portlet.</li> + <li>RootFragment.jsp - Defines the layout of the Portal. This is the file to modify if you need to modify the width of the navigation bar, for instance.</li> + <li>RowFragment.jsp - Called for each row fragment.</li> + <li>TabNavigation.jsp - Displays the navigation menu.</li> -</ul> -</p> + </ul> + + <p> Most customization of the Portal can be done in RootFragment.jsp, PortletFragmentHeader.jsp and PortletFragmentFooter.jsp. </p> -</div> -<div class="section"><h3><a name="Internationalization"></a>Internationalization</h3> + </div> + +<div class="section"> +<h3><a name="Internationalization"></a>Internationalization</h3> + <p>The Pluto portal supports non latin-1 character-sets in its output. To enable this, uncomment the section - <div class="source"><pre> + </p> +<div class="source"> +<pre> <init-param> <param-name>charset</param-name> <param-value>utf-8</param-value> </init-param> - </pre> -</div> - - from the "pluto" Servlet section in the file ${TOMCAT_HOME}/webapps/pluto/WEB-INF/web.xml.</p> -</div> -<div class="section"><h3><a name="Further_Information"></a>Further Information</h3> + </pre></div> + from the "pluto" Servlet section in the file ${TOMCAT_HOME}/webapps/pluto/WEB-INF/web.xml. + </div> + +<div class="section"> +<h3><a name="Further_Information"></a>Further Information</h3> + <p> Further information can be found in the <a href="../faq.html">FAQ</a>, on the <a href="../../mail-lists.html">Mailing Lists</a> - and on the <a href="../../wiki.html">Wiki</a></p> -</div> -</div> - - </div> - </div> - <div class="clear"> - <hr/> - </div> - <div id="footer"> - <div class="xright">© - 2004-2018 - - Apache Software Foundation - - - - - - - - - </div> - <div class="clear"> - <hr/> - </div> - </div> - </body> -</html> + and on the <a href="../../wiki.html">Wiki</a> + </p> + </div> + </div> + + + </div> + </div> + <div class="clear"> + <hr/> + </div> + <div id="footer"> + <div class="xright"> + Copyright © 2004–2019 <a href="http://www.apache.org/";>Apache Software Foundation</a>. +All rights reserved. </div> + <div class="clear"> + <hr/> + </div> + </div> + </body> +</html>
Modified: portals/site-live/pluto/v101/userguide/testsuite.html URL: http://svn.apache.org/viewvc/portals/site-live/pluto/v101/userguide/testsuite.html?rev=1858149&r1=1858148&r2=1858149&view=diff ============================================================================== --- portals/site-live/pluto/v101/userguide/testsuite.html (original) +++ portals/site-live/pluto/v101/userguide/testsuite.html Thu Apr 25 17:29:43 2019 @@ -1,285 +1,140 @@ -<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd";> - - - - - - - - - - - -<html xmlns="http://www.w3.org/1999/xhtml";> - <head> - <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /> - <title>Pluto - User Guide: Testsuite</title> - <style type="text/css" media="all"> - @import url("../../css/maven-base.css"); - @import url("../../css/maven-theme.css"); - @import url("../../css/site.css"); - </style> - <link rel="stylesheet" href="../../css/print.css" type="text/css" media="print" /> - </head> - <body class="composite"> - <div id="banner"> - <a href="http://portals.apache.org/pluto/"; id="bannerLeft"> - - <img src="http://portals.apache.org/pluto/images/apache-portals.gif"; alt="" /> - - </a> - <span id="bannerRight"> - - <img src="http://portals.apache.org/pluto/images/banner.png"; alt="" /> - - </span> - <div class="clear"> - <hr/> - </div> - </div> - <div id="breadcrumbs"> - - - - - - - - - <div class="xleft"> - Last Published: 2018-06-22 - | - <a href="http://portals.apache.org/pluto"; class="externalLink">Home</a> - </div> - <div class="xright"> <a href="../../portlet-3.0-apidocs/index.html">Portlet 3.0 API</a> - | - <a href="../../portlet-2.0-apidocs/index.html">Portlet 2.0 API</a> - | - <a href="../../portlet-1.0-apidocs/index.html">Portlet 1.0 API</a> - | - <a href="http://jcp.org/en/jsr/detail?id=362"; class="externalLink">JSR 362 JCP Page</a> - | - <a href="http://jcp.org/en/jsr/detail?id=286"; class="externalLink">JSR 286 JCP Page</a> - | - <a href="http://jcp.org/en/jsr/detail?id=168"; class="externalLink">JSR 168 JCP Page</a> - - - - - - - - - </div> - <div class="clear"> - <hr/> - </div> - </div> - <div id="leftColumn"> - <div id="navcolumn"> - - - - - - - - - <h5>The Pluto Project</h5> - <ul> - - <li class="none"> - <a href="../../index.html">About Pluto</a> - </li> - - <li class="none"> - <a href="../../mission.html">Mission</a> - </li> - - <li class="none"> - <a href="../../download.html">Download</a> - </li> - - <li class="none"> - <a href="../../news.html">News</a> - </li> - - <li class="none"> - <a href="../../security.html">Security</a> - </li> - - <li class="none"> - <a href="../../status.html">Status</a> - </li> - - <li class="none"> - <a href="../../architecture.html">Architecture</a> - </li> - - <li class="none"> - <a href="../../resources.html">Resources</a> - </li> - - <li class="none"> - <a href="../../faq.html">FAQ</a> - </li> - - <li class="none"> - <a href="http://wiki.apache.org/portals/Pluto"; class="externalLink">Wiki</a> - </li> - - <li class="none"> - <a href="https://issues.apache.org/jira/browse/PLUTO"; class="externalLink">Issue Tracker (JIRA)</a> - </li> - - <li class="none"> - <a href="../../helping.html">Get Involved</a> - </li> - </ul> - <h5>Pluto 3.0</h5> - <ul> - - <li class="none"> - <a href="../../v301/getting-started.html">Getting Started</a> - </li> - - <li class="none"> - <a href="../../v301/deploying.html">Deploying Portlets</a> - </li> - - <li class="none"> - <a href="../../v301/portlet-api.html">Portlet Concepts</a> - </li> - - <li class="none"> - <a href="../../v301/v3Features.html">Version 3 Features</a> - </li> - - <li class="none"> - <a href="../../v301/tck.html">Using the TCK</a> - </li> - - <li class="none"> - <a href="../../v301/release-notes.html">Release Notes</a> - </li> - </ul> - <h5>Pluto 2.0</h5> - <ul> - - <li class="none"> - <a href="../../v20/getting-started.html">Getting Started</a> - </li> - - <li class="none"> - <a href="../../v20/deploying.html">Deploying</a> - </li> - - <li class="none"> - <a href="../../v20/embedding.html">Embedding</a> - </li> - - <li class="none"> - <a href="../../v20/release-notes.html">Release Notes</a> - </li> - - <li class="none"> - <a href="../../v20/app-servers.html">App Servers</a> - </li> - - <li class="none"> - <a href="../../v20/powered.html">Powered By Pluto</a> - </li> - </ul> - <h5>Pluto 1.1</h5> - <ul> - - <li class="none"> - <a href="../../v11/getting-started.html">Getting Started</a> - </li> - - <li class="none"> - <a href="../../v11/deploying.html">Deploying</a> - </li> - - <li class="none"> - <a href="../../v11/release-notes.html">Release Notes</a> - </li> - </ul> - <h5>Subprojects</h5> - <ul> - - <li class="none"> - <a href="../../subprojects/subprojects.html">Overview</a> - </li> - </ul> - <h5>Project Info</h5> - <ul> - - <li class="none"> - <a href="../../project-summary.html">Project Summary</a> - </li> - - <li class="none"> - <a href="../../team-list.html">Project Team</a> - </li> - - <li class="none"> - <a href="../../license.html">Project License</a> - </li> - - <li class="none"> - <a href="../../mail-lists.html">Mailing Lists</a> - </li> - - <li class="none"> - <a href="../../source-repository.html">Source Repository</a> - </li> - - <li class="none"> - <a href="../../issue-tracking.html">Issue Tracking</a> - </li> - </ul> - <a href="http://maven.apache.org/"; title="Built by Maven" class="poweredBy"> - <img alt="Built by Maven" src="../../images/logos/maven-feather.png"></img> - </a> - - - - - - - - - </div> - </div> - <div id="bodyColumn"> - <div id="contentBox"> - <div class="section"><h2><a name="Testsuite_Overview"></a>Testsuite Overview</h2> -<p></p> +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd";> +<!-- Generated by Apache Maven Doxia Site Renderer 1.8.1 from src/site/xdoc/v101/userguide/testsuite.xml at 2019-04-25 --> +<html xmlns="http://www.w3.org/1999/xhtml"; xml:lang="en" lang="en"> + <head> + <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /> + <title>Pluto – User Guide: Testsuite</title> + <style type="text/css" media="all"> + @import url("../../css/maven-base.css"); + @import url("../../css/maven-theme.css"); + @import url("../../css/site.css"); + </style> + <link rel="stylesheet" href="../../css/print.css" type="text/css" media="print" /> + <meta http-equiv="Content-Language" content="en" /> + + </head> + <body class="composite"> + <div id="banner"> +<a href="http://portals.apache.org/pluto/"; id="bannerLeft"><img src="http://portals.apache.org/pluto/images/apache-portals.gif"; alt="Pluto"/></a> +<div id="bannerRight"> +<img src="http://portals.apache.org/pluto/images/banner.png"; alt=""/></div> + <div class="clear"> + <hr/> + </div> + </div> + <div id="breadcrumbs"> + <div class="xleft"> + <span id="publishDate">Last Published: 2019-04-25</span> + | <a href="http://portals.apache.org/pluto"; class="externalLink" title="Home">Home</a> > +User Guide: Testsuite + </div> + <div class="xright"><a href="../../portlet-3.0-apidocs/index.html" title="Portlet 3.0 API">Portlet 3.0 API</a> | +<a href="../../portlet-2.0-apidocs/index.html" title="Portlet 2.0 API">Portlet 2.0 API</a> | +<a href="../../portlet-1.0-apidocs/index.html" title="Portlet 1.0 API">Portlet 1.0 API</a> | +<a href="http://jcp.org/en/jsr/detail?id=362"; class="externalLink" title="JSR 362 JCP Page">JSR 362 JCP Page</a> | +<a href="http://jcp.org/en/jsr/detail?id=286"; class="externalLink" title="JSR 286 JCP Page">JSR 286 JCP Page</a> | +<a href="http://jcp.org/en/jsr/detail?id=168"; class="externalLink" title="JSR 168 JCP Page">JSR 168 JCP Page</a> </div> + <div class="clear"> + <hr/> + </div> + </div> + <div id="leftColumn"> + <div id="navcolumn"> + <h5>The Pluto Project</h5> + <ul> + <li class="none"><a href="../../index.html" title="About Pluto">About Pluto</a></li> + <li class="none"><a href="../../mission.html" title="Mission">Mission</a></li> + <li class="none"><a href="../../download.html" title="Download">Download</a></li> + <li class="none"><a href="../../news.html" title="News">News</a></li> + <li class="none"><a href="../../security.html" title="Security">Security</a></li> + <li class="none"><a href="../../status.html" title="Status">Status</a></li> + <li class="none"><a href="../../architecture.html" title="Architecture">Architecture</a></li> + <li class="none"><a href="../../resources.html" title="Resources">Resources</a></li> + <li class="none"><a href="../../faq.html" title="FAQ">FAQ</a></li> + <li class="none"><a href="http://wiki.apache.org/portals/Pluto"; class="externalLink" title="Wiki">Wiki</a></li> + <li class="none"><a href="https://issues.apache.org/jira/browse/PLUTO"; class="externalLink" title="Issue Tracker (JIRA)">Issue Tracker (JIRA)</a></li> + <li class="none"><a href="../../helping.html" title="Get Involved">Get Involved</a></li> + </ul> + <h5>Pluto 3.1</h5> + <ul> + <li class="none"><a href="../../v310/mvcbean-portlets.html" title="MVCBean Portlets">MVCBean Portlets</a></li> + <li class="none"><a href="../../v310/getting-started.html" title="Getting Started">Getting Started</a></li> + <li class="none"><a href="../../v310/maven-archetypes.html" title="Maven Archetypes">Maven Archetypes</a></li> + <li class="none"><a href="../../v310/deploying.html" title="Deploying Portlets">Deploying Portlets</a></li> + <li class="none"><a href="../../v310/portlet-api.html" title="Portlet Concepts">Portlet Concepts</a></li> + <li class="none"><a href="../../v310/v3Features.html" title="Version 3 Features">Version 3 Features</a></li> + <li class="none"><a href="../../v310/tck.html" title="Using the TCK">Using the TCK</a></li> + <li class="none"><a href="../../v310/release-notes.html" title="Release Notes">Release Notes</a></li> + </ul> + <h5>Pluto 3.0</h5> + <ul> + <li class="none"><a href="../../v301/getting-started.html" title="Getting Started">Getting Started</a></li> + <li class="none"><a href="../../v301/deploying.html" title="Deploying Portlets">Deploying Portlets</a></li> + <li class="none"><a href="../../v301/portlet-api.html" title="Portlet Concepts">Portlet Concepts</a></li> + <li class="none"><a href="../../v301/v3Features.html" title="Version 3 Features">Version 3 Features</a></li> + <li class="none"><a href="../../v301/tck.html" title="Using the TCK">Using the TCK</a></li> + <li class="none"><a href="../../v301/release-notes.html" title="Release Notes">Release Notes</a></li> + </ul> + <h5>Pluto 2.0</h5> + <ul> + <li class="none"><a href="../../v20/getting-started.html" title="Getting Started">Getting Started</a></li> + <li class="none"><a href="../../v20/deploying.html" title="Deploying">Deploying</a></li> + <li class="none"><a href="../../v20/embedding.html" title="Embedding">Embedding</a></li> + <li class="none"><a href="../../v20/release-notes.html" title="Release Notes">Release Notes</a></li> + <li class="none"><a href="../../v20/app-servers.html" title="App Servers">App Servers</a></li> + <li class="none"><a href="../../v20/powered.html" title="Powered By Pluto">Powered By Pluto</a></li> + </ul> + <h5>Pluto 1.1</h5> + <ul> + <li class="none"><a href="../../v11/getting-started.html" title="Getting Started">Getting Started</a></li> + <li class="none"><a href="../../v11/deploying.html" title="Deploying">Deploying</a></li> + <li class="none"><a href="../../v11/release-notes.html" title="Release Notes">Release Notes</a></li> + </ul> + <h5>Subprojects</h5> + <ul> + <li class="none"><a href="../../subprojects/subprojects.html" title="Overview">Overview</a></li> + </ul> + <h5>Project Info</h5> + <ul> + <li class="none"><a href="../../project-summary.html" title="Project Summary">Project Summary</a></li> + <li class="none"><a href="../../team-list.html" title="Project Team">Project Team</a></li> + <li class="none"><a href="../../license.html" title="Project License">Project License</a></li> + <li class="none"><a href="../../mail-lists.html" title="Mailing Lists">Mailing Lists</a></li> + <li class="none"><a href="../../source-repository.html" title="Source Repository">Source Repository</a></li> + <li class="none"><a href="../../issue-tracking.html" title="Issue Tracking">Issue Tracking</a></li> + </ul> + <a href="http://maven.apache.org/"; title="Built by Maven" class="poweredBy"> + <img class="poweredBy" alt="Built by Maven" src="../../images/logos/maven-feather.png" /> + </a> + </div> + </div> + <div id="bodyColumn"> + <div id="contentBox"> + + +<div class="section"> +<h2><a name="Testsuite_Overview"></a>Testsuite Overview</h2> + +<p> + +</p> </div> - - </div> - </div> - <div class="clear"> - <hr/> - </div> - <div id="footer"> - <div class="xright">© - 2004-2018 - - Apache Software Foundation - - - - - - - - - </div> - <div class="clear"> - <hr/> - </div> - </div> - </body> -</html> + + + + + </div> + </div> + <div class="clear"> + <hr/> + </div> + <div id="footer"> + <div class="xright"> + Copyright © 2004–2019 <a href="http://www.apache.org/";>Apache Software Foundation</a>. +All rights reserved. </div> + <div class="clear"> + <hr/> + </div> + </div> + </body> +</html> Modified: portals/site-live/pluto/v11/deploying.html URL: http://svn.apache.org/viewvc/portals/site-live/pluto/v11/deploying.html?rev=1858149&r1=1858148&r2=1858149&view=diff ============================================================================== --- portals/site-live/pluto/v11/deploying.html (original) +++ portals/site-live/pluto/v11/deploying.html Thu Apr 25 17:29:43 2019 @@ -1,291 +1,170 @@ -<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd";> - - - - - - - - - - - -<html xmlns="http://www.w3.org/1999/xhtml";> - <head> - <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /> - <title>Pluto - Deploying Portlet to Pluto Portal</title> - <style type="text/css" media="all"> - @import url("../css/maven-base.css"); - @import url("../css/maven-theme.css"); - @import url("../css/site.css"); - </style> - <link rel="stylesheet" href="../css/print.css" type="text/css" media="print" /> - </head> - <body class="composite"> - <div id="banner"> - <a href="http://portals.apache.org/pluto/"; id="bannerLeft"> - - <img src="http://portals.apache.org/pluto/images/apache-portals.gif"; alt="" /> - - </a> - <span id="bannerRight"> - - <img src="http://portals.apache.org/pluto/images/banner.png"; alt="" /> - - </span> - <div class="clear"> - <hr/> - </div> - </div> - <div id="breadcrumbs"> - - - - - - - - - <div class="xleft"> - Last Published: 2018-06-22 - | - <a href="http://portals.apache.org/pluto"; class="externalLink">Home</a> - </div> - <div class="xright"> <a href="../portlet-3.0-apidocs/index.html">Portlet 3.0 API</a> - | - <a href="../portlet-2.0-apidocs/index.html">Portlet 2.0 API</a> - | - <a href="../portlet-1.0-apidocs/index.html">Portlet 1.0 API</a> - | - <a href="http://jcp.org/en/jsr/detail?id=362"; class="externalLink">JSR 362 JCP Page</a> - | - <a href="http://jcp.org/en/jsr/detail?id=286"; class="externalLink">JSR 286 JCP Page</a> - | - <a href="http://jcp.org/en/jsr/detail?id=168"; class="externalLink">JSR 168 JCP Page</a> - - - - - - - - - </div> - <div class="clear"> - <hr/> - </div> - </div> - <div id="leftColumn"> - <div id="navcolumn"> - - - - - - - - - <h5>The Pluto Project</h5> - <ul> - - <li class="none"> - <a href="../index.html">About Pluto</a> - </li> - - <li class="none"> - <a href="../mission.html">Mission</a> - </li> - - <li class="none"> - <a href="../download.html">Download</a> - </li> - - <li class="none"> - <a href="../news.html">News</a> - </li> - - <li class="none"> - <a href="../security.html">Security</a> - </li> - - <li class="none"> - <a href="../status.html">Status</a> - </li> - - <li class="none"> - <a href="../architecture.html">Architecture</a> - </li> - - <li class="none"> - <a href="../resources.html">Resources</a> - </li> - - <li class="none"> - <a href="../faq.html">FAQ</a> - </li> - - <li class="none"> - <a href="http://wiki.apache.org/portals/Pluto"; class="externalLink">Wiki</a> - </li> - - <li class="none"> - <a href="https://issues.apache.org/jira/browse/PLUTO"; class="externalLink">Issue Tracker (JIRA)</a> - </li> - - <li class="none"> - <a href="../helping.html">Get Involved</a> - </li> - </ul> - <h5>Pluto 3.0</h5> - <ul> - - <li class="none"> - <a href="../v301/getting-started.html">Getting Started</a> - </li> - - <li class="none"> - <a href="../v301/deploying.html">Deploying Portlets</a> - </li> - - <li class="none"> - <a href="../v301/portlet-api.html">Portlet Concepts</a> - </li> - - <li class="none"> - <a href="../v301/v3Features.html">Version 3 Features</a> - </li> - - <li class="none"> - <a href="../v301/tck.html">Using the TCK</a> - </li> - - <li class="none"> - <a href="../v301/release-notes.html">Release Notes</a> - </li> - </ul> - <h5>Pluto 2.0</h5> - <ul> - - <li class="none"> - <a href="../v20/getting-started.html">Getting Started</a> - </li> - - <li class="none"> - <a href="../v20/deploying.html">Deploying</a> - </li> - - <li class="none"> - <a href="../v20/embedding.html">Embedding</a> - </li> - - <li class="none"> - <a href="../v20/release-notes.html">Release Notes</a> - </li> - - <li class="none"> - <a href="../v20/app-servers.html">App Servers</a> - </li> - - <li class="none"> - <a href="../v20/powered.html">Powered By Pluto</a> - </li> - </ul> - <h5>Pluto 1.1</h5> - <ul> - - <li class="none"> - <a href="../v11/getting-started.html">Getting Started</a> - </li> - - <li class="none"> - <strong>Deploying</strong> - </li> - - <li class="none"> - <a href="../v11/release-notes.html">Release Notes</a> - </li> - </ul> - <h5>Subprojects</h5> - <ul> - - <li class="none"> - <a href="../subprojects/subprojects.html">Overview</a> - </li> - </ul> - <h5>Project Info</h5> - <ul> - - <li class="none"> - <a href="../project-summary.html">Project Summary</a> - </li> - - <li class="none"> - <a href="../team-list.html">Project Team</a> - </li> - - <li class="none"> - <a href="../license.html">Project License</a> - </li> - - <li class="none"> - <a href="../mail-lists.html">Mailing Lists</a> - </li> - - <li class="none"> - <a href="../source-repository.html">Source Repository</a> - </li> - - <li class="none"> - <a href="../issue-tracking.html">Issue Tracking</a> - </li> - </ul> - <a href="http://maven.apache.org/"; title="Built by Maven" class="poweredBy"> - <img alt="Built by Maven" src="../images/logos/maven-feather.png"></img> - </a> - - - - - - - - - </div> - </div> - <div id="bodyColumn"> - <div id="contentBox"> - <div class="section"><h2><a name="Deploying_Portlet_to_Pluto_Portal"></a>Deploying Portlet to Pluto Portal</h2> +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd";> +<!-- Generated by Apache Maven Doxia Site Renderer 1.8.1 from src/site/xdoc/v11/deploying.xml at 2019-04-25 --> +<html xmlns="http://www.w3.org/1999/xhtml"; xml:lang="en" lang="en"> + <head> + <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /> + <title>Pluto – Deploying Portlet to Pluto Portal</title> + <style type="text/css" media="all"> + @import url("../css/maven-base.css"); + @import url("../css/maven-theme.css"); + @import url("../css/site.css"); + </style> + <link rel="stylesheet" href="../css/print.css" type="text/css" media="print" /> + <meta http-equiv="Content-Language" content="en" /> + + </head> + <body class="composite"> + <div id="banner"> +<a href="http://portals.apache.org/pluto/"; id="bannerLeft"><img src="http://portals.apache.org/pluto/images/apache-portals.gif"; alt="Pluto"/></a> +<div id="bannerRight"> +<img src="http://portals.apache.org/pluto/images/banner.png"; alt=""/></div> + <div class="clear"> + <hr/> + </div> + </div> + <div id="breadcrumbs"> + <div class="xleft"> + <span id="publishDate">Last Published: 2019-04-25</span> + | <a href="http://portals.apache.org/pluto"; class="externalLink" title="Home">Home</a> > +Deploying Portlet to Pluto Portal + </div> + <div class="xright"><a href="../portlet-3.0-apidocs/index.html" title="Portlet 3.0 API">Portlet 3.0 API</a> | +<a href="../portlet-2.0-apidocs/index.html" title="Portlet 2.0 API">Portlet 2.0 API</a> | +<a href="../portlet-1.0-apidocs/index.html" title="Portlet 1.0 API">Portlet 1.0 API</a> | +<a href="http://jcp.org/en/jsr/detail?id=362"; class="externalLink" title="JSR 362 JCP Page">JSR 362 JCP Page</a> | +<a href="http://jcp.org/en/jsr/detail?id=286"; class="externalLink" title="JSR 286 JCP Page">JSR 286 JCP Page</a> | +<a href="http://jcp.org/en/jsr/detail?id=168"; class="externalLink" title="JSR 168 JCP Page">JSR 168 JCP Page</a> </div> + <div class="clear"> + <hr/> + </div> + </div> + <div id="leftColumn"> + <div id="navcolumn"> + <h5>The Pluto Project</h5> + <ul> + <li class="none"><a href="../index.html" title="About Pluto">About Pluto</a></li> + <li class="none"><a href="../mission.html" title="Mission">Mission</a></li> + <li class="none"><a href="../download.html" title="Download">Download</a></li> + <li class="none"><a href="../news.html" title="News">News</a></li> + <li class="none"><a href="../security.html" title="Security">Security</a></li> + <li class="none"><a href="../status.html" title="Status">Status</a></li> + <li class="none"><a href="../architecture.html" title="Architecture">Architecture</a></li> + <li class="none"><a href="../resources.html" title="Resources">Resources</a></li> + <li class="none"><a href="../faq.html" title="FAQ">FAQ</a></li> + <li class="none"><a href="http://wiki.apache.org/portals/Pluto"; class="externalLink" title="Wiki">Wiki</a></li> + <li class="none"><a href="https://issues.apache.org/jira/browse/PLUTO"; class="externalLink" title="Issue Tracker (JIRA)">Issue Tracker (JIRA)</a></li> + <li class="none"><a href="../helping.html" title="Get Involved">Get Involved</a></li> + </ul> + <h5>Pluto 3.1</h5> + <ul> + <li class="none"><a href="../v310/mvcbean-portlets.html" title="MVCBean Portlets">MVCBean Portlets</a></li> + <li class="none"><a href="../v310/getting-started.html" title="Getting Started">Getting Started</a></li> + <li class="none"><a href="../v310/maven-archetypes.html" title="Maven Archetypes">Maven Archetypes</a></li> + <li class="none"><a href="../v310/deploying.html" title="Deploying Portlets">Deploying Portlets</a></li> + <li class="none"><a href="../v310/portlet-api.html" title="Portlet Concepts">Portlet Concepts</a></li> + <li class="none"><a href="../v310/v3Features.html" title="Version 3 Features">Version 3 Features</a></li> + <li class="none"><a href="../v310/tck.html" title="Using the TCK">Using the TCK</a></li> + <li class="none"><a href="../v310/release-notes.html" title="Release Notes">Release Notes</a></li> + </ul> + <h5>Pluto 3.0</h5> + <ul> + <li class="none"><a href="../v301/getting-started.html" title="Getting Started">Getting Started</a></li> + <li class="none"><a href="../v301/deploying.html" title="Deploying Portlets">Deploying Portlets</a></li> + <li class="none"><a href="../v301/portlet-api.html" title="Portlet Concepts">Portlet Concepts</a></li> + <li class="none"><a href="../v301/v3Features.html" title="Version 3 Features">Version 3 Features</a></li> + <li class="none"><a href="../v301/tck.html" title="Using the TCK">Using the TCK</a></li> + <li class="none"><a href="../v301/release-notes.html" title="Release Notes">Release Notes</a></li> + </ul> + <h5>Pluto 2.0</h5> + <ul> + <li class="none"><a href="../v20/getting-started.html" title="Getting Started">Getting Started</a></li> + <li class="none"><a href="../v20/deploying.html" title="Deploying">Deploying</a></li> + <li class="none"><a href="../v20/embedding.html" title="Embedding">Embedding</a></li> + <li class="none"><a href="../v20/release-notes.html" title="Release Notes">Release Notes</a></li> + <li class="none"><a href="../v20/app-servers.html" title="App Servers">App Servers</a></li> + <li class="none"><a href="../v20/powered.html" title="Powered By Pluto">Powered By Pluto</a></li> + </ul> + <h5>Pluto 1.1</h5> + <ul> + <li class="none"><a href="../v11/getting-started.html" title="Getting Started">Getting Started</a></li> + <li class="none"><strong>Deploying</strong></li> + <li class="none"><a href="../v11/release-notes.html" title="Release Notes">Release Notes</a></li> + </ul> + <h5>Subprojects</h5> + <ul> + <li class="none"><a href="../subprojects/subprojects.html" title="Overview">Overview</a></li> + </ul> + <h5>Project Info</h5> + <ul> + <li class="none"><a href="../project-summary.html" title="Project Summary">Project Summary</a></li> + <li class="none"><a href="../team-list.html" title="Project Team">Project Team</a></li> + <li class="none"><a href="../license.html" title="Project License">Project License</a></li> + <li class="none"><a href="../mail-lists.html" title="Mailing Lists">Mailing Lists</a></li> + <li class="none"><a href="../source-repository.html" title="Source Repository">Source Repository</a></li> + <li class="none"><a href="../issue-tracking.html" title="Issue Tracking">Issue Tracking</a></li> + </ul> + <a href="http://maven.apache.org/"; title="Built by Maven" class="poweredBy"> + <img class="poweredBy" alt="Built by Maven" src="../images/logos/maven-feather.png" /> + </a> + </div> + </div> + <div id="bodyColumn"> + <div id="contentBox"> + + + + + <div class="section"> +<h2><a name="Deploying_Portlet_to_Pluto_Portal"></a>Deploying Portlet to Pluto Portal</h2> + + <p> There are 2 steps involved in deploying a portlet application in Pluto 1.1: - <ul><li><b>Assembly</b>: All portlet applications must be run through the + </p> +<ul> + +<li> + <b>Assembly</b>: All portlet applications must be run through the pluto assembler before being deployed. The assembly process injects pluto specific information for deployment. Specifically, a servlet and servlet mapping are added to the deployment descriptor (web.xml). - This servlet (<code>org.apache.pluto.core.PortletServlet</code> + This servlet (<tt>org.apache.pluto.core.PortletServlet</tt> will be used to dispatch portlet requests to the portlet application. </li> -<li><b>Deployment</b>: After portlet applications are assembled properly + +<li> + <b>Deployment</b>: After portlet applications are assembled properly they must be deployed to the servlet engine within which the portal application is running. The current bundled distribution uses Tomcat 5.5 as the servlet engine. </li> -</ul> -</p> -<div class="section"><h3><a name="Portlet_Assembly"></a>Portlet Assembly</h3> + </ul> + + + +<div class="section"> +<h3><a name="Portlet_Assembly"></a>Portlet Assembly</h3> + <p> The maven-pluto-plugin can be used to assemble a portlet application war. - It will place the proper <code>PortletServlet</code> configuration in web.xml. + It will place the proper <tt>PortletServlet</tt> configuration in web.xml. </p> + <p> The custom Maven 2 build shown below requires a Tomcat context deployment descriptor that has the same name as your artifactId with an xml extension (e.g. HelloWorldPortlet.xml). </p> + <p> To properly assemble your portlet using the Maven 2 plugin, your project's directory structure and artifact placement must conform to Maven's standard: </p> -<p><div class="source"><pre> + +<p> + </p> +<div class="source"> +<pre> HelloWorldPortlet (top level directory) |- pom.xml (the pom file) |- src (Subdir containing main subdirectory) @@ -304,23 +183,28 @@ `- WEB-INF `- portlet.xml (JSR-168 deployment descriptor) `- web.xml (This will be modified by maven-pluto-plugin) - </pre> -</div> -</p> + </pre></div> + + + <p> This is an example of what the Tomcat context deployment descriptor will contain: - <div class="source"><pre> + </p> +<div class="source"> +<pre> <Context path="/HelloWorldPortlet" docBase="HelloWorldPortlet" crossContext="true"/> - </pre> -</div> -</p> + </pre></div> + + <p> To configure the maven-pluto-plugin, you must configure it in your pom. For easy of setup, use this as you pom file, changing the groupId, artifactId and version to values appropriate to your custom portlet. - <div class="source"><pre> + </p> +<div class="source"> +<pre> <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"> @@ -406,15 +290,19 @@ </build> </project> - </pre> -</div> -</p> + </pre></div> + + <p> Once configured, the war generated by an 'mvn package' (or install) command will contain the appropriate pluto configuration. </p> -</div> -<div class="section"><h3><a name="Portlet_Deployment"></a>Portlet Deployment</h3> + </div> + + +<div class="section"> +<h3><a name="Portlet_Deployment"></a>Portlet Deployment</h3> + <p> To deploy a portlet application, simply deploy the application war using any standard mechanism for your application server. There are many @@ -423,12 +311,15 @@ Pluto bundled distribution and is accessed via the 'Upload and deploy portlet war' link on the page administration portlet. See the Help link on that portlet for more details. </p> + <p> In the bundled distribution that uses Tomcat, deployment of an assembled war can simply be done by dropping the war into the webapps directory. You can automatically achive this by adding the following code within the plugins section of your maven pom.xml: </p> -<div class="source"><pre> + +<div class="source"> +<pre> <plugin> <artifactId>maven-antrun-plugin</artifactId> <executions> @@ -448,8 +339,8 @@ </execution> </executions> </plugin> - </pre> -</div> + </pre></div> + <p> Once the pom.xml file has been updated with this plugin, you can run the full build and deployment using the command: mvn integration-test. The code assumes that you have set @@ -457,25 +348,36 @@ done, just set pluto.home from the command line with the -D flag. The command line would then be: mvn -Dpluto.home=C:/pluto integration-test. </p> -</div> -<div class="section"><h3><a name="Portlet_Publishing"></a>Portlet Publishing</h3> + + </div> + + +<div class="section"> +<h3><a name="Portlet_Publishing"></a>Portlet Publishing</h3> + <p> As soon as the portlet application (war) is deployed to the servlet container the portlet application will be available to the portal and can be added to pages using the page administration portlet. See the help mode in this portlet for details on its use. </p> + + <p><b>Portal Page Configuration</b></p> + <p> If you'd like for your page configuration to be consistent throughout restarts of the application server (currently placements made through the page administration portlet is not persistent), you should then configure the page layout in the portal-driver configuration file (pluto-portal-driver-config.xml). </p> + <p> - The page can then be configured by adding a <code>page</code> child element of the <code>render-config</code> + The page can then be configured by adding a <tt>page</tt> child element of the <tt>render-config</tt> element, like this: - <div class="source"><pre> + </p> +<div class="source"> +<pre> <render-config default="Test Page"> ... ... <page name="Your Portal Page Name" uri="/WEB-INF/fragments/portlet.jsp"> @@ -485,41 +387,35 @@ name="your_portlet_2"/> </page> </render-config> - </pre> -</div> -</p> + </pre></div> + + <p> - The <code>uri</code> attribute defines the theme of your portal page. - If you use <code>/WEB-INF/fragments/portlet.jsp</code> (which is the + The <tt>uri</tt> attribute defines the theme of your portal page. + If you use <tt>/WEB-INF/fragments/portlet.jsp</tt> (which is the default theme of Pluto Testsuite portlet app), your portlets will be displayed in two columns. You can clone this file to customize your layout. - If you do so, make sure the <code>uri</code> attribute points to the new file. + If you do so, make sure the <tt>uri</tt> attribute points to the new file. </p> -</div> -</div> - - </div> - </div> - <div class="clear"> - <hr/> - </div> - <div id="footer"> - <div class="xright">© - 2004-2018 - - Apache Software Foundation - - - - - - - - - </div> - <div class="clear"> - <hr/> - </div> - </div> - </body> -</html> + </div> + + </div> + + + + + </div> + </div> + <div class="clear"> + <hr/> + </div> + <div id="footer"> + <div class="xright"> + Copyright © 2004–2019 <a href="http://www.apache.org/";>Apache Software Foundation</a>. +All rights reserved. </div> + <div class="clear"> + <hr/> + </div> + </div> + </body> +</html>
![http://portals.apache.org/pluto/images/apache-portals.gif"](http://portals.apache.org/pluto/images/apache-portals.gif"){kind=link}
![http://portals.apache.org/pluto/images/banner.png"](http://portals.apache.org/pluto/images/banner.png"){kind=link}