Return-Path:
- This install guide covers the following types of installations:
-
- The binary distribution of Pluto is packaged with Tomcat (currently - version 5.5.9). Pluto leverages Tomcat to provide the web container - in which the Pluto portlet container executes. The binary distribution - includes the Pluto Portlet Container, The Portal Driver, the Pluto - Testsuite and the Admin Portlet application. -
-- To install the binary distribution: -
"<PLUTO_HOME>"
.<PLUTO_HOME>/bin
.
- For *nix use startup.sh
; for windows use
- startup.bat
.http://localhost:8080/pluto/portal
,
- the Pluto Driver, and your ready to go!- The pluto library distributions are packaged to allow integration with - an external portal server. -
-- To install the library distributions to your portal server, ensure - that the pluto-x.x.x.jar is loaded by a classloader to which both the - portal and portlet application web apps have access. -
-- Installing the source distribution requires the most effort, and is - recomended only for those individuals who are interested in modifying - the container. The source distribution is basically a snapshot of the - source code repository at a given time. Because of this, please see - the build instructions, which will provide information about how to - build Pluto from scratch. -
-- To install the source distribution into Tomcat: -
<TOMCAT_HOME>
<PLUTO_HOME>/build.properties
to
- include the following properties:
- Property | -Value | -Example(s) | -
---|---|---|
maven.tomcat.home | -Tomcat Installation Directory | -/usr/local/apache-tomcat.5.0.27 ,
- c:\\apache-tomcat.5.0.27 |
-
maven.tomcat.version.major | -Tomcat Major Version Number | -5 | -
<PLUTO_HOME>
issue the command:
- maven fullDeployment
<PLUTO_HOME>/bin
.
- For *nix use startup.sh
; for windows use
- startup.bat
.http://localhost:8080/pluto/portal
, the Pluto Driver,
- and your ready to go!- Currently, to automate the - deployment/installation of portlets you must utilize the source - distribution of pluto. Alternatively, you could use the - Admin Portlet - Application to install custom portlets. -
-- In order to deploy a portlet application to pluto, you must follow the - steps below: -
-- Step 1: Assemble your portlet application into a valid war. -
-- Step 2: Run the maven deploy goal on your war. This can be done - by running this command line in the deploy subdirectory: - - See the Building From Source - document for detailed instructions. -
-
- Alternatively, there is an interactive ant script in the
- portlet-deploy
directory that will perform the same task
- as the Maven deployment goal.
-
- Step 3: Modify the Portlet Entity Registry and the Page - Registry and Portlet Contexts files. These configuration files are - located at: -
[portal-home]/WEB-INF/data/portletentityregistry.xml
[portal-home]/WEB-INF/data/pageregistry.xml
[portal-home]/WEB-INF/data/portletcontexts.txt
- The Portlet Entity Registry file requires that you specify an - application and a Portlet ID for your new Portlet. The Application ID - must be unique. It also needs to know the name of the Portlet so that - it can go out and find it in the webapps path. Furthermore, this - information is used to map the Portlet name to the appropriate class - path for loading the class. The following is an example of some - additions you can make to the entity registry file: -
-- -
-- The Page Registry provides Pluto with the layout information for your - Portlet. The names used in the fragments must be unique as done in - the following example: -
-- -
-
- The Portlet Contexts file (portletcontexts.txt
) lists
- the webapp contexts for each portlet application that runs in Pluto.
- Each portlet app has a line in this file corresponding to a path and
- starting with a slash ('/'). In Tomcat, this path is the value of the
- 'path' attribute of the 'Context' element in a context XML descriptor
- in <TOMCAT_HOME>/conf/Catalina/localhost
- (or another 'conf' subdirectory).
-
- The Admin Portlet Application allows you to deploy custom portlets - using an interface in Pluto's portal. This application automatically - places the custom portlets to their proper place and updates the - registries. -
-- Deploying a custom portlet application to Pluto using the Admin - Portlet Application requires the following steps: -
http://localhost:8080/pluto/portal
, the local Pluto
- home page.- Check out the Deploy War Portlet's help mode (help link) for - information on redeploying and undeploying portlets and - troubleshooting problems. -
-+ This install guide covers the following types of installations: +
+ ++ The binary distribution of Pluto is packaged with Tomcat (currently + version 5.5.9). Pluto leverages Tomcat to provide the web container + in which the Pluto portlet container executes. The binary distribution + includes the Pluto Portlet Container, The Portal Driver, the Pluto + Testsuite and the Admin Portlet application. +
++ To install the binary distribution: +
"<PLUTO_HOME>"
.<PLUTO_HOME>/bin
.
+ For *nix use startup.sh
; for windows use
+ startup.bat
.http://localhost:8080/pluto/portal
,
+ the Pluto Driver, and your ready to go!+ The pluto library distributions are packaged to allow integration with + an external portal server. +
++ To install the library distributions to your portal server, ensure + that the pluto-x.x.x.jar is loaded by a classloader to which both the + portal and portlet application web apps have access. +
++ Installing the source distribution requires the most effort, and is + recomended only for those individuals who are interested in modifying + the container. The source distribution is basically a snapshot of the + source code repository at a given time. Because of this, please see + the build instructions, which will provide information about how to + build Pluto from scratch. +
++ To install the source distribution into Tomcat: +
<TOMCAT_HOME>
<PLUTO_HOME>/build.properties
to
+ include the following properties:
+ Property | +Value | +Example(s) | +
---|---|---|
maven.tomcat.home | +Tomcat Installation Directory | +/usr/local/apache-tomcat.5.0.27 ,
+ c:\\apache-tomcat.5.0.27 |
+
maven.tomcat.version.major | +Tomcat Major Version Number | +5 | +
<PLUTO_HOME>
issue the command:
+ maven fullDeployment
<PLUTO_HOME>/bin
.
+ For *nix use startup.sh
; for windows use
+ startup.bat
.http://localhost:8080/pluto/portal
, the Pluto Driver,
+ and your ready to go!+ Currently, to automate the + deployment/installation of portlets you must utilize the source + distribution of pluto. Alternatively, you could use the + Admin Portlet + Application to install custom portlets. +
++ In order to deploy a portlet application to pluto, you must follow the + steps below: +
++ Step 1: Assemble your portlet application into a valid war. +
++ Step 2: Run the maven deploy goal on your war. This can be done + by running this command line in the deploy subdirectory: + + See the Building From Source + document for detailed instructions. +
+
+ Alternatively, there is an interactive ant script in the
+ portlet-deploy
directory that will perform the same task
+ as the Maven deployment goal.
+
+ Step 3: Modify the Portlet Entity Registry and the Page + Registry and Portlet Contexts files. These configuration files are + located at: +
[portal-home]/WEB-INF/data/portletentityregistry.xml
[portal-home]/WEB-INF/data/pageregistry.xml
[portal-home]/WEB-INF/data/portletcontexts.txt
+ The Portlet Entity Registry file requires that you specify an + application and a Portlet ID for your new Portlet. The Application ID + must be unique. It also needs to know the name of the Portlet so that + it can go out and find it in the webapps path. Furthermore, this + information is used to map the Portlet name to the appropriate class + path for loading the class. The following is an example of some + additions you can make to the entity registry file: +
++ +
++ The Page Registry provides Pluto with the layout information for your + Portlet. The names used in the fragments must be unique as done in + the following example: +
++ +
+
+ The Portlet Contexts file (portletcontexts.txt
) lists
+ the webapp contexts for each portlet application that runs in Pluto.
+ Each portlet app has a line in this file corresponding to a path and
+ starting with a slash ('/'). In Tomcat, this path is the value of the
+ 'path' attribute of the 'Context' element in a context XML descriptor
+ in <TOMCAT_HOME>/conf/Catalina/localhost
+ (or another 'conf' subdirectory).
+
+ The Admin Portlet Application allows you to deploy custom portlets + using an interface in Pluto's portal. This application automatically + places the custom portlets to their proper place and updates the + registries. +
++ Deploying a custom portlet application to Pluto using the Admin + Portlet Application requires the following steps: +
http://localhost:8080/pluto/portal
, the local Pluto
+ home page.+ Check out the Deploy War Portlet's help mode (help link) for + information on redeploying and undeploying portlets and + troubleshooting problems. +
+-
Resource | -Type | -
---|---|
JSR 168 | -JCP Request Info | -
JSR 286 | -JCP Request Info | -
Portlet Specification 1.0 | -Specification | -
Chinese translation of Pluto website | -Documentation | -
Integrating Java Open Single Sign-On in Pluto | -Documentation | -
Clustering JSR-168 Portlet Applications in Tomcat | -Documentation | -
+
Resource | +Type | +
---|---|
JSR 168 | +JCP Request Info | +
JSR 286 | +JCP Request Info | +
Portlet Specification 1.0 | +Specification | +
Chinese translation of Pluto website | +Documentation | +
Integrating Java Open Single Sign-On in Pluto | +Documentation | +
Clustering JSR-168 Portlet Applications in Tomcat | +Documentation | +
It is expected that the reader of the user guide documentation - should has an understanding of Java Web Application development, and - Java Portlet Development.
-- Pluto is the reference implementation of the Portlet Specification. - It is a portlet container which manages the lifecycle and request - processing of portlets which adhere to the specification. -
- -- In an of itself, Pluto is not very usefull to the end user. - As a container, it does not have any understanding of portlet - invocation, portlet aggregation or other portal specific features. -
- -- For more information on how to integrate Pluto into your portal, - please see the developer guides. -
- -- The Pluto Portal Driver is a simple portal implementation that - is provided for convenience sake. It's purpose is to provide - aggregation support so that Pluto may be easily tested, and - portlets may be easily developed. -
- -- For information on how to use, configure, and customize the - Portal Driver, please see the - Portal Driver User Guide. -
- -- The Pluto TestSuite is a Portlet Application which can be used to test - Portlet Implementations. The TestSuite tests several basic portlet - functions and is a quick and dirty way to test for Portlet Specification - compliance. While a quick test of a portal using the testsuite won't - garuntee compliance, it will help flag any notable incompliance. -
- -- For information on how to use and configure the TestSuite, please see - the TestSuite User Guide -
-It is expected that the reader of the user guide documentation + should has an understanding of Java Web Application development, and + Java Portlet Development.
++ Pluto is the reference implementation of the Portlet Specification. + It is a portlet container which manages the lifecycle and request + processing of portlets which adhere to the specification. +
+ ++ In an of itself, Pluto is not very usefull to the end user. + As a container, it does not have any understanding of portlet + invocation, portlet aggregation or other portal specific features. +
+ ++ For more information on how to integrate Pluto into your portal, + please see the developer guides. +
+ ++ The Pluto Portal Driver is a simple portal implementation that + is provided for convenience sake. It's purpose is to provide + aggregation support so that Pluto may be easily tested, and + portlets may be easily developed. +
+ ++ For information on how to use, configure, and customize the + Portal Driver, please see the + Portal Driver User Guide. +
+ ++ The Pluto TestSuite is a Portlet Application which can be used to test + Portlet Implementations. The TestSuite tests several basic portlet + functions and is a quick and dirty way to test for Portlet Specification + compliance. While a quick test of a portal using the testsuite won't + garuntee compliance, it will help flag any notable incompliance. +
+ ++ For information on how to use and configure the TestSuite, please see + the TestSuite User Guide +
+-
- -- The Pluto Portal is intended to provide an example implementation of - how to integrate Pluto into a portal. Additionally, it may be used for - the development of compliant portlets. In some places it lacks the - flexibility a true portal supplies. The portal is not designed for - maximum performance, but rather simplicity. -
- -- To learn how to embed Pluto in your own portal, see the - "Integration Guide" document.
-
- Upon installation of the binary distribution of Pluto 1.0.1, the portal
- driver is made available at http://localhost:8080/pluto/portal
.
- 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.
-
-
Configuration | -Platform | -Value | Description |
---|---|---|---|
Installation Directory | -All | -<PLUTO_HOME> | -The directory to which you unarchived the distribution |
Startup Scripts | -*nix | -<PLUTO_HOME>/bin/startup.sh | -The script used to startup the portal driver |
Startup Scripts | -Windows | -<PLUTO_HOME>/bin/startup.bat | -The script used to startup the portal driver |
Context Configuration | -All | -<PLUTO_HOME>/conf/Catalina/localhost/pluto.xml | -The Tomcat Context Configuration file |
-
Configuration | -Platform | -Value | Description |
---|---|---|---|
Installation Directory | -All | -${maven.tomcat.home} | -The tomcat installation directory to which pluto has been installed |
Startup Scipts | -*nix | -${maven.tomcat.home}/bin/startup.sh | -The script used to startup the portal driver |
Startup Scipts | -Windows | -${maven.tomcat.home}/bin/startup.bat | -The script used to startup the portal driver |
Context Configuration | -Tomcat 5.5 | -${maven.tomcat.home}/conf/Catalina/localhost/pluto.xml | -The Tomcat Context Configuration file |
When the Pluto Portal is first installed, it is made available at - the address http://localhost:8080/pluto/portal/.
- -This location can be customized, using standard Tomcat functionality. To modify the pluto part of the - location, alter the path mapping in pluto's context configuration file pluto.xml
- -Under Tomcat 5.5, pluto.xml will be located - in the ${TOMCAT_HOME}/conf/Catalina/ directory.
- -In order to modify the context Pluto is running under, modify the path attribute:
-- Before: - -
-After: - -
- -You might also need to modify host.name and portletcontainer.uniquename in - ${TOMCAT_HOME}/webapps/pluto/WEB-INF/config/services/ConfigService.properties. -
- -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 - Tomcat 5.5. -
- -To modify the portal part of the location, alter the url-pattern for the - pluto servlet. This mapping can be found in the web.xml configuration file - for the Pluto web application.
-- Before: - -
-- After: - -
- -You will also need to modify servlet.insecure in ${TOMCAT_HOME}/webapps/pluto/WEB-INF/config/services/ConfigService.properties. -
- -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). -
-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 portletentityregistry.xml in the directory - ${TOMCAT_HOME}/webapps/pluto/data.
- -By default, this file looks like this: - -
-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.
- -The <definition-id> tag within the <application> refers to the name of the - web-app that contains the portlets in this application.
- -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).
- -Each <preferences> tag within the <portlet> tag defines name/value pairs for - the PorletPreferences.
- -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 (<definition-id>testsuite</definition-id>). - Both applications define a single Portlet each. Application id 3 uses the Portlet TestPortlet1 - (<definition-id>testsuite.TestPortlet1</definition-id>), while Application id 4 uses - the Portlet TestPortlet2 (<definition-id>testsuite.TestPortlet2</definition-id>). - Note that prefixing the name of the Portlet with the name of web application (testsuite.TestPortlet1) - is required. -
- -- 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) - lists the webapp - contexts for each portlet application that runs in Pluto. Each portlet app has a line in this - file corresponding to a path and starting with a slash ('/'). In Tomcat, this path is the value - of the 'path' attribute of the 'Context' element in a context XML descriptor in - $TOMCAT_HOME/conf/Catalina/localhost (or another 'conf' subdirectory). - -
- -The Portlets themselves are defined in the portlet.xml configuration file within the - testsuite web application. In that file there are two Portlets defined, - TestPortlet1 and TestPortlet2, both of which point to the same - portlet class (org.apache.pluto.portalImpl.portlet.TestPortlet). - See the javax.portlet specification (JSR-168) for futher details on using the portlet.xml file. -
-Once the Portlets available have been defined the Portal layout needs to be defined. In the - Pluto Portal the file pageregistry.xml in the directory ${TOMCAT_HOME}/webapps/pluto/data defines this layout.
- -When Pluto is first installed, pageregistry.xml looks like this: - -
- -This configuration results in the Portal being displayed - (from the url http://servername/pluto/portal/test/) as Figure 1 shows.
- -- - -
-- Figure 1. Default Portal Layout. Click on the picture to enlarge it -
-Working from the top of pageregistry.xml down, the first important section we come to is: - -
-This section tells the Portal to add a navigation menu to the user interface. Each fragment of - type page will be displayed in the navigation menu, provided the fragment has a <navigation> - sub-element. Removing the <fragment name="navigation" ...></fragment> section - will result in no navigation menu being displayed. -
- -- The next section is: - -
-- This section defines a Portal "page", which is simply a container for one or more Portlets. The name - attribute must be unique within the pageregistry.xml file (if this constraint is not met an error - message Fragment with this name <duplicated name> already exists in the pageregistry.xml. will be written to your - log and your Pluto web application will fail to load). -
-- 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. -
- -Inside the <fragment type="page" .... ></fragment> elements we find - -
-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. -
-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. - -
-The section - -
-defines which portlet to display. <property name="portlet" value="3.1"/> 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 portletentityregistry.xml (discussed previously). In this case, it mean application id "3", - portlet id "1". -
-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.
- -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 - - to the file ${TOMCAT_HOME}/webapps/pluto/WEB-INF/config/services/ConfigService.properties. -
-The following JSP files are used by the Portal: -
- Most customization of the Portal can be done in RootFragment.jsp, - PortletFragmentHeader.jsp and PortletFragmentFooter.jsp. -
-The Pluto portal supports non latin-1 character-sets in its output. To enable this, uncomment the section - - from the "pluto" Servlet section in the file ${TOMCAT_HOME}/webapps/pluto/WEB-INF/web.xml.
-- Further information can be found in the FAQ, on the Mailing Lists - and on the Wiki -
-+
+ ++ The Pluto Portal is intended to provide an example implementation of + how to integrate Pluto into a portal. Additionally, it may be used for + the development of compliant portlets. In some places it lacks the + flexibility a true portal supplies. The portal is not designed for + maximum performance, but rather simplicity. +
+ ++ To learn how to embed Pluto in your own portal, see the + "Integration Guide" document.
+
+ Upon installation of the binary distribution of Pluto 1.0.1, the portal
+ driver is made available at http://localhost:8080/pluto/portal
.
+ 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.
+
+
Configuration | +Platform | +Value | Description |
---|---|---|---|
Installation Directory | +All | +<PLUTO_HOME> | +The directory to which you unarchived the distribution |
Startup Scripts | +*nix | +<PLUTO_HOME>/bin/startup.sh | +The script used to startup the portal driver |
Startup Scripts | +Windows | +<PLUTO_HOME>/bin/startup.bat | +The script used to startup the portal driver |
Context Configuration | +All | +<PLUTO_HOME>/conf/Catalina/localhost/pluto.xml | +The Tomcat Context Configuration file |
+
Configuration | +Platform | +Value | Description |
---|---|---|---|
Installation Directory | +All | +${maven.tomcat.home} | +The tomcat installation directory to which pluto has been installed |
Startup Scipts | +*nix | +${maven.tomcat.home}/bin/startup.sh | +The script used to startup the portal driver |
Startup Scipts | +Windows | +${maven.tomcat.home}/bin/startup.bat | +The script used to startup the portal driver |
Context Configuration | +Tomcat 5.5 | +${maven.tomcat.home}/conf/Catalina/localhost/pluto.xml | +The Tomcat Context Configuration file |
When the Pluto Portal is first installed, it is made available at + the address http://localhost:8080/pluto/portal/.
+ +This location can be customized, using standard Tomcat functionality. To modify the pluto part of the + location, alter the path mapping in pluto's context configuration file pluto.xml
+ +Under Tomcat 5.5, pluto.xml will be located + in the ${TOMCAT_HOME}/conf/Catalina/ directory.
+ +In order to modify the context Pluto is running under, modify the path attribute:
++ Before: + +
+After: + +
+ +You might also need to modify host.name and portletcontainer.uniquename in + ${TOMCAT_HOME}/webapps/pluto/WEB-INF/config/services/ConfigService.properties. +
+ +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 + Tomcat 5.5. +
+ +To modify the portal part of the location, alter the url-pattern for the + pluto servlet. This mapping can be found in the web.xml configuration file + for the Pluto web application.
++ Before: + +
++ After: + +
+ +You will also need to modify servlet.insecure in ${TOMCAT_HOME}/webapps/pluto/WEB-INF/config/services/ConfigService.properties. +
+ +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). +
+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 portletentityregistry.xml in the directory + ${TOMCAT_HOME}/webapps/pluto/data.
+ +By default, this file looks like this: + +
+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.
+ +The <definition-id> tag within the <application> refers to the name of the + web-app that contains the portlets in this application.
+ +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).
+ +Each <preferences> tag within the <portlet> tag defines name/value pairs for + the PorletPreferences.
+ +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 (<definition-id>testsuite</definition-id>). + Both applications define a single Portlet each. Application id 3 uses the Portlet TestPortlet1 + (<definition-id>testsuite.TestPortlet1</definition-id>), while Application id 4 uses + the Portlet TestPortlet2 (<definition-id>testsuite.TestPortlet2</definition-id>). + Note that prefixing the name of the Portlet with the name of web application (testsuite.TestPortlet1) + is required. +
+ ++ 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) + lists the webapp + contexts for each portlet application that runs in Pluto. Each portlet app has a line in this + file corresponding to a path and starting with a slash ('/'). In Tomcat, this path is the value + of the 'path' attribute of the 'Context' element in a context XML descriptor in + $TOMCAT_HOME/conf/Catalina/localhost (or another 'conf' subdirectory). + +
+ +The Portlets themselves are defined in the portlet.xml configuration file within the + testsuite web application. In that file there are two Portlets defined, + TestPortlet1 and TestPortlet2, both of which point to the same + portlet class (org.apache.pluto.portalImpl.portlet.TestPortlet). + See the javax.portlet specification (JSR-168) for futher details on using the portlet.xml file. +
+Once the Portlets available have been defined the Portal layout needs to be defined. In the + Pluto Portal the file pageregistry.xml in the directory ${TOMCAT_HOME}/webapps/pluto/data defines this layout.
+ +When Pluto is first installed, pageregistry.xml looks like this: + +
+ +This configuration results in the Portal being displayed + (from the url http://servername/pluto/portal/test/) as Figure 1 shows.
+ ++ + +
++ Figure 1. Default Portal Layout. Click on the picture to enlarge it +
+Working from the top of pageregistry.xml down, the first important section we come to is: + +
+This section tells the Portal to add a navigation menu to the user interface. Each fragment of + type page will be displayed in the navigation menu, provided the fragment has a <navigation> + sub-element. Removing the <fragment name="navigation" ...></fragment> section + will result in no navigation menu being displayed. +
+ ++ The next section is: + +
++ This section defines a Portal "page", which is simply a container for one or more Portlets. The name + attribute must be unique within the pageregistry.xml file (if this constraint is not met an error + message Fragment with this name <duplicated name> already exists in the pageregistry.xml. will be written to your + log and your Pluto web application will fail to load). +
++ 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. +
+ +Inside the <fragment type="page" .... ></fragment> elements we find + +
+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. +
+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. + +
+The section + +
+defines which portlet to display. <property name="portlet" value="3.1"/> 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 portletentityregistry.xml (discussed previously). In this case, it mean application id "3", + portlet id "1". +
+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.
+ +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 + + to the file ${TOMCAT_HOME}/webapps/pluto/WEB-INF/config/services/ConfigService.properties. +
+The following JSP files are used by the Portal: +
+ Most customization of the Portal can be done in RootFragment.jsp, + PortletFragmentHeader.jsp and PortletFragmentFooter.jsp. +
+The Pluto portal supports non latin-1 character-sets in its output. To enable this, uncomment the section + + from the "pluto" Servlet section in the file ${TOMCAT_HOME}/webapps/pluto/WEB-INF/web.xml.
++ Further information can be found in the FAQ, on the Mailing Lists + and on the Wiki +
+- -
-+ +
+actionURL
tag. Creates a url that
- * points to the current Portlet and triggers an action request with the
- * supplied parameters.
- */
-public class ActionURLTag extends BasicURLTag {
-
- protected PortletURL createPortletURL() {
- RenderResponse renderResponse = (RenderResponse) pageContext.getRequest()
- .getAttribute("javax.portlet.response");
- return renderResponse.createActionURL();
- }
-
-}
-
+ * 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.
+ */
+/*
+
+ */
+
+/*
+ * Created on Feb 21, 2003
+ *
+ * To change this generated comment go to
+ * Window>Preferences>Java>Code Generation>Code Template
+ */
+package org.apache.pluto.tags;
+
+import javax.portlet.PortletURL;
+import javax.portlet.RenderResponse;
+
+/**
+ * Supporting class for the actionURL
tag. Creates a url that
+ * points to the current Portlet and triggers an action request with the
+ * supplied parameters.
+ */
+public class ActionURLTag extends BasicURLTag {
+
+ protected PortletURL createPortletURL() {
+ RenderResponse renderResponse = (RenderResponse) pageContext.getRequest()
+ .getAttribute("javax.portlet.response");
+ return renderResponse.createActionURL();
+ }
+
+}
+
Propchange: portals/pluto/branches/pluto-1.1.x/pluto-taglib/src/main/java/org/apache/pluto/tags/ActionURLTag.java
------------------------------------------------------------------------------
svn:eol-style = native