Author: jaredmorgs Date: 2012-10-25 02:01:34 -0400 (Thu, 25 Oct 2012) New Revision: 8939 Modified: epp/docs/branches/6.0/Admin_Guide/en-US/Administration_Guide.ent epp/docs/branches/6.0/Admin_Guide/en-US/Author_Group.xml epp/docs/branches/6.0/Admin_Guide/en-US/Book_Info.xml epp/docs/branches/6.0/Admin_Guide/en-US/Preface.xml epp/docs/branches/6.0/Admin_Guide/en-US/Revision_History.xml epp/docs/branches/6.0/Admin_Guide/en-US/chapter-1-Introduction.xml epp/docs/branches/6.0/Admin_Guide/en-US/chapter-2-REST.xml epp/docs/branches/6.0/Admin_Guide/en-US/chapter-3-Command_Line_Interface.xml epp/docs/branches/6.0/Admin_Guide/en-US/chapter-4-Management_Extensions.xml epp/docs/branches/6.0/Admin_Guide/en-US/chapter-5-Administration_and_Monitoring.xml epp/docs/branches/6.0/Admin_Guide/publican.cfg epp/docs/branches/6.0/Developer_Guide/en-US/Author_Group.xml epp/docs/branches/6.0/Developer_Guide/en-US/Book_Info.xml epp/docs/branches/6.0/Developer_Guide/en-US/Developer_Guide.ent epp/docs/branches/6.0/Developer_Guide/en-US/Developer_Guide.xml epp/docs/branches/6.0/Developer_Guide/en-US/Revision_History.xml epp/docs/branches/6.0/Developer_Guide/en-US/chapter-1-GDG_Introduction.xml epp/docs/branches/6.0/Developer_Guide/en-US/chapter-2-GDG_Architectural_choices.xml epp/docs/branches/6.0/Developer_Guide/en-US/chapter-3-GDG_Design_choices.xml epp/docs/branches/6.0/Developer_Guide/en-US/chapter-4-GDG_Portal_Development.xml epp/docs/branches/6.0/Developer_Guide/en-US/chapter-5-GDG_Application_development.xml epp/docs/branches/6.0/Reference_Guide/en-US/Book_Info.xml epp/docs/branches/6.0/Reference_Guide/en-US/Preface.xml epp/docs/branches/6.0/Reference_Guide/en-US/Reference_Guide.ent epp/docs/branches/6.0/Reference_Guide/en-US/Revision_History.xml epp/docs/branches/6.0/Reference_Guide/en-US/modules/Advanced/Foundations/Configuring_Services.xml epp/docs/branches/6.0/Reference_Guide/en-US/modules/Advanced/Foundations/Extensions_And_Multiple_Portals.xml epp/docs/branches/6.0/Reference_Guide/en-US/modules/Advanced/Foundations/Kernel.xml epp/docs/branches/6.0/Reference_Guide/en-US/modules/AuthenticationAndIdentity/AuthenticationAuthorizationOverview.xml epp/docs/branches/6.0/Reference_Guide/en-US/modules/AuthenticationAndIdentity/AuthenticationTokenConfiguration.xml epp/docs/branches/6.0/Reference_Guide/en-US/modules/AuthenticationAndIdentity/BackendConfiguration.xml epp/docs/branches/6.0/Reference_Guide/en-US/modules/AuthenticationAndIdentity/LDAP.xml epp/docs/branches/6.0/Reference_Guide/en-US/modules/AuthenticationAndIdentity/PasswordEncryption.xml epp/docs/branches/6.0/Reference_Guide/en-US/modules/AuthenticationAndIdentity/PredefinedUserConfiguration.xml epp/docs/branches/6.0/Reference_Guide/en-US/modules/AuthenticationAndIdentity/SAML2.xml epp/docs/branches/6.0/Reference_Guide/en-US/modules/AuthenticationAndIdentity/SSO.xml epp/docs/branches/6.0/Reference_Guide/en-US/modules/Introduction.xml epp/docs/branches/6.0/Reference_Guide/en-US/modules/PortalDevelopment/DefaultPortalConfiguration.xml epp/docs/branches/6.0/Reference_Guide/en-US/modules/PortalDevelopment/DefaultPortalNavigationConfiguration.xml epp/docs/branches/6.0/Reference_Guide/en-US/modules/PortalDevelopment/InternationalizationConfiguration.xml epp/docs/branches/6.0/Reference_Guide/en-US/modules/PortalDevelopment/LocalizationConfiguration.xml epp/docs/branches/6.0/Reference_Guide/en-US/modules/PortalDevelopment/NavigationController.xml epp/docs/branches/6.0/Reference_Guide/en-US/modules/PortalDevelopment/PortalLifecycle.xml epp/docs/branches/6.0/Reference_Guide/en-US/modules/PortalDevelopment/Skinning.xml epp/docs/branches/6.0/Reference_Guide/en-US/modules/PortletDevelopment/Standard.xml epp/docs/branches/6.0/Reference_Guide/en-US/modules/WSRP.xml epp/docs/branches/6.0/Reference_Guide/en-US/modules/eXoJCR/jcr-with-gtn/managed-datasources-under-jboss-as.xml epp/docs/branches/6.0/Reference_Guide/en-US/modules/eXoJCR/jcr/configuration/jdbc-data-container-config.xml epp/docs/branches/6.0/Reference_Guide/en-US/modules/eXoJCR/jcr/intro.xml epp/docs/branches/6.0/Reference_Guide/en-US/modules/eXoJCR/jcr/lock-manager-config.xml epp/docs/branches/6.0/Reference_Guide/en-US/modules/eXoJCR/jcr/query-handler-config.xml epp/docs/branches/6.0/Reference_Guide/en-US/modules/eXoJCR/jcr/repository-check-controller.xml epp/docs/branches/6.0/Reference_Guide/en-US/modules/eXoJCR/jcr/searching/fulltext-search-and-settings.xml epp/docs/branches/6.0/Reference_Guide/en-US/modules/eXoJCR/jcr/searching/searching-repository-content.xml epp/docs/branches/6.0/User_Guide/en-US/Book_Info.xml epp/docs/branches/6.0/User_Guide/en-US/Revision_History.xml epp/docs/branches/6.0/User_Guide/en-US/User_Guide.ent epp/docs/branches/6.0/User_Guide/en-US/modules/Further_Documentation.xml epp/docs/branches/6.0/User_Guide/en-US/modules/Introduction.xml epp/docs/branches/6.0/User_Guide/en-US/modules/Supported_Browsers.xml epp/docs/branches/6.0/User_Guide/en-US/modules/account/Account_and_Password_Retrieval.xml epp/docs/branches/6.0/User_Guide/en-US/modules/account/Remember_User_Account.xml epp/docs/branches/6.0/User_Guide/en-US/modules/account/Sign_in_and_Sign_out.xml epp/docs/branches/6.0/User_Guide/en-US/modules/gadgetsAdmin/Manage_Portlets_and_Gadgets.xml epp/docs/branches/6.0/User_Guide/en-US/modules/language/Change_Interface_Language.xml epp/docs/branches/6.0/User_Guide/en-US/modules/language/Multi-Language_Navigation_Nodes.xml epp/docs/branches/6.0/User_Guide/en-US/modules/language/Right_To_Left_Support_(RTL).xml epp/docs/branches/6.0/User_Guide/en-US/modules/portal/EPP_Roles.xml epp/docs/branches/6.0/User_Guide/en-US/modules/portal/Manage_Pages.xml epp/docs/branches/6.0/User_Guide/en-US/modules/portal/Manage_Portals.xml epp/docs/branches/6.0/User_Guide/en-US/modules/portletsUser/Dashboard_Portlet.xml epp/docs/branches/6.0/User_Guide/en-US/modules/portletsUser/Functional_Portlets.xml epp/docs/branches/6.0/User_Guide/en-US/modules/portletsUser/Interface_Portlets.xml epp/docs/branches/6.0/User_Guide/en-US/modules/terms/Gadget_concept.xml epp/docs/branches/6.0/User_Guide/en-US/modules/terms/Navigation_concept.xml epp/docs/branches/6.0/User_Guide/en-US/modules/terms/Portlet_concept.xml epp/docs/branches/6.0/User_Guide/en-US/modules/terms/Public_mode_and_Private_mode.xml Log: Changing all book names to correspond with the new product name change to JBoss Portal Platform Modified: epp/docs/branches/6.0/Admin_Guide/en-US/Administration_Guide.ent =================================================================== --- epp/docs/branches/6.0/Admin_Guide/en-US/Administration_Guide.ent 2012-10-24 06:12:02 UTC (rev 8938) +++ epp/docs/branches/6.0/Admin_Guide/en-US/Administration_Guide.ent 2012-10-25 06:01:34 UTC (rev 8939) @@ -1,19 +1,19 @@ <!-- Product Specifics: --> -<!ENTITY PRODUCT "JBoss Enterprise Portal Platform"> +<!ENTITY PRODUCT "JBoss Portal Platform"> <!-- Book specifics: --> -<!ENTITY BOOKID "Admin Guide"> +<!ENTITY BOOKID "Administration Guide"> <!-- Bugzilla Specifics --> -<!ENTITY BZPRODUCT "JBoss Enterprise Portal Platform 5"> +<!ENTITY BZPRODUCT "JBoss Portal Platform 6"> <!ENTITY BZCOMPONENT "docs-Admin_Guide"> -<!ENTITY BZURL "<ulink url='https://bugzilla.redhat.com/enter_bug.cgi?product=JBoss&perc... +<!ENTITY BZURL "<ulink url='https://bugzilla.redhat.com/enter_bug.cgi?product=JBoss&perc... <!-- Corporate Specifics: --> -<!ENTITY YEAR "2011"> +<!ENTITY YEAR "2012"> <!ENTITY HOLDER "Red Hat, Inc"> <!-- Version Specifcs: --> -<!ENTITY VX "5"> -<!ENTITY VY "5.2"> -<!ENTITY VZ "5.2.0"> \ No newline at end of file +<!ENTITY VX "6"> +<!ENTITY VY "6.0"> +<!ENTITY VZ "6.0.0"> Modified: epp/docs/branches/6.0/Admin_Guide/en-US/Author_Group.xml =================================================================== --- epp/docs/branches/6.0/Admin_Guide/en-US/Author_Group.xml 2012-10-24 06:12:02 UTC (rev 8938) +++ epp/docs/branches/6.0/Admin_Guide/en-US/Author_Group.xml 2012-10-25 06:01:34 UTC (rev 8939) @@ -1,5 +1,8 @@ <?xml version='1.0' encoding='utf-8' ?> -<!DOCTYPE authorgroup PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> +<!DOCTYPE authorgroup PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [ +<!ENTITY % BOOK_ENTITIES SYSTEM "Administration_Guide.ent"> +%BOOK_ENTITIES; +]> <authorgroup> <author> Modified: epp/docs/branches/6.0/Admin_Guide/en-US/Book_Info.xml =================================================================== --- epp/docs/branches/6.0/Admin_Guide/en-US/Book_Info.xml 2012-10-24 06:12:02 UTC (rev 8938) +++ epp/docs/branches/6.0/Admin_Guide/en-US/Book_Info.xml 2012-10-25 06:01:34 UTC (rev 8939) @@ -5,13 +5,13 @@ ]> <bookinfo id="book-Admin_Guide-Admin_Guide"> <title>Administration Guide</title> - <subtitle>For use with JBoss Enterprise Portal Platform 5</subtitle> - <productname>JBoss Enterprise Portal Platform</productname> - <productnumber>5.2</productnumber> - <edition>5.2.2</edition> + <subtitle>for use with JBoss Portal Platform 6 and it&apos;s patch releases.</subtitle> + <productname>JBoss Portal Platform</productname> + <productnumber>6</productnumber> + <edition>6.0.0</edition> <abstract> <para> - This document is a guide to administering an implementation of JBoss Enterprise Portal Platform. It is intended for System Administrators and assumes a high level of technical knowledge. + This document is a guide to administering an implementation of JBoss Portal Platform. It is intended for System Administrators and assumes a high level of technical knowledge. </para> </abstract> <corpauthor> Modified: epp/docs/branches/6.0/Admin_Guide/en-US/Preface.xml =================================================================== --- epp/docs/branches/6.0/Admin_Guide/en-US/Preface.xml 2012-10-24 06:12:02 UTC (rev 8938) +++ epp/docs/branches/6.0/Admin_Guide/en-US/Preface.xml 2012-10-25 06:01:34 UTC (rev 8939) @@ -1,6 +1,6 @@ <?xml version='1.0' encoding='utf-8' ?> <!DOCTYPE preface PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [ -<!ENTITY % BOOK_ENTITIES SYSTEM "Admin_Guide.ent"> +<!ENTITY % BOOK_ENTITIES SYSTEM "Administration_Guide.ent"> %BOOK_ENTITIES; ]> <preface id="pref-Admin_Guide-Preface"> Modified: epp/docs/branches/6.0/Admin_Guide/en-US/Revision_History.xml =================================================================== --- epp/docs/branches/6.0/Admin_Guide/en-US/Revision_History.xml 2012-10-24 06:12:02 UTC (rev 8938) +++ epp/docs/branches/6.0/Admin_Guide/en-US/Revision_History.xml 2012-10-25 06:01:34 UTC (rev 8939) @@ -8,8 +8,8 @@ <simpara> <revhistory> <revision> - <revnumber>5.2.2-100</revnumber> - <date>Tue Sep 5 2012</date> + <revnumber>6.0.0-1</revnumber> + <date>Thu Oct 25 2012</date> <author> <firstname>Jared</firstname> <surname>Morgan</surname> @@ -17,52 +17,10 @@ </author> <revdescription> <simplelist> - <member>Prepared guide for JBoss Enterprise Portal Platform 5.2.2 GA. Refer to 5.2.2 Release Notes for a summary of changes to this guide.</member> + <member>Re-brewed guide for new product name change to JBoss Portal Platform.</member> </simplelist> </revdescription> </revision> - <revision> - <revnumber>5.2.1-100</revnumber> - <date>Tue Apr 17 2012</date> - <author> - <firstname>Jared</firstname> - <surname>Morgan</surname> - <email/> - </author> - <revdescription> - <simplelist> - <member>Prepared guide for JBoss Enterprise Portal Platform 5.2.1 GA. Refer to 5.2.1 Release Notes for a summary of changes to this guide.</member> - </simplelist> - </revdescription> - </revision> - <revision> - <revnumber>5.2.0-100</revnumber> - <date>Wed Dec 14 2011</date> - <author> - <firstname>Scott</firstname> - <surname>Mumford</surname> - <email/> - </author> - <revdescription> - <simplelist> - <member>Publication build.</member> - </simplelist> - </revdescription> - </revision> - <revision> - <revnumber>5.2.0-4</revnumber> - <date>Tue Nov 15 2011</date> - <author> - <firstname>Scott</firstname> - <surname>Mumford</surname> - <email/> - </author> - <revdescription> - <simplelist> - <member>Staged for beta release.</member> - </simplelist> - </revdescription> - </revision> </revhistory> </simpara> </appendix> Modified: epp/docs/branches/6.0/Admin_Guide/en-US/chapter-1-Introduction.xml =================================================================== --- epp/docs/branches/6.0/Admin_Guide/en-US/chapter-1-Introduction.xml 2012-10-24 06:12:02 UTC (rev 8938) +++ epp/docs/branches/6.0/Admin_Guide/en-US/chapter-1-Introduction.xml 2012-10-25 06:01:34 UTC (rev 8939) @@ -1,5 +1,8 @@ <?xml version='1.0' encoding='UTF-8'?> -<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" []> +<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [ +<!ENTITY % BOOK_ENTITIES SYSTEM "Administration_Guide.ent"> +%BOOK_ENTITIES; +]> <chapter id="sid-8094332_GateInManagement-Introduction"> <title>Introduction</title> <para>The management component of the portal allows portal resources to be managed over commons interfaces like REST, CLI, and Portlets/Gadgets. This guide will discuss these interfaces as well as general portal management concepts and terms. It will then discuss specific management extensions included in the portal.</para> Modified: epp/docs/branches/6.0/Admin_Guide/en-US/chapter-2-REST.xml =================================================================== --- epp/docs/branches/6.0/Admin_Guide/en-US/chapter-2-REST.xml 2012-10-24 06:12:02 UTC (rev 8938) +++ epp/docs/branches/6.0/Admin_Guide/en-US/chapter-2-REST.xml 2012-10-25 06:01:34 UTC (rev 8939) @@ -1,5 +1,8 @@ <?xml version="1.0" encoding="UTF-8"?> -<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> +<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [ +<!ENTITY % BOOK_ENTITIES SYSTEM "Administration_Guide.ent"> +%BOOK_ENTITIES; +]> <chapter id="sid-8094332_GateInManagement-REST"> <title>REST</title> Modified: epp/docs/branches/6.0/Admin_Guide/en-US/chapter-3-Command_Line_Interface.xml =================================================================== --- epp/docs/branches/6.0/Admin_Guide/en-US/chapter-3-Command_Line_Interface.xml 2012-10-24 06:12:02 UTC (rev 8938) +++ epp/docs/branches/6.0/Admin_Guide/en-US/chapter-3-Command_Line_Interface.xml 2012-10-25 06:01:34 UTC (rev 8939) @@ -1,5 +1,8 @@ <?xml version='1.0' encoding='UTF-8'?> -<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" []> +<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [ +<!ENTITY % BOOK_ENTITIES SYSTEM "Administration_Guide.ent"> +%BOOK_ENTITIES; +]> <chapter id="sid-8094332_GateInManagement-CommandLineInterface"> <title>Command Line Interface</title> <para>The command line interface (CLI) component provides an interactive shell using CRaSH to map commands to management requests. It connects over SSH, using the CRaSH SSH plugin.</para> @@ -14,7 +17,7 @@ <section id="sid-8094332_GateInManagement-DeployingtheCLI"> <title>Deploying the CLI</title> <para> - The JBoss Enterprise Portal Platform distribution includes an archive of the gatein-management-cli application. + The JBoss Portal Platform distribution includes an archive of the gatein-management-cli application. </para> <para> To deploy the application, copy the <filename><replaceable>&lt;JBOSS_HOME&gt;</replaceable>/gatein-management/gatein-management-cli.war</filename> to the <filename>deploy</filename> directory of your portal profile (<filename><replaceable>&lt;JBOSS_HOME&gt;</replaceable>/server/<replaceable>default</replaceable>/deploy/</filename>, for example). Modified: epp/docs/branches/6.0/Admin_Guide/en-US/chapter-4-Management_Extensions.xml =================================================================== --- epp/docs/branches/6.0/Admin_Guide/en-US/chapter-4-Management_Extensions.xml 2012-10-24 06:12:02 UTC (rev 8938) +++ epp/docs/branches/6.0/Admin_Guide/en-US/chapter-4-Management_Extensions.xml 2012-10-25 06:01:34 UTC (rev 8939) @@ -1,5 +1,8 @@ <?xml version='1.0' encoding='UTF-8'?> -<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" []> +<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [ +<!ENTITY % BOOK_ENTITIES SYSTEM "Administration_Guide.ent"> +%BOOK_ENTITIES; +]> <chapter id="sid-8094332_GateInManagement-ManagementExtensions"> <title>Management Extensions</title> <para>The following management extensions supported in the portal are:</para> Modified: epp/docs/branches/6.0/Admin_Guide/en-US/chapter-5-Administration_and_Monitoring.xml =================================================================== --- epp/docs/branches/6.0/Admin_Guide/en-US/chapter-5-Administration_and_Monitoring.xml 2012-10-24 06:12:02 UTC (rev 8938) +++ epp/docs/branches/6.0/Admin_Guide/en-US/chapter-5-Administration_and_Monitoring.xml 2012-10-25 06:01:34 UTC (rev 8939) @@ -1,9 +1,11 @@ <?xml version='1.0' encoding='UTF-8'?> -<!-- This document was created with Syntext Serna Free. --> -<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" []> +<!-- This document was created with Syntext Serna Free. --><!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [ +<!ENTITY % BOOK_ENTITIES SYSTEM "Administration_Guide.ent"> +%BOOK_ENTITIES; +]> <chapter id="Administration_and_Monitoring"> <title>Administration and Monitoring</title> - <para>JBoss Enterprise Portal Platform provides a JBoss Operations Network plug-in (<firstterm>GateIn JON Plug-in</firstterm>) to assist with monitoring the platform.</para> + <para>JBoss Portal Platform provides a JBoss Operations Network plug-in (<firstterm>GateIn JON Plug-in</firstterm>) to assist with monitoring the platform.</para> <para>The plug-in captures portlet and site statistics. A different set of statistics are collected depending on the context of each portlet. <xref linkend="fig-GateIn_JON_Plug-in_Interface"/> shows the basic JON interface.</para> <figure id="fig-GateIn_JON_Plug-in_Interface"> <title>GateIn JON Plug-in Interface</title> @@ -81,7 +83,7 @@ </section> <section id="Administration_and_Monitoring-Operations"> <title>Operations</title> - <para>The GateIn JON Plug-in itself does not provide any operations; it&apos;s sole purpose is reporting and statistics relating to portlets and sites. The JBoss Operations Network AS plug-in does support many management operations, and is included in JBoss Enterprise Portal Platform binaries. With the AS plug-in, the following non-exhaustive list of actions are possible:</para> + <para>The GateIn JON Plug-in itself does not provide any operations; it&apos;s sole purpose is reporting and statistics relating to portlets and sites. The JBoss Operations Network AS plug-in does support many management operations, and is included in JBoss Portal Platform binaries. With the AS plug-in, the following non-exhaustive list of actions are possible:</para> <itemizedlist> <listitem> <para>Server control: start, stop, restart.</para> Modified: epp/docs/branches/6.0/Admin_Guide/publican.cfg =================================================================== --- epp/docs/branches/6.0/Admin_Guide/publican.cfg 2012-10-24 06:12:02 UTC (rev 8938) +++ epp/docs/branches/6.0/Admin_Guide/publican.cfg 2012-10-25 06:01:34 UTC (rev 8939) @@ -4,5 +4,5 @@ debug: 1 type: Book git_branch: docs-rhel-6 -#show_remarks: 1 +show_remarks: 1 Modified: epp/docs/branches/6.0/Developer_Guide/en-US/Author_Group.xml =================================================================== --- epp/docs/branches/6.0/Developer_Guide/en-US/Author_Group.xml 2012-10-24 06:12:02 UTC (rev 8938) +++ epp/docs/branches/6.0/Developer_Guide/en-US/Author_Group.xml 2012-10-25 06:01:34 UTC (rev 8939) @@ -5,8 +5,4 @@ <firstname>Red Hat</firstname> <surname>Documentation Group</surname> </author> - <author> - <firstname>Thomas</firstname> - <surname>Heute</surname> - </author> </authorgroup> Modified: epp/docs/branches/6.0/Developer_Guide/en-US/Book_Info.xml =================================================================== --- epp/docs/branches/6.0/Developer_Guide/en-US/Book_Info.xml 2012-10-24 06:12:02 UTC (rev 8938) +++ epp/docs/branches/6.0/Developer_Guide/en-US/Book_Info.xml 2012-10-25 06:01:34 UTC (rev 8939) @@ -1,14 +1,17 @@ <?xml version='1.0' encoding='UTF-8'?> -<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" []> +<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [ +<!ENTITY % BOOK_ENTITIES SYSTEM "Developer_Guide.ent"> +%BOOK_ENTITIES; +]> <bookinfo id="book-Developer_Guide-Developer_Guide"> <title>Developer Guide</title> - <subtitle>for use with JBoss Enterprise Portal Platform 6 and its patch releases.</subtitle> - <productname>JBoss Enterprise Portal Platform</productname> - <productnumber>6.0</productnumber> + <subtitle>for use with JBoss Portal Platform &VY; and its patch releases.</subtitle> + <productname>JBoss Portal Platform</productname> + <productnumber>6</productnumber> <edition>6.0.0</edition> <abstract> <para> - This guide is intended to assist developers working with JBoss Enterprise Portal Platform. It assumes a high level of technical knowledge. + This guide is intended to assist developers working with JBoss Portal Platform. It assumes a high level of technical knowledge. </para> </abstract> <corpauthor> Modified: epp/docs/branches/6.0/Developer_Guide/en-US/Developer_Guide.ent =================================================================== --- epp/docs/branches/6.0/Developer_Guide/en-US/Developer_Guide.ent 2012-10-24 06:12:02 UTC (rev 8938) +++ epp/docs/branches/6.0/Developer_Guide/en-US/Developer_Guide.ent 2012-10-25 06:01:34 UTC (rev 8939) @@ -1,19 +1,19 @@ <!-- Product Specifics: --> -<!ENTITY PRODUCT "JBoss Enterprise Portal Platform"> +<!ENTITY PRODUCT "JBoss Portal Platform"> <!-- Book specifics: --> <!ENTITY BOOKID "Developer Guide"> <!-- Bugzilla Specifics --> -<!ENTITY BZPRODUCT "JBoss Enterprise Portal Platform 5"> +<!ENTITY BZPRODUCT "JBoss Portal Platform 6"> <!ENTITY BZCOMPONENT "docs-Developer_Guide"> -<!ENTITY BZURL "<ulink url='https://bugzilla.redhat.com/enter_bug.cgi?product=JBoss&perc... +<!ENTITY BZURL "<ulink url='https://bugzilla.redhat.com/enter_bug.cgi?product=JBoss&perc... <!-- Corporate Specifics: --> -<!ENTITY YEAR "2011"> +<!ENTITY YEAR "2012"> <!ENTITY HOLDER "Red Hat, Inc"> <!-- Version Specifcs: --> -<!ENTITY VX "5"> -<!ENTITY VY "5.2"> -<!ENTITY VZ "5.2.2"> +<!ENTITY VX "6"> +<!ENTITY VY "6.0"> +<!ENTITY VZ "6.0.0"> Modified: epp/docs/branches/6.0/Developer_Guide/en-US/Developer_Guide.xml =================================================================== --- epp/docs/branches/6.0/Developer_Guide/en-US/Developer_Guide.xml 2012-10-24 06:12:02 UTC (rev 8938) +++ epp/docs/branches/6.0/Developer_Guide/en-US/Developer_Guide.xml 2012-10-25 06:01:34 UTC (rev 8939) @@ -1,6 +1,8 @@ <?xml version='1.0' encoding='UTF-8'?> -<!-- This document was created with Syntext Serna Free. --> -<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" []> +<!-- This document was created with Syntext Serna Free. --><!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [ +<!ENTITY % BOOK_ENTITIES SYSTEM "Developer_Guide.ent"> +%BOOK_ENTITIES; +]> <book> <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="Book_Info.xml"/> <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="Preface.xml"/> Modified: epp/docs/branches/6.0/Developer_Guide/en-US/Revision_History.xml =================================================================== --- epp/docs/branches/6.0/Developer_Guide/en-US/Revision_History.xml 2012-10-24 06:12:02 UTC (rev 8938) +++ epp/docs/branches/6.0/Developer_Guide/en-US/Revision_History.xml 2012-10-25 06:01:34 UTC (rev 8939) @@ -5,6 +5,20 @@ <simpara> <revhistory> <revision> + <revnumber>6.0.0-4</revnumber> + <date>Thu Oct 25 2012</date> + <author> + <firstname>Jared</firstname> + <surname>Morgan</surname> + <email/> + </author> + <revdescription> + <simplelist> + <member>Restaged book under the new JBoss Portal Platform banner.</member> + </simplelist> + </revdescription> + </revision> + <revision> <revnumber>6.0.0-3</revnumber> <date>Fri Oct 19 2012</date> <author> Modified: epp/docs/branches/6.0/Developer_Guide/en-US/chapter-1-GDG_Introduction.xml =================================================================== --- epp/docs/branches/6.0/Developer_Guide/en-US/chapter-1-GDG_Introduction.xml 2012-10-24 06:12:02 UTC (rev 8938) +++ epp/docs/branches/6.0/Developer_Guide/en-US/chapter-1-GDG_Introduction.xml 2012-10-25 06:01:34 UTC (rev 8939) @@ -1,9 +1,8 @@ -<?xml version="1.0" encoding="UTF-8"?> -<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> - <chapter id="sid-819799"> - <title>Introduction</title> - - <para> - This is the JBoss Enterprise Portal Platform Developer Guide. This document is intended for those developing applications and gadgets for the JBoss Enterprise Portal Platform product and outlines options and strategies for successful deployment. +<?xml version='1.0' encoding='UTF-8'?> +<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" []> +<chapter id="sid-819799"> + <title>Introduction</title> + <para> + This is the JBoss Portal Platform Developer Guide. This document is intended for those developing applications and gadgets for the JBoss Portal Platform product and outlines options and strategies for successful deployment. </para> - </chapter> +</chapter> Modified: epp/docs/branches/6.0/Developer_Guide/en-US/chapter-2-GDG_Architectural_choices.xml =================================================================== --- epp/docs/branches/6.0/Developer_Guide/en-US/chapter-2-GDG_Architectural_choices.xml 2012-10-24 06:12:02 UTC (rev 8938) +++ epp/docs/branches/6.0/Developer_Guide/en-US/chapter-2-GDG_Architectural_choices.xml 2012-10-25 06:01:34 UTC (rev 8939) @@ -1,161 +1,128 @@ -<?xml version="1.0" encoding="UTF-8"?> -<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> - <chapter id="sid-7372876"> - <title>Architectural choices</title> - - <para> +<?xml version='1.0' encoding='UTF-8'?> +<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" []> +<chapter id="sid-7372876"> + <title>Architectural choices</title> + <para> Depending on environment and goals, decisions have to be made regarding the components that will make up the final website. Some elements may already be in place (such as an identity server) and some elements may still be free to choose. This section aims at helping taking the right decisions. </para> - - <section id="sid-7372876_GDG-Architecturalchoices-Identityserver"> - <title>Identity server</title> - - <para> - JBoss Enterprise Portal Platform &VY; comes with a component named PicketLink IDM, which is made to adapt to store and retrieve users and groups from various identity servers. We can separate the different options into three: + <section id="sid-7372876_GDG-Architecturalchoices-Identityserver"> + <title>Identity server</title> + <para> +JBoss Portal Platform &VY; comes with a component named PicketLink IDM, which is made to adapt to store and retrieve users and groups from various identity servers. We can separate the different options into three: </para> - - <orderedlist> - <listitem> - <para> + <orderedlist> + <listitem> + <para> <emphasis role="strong">Database</emphasis> : users, groups and their relationships are stored in a RDBMS database. Table names and column names can be changed, but the overall relationship between tables remains the same. This solution is particularly adapted to a new identity server that will handle thousands of users. </para> - </listitem> - - <listitem> - <para> + </listitem> + <listitem> + <para> <emphasis role="strong">LDAP</emphasis> : users, groups and their relationships are stored in an LDAP (or ActiveDirectory) server, the directory structure can be adapted by configuration to the most common scenarios. This solution is particularly suited to infrastructures that already use an LDAP server, infrastructures that will share the server identity among multiple services (and the website being one of them) or for very large sets of users (millions). When using LDAP with large number of users, it is recommended to use LDAP tools to do the provisioning of users. </para> - </listitem> - - <listitem> - <para> + </listitem> + <listitem> + <para> <emphasis role="strong">Custom</emphasis> : when retrieving users, groups and their relationship cannot be done by configuration, it is possible to use the Picketlink IDM SPI to implement the methods which control retrieving and storing user information. </para> - </listitem> - </orderedlist> - - <para> + </listitem> + </orderedlist> + <para> Picketlink IDM also supports mix environments, which is very useful when an LDAP infrastructure is provided in a read-only mode. Since a website may need to store additional information about users (such as their preferred language or skin), it can combine LDAP and database services to retrieve users from LDAP and store additional properties in a database. During the calls to the identity API, the information from both sources will be transparently merged. </para> - - <para> - For more information about PicketLink IDM, please check the JBoss Enterprise Portal Platform &VY; reference guide and the PicketLink IDM documentation. + <para> + For more information about PicketLink IDM, please check the JBoss Portal Platform &VY; reference guide and the PicketLink IDM documentation. </para> - </section> - - <section id="sid-7372876_GDG-Architecturalchoices-Storage"> - <title>Storage</title> - - <para> + </section> + <section id="sid-7372876_GDG-Architecturalchoices-Storage"> + <title>Storage</title> + <para> The portal framework stores page compositions, portlet preferences, gadget code in a database through a Java Content Repository (JCR) API. A set of database servers and JDBC connectors are part of our quality assurance cycles and the certified environments are mentioned <ulink url="http://www.jboss.com/products/platforms/portals/testedconfigura... . </para> - - <para> + <para> It is important to choose one of the combinations or check with a Red Hat contact for specific environments that would differ from this list. </para> - - <para> + <para> The database schema will be automatically created during the very first start up of a website and then it is required that the database users have sufficient rights to create tables. This privilege can be revoked after the initial start up, also the database content can be exported and imported in a new server. This makes the installation of the product very easy in most cases. </para> - - <para> + <para> We do not provide additional recommendations to choose one database server over another as long as it is one of the certified environments. </para> - - <para> - As said earlier, content is stored through a JCR API, RDBMS aren't a great fit to store large files and it is possible to configure eXo JCR to store such files in the filesystem instead of a database, whereas metadata about the files would still be stored in the database. Note that if the website is running on a cluster, the filesystem will need to be accessible from all the nodes and a NFS solution needs to be set up. For more details see the notion of "value storage" in the reference guide. + <para> + As said earlier, content is stored through a JCR API, RDBMS aren&apos;t a great fit to store large files and it is possible to configure eXo JCR to store such files in the filesystem instead of a database, whereas metadata about the files would still be stored in the database. Note that if the website is running on a cluster, the filesystem will need to be accessible from all the nodes and a NFS solution needs to be set up. For more details see the notion of &quot;value storage&quot; in the reference guide. </para> - </section> - - <section id="sid-7372876_GDG-Architecturalchoices-Cluster"> - <title>Cluster</title> - - <para> - Clustering for failover or load-balancing requirements requires spending more time configuring it for your environment, we made it easy to handle common situations though. There is a cost associated with clustering (JBoss Enterprise Portal Platform &VY; has some optimizations when running on a single node), but the product is designed to linearly scale up so that the same performance is added every time a new node is added. All critical parts are kept in sync among nodes and the less critical ones are left aside to achieve better performance. It will be equally critical that applications developed for the final websites pay the same attention when it comes to replicating data across a cluster of nodes. + </section> + <section id="sid-7372876_GDG-Architecturalchoices-Cluster"> + <title>Cluster</title> + <para> + Clustering for failover or load-balancing requirements requires spending more time configuring it for your environment, we made it easy to handle common situations though. There is a cost associated with clustering (JBoss Portal Platform &VY; has some optimizations when running on a single node), but the product is designed to linearly scale up so that the same performance is added every time a new node is added. All critical parts are kept in sync among nodes and the less critical ones are left aside to achieve better performance. It will be equally critical that applications developed for the final websites pay the same attention when it comes to replicating data across a cluster of nodes. </para> - - <para> + <para> The number of nodes will vary a lot depending on the applications developed and used on the final website. We recommend to do early performance analysis with tools such as JMeter, Grinder or similar to measure the impact of heavy loads. </para> - - <para> + <para> It is usually recommended to run a cluster to achieve high availability. </para> - </section> - - <section id="sid-7372876_GDG-Architecturalchoices-SSO"> - <title>SSO</title> - - <para> - If a website is a part of a more global infrastructure with various components (the website being one of several), it may be in the benefit of users to use a Single-Sign-On solution. Various SSO solutions are supported by JBoss Enterprise Portal Platform &VY; as seen <ulink url="http://www.jboss.com/products/platforms/portals/testedconfigura... . In some cases it can be better to have the token manager service on a specific server. + </section> + <section id="sid-7372876_GDG-Architecturalchoices-SSO"> + <title>SSO</title> + <para> + If a website is a part of a more global infrastructure with various components (the website being one of several), it may be in the benefit of users to use a Single-Sign-On solution. Various SSO solutions are supported by JBoss Portal Platform &VY; as seen <ulink url="http://www.jboss.com/products/platforms/portals/testedconfigura... . In some cases it can be better to have the token manager service on a specific server. </para> - - <section id="sid-7372876_GDG-Architecturalchoices-Summary"> - <title>Summary</title> - - <para> + <section id="sid-7372876_GDG-Architecturalchoices-Summary"> + <title>Summary</title> + <para> By now you should know what infrastructure you will need: </para> - - <itemizedlist> - <listitem> - <para> + <itemizedlist> + <listitem> + <para> A database </para> - </listitem> - - <listitem> - <para> + </listitem> + <listitem> + <para> Optionally LDAP, depending on your choice </para> - </listitem> - - <listitem> - <para> + </listitem> + <listitem> + <para> Optionally NFS, depending on the configuration (mandatory on a cluster with default settings) </para> - </listitem> - - <listitem> - <para> + </listitem> + <listitem> + <para> Optionally an SSO token service </para> - </listitem> - - <listitem> - <para> + </listitem> + <listitem> + <para> Optionally a cluster of nodes </para> - </listitem> - </itemizedlist> - - <para> + </listitem> + </itemizedlist> + <para> Here is an example of the simplest set-up: </para> - - <figure> - <title>Example</title> - - <mediaobject> - <imageobject role="html"> - <imagedata fileref="images/7372876/simpleinfra.png" format="PNG" align="center" scale="100"/> - </imageobject> - </mediaobject> - </figure> - - <para> + <figure> + <title>Example</title> + <mediaobject> + <imageobject role="html"> + <imagedata align="center" scale="100" fileref="images/7372876/simpleinfra.png" format="PNG"/> + </imageobject> + </mediaobject> + </figure> + <para> Here is an example of a more complex set-up: </para> - - <figure> - <title>Example</title> - - <mediaobject> - <imageobject role="html"> - <imagedata fileref="images/7372876/complexinfra.png" format="PNG" align="center" scale="100"/> - </imageobject> - </mediaobject> - </figure> - </section> - </section> - </chapter> + <figure> + <title>Example</title> + <mediaobject> + <imageobject role="html"> + <imagedata align="center" scale="100" fileref="images/7372876/complexinfra.png" format="PNG"/> + </imageobject> + </mediaobject> + </figure> + </section> + </section> +</chapter> Modified: epp/docs/branches/6.0/Developer_Guide/en-US/chapter-3-GDG_Design_choices.xml =================================================================== --- epp/docs/branches/6.0/Developer_Guide/en-US/chapter-3-GDG_Design_choices.xml 2012-10-24 06:12:02 UTC (rev 8938) +++ epp/docs/branches/6.0/Developer_Guide/en-US/chapter-3-GDG_Design_choices.xml 2012-10-25 06:01:34 UTC (rev 8939) @@ -1,184 +1,149 @@ -<?xml version="1.0" encoding="UTF-8"?> -<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> - <chapter id="sid-7372952"> - <title>Design choices</title> - - <para> +<?xml version='1.0' encoding='UTF-8'?> +<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" []> +<chapter id="sid-7372952"> + <title>Design choices</title> + <para> Now that the main components of the architecture have been decided, choices must be made on the overall design. </para> - - <section id="sid-7372952_GDG-Designchoices-Dashboards"> - <title>Dashboards</title> - - <para> + <section id="sid-7372952_GDG-Designchoices-Dashboards"> + <title>Dashboards</title> + <para> User dashboards may be very costly in a website. Each user has an opportunity to design his own personal website, it comes with the cost of storing all that information. Efforts have been made (and are still being made) to reduce this cost, but there will always be an overhead. </para> - - <para> + <para> This overhead might be hard to estimate as this will depend a lot on how the users will navigate through the website. Maybe only a minority will use this functionality, or maybe the website is only made of dashboards. In any case the impact of making this feature available must be measured by: </para> - - <itemizedlist> - <listitem> - <para> + <itemizedlist> + <listitem> + <para> estimating the number of dashboards and pages that will be created </para> - </listitem> - - <listitem> - <para> + </listitem> + <listitem> + <para> observing the impact on the database (through JCR) in terms of size </para> - </listitem> - </itemizedlist> - </section> - - <section id="sid-7372952_GDG-Designchoices-JCRindexreplicationforclusterset-up"> - <title>JCR index replication for cluster set-up</title> - - <para> + </listitem> + </itemizedlist> + </section> + <section id="sid-7372952_GDG-Designchoices-JCRindexreplicationforclusterset-up"> + <title>JCR index replication for cluster set-up</title> + <para> The JCR implementation uses Apache Lucene for indexing the data. The indexes are used to search for content (It can be page nodes or WCM content for instance). </para> - - <para> - Lucene isn't cluster-ready, but on a cluster, each node will need to be able to search for content and will need to have access to the lucene indexes. + <para> + Lucene isn&apos;t cluster-ready, but on a cluster, each node will need to be able to search for content and will need to have access to the lucene indexes. </para> - - <para> + <para> When it comes to searching, there is always a tradeoff. Everyone would want to achieve all of the following: </para> - - <itemizedlist> - <listitem> - <para> + <itemizedlist> + <listitem> + <para> Fast to search </para> - </listitem> - - <listitem> - <para> + </listitem> + <listitem> + <para> Fast to index </para> - </listitem> - - <listitem> - <para> + </listitem> + <listitem> + <para> Same search result on each node at the same time </para> - </listitem> - - <listitem> - <para> + </listitem> + <listitem> + <para> No need to rebuild the index ever (No inconsistency) </para> - </listitem> - - <listitem> - <para> + </listitem> + <listitem> + <para> No impact on overall performance </para> - </listitem> - - <listitem> - <para> + </listitem> + <listitem> + <para> Easy to set-up (no infrastructure change) </para> - </listitem> - </itemizedlist> - - <para> - But there are choices to be made. The JCR implementation used by JBoss Enterprise Portal Platform (eXo JCR) makes it possible to configure the storage and retrieval of indexes according to architect's choice on where it is acceptable to relax some constraints. For configuration details please refer to the JBoss Enterprise Portal Platform Reference Guide. + </listitem> + </itemizedlist> + <para> + But there are choices to be made. The JCR implementation used by JBoss Portal Platform (eXo JCR) makes it possible to configure the storage and retrieval of indexes according to architect&apos;s choice on where it is acceptable to relax some constraints. For configuration details please refer to the JBoss Portal Platform Reference Guide. </para> - - <section id="sid-7372952_GDG-Designchoices-Standaloneindex"> - <title>Standalone index</title> - - <para> + <section id="sid-7372952_GDG-Designchoices-Standaloneindex"> + <title>Standalone index</title> + <para> This is only for a non-cluster environment, this is obviously the easiest set-up, with a combination of in-memory and file based indexes. There is no replication involved so any entry can be found by a search as soon as it is created. </para> - - <figure> - <title>Example</title> - <mediaobject> - <imageobject role="html"> - <imagedata fileref="images/7372952/diagram-standalone-index.png" format="PNG" align="center" scale="100"/> - </imageobject> - </mediaobject> - </figure> - </section> - - <section id="sid-7372952_GDG-Designchoices-Localindex"> - <title>Local index</title> - - <para> + <figure> + <title>Example</title> + <mediaobject> + <imageobject role="html"> + <imagedata align="center" scale="100" fileref="images/7372952/diagram-standalone-index.png" format="PNG"/> + </imageobject> + </mediaobject> + </figure> + </section> + <section id="sid-7372952_GDG-Designchoices-Localindex"> + <title>Local index</title> + <para> This environment is easy to set up, each node keeps a local copy of the full indexes so that when a search is requested on a node, there is no network communication required. The downside is that when a node indexes an item, it is required to replicate that index on each and every node. If a node is unavailable at that time, it may miss an index update request and then the different nodes may be inconsistent. </para> - - <para> - Also when a node is added, it has to recreate it's own full index. + <para> + Also when a node is added, it has to recreate it&apos;s own full index. </para> - - <para> - An alternative to this set-up is to ask a node to retrieve the info from a coordinator on each search, which makes the startup of the new node faster, but impacts its performance during the runtime. This set-up is new to JBoss Enterprise Portal Platform &VY;. + <para> + An alternative to this set-up is to ask a node to retrieve the info from a coordinator on each search, which makes the startup of the new node faster, but impacts its performance during the runtime. This set-up is new to JBoss Portal Platform &VY;. </para> - - <figure> - <title>Example</title> - - <mediaobject> - <imageobject role="html"> - <imagedata fileref="images/7372952/diagram-local-index.png" format="PNG" align="center" scale="100"/> - </imageobject> - </mediaobject> - </figure> - </section> - - <section id="sid-7372952_GDG-Designchoices-Sharedindex"> - <title>Shared index</title> - - <para> + <figure> + <title>Example</title> + <mediaobject> + <imageobject role="html"> + <imagedata align="center" scale="100" fileref="images/7372952/diagram-local-index.png" format="PNG"/> + </imageobject> + </mediaobject> + </figure> + </section> + <section id="sid-7372952_GDG-Designchoices-Sharedindex"> + <title>Shared index</title> + <para> In this set-up there is a unique index created and shared among all the nodes. It is required to configure the infrastructure so that a network file system is installed where all nodes can read content. </para> - - <para> + <para> Advantages: </para> - - <itemizedlist> - <listitem> - <para> + <itemizedlist> + <listitem> + <para> Consistency, all the nodes see the same data </para> - </listitem> - </itemizedlist> - - <para> + </listitem> + </itemizedlist> + <para> Drawback: </para> - - <itemizedlist> - <listitem> - <para> + <itemizedlist> + <listitem> + <para> Requires a highly available NFS set-up (NFS 3 is recommended) </para> - </listitem> - - <listitem> - <para> + </listitem> + <listitem> + <para> More network communication </para> - </listitem> - </itemizedlist> - - <figure> - <title>Example</title> - - <mediaobject> - <imageobject role="html"> - <imagedata fileref="images/7372952/diagram-shared-index.png" format="PNG" align="center" scale="100"/> - </imageobject> - </mediaobject> - </figure> - </section> - </section> - </chapter> + </listitem> + </itemizedlist> + <figure> + <title>Example</title> + <mediaobject> + <imageobject role="html"> + <imagedata align="center" scale="100" fileref="images/7372952/diagram-shared-index.png" format="PNG"/> + </imageobject> + </mediaobject> + </figure> + </section> + </section> +</chapter> Modified: epp/docs/branches/6.0/Developer_Guide/en-US/chapter-4-GDG_Portal_Development.xml =================================================================== --- epp/docs/branches/6.0/Developer_Guide/en-US/chapter-4-GDG_Portal_Development.xml 2012-10-24 06:12:02 UTC (rev 8938) +++ epp/docs/branches/6.0/Developer_Guide/en-US/chapter-4-GDG_Portal_Development.xml 2012-10-25 06:01:34 UTC (rev 8939) @@ -1,120 +1,95 @@ -<?xml version="1.0" encoding="UTF-8"?> -<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> - <chapter id="sid-8094155"> - <title>Portal Development</title> - - <section id="sid-7372962"> - <title>Portal containers</title> - - <para> - In a single instance (or cluster) of JBoss Enterprise Portal Platform, multiple portals can be running and share resources with other portals with two levels of granularity: +<?xml version='1.0' encoding='UTF-8'?> +<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" []> +<chapter id="sid-8094155"> + <title>Portal Development</title> + <section id="sid-7372962"> + <title>Portal containers</title> + <para> + In a single instance (or cluster) of JBoss Portal Platform, multiple portals can be running and share resources with other portals with two levels of granularity: </para> - - <itemizedlist> - <listitem> - <para> - Portal Containers: A portal container can host multiple sites, and a JBoss Enterprise Portal Platform instance can host multiple portal containers + <itemizedlist> + <listitem> + <para> + Portal Containers: A portal container can host multiple sites, and a JBoss Portal Platform instance can host multiple portal containers </para> - </listitem> - - <listitem> - <para> + </listitem> + <listitem> + <para> Site: A site can have a unique identity, with its own skin applied to a set of pages. </para> - </listitem> - </itemizedlist> - - <para> - The biggest granularity is what is called "Portal Containers". A Portal Container can host multiple "Sites". Those two components have a unique identifier that can be found in the default URL mapping according to the following scheme: <code> <ulink url="http://localhost:8080/"/>&lt;portalcontainer&gt;/&lt;site&gt; </code> + </listitem> + </itemizedlist> + <para> + The biggest granularity is what is called &quot;Portal Containers&quot;. A Portal Container can host multiple &quot;Sites&quot;. Those two components have a unique identifier that can be found in the default URL mapping according to the following scheme: <code><ulink url="http://localhost:8080/"/>&lt;portalcontainer&gt;/&lt;site&gt; </code> </para> - - <para> - When creating a website, it is possible to create a portal container from scratch or extend an existing one. It is then possible to extend the portal container which is accessed at <ulink url="http://localhost:8080/portal"/> on the out of the box solution, this is the recommended way. While running multiple portal containers is possible, it's usually better to keep those on separate installations. Note that multiple websites can run in a single portal container and share some services. + <para> + When creating a website, it is possible to create a portal container from scratch or extend an existing one. It is then possible to extend the portal container which is accessed at <ulink url="http://localhost:8080/portal"/> on the out of the box solution, this is the recommended way. While running multiple portal containers is possible, it&apos;s usually better to keep those on separate installations. Note that multiple websites can run in a single portal container and share some services. </para> - - <para> - By providing an extension you can benefit from the portal provided by JBoss Enterprise Portal Platform and be able to customize the parts you want. The benefit over directly modifying the shipped files is that it will make the updates much easier (by just replacing the archives provided by JBoss Enterprise Portal Platform). + <para> + By providing an extension you can benefit from the portal provided by JBoss Portal Platform and be able to customize the parts you want. The benefit over directly modifying the shipped files is that it will make the updates much easier (by just replacing the archives provided by JBoss Portal Platform). <figure> - <title>Example</title> - - <mediaobject> - <imageobject role="html"> - <imagedata fileref="images/7372962/portalextensionstructure.png" format="PNG" align="center" scale="100"/> - </imageobject> - - <imageobject role="fo"> - <imagedata fileref="images/7372962/portalextensionstructure.png" format="PNG" align="center" width="150mm"/> - </imageobject> - </mediaobject> - </figure> + <title>Example</title> + <mediaobject> + <imageobject role="html"> + <imagedata align="center" scale="100" fileref="images/7372962/portalextensionstructure.png" format="PNG"/> + </imageobject> + <imageobject role="fo"> + <imagedata width="150mm" align="center" fileref="images/7372962/portalextensionstructure.png" format="PNG"/> + </imageobject> + </mediaobject> + </figure> </para> - - <section id="sid-7372962_GDG-Portalcontainers-Portalextension"> - <title>Portal extension</title> - - <para> + <section id="sid-7372962_GDG-Portalcontainers-Portalextension"> + <title>Portal extension</title> + <para> A portal extension is packaged as an Enterprise ARchive (EAR), a configuration file allows to define which services are required and by ordering those, it is possible to modify some elements. It can be a configuration setting, a translation, a visual template, a page to add. </para> - - <para> + <para> Portal extensions can shadow existing services, a portal will usually be composed of various extensions, which usually add services. </para> - - <figure> - <title>Example</title> - - <mediaobject> - <imageobject role="html"> - <imagedata fileref="images/7372962/portalExtensions.png" format="PNG" align="center" scale="100"/> - </imageobject> - </mediaobject> - </figure> - - <para> + <figure> + <title>Example</title> + <mediaobject> + <imageobject role="html"> + <imagedata align="center" scale="100" fileref="images/7372962/portalExtensions.png" format="PNG"/> + </imageobject> + </mediaobject> + </figure> + <para> In a portal extension, elements are shadowed by using the same directory location, so if you want to rewrite the groovy template of the HomePagePortlet which is located in <filename>gatein.ear/02portal.war/templates/groovy/webui/component/UIHomePagePortlet.gtmpl</filename>, it would be in an extension at a location such as <filename>myExtension/myWar.war/templates/groovy/webui/component/UIHomePagePortlet.gtmpl</filename>. The ordering will be defined by the portal extension configuration. </para> - </section> - </section> - - <section id="sid-8094158"> - <title>Visual identity</title> - - <para> + </section> + </section> + <section id="sid-8094158"> + <title>Visual identity</title> + <para> A portal visual identity is made of HTML produced as a result of portal aggregation (the components that make a page like columns and rows combined with the content produced by the portlets) and associated CSS files. </para> - - <para> - JBoss Enterprise Portal Platform allows to deploy multiple skins consisting of CSS files, which makes it possible to apply styling to the page compositions and components of a page (portlets). Different skins can be applied to the different websites, also if made available to the users, they can choose their preferred skin. + <para> +JBoss Portal Platform allows to deploy multiple skins consisting of CSS files, which makes it possible to apply styling to the page compositions and components of a page (portlets). Different skins can be applied to the different websites, also if made available to the users, they can choose their preferred skin. </para> - - <section id="sid-8094158_GDG-Visualidentity-Customizingtheloginpage"> - <title>Customizing the login page</title> - - <para> + <section id="sid-8094158_GDG-Visualidentity-Customizingtheloginpage"> + <title>Customizing the login page</title> + <para> When accessing a page that requires privileges, a login page is shown and it can be customized by using an extension. To do so, it would be enough to copy the file located at: </para> - - <example> - <title>Login JSP</title> -<programlisting>gatein.ear/02portal.war/login/jsp/login.jsp</programlisting> - </example> - - <para> + <example> + <title>Login JSP</title> + <programlisting>gatein.ear/02portal.war/login/jsp/login.jsp</programlisting> + </example> + <para> and include it in a portal extension such as myExtension.ear/myWar.war/login/jsp/login.jsp </para> - - <para> + <para> All the logic must be carefully kept in the login page so that the portal will keep working as it should. </para> - - <para> + <para> To modify the modal window which pops up when the user decides to sign-in, the extension would have a modified copy of: </para> - - <example> - <title>Login Form</title> -<programlisting>gatein.ear/02portal.war/groovy/portal/webui/UILoginForm.gtmpl</programlisting> - </example> - </section> - </section> - </chapter> + <example> + <title>Login Form</title> + <programlisting>gatein.ear/02portal.war/groovy/portal/webui/UILoginForm.gtmpl</programlisting> + </example> + </section> + </section> +</chapter> Modified: epp/docs/branches/6.0/Developer_Guide/en-US/chapter-5-GDG_Application_development.xml =================================================================== --- epp/docs/branches/6.0/Developer_Guide/en-US/chapter-5-GDG_Application_development.xml 2012-10-24 06:12:02 UTC (rev 8938) +++ epp/docs/branches/6.0/Developer_Guide/en-US/chapter-5-GDG_Application_development.xml 2012-10-25 06:01:34 UTC (rev 8939) @@ -1,49 +1,38 @@ -<?xml version="1.0" encoding="UTF-8"?> -<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> - <chapter id="sid-819803"> - <title>Application development</title> - - <section id="sid-819807"> - <title>Gadget Development</title> - - <section id="sid-819807_GDG-GadgetDevelopment-Introduction"> - <title>Introduction</title> - - <para> - In the context of JBoss Enterprise Portal Platform, gadgets are defined by the Google OpenSocial specifications. Since JBoss Enterprise Portal Platform &VY;, the portal framework includes Apache Shindig 2.0 which is made to support the version 0.9 and 1.0 of OpenSocial. +<?xml version='1.0' encoding='UTF-8'?> +<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" []> +<chapter id="sid-819803"> + <title>Application development</title> + <section id="sid-819807"> + <title>Gadget Development</title> + <section id="sid-819807_GDG-GadgetDevelopment-Introduction"> + <title>Introduction</title> + <para> + In the context of JBoss Portal Platform, gadgets are defined by the Google OpenSocial specifications. Since JBoss Portal Platform &VY;, the portal framework includes Apache Shindig 2.0 which is made to support the version 0.9 and 1.0 of OpenSocial. </para> - - <para> - Within a portal, it is possible to embed any OpenSocial gadget in a page or in a user's dashboard. Gadgets can be added to the application registry and links can be added to the mini-composer (see the JBoss Enterprise Portal Platform User Guide). + <para> + Within a portal, it is possible to embed any OpenSocial gadget in a page or in a user&apos;s dashboard. Gadgets can be added to the application registry and links can be added to the mini-composer (see the JBoss Portal Platform User Guide). </para> - </section> - - <section id="sid-819807_GDG-GadgetDevelopment-DevelopingGadgets"> - <title>Developing Gadgets</title> - - <para> + </section> + <section id="sid-819807_GDG-GadgetDevelopment-DevelopingGadgets"> + <title>Developing Gadgets</title> + <para> OpenSocial gadgets are made of standard HTML and JavaScript. The container offers an API, the documentation for which is available <ulink url="http://opensocial-resources.googlecode.com/svn/spec/1.0/Core-Ga... . </para> - - <para> + <para> Note that, unlike portlets, a gadget has very little knowledge of its context (the portal) and its integration within the portal may be more limited (in terms of visual integration for instance). </para> - - <para> - While Google Web Toolkit (GWT) applications can also technically be used as gadgets and GWT makes it easy to write user-friendly applications, we do not recommend its usage as its support can be limited and Google's strategy to keep GWT applications running as gadgets cannot clearly be established. Consequently, GWT applications are not supported by the JBoss Enterprise Portal Platform support agreement. + <para> + While Google Web Toolkit (GWT) applications can also technically be used as gadgets and GWT makes it easy to write user-friendly applications, we do not recommend its usage as its support can be limited and Google&apos;s strategy to keep GWT applications running as gadgets cannot clearly be established. Consequently, GWT applications are not supported by the JBoss Portal Platform support agreement. </para> - </section> - </section> - - <section id="sid-819805"> - <title>Portlet Development</title> - - <para> - JBoss Enterprise Portal interface is fully customized with applications called portlets. Application development can be done by using the plain Portlet specification JSR-286 (refer to the "Portlet Primer" chapter in the JBoss Enterprise Portal Platform Reference Guide for more information), but it is also possible to use the JBoss Portlet Bridge to write applications with JSF and/or RichFaces and/or Seam (refer to the "Getting started with JBoss Portlet Bridge" chapter of the JBoss Enterprise Portal Platform Reference Guide). + </section> + </section> + <section id="sid-819805"> + <title>Portlet Development</title> + <para> + JBoss Enterprise Portal interface is fully customized with applications called portlets. Application development can be done by using the plain Portlet specification JSR-286 (refer to the &quot;Portlet Primer&quot; chapter in the JBoss Portal Platform Reference Guide for more information), but it is also possible to use the JBoss Portlet Bridge to write applications with JSF and/or RichFaces and/or Seam (refer to the &quot;Getting started with JBoss Portlet Bridge&quot; chapter of the JBoss Portal Platform Reference Guide). </para> - - <para> + <para> Depending on the complexity of the application and the familiarity of the team with JSF, one approach or the other can be the right choice for your team. </para> - </section> - </chapter> + </section> +</chapter> Modified: epp/docs/branches/6.0/Reference_Guide/en-US/Book_Info.xml =================================================================== --- epp/docs/branches/6.0/Reference_Guide/en-US/Book_Info.xml 2012-10-24 06:12:02 UTC (rev 8938) +++ epp/docs/branches/6.0/Reference_Guide/en-US/Book_Info.xml 2012-10-25 06:01:34 UTC (rev 8939) @@ -5,13 +5,13 @@ ]> <bookinfo id="book-Reference_Guide-Reference_Guide"> <title>Reference Guide</title> - <subtitle>for use with JBoss Enterprise Portal Platform 6.0, and its patch releases.</subtitle> - <productname>JBoss Enterprise Portal Platform</productname> - <productnumber>6.0</productnumber> + <subtitle>for use with JBoss Portal Platform and its patch releases.</subtitle> + <productname>JBoss Portal Platform</productname> + <productnumber>6</productnumber> <edition>6.0.0</edition> <abstract> <para> - This Reference Guide is a high-level usage document. It deals with more advanced topics than the Installation and User Guides, adding new content or taking concepts discussed in the earlier documents further. It aims to provide supporting documentation for advanced users of the JBoss Enterprise Portal Platform product. Its primary focus is on advanced use of the product and it assumes an intermediate or advanced knowledge of the technology and terms. + This Reference Guide is a high-level usage document. It deals with more advanced topics than the Installation and User Guides, adding new content or taking concepts discussed in the earlier documents further. It aims to provide supporting documentation for advanced users of the JBoss Portal Platform product. Its primary focus is on advanced use of the product and it assumes an intermediate or advanced knowledge of the technology and terms. </para> </abstract> <corpauthor> Modified: epp/docs/branches/6.0/Reference_Guide/en-US/Preface.xml =================================================================== --- epp/docs/branches/6.0/Reference_Guide/en-US/Preface.xml 2012-10-24 06:12:02 UTC (rev 8938) +++ epp/docs/branches/6.0/Reference_Guide/en-US/Preface.xml 2012-10-25 06:01:34 UTC (rev 8939) @@ -19,7 +19,7 @@ <listitem> <para>The installation root of the JBoss Enterprise Application Platform instance. This folder contains the main folders that comprise the server such as <filename>/jboss-as</filename>. </para> - <para>For example, if the JBoss Enterprise Portal Platform instance is deployed into the <filename>/opt/jboss/jboss-epp-&VY;/</filename> directory, the <replaceable>EPP_DIST</replaceable> directory is <filename>/opt/jboss/jboss-epp-&VY;</filename>. + <para>For example, if the JBoss Portal Platform instance is deployed into the <filename>/opt/jboss/jboss-epp-&VY;/</filename> directory, the <replaceable>EPP_DIST</replaceable> directory is <filename>/opt/jboss/jboss-epp-&VY;</filename>. </para> </listitem> </varlistentry> @@ -28,7 +28,7 @@ <replaceable>PORTAL_SSO</replaceable> </term> <listitem> - <para>The zip file located in the <filename><filename>EPP_DIST</filename>/gatein-sso</filename> directory of the JBoss Enterprise Portal Platform binary package. Used throughout <xref linkend="sect-Reference_Guide-SSO_Single_Sign_On"/>.</para> + <para>The zip file located in the <filename><filename>EPP_DIST</filename>/gatein-sso</filename> directory of the JBoss Portal Platform binary package. Used throughout <xref linkend="sect-Reference_Guide-SSO_Single_Sign_On"/>.</para> </listitem> </varlistentry> <varlistentry> Modified: epp/docs/branches/6.0/Reference_Guide/en-US/Reference_Guide.ent =================================================================== --- epp/docs/branches/6.0/Reference_Guide/en-US/Reference_Guide.ent 2012-10-24 06:12:02 UTC (rev 8938) +++ epp/docs/branches/6.0/Reference_Guide/en-US/Reference_Guide.ent 2012-10-25 06:01:34 UTC (rev 8939) @@ -1,13 +1,13 @@ <!-- Product Specifics: --> -<!ENTITY PRODUCT "JBoss Enterprise Portal Platform"> +<!ENTITY PRODUCT "JBoss Portal Platform"> <!-- Book specifics: --> <!ENTITY BOOKID "Reference Guide"> <!-- Bugzilla Specifics --> -<!ENTITY BZPRODUCT "JBoss Enterprise Portal Platform 6"> +<!ENTITY BZPRODUCT "JBoss Portal Platform 6"> <!ENTITY BZCOMPONENT "docs-Reference_Guide"> -<!ENTITY BZURL "<ulink url='https://bugzilla.redhat.com/enter_bug.cgi?product=JBoss&perc... +<!ENTITY BZURL "<ulink url='https://bugzilla.redhat.com/enter_bug.cgi?product=JBoss&perc... <!-- Corporate Specifics: --> <!ENTITY YEAR "2012"> Modified: epp/docs/branches/6.0/Reference_Guide/en-US/Revision_History.xml =================================================================== --- epp/docs/branches/6.0/Reference_Guide/en-US/Revision_History.xml 2012-10-24 06:12:02 UTC (rev 8938) +++ epp/docs/branches/6.0/Reference_Guide/en-US/Revision_History.xml 2012-10-25 06:01:34 UTC (rev 8939) @@ -8,6 +8,20 @@ <simpara> <revhistory> <revision> + <revnumber>6.0.0-12</revnumber> + <date>Mon Oct 25 2012</date> + <author> + <firstname>Jared</firstname> + <surname>Morgan</surname> + <email/> + </author> + <revdescription> + <simplelist> + <member>Restaging book under the JBoss Portal Platform name.</member> + </simplelist> + </revdescription> + </revision> + <revision> <revnumber>6.0.0-11</revnumber> <date>Mon Oct 24 2012</date> <author> Modified: epp/docs/branches/6.0/Reference_Guide/en-US/modules/Advanced/Foundations/Configuring_Services.xml =================================================================== --- epp/docs/branches/6.0/Reference_Guide/en-US/modules/Advanced/Foundations/Configuring_Services.xml 2012-10-24 06:12:02 UTC (rev 8938) +++ epp/docs/branches/6.0/Reference_Guide/en-US/modules/Advanced/Foundations/Configuring_Services.xml 2012-10-25 06:01:34 UTC (rev 8939) @@ -201,11 +201,11 @@ You see, here the <emphasis>/conf/portal/configuration.xml</emphasis> file of each jar enters the game, they are searched at first. Next, there is nearly always a configuration.xml in the portal.war file (or in the portal webapp folder), you find this file at <emphasis>/WEB-INF/conf/configuration.xml</emphasis>. If you open it, you will find a lot of import statements that point to other configuration files in the same portal.war (or portal webapp). </para> <para> - <emphasis role="bold">Multiple Portals</emphasis> Be aware that you might set up several different portals (&quot;admin&quot;, &quot;mexico&quot;, etc.), and each of these portals will use a different PortalContainer. And each of these PortalContainers can be configured separately. As of JBoss Enterprise Portal Platform &VY; you also will be able to provide configurations from outside the jars and wars or webapps. Put a configuration file in <emphasis>exo-tomcat/exo-conf/portal/$portal_name/configuration.xml</emphasis> where <parameter>$portal_name</parameter> is the name of the portal you want to configure for . But normally you only have one portal which is called &quot;portal&quot; so you use <emphasis>exo-tomcat/exo-conf/portal/portal/configuration.xml</emphasis>. + <emphasis role="bold">Multiple Portals</emphasis> Be aware that you might set up several different portals (&quot;admin&quot;, &quot;mexico&quot;, etc.), and each of these portals will use a different PortalContainer. And each of these PortalContainers can be configured separately. As of JBoss Portal Platform &VY; you also will be able to provide configurations from outside the jars and wars or webapps. Put a configuration file in <emphasis>exo-tomcat/exo-conf/portal/$portal_name/configuration.xml</emphasis> where <parameter>$portal_name</parameter> is the name of the portal you want to configure for . But normally you only have one portal which is called &quot;portal&quot; so you use <emphasis>exo-tomcat/exo-conf/portal/portal/configuration.xml</emphasis>. </para> <note> <para> - As of JBoss Enterprise Portal Platform &VY; you can override the external configuration location with the system property <emphasis>exo.conf.dir</emphasis>. If the property exists its value will be used as path to the eXo configuration directory, that means this is an alternative to <emphasis>exo-tomcat/exo-conf</emphasis>. Just put this property in the command line: <emphasis>java -Dexo.conf.dir=/path/to/exo/conf</emphasis> or use eXo.bat or eXo.sh. In this particular use case, you have no need to use any prefixes in your configuration file to import other files. For example, if your configuration file is <emphasis>exo-tomcat/exo-conf/portal/PORTAL_NAME/configuration.xml</emphasis> and you want to import the configuration file <emphasis>exo-tomcat/exo-conf/portal/PORTAL_NAME/mySubConfDir/myConfig.xml</emphasis>, you can do it by adding <emphasis>&lt;import&gt;mySubConfDir/myConfig.xml&lt;/import&gt;</emphasis> to your configuration file. + As of JBoss Portal Platform &VY; you can override the external configuration location with the system property <emphasis>exo.conf.dir</emphasis>. If the property exists its value will be used as path to the eXo configuration directory, that means this is an alternative to <emphasis>exo-tomcat/exo-conf</emphasis>. Just put this property in the command line: <emphasis>java -Dexo.conf.dir=/path/to/exo/conf</emphasis> or use eXo.bat or eXo.sh. In this particular use case, you have no need to use any prefixes in your configuration file to import other files. For example, if your configuration file is <emphasis>exo-tomcat/exo-conf/portal/PORTAL_NAME/configuration.xml</emphasis> and you want to import the configuration file <emphasis>exo-tomcat/exo-conf/portal/PORTAL_NAME/mySubConfDir/myConfig.xml</emphasis>, you can do it by adding <emphasis>&lt;import&gt;mySubConfDir/myConfig.xml&lt;/import&gt;</emphasis> to your configuration file. </para> </note> <note> @@ -352,8 +352,8 @@ <para> Below is an example <filename>configuration.xml</filename> that &apos;outsources&apos; its content into several files: </para> - <programlisting language="XML" role="XML"><xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="../../../extras/Advanced_Development_Foundations/default2.xml" parse="text"/></programlisting> - <para> + <programlisting language="XML" role="XML"><xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="../../../extras/Advanced_Development_Foundations/default2.xml" parse="text"/></programlisting> + <para> Comment #1: This line is being used to reference another configuration file. The <code>war:</code> URL schema indicates that the following path is to be resolved relative to the current <literal>PortalContainer</literal>&apos;s servlet context resource path, starting with <emphasis role="bold">WEB-INF</emphasis> as a root. </para> <note> @@ -390,7 +390,7 @@ <para>&lt;init-params&gt; is a configuration element that is essentially a map of key-value pairs, where <emphasis role="bold">key</emphasis> is always a <literal>String</literal>, and <emphasis role="bold">value</emphasis> can be any type that can be described using the kernel XML configuration. </para> <para> - Service components that form the JBoss Enterprise Portal Platform infrastructure use &lt;init-params&gt; elements to configure themselves. A component can have one instance of &lt;init-params&gt; injected at most. + Service components that form the JBoss Portal Platform infrastructure use &lt;init-params&gt; elements to configure themselves. A component can have one instance of &lt;init-params&gt; injected at most. </para> <para> If the service component&apos;s constructor takes &lt;init-params&gt; as any of the parameters it will automatically be injected at component instantiation time. @@ -780,7 +780,7 @@ &lt;/init-params&gt; &lt;/component&gt;</programlisting> <para> - As these are system properties you use the -D command: <emphasis role="bold">java -DconnectionUrl=jdbc:hsqldb:file:../temp/data/exodb -DdriverClass=org.hsqldb.jdbcDriver</emphasis> Or better use the parameters of eXo.bat / eXo.sh when you start JBoss Enterprise Portal Platform: <emphasis role="bold">set EXO_OPTS=&quot;-DconnectionUrl=jdbc:hsqldb:file:../temp/data/exodb -DdriverClass=org.hsqldb.jdbcDriver&quot;</emphasis> + As these are system properties you use the -D command: <emphasis role="bold">java -DconnectionUrl=jdbc:hsqldb:file:../temp/data/exodb -DdriverClass=org.hsqldb.jdbcDriver</emphasis> Or better use the parameters of eXo.bat / eXo.sh when you start JBoss Portal Platform: <emphasis role="bold">set EXO_OPTS=&quot;-DconnectionUrl=jdbc:hsqldb:file:../temp/data/exodb -DdriverClass=org.hsqldb.jdbcDriver&quot;</emphasis> </para> </section> </section> Modified: epp/docs/branches/6.0/Reference_Guide/en-US/modules/Advanced/Foundations/Extensions_And_Multiple_Portals.xml =================================================================== --- epp/docs/branches/6.0/Reference_Guide/en-US/modules/Advanced/Foundations/Extensions_And_Multiple_Portals.xml 2012-10-24 06:12:02 UTC (rev 8938) +++ epp/docs/branches/6.0/Reference_Guide/en-US/modules/Advanced/Foundations/Extensions_And_Multiple_Portals.xml 2012-10-25 06:01:34 UTC (rev 8939) @@ -1,175 +1,156 @@ -<?xml version='1.0' encoding='utf-8' ?> +<?xml version='1.0' encoding='UTF-8'?> <!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [ <!ENTITY % BOOK_ENTITIES SYSTEM "Reference_Guide.ent"> %BOOK_ENTITIES; ]> <section id="sect-Reference_Guide-The_Extension_Mechanism_and_Portal_Extensions"> - <title>The Extension Mechanism and Portal Extensions</title> - <para> - The <emphasis role="bold">Extension mechanism</emphasis> makes it possible to override portal resources in a way similar to hardware plug-and-play functionalities. - </para> - <para> - Customizations can be implemented without unpacking and repacking the original portal <code>.war</code> archives by adding a <code>.war</code> archive to the resources and configuring its position in the portal's classpath. Custom <code>.war</code> archives can be created with new resources that override the resources in the original archive. - </para> - <para> - These archives, packaged for use through the extension mechanism, are called <emphasis role="bold">portal extensions</emphasis>. - </para> - <procedure id="proc-Reference_Guide-The_Extension_Mechanism_and_Portal_Extensions-Creating_a_portal_extension"> - <title>Creating a portal extension</title> - <step> - <para> - Declare the <emphasis role="bold">PortalConfigOwner</emphasis> servlet context listener in the <filename>web.xml</filename> of your web application. - </para> - <para> - This example shows a portal extension called <emphasis role="bold">sample-ext</emphasis>. - </para> - -<programlisting language="XML" role="XML"><xi:include href="../../../extras/Advanced_Development_Foundations/default8.xml" parse="text" xmlns:xi="http://www.w3.org/2001/XInclude" /></programlisting> - - </step> - <step> - <para> - Add the application's servlet context name to the <literal>PortalContainerDefinition</literal>'s list of dependencies. This must be done for each portal container that you want to have access to the new application. - </para> - <para> - The application's position in these lists will dictate its priority when the portal loads resources. The later your application appears in the list, the higher its resource priority will be. - </para> - - </step> - <step> - <para> - At this point your new web archive will be on both the portal's unified classpath and unified servlet context resource path. - </para> - - </step> - - </procedure> - - <note> - <title>Example</title> - <para> - Refer to the code extract in <xref linkend="sect-Reference_Guide-Configuring_a_portal_container" /> for an example of a <literal>PortalContainerDefinition</literal> that has <emphasis role="bold">sample-ext</emphasis> in its list of dependencies. - </para> - - </note> - <section id="sect-Reference_Guide-The_Extension_Mechanism_and_Portal_Extensions-Running_Multiple_Portals"> - <title>Running Multiple Portals</title> - <!-- DOC TODO: This section requires more work to structure the information effectively. Consider sub-sections --> <para> - It is possible to run several independent portal containers, each bound to a different URL context, within the same JVM instance. - </para> - <para> - This method of deployment allows for efficient administration and resource consumption by allowing coexisting portals to <emphasis>reuse</emphasis> configuration arrangements through the extension mechanism. - </para> - <para> - Portals can <emphasis>inherit</emphasis> resources and configuration from existing web archives and add extra resources as needed, <emphasis>overriding</emphasis> those that need to be changed by including modified copies. - </para> - <para> - In order for a portal application to function correctly when deployed within a multiple portal deployment, it may have to dynamically query the information about the current portal container. The application should not make any assumptions about the name, and other information of the current portal, as there are now multiple different portals in play. - </para> - <para> - At any point during request processing, or life-cycle event processing, an application can retrieve this information through <literal>org.exoplatform.container.eXoContainerContext</literal>. - </para> - <para> - Sometimes an application must ensure that the proper <literal>PortalContainer</literal> is associated with the current <literal>eXoContainerContext</literal> call. - </para> - <para> - If the portal application contains servlets or servlet filters that need to access portal specific resources during their request processing, the servlet or filter must be associated with the current container. - </para> - <para> - A servlet in this instance should extend the <literal>org.exoplatform.container.web.AbstractHttpServlet</literal> class so as to properly initialize the current <literal>PortalContainer</literal>. - </para> - <para> - This will also set the current thread's context Classloader to one that looks for resources in associated web applications in the order specified by the <emphasis role="bold">dependencies</emphasis> configuration (as seen in <xref linkend="sect-Reference_Guide-The_Extension_Mechanism_and_Portal_Extensions" />). - </para> - <para> - Filter classes need to extend the <literal>org.exoplatform.container.web.AbstractFilter</literal>. - </para> - <para> - Both <literal>AbstractHttpServlet</literal>, and <literal>AbstractFilter</literal> have a <literal>getContainer()</literal> method, which returns the current <literal>PortalContainer</literal>. - </para> - <para> - If your servlet handles the requests by implementing a <literal>service()</literal> method, that method must be renamed to match the following signature: - </para> - -<programlisting language="Java" role="Java"><xi:include href="../../../extras/Advanced_Development_Foundations/default9.java" parse="text" xmlns:xi="http://www.w3.org/2001/XInclude" /></programlisting> - <note> - <para> - This ensures that <literal>AbstractHttpServlet</literal>'s <literal>service()</literal> interception is not overwritten. - </para> - - </note> - <para> - An application may also need access to portal information within the <emphasis role="bold">HttpSessionListener</emphasis>. Ensure the abstract class <emphasis role="bold">org.exoplatform.container.web.AbstractHttpSessionListener</emphasis> is extended. - </para> - <para> - In this instance, modify the method signatures as follows: - </para> - -<programlisting language="Java" role="Java"><xi:include href="../../../extras/Advanced_Development_Foundations/default10.java" parse="text" xmlns:xi="http://www.w3.org/2001/XInclude" /></programlisting> - <para> - Another method must also be implemented in this case: - </para> - -<programlisting language="Java" role="Java"><xi:include href="../../../extras/Advanced_Development_Foundations/default11.java" parse="text" xmlns:xi="http://www.w3.org/2001/XInclude" /></programlisting> - <para> - If this method returns <emphasis>true</emphasis> the current thread's context Classloader is set up according to the <emphasis role="bold">dependencies</emphasis> configuration and availability of the associated web applications. - </para> - <para> - If it returns <emphasis>false</emphasis> the standard application separation rules are used for resource loading (effectively turning off the extension mechanism). - </para> - <para> - This method exists on both <literal>AbstractHttpServlet</literal> and <literal>AbstractFilter</literal>. This is a default implementation that automatically returns <emphasis>true</emphasis> when it detects there is a current <literal>PortalContainer</literal> present and <emphasis>false</emphasis> otherwise. - </para> - <formalpara id="form-Reference_Guide-Running_Multiple_Portals-ServletContextListener_based_initialization_access_to_PortalContainer"> - <title>ServletContextListener-based initialization access to PortalContainer</title> - <para> - JBoss Enterprise Portal Platform has no direct control over the deployment of application archives (<code>.war</code> and <code>.ear</code> files); it is the application server that performs the deployment. - </para> - - </formalpara> - <para> - However, applications in the <emphasis role="bold">dependencies</emphasis> configuration must be deployed <emphasis>before</emphasis> the portal that depends on them is initialized in order for the <emphasis role="bold">extension mechanism</emphasis> to work properly. - </para> - <para> - Conversely, some applications may require an already initialized <literal>PortalContainer</literal> to properly initialize themselves. This gives rise to a recursive dependency problem. - </para> - <para> - A mechanism of <emphasis role="bold">initialization tasks</emphasis> and <emphasis role="bold">task queues</emphasis> has been implemented in JBoss Enterprise Portal Platform to resolve this dependency issue. - </para> - <para> - Web applications that depend on a current <literal>PortalContainer</literal> to initialize must avoid performing their initialization directly on a <literal>ServletContextListener</literal> executed during their deployment (before any <literal>PortalContainer</literal> was initialized). - </para> - <para> - To ensure this, a web application should package its initialization logic into an <code>init</code> task of an appropriate type and only use <literal>ServletContextListener</literal> to insert the <code>init</code> task instance into the proper <code>init</code> tasks queue. - </para> - <para> - An example of this is the Gadgets application which registers Google gadgets with the current <literal>PortalContainer</literal>. This example uses <emphasis role="bold">PortalContainerPostInitTask</emphasis> which is executed after the portal container has been initialized. - </para> - -<programlisting language="Java" role="Java"><xi:include href="../../../extras/Advanced_Development_Foundations/GadgetRegister.java" parse="text" xmlns:xi="http://www.w3.org/2001/XInclude" /></programlisting> - <para> - In some situations initialization may be required <emphasis>after</emphasis> the portal container is instantiated but <emphasis>before</emphasis> it has initialized. <literal>PortalContainerPreInitTask</literal> can be used in that case. - </para> - <para> - Use <emphasis role="bold">PortalContainerPostCreateTask</emphasis> if initialization is required <emphasis>after</emphasis> all the <code>post-init</code> tasks have been executed. - </para> - <formalpara id="form-Reference_Guide-Running_Multiple_Portals-LoginModules"> - <title>LoginModules</title> - <para> - If some custom <literal>LoginModules</literal> require the current <literal>eXoContainer</literal> for initialization ensure they extend <emphasis role="bold">org.exoplatform.services.security.jaas.AbstractLoginModule</emphasis>. - </para> - - </formalpara> - <para> - <literal>AbstractLoginModule</literal> enforces some basic configuration. It recognizes two initialization options; <emphasis role="bold">portalContainerName</emphasis> and <emphasis role="bold">realmName</emphasis>. - </para> - <para> - The values for these options can be accessed via protected fields of the same name. - </para> - - </section> - - + <title>The Extension Mechanism and Portal Extensions</title> + <para> + The <emphasis role="bold">Extension mechanism</emphasis> makes it possible to override portal resources in a way similar to hardware plug-and-play functionalities. + </para> + <para> + Customizations can be implemented without unpacking and repacking the original portal <code>.war</code> archives by adding a <code>.war</code> archive to the resources and configuring its position in the portal&apos;s classpath. Custom <code>.war</code> archives can be created with new resources that override the resources in the original archive. + </para> + <para> + These archives, packaged for use through the extension mechanism, are called <emphasis role="bold">portal extensions</emphasis>. + </para> + <procedure id="proc-Reference_Guide-The_Extension_Mechanism_and_Portal_Extensions-Creating_a_portal_extension"> + <title>Creating a portal extension</title> + <step> + <para> + Declare the <emphasis role="bold">PortalConfigOwner</emphasis> servlet context listener in the <filename>web.xml</filename> of your web application. + </para> + <para> + This example shows a portal extension called <emphasis role="bold">sample-ext</emphasis>. + </para> + <programlisting language="XML" role="XML"><xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="../../../extras/Advanced_Development_Foundations/default8.xml" parse="text"/></programlisting> + </step> + <step> + <para> + Add the application&apos;s servlet context name to the <literal>PortalContainerDefinition</literal>&apos;s list of dependencies. This must be done for each portal container that you want to have access to the new application. + </para> + <para> + The application&apos;s position in these lists will dictate its priority when the portal loads resources. The later your application appears in the list, the higher its resource priority will be. + </para> + </step> + <step> + <para> + At this point your new web archive will be on both the portal&apos;s unified classpath and unified servlet context resource path. + </para> + </step> + </procedure> + <note> + <title>Example</title> + <para> + Refer to the code extract in <xref linkend="sect-Reference_Guide-Configuring_a_portal_container"/> for an example of a <literal>PortalContainerDefinition</literal> that has <emphasis role="bold">sample-ext</emphasis> in its list of dependencies. + </para> + </note> + <section id="sect-Reference_Guide-The_Extension_Mechanism_and_Portal_Extensions-Running_Multiple_Portals"> + <title>Running Multiple Portals</title> +<!-- DOC TODO: This section requires more work to structure the information effectively. Consider sub-sections --> <para> + It is possible to run several independent portal containers, each bound to a different URL context, within the same JVM instance. + </para> + <para> + This method of deployment allows for efficient administration and resource consumption by allowing coexisting portals to <emphasis>reuse</emphasis> configuration arrangements through the extension mechanism. + </para> + <para> + Portals can <emphasis>inherit</emphasis> resources and configuration from existing web archives and add extra resources as needed, <emphasis>overriding</emphasis> those that need to be changed by including modified copies. + </para> + <para> + In order for a portal application to function correctly when deployed within a multiple portal deployment, it may have to dynamically query the information about the current portal container. The application should not make any assumptions about the name, and other information of the current portal, as there are now multiple different portals in play. + </para> + <para> + At any point during request processing, or life-cycle event processing, an application can retrieve this information through <literal>org.exoplatform.container.eXoContainerContext</literal>. + </para> + <para> + Sometimes an application must ensure that the proper <literal>PortalContainer</literal> is associated with the current <literal>eXoContainerContext</literal> call. + </para> + <para> + If the portal application contains servlets or servlet filters that need to access portal specific resources during their request processing, the servlet or filter must be associated with the current container. + </para> + <para> + A servlet in this instance should extend the <literal>org.exoplatform.container.web.AbstractHttpServlet</literal> class so as to properly initialize the current <literal>PortalContainer</literal>. + </para> + <para> + This will also set the current thread&apos;s context Classloader to one that looks for resources in associated web applications in the order specified by the <emphasis role="bold">dependencies</emphasis> configuration (as seen in <xref linkend="sect-Reference_Guide-The_Extension_Mechanism_and_Portal_Extensions"/>). + </para> + <para> + Filter classes need to extend the <literal>org.exoplatform.container.web.AbstractFilter</literal>. + </para> + <para> + Both <literal>AbstractHttpServlet</literal>, and <literal>AbstractFilter</literal> have a <literal>getContainer()</literal> method, which returns the current <literal>PortalContainer</literal>. + </para> + <para> + If your servlet handles the requests by implementing a <literal>service()</literal> method, that method must be renamed to match the following signature: + </para> + <programlisting language="Java" role="Java"><xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="../../../extras/Advanced_Development_Foundations/default9.java" parse="text"/></programlisting> + <note> + <para> + This ensures that <literal>AbstractHttpServlet</literal>&apos;s <literal>service()</literal> interception is not overwritten. + </para> + </note> + <para> + An application may also need access to portal information within the <emphasis role="bold">HttpSessionListener</emphasis>. Ensure the abstract class <emphasis role="bold">org.exoplatform.container.web.AbstractHttpSessionListener</emphasis> is extended. + </para> + <para> + In this instance, modify the method signatures as follows: + </para> + <programlisting language="Java" role="Java"><xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="../../../extras/Advanced_Development_Foundations/default10.java" parse="text"/></programlisting> + <para> + Another method must also be implemented in this case: + </para> + <programlisting language="Java" role="Java"><xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="../../../extras/Advanced_Development_Foundations/default11.java" parse="text"/></programlisting> + <para> + If this method returns <emphasis>true</emphasis> the current thread&apos;s context Classloader is set up according to the <emphasis role="bold">dependencies</emphasis> configuration and availability of the associated web applications. + </para> + <para> + If it returns <emphasis>false</emphasis> the standard application separation rules are used for resource loading (effectively turning off the extension mechanism). + </para> + <para> + This method exists on both <literal>AbstractHttpServlet</literal> and <literal>AbstractFilter</literal>. This is a default implementation that automatically returns <emphasis>true</emphasis> when it detects there is a current <literal>PortalContainer</literal> present and <emphasis>false</emphasis> otherwise. + </para> + <formalpara id="form-Reference_Guide-Running_Multiple_Portals-ServletContextListener_based_initialization_access_to_PortalContainer"> + <title>ServletContextListener-based initialization access to PortalContainer</title> + <para> +JBoss Portal Platform has no direct control over the deployment of application archives (<code>.war</code> and <code>.ear</code> files); it is the application server that performs the deployment. + </para> + </formalpara> + <para> + However, applications in the <emphasis role="bold">dependencies</emphasis> configuration must be deployed <emphasis>before</emphasis> the portal that depends on them is initialized in order for the <emphasis role="bold">extension mechanism</emphasis> to work properly. + </para> + <para> + Conversely, some applications may require an already initialized <literal>PortalContainer</literal> to properly initialize themselves. This gives rise to a recursive dependency problem. + </para> + <para> + A mechanism of <emphasis role="bold">initialization tasks</emphasis> and <emphasis role="bold">task queues</emphasis> has been implemented in JBoss Portal Platform to resolve this dependency issue. + </para> + <para> + Web applications that depend on a current <literal>PortalContainer</literal> to initialize must avoid performing their initialization directly on a <literal>ServletContextListener</literal> executed during their deployment (before any <literal>PortalContainer</literal> was initialized). + </para> + <para> + To ensure this, a web application should package its initialization logic into an <code>init</code> task of an appropriate type and only use <literal>ServletContextListener</literal> to insert the <code>init</code> task instance into the proper <code>init</code> tasks queue. + </para> + <para> + An example of this is the Gadgets application which registers Google gadgets with the current <literal>PortalContainer</literal>. This example uses <emphasis role="bold">PortalContainerPostInitTask</emphasis> which is executed after the portal container has been initialized. + </para> + <programlisting language="Java" role="Java"><xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="../../../extras/Advanced_Development_Foundations/GadgetRegister.java" parse="text"/></programlisting> + <para> + In some situations initialization may be required <emphasis>after</emphasis> the portal container is instantiated but <emphasis>before</emphasis> it has initialized. <literal>PortalContainerPreInitTask</literal> can be used in that case. + </para> + <para> + Use <emphasis role="bold">PortalContainerPostCreateTask</emphasis> if initialization is required <emphasis>after</emphasis> all the <code>post-init</code> tasks have been executed. + </para> + <formalpara id="form-Reference_Guide-Running_Multiple_Portals-LoginModules"> + <title>LoginModules</title> + <para> + If some custom <literal>LoginModules</literal> require the current <literal>eXoContainer</literal> for initialization ensure they extend <emphasis role="bold">org.exoplatform.services.security.jaas.AbstractLoginModule</emphasis>. + </para> + </formalpara> + <para> + <literal>AbstractLoginModule</literal> enforces some basic configuration. It recognizes two initialization options; <emphasis role="bold">portalContainerName</emphasis> and <emphasis role="bold">realmName</emphasis>. + </para> + <para> + The values for these options can be accessed via protected fields of the same name. + </para> + </section> </section> - - Modified: epp/docs/branches/6.0/Reference_Guide/en-US/modules/Advanced/Foundations/Kernel.xml =================================================================== --- epp/docs/branches/6.0/Reference_Guide/en-US/modules/Advanced/Foundations/Kernel.xml 2012-10-24 06:12:02 UTC (rev 8938) +++ epp/docs/branches/6.0/Reference_Guide/en-US/modules/Advanced/Foundations/Kernel.xml 2012-10-25 06:01:34 UTC (rev 8939) @@ -6,10 +6,10 @@ <section id="sect-Reference_Guide-The_eXo_Kernel"> <title>eXo Kernel</title> <para> - JBoss Enterprise Portal Platform is built as a set of services on top of a dependency injection kernel. The kernel provides configuration, life-cycle handling, component scopes and some core services. +JBoss Portal Platform is built as a set of services on top of a dependency injection kernel. The kernel provides configuration, life-cycle handling, component scopes and some core services. </para> <para> - The portal kernel and the JCR used in JBoss Enterprise Portal Platform use the <emphasis>Inversion of Control</emphasis> (<emphasis role="bold">IoC</emphasis>) system to control service instantiation. This method is also known as &apos;dependency injection&apos;. + The portal kernel and the JCR used in JBoss Portal Platform use the <emphasis>Inversion of Control</emphasis> (<emphasis role="bold">IoC</emphasis>) system to control service instantiation. This method is also known as &apos;dependency injection&apos;. </para> <para> In this system, services are not responsible for the instantiation of the components on which they depend. It prevents objects creating the instances of any objects referenced. This task is delegated to the container. The below image illustrates this: @@ -87,7 +87,7 @@ Whenever a specific service is looked up through the <literal>PortalContainer</literal>, and the service is not available, the lookup is delegated further up to the <literal>RootContainer</literal>. </para> <para> - JBoss Enterprise Portal Platform can have default instances of a certain component in the <literal>RootContainer</literal>, and portal specific instances in some or all <literal>PortalContainers</literal>, that override the default instance. +JBoss Portal Platform can have default instances of a certain component in the <literal>RootContainer</literal>, and portal specific instances in some or all <literal>PortalContainers</literal>, that override the default instance. </para> <para> Whenever your portal application has to be integrated more closely with eXo services, these services can be looked up through the <literal>PortalContainer</literal>. Modified: epp/docs/branches/6.0/Reference_Guide/en-US/modules/AuthenticationAndIdentity/AuthenticationAuthorizationOverview.xml =================================================================== --- epp/docs/branches/6.0/Reference_Guide/en-US/modules/AuthenticationAndIdentity/AuthenticationAuthorizationOverview.xml 2012-10-24 06:12:02 UTC (rev 8938) +++ epp/docs/branches/6.0/Reference_Guide/en-US/modules/AuthenticationAndIdentity/AuthenticationAuthorizationOverview.xml 2012-10-25 06:01:34 UTC (rev 8939) @@ -8,10 +8,10 @@ <section id="sect-Reference_Guide-Authentication_Authorization_Intro-Authentication"> <title>Authentication Overview</title> <para> - Authentication in JBoss Enterprise Portal Platform is based on <ulink url="http://docs.oracle.com/javase/6/docs/technotes/guides/security/... type="http">JAAS</ulink> and by default it is a standard J2EE FORM based authentication. + Authentication in JBoss Portal Platform is based on <ulink url="http://docs.oracle.com/javase/6/docs/technotes/guides/security/... type="http">JAAS</ulink> and by default it is a standard J2EE FORM based authentication. </para> <para> - JBoss Enterprise Portal Platform supports the following authentication methods: +JBoss Portal Platform supports the following authentication methods: </para> <itemizedlist> <listitem> @@ -125,7 +125,7 @@ <section id="sect-Reference_Guide-Authentication_Authorization_Intro-LoginModules"> <title>Login modules</title> <para> - JBoss Enterprise Portal Platform uses its own security domain (<emphasis role="bold">gatein-domain</emphasis>) with a set of predefined login modules. Login module configuration for <emphasis>gatein-domain</emphasis> is contained in the <filename>deploy/gatein.ear/META-INF/gatein-jboss-beans.xml</filename> file. +JBoss Portal Platform uses its own security domain (<emphasis role="bold">gatein-domain</emphasis>) with a set of predefined login modules. Login module configuration for <emphasis>gatein-domain</emphasis> is contained in the <filename>deploy/gatein.ear/META-INF/gatein-jboss-beans.xml</filename> file. </para> <para> Below is the default login modules stack: @@ -184,7 +184,7 @@ Either method (<emphasis>login</emphasis> or <emphasis>commit</emphasis>) can throw <literal>LoginException</literal>. If this happens, the whole authentication process ends unsuccessfully, which in turn, invokes the <emphasis>abort</emphasis> method on each login module. </para> <para> - By returning &quot;false&quot; from the login method ensures that login module is ignored. This is not specific to JBoss Enterprise Portal Platform but generic to JAAS. More info about login modules in general can be found at <ulink url="http://docs.oracle.com/javase/6/docs/technotes/guides/security/... type="http"/>. + By returning &quot;false&quot; from the login method ensures that login module is ignored. This is not specific to JBoss Portal Platform but generic to JAAS. More info about login modules in general can be found at <ulink url="http://docs.oracle.com/javase/6/docs/technotes/guides/security/... type="http"/>. </para> </listitem> </itemizedlist> @@ -265,7 +265,7 @@ <itemizedlist> <listitem> <para> - <emphasis>PortalLoginModule</emphasis> - is located in JBoss Enterprise Portal Platform sources in <ulink url="http://anonsvn.jboss.org/repos/gatein/portal/trunk/component/we... type="http">http://anonsvn.jboss.org/repos/gatein/portal/tru... + <emphasis>PortalLoginModule</emphasis> - is located in JBoss Portal Platform sources in <ulink url="http://anonsvn.jboss.org/repos/gatein/portal/trunk/component/we... type="http">http://anonsvn.jboss.org/repos/gatein/portal/tru... </para> </listitem> <listitem> @@ -275,7 +275,7 @@ </listitem> <listitem> <para> - <emphasis>CustomMembershipLoginModule</emphasis> - located in JBoss Enterprise Portal Platform sources in module for identity integration - <ulink url="http://anonsvn.jboss.org/repos/gatein/portal/trunk/component/id... type="http">http://anonsvn.jboss.org/repos/gatein/portal/tru... + <emphasis>CustomMembershipLoginModule</emphasis> - located in JBoss Portal Platform sources in module for identity integration - <ulink url="http://anonsvn.jboss.org/repos/gatein/portal/trunk/component/id... type="http">http://anonsvn.jboss.org/repos/gatein/portal/tru... </para> </listitem> </itemizedlist> @@ -297,7 +297,7 @@ </listitem> <listitem> <para> - Authentication on JBoss Enterprise Portal Platform level + Authentication on JBoss Portal Platform level </para> </listitem> </itemizedlist> @@ -308,12 +308,12 @@ </para> </formalpara> <para> - After successful authentication, user needs to be at least in JAAS role &quot;users&quot; because this role is declared in web.xml as you saw above. JAAS roles are extracted by special algorithm from JBoss Enterprise Portal Platform memberships. See below in section with RolesExtractor. + After successful authentication, user needs to be at least in JAAS role &quot;users&quot; because this role is declared in web.xml as you saw above. JAAS roles are extracted by special algorithm from JBoss Portal Platform memberships. See below in section with RolesExtractor. </para> <formalpara id="form-Authentication_Authorization_Intro-authenticationGateInServerLevel"> - <title>Authentication on JBoss Enterprise Portal Platform level</title> + <title>Authentication on JBoss Portal Platform level</title> <para> - Login process needs to create special object <literal>org.exoplatform.services.security.Identity</literal> and register this object into JBoss Enterprise Portal Platform component <literal>IdentityRegistry</literal>. This Identity object should encapsulate username of authenticated user, Memberships of this user and also JAAS roles. Identity object can be easily created with interface <literal>Authenticator</literal> as can be seen below. + Login process needs to create special object <literal>org.exoplatform.services.security.Identity</literal> and register this object into JBoss Portal Platform component <literal>IdentityRegistry</literal>. This Identity object should encapsulate username of authenticated user, Memberships of this user and also JAAS roles. Identity object can be easily created with interface <literal>Authenticator</literal> as can be seen below. </para> </formalpara> <para> @@ -413,7 +413,7 @@ <itemizedlist> <listitem> <para> - User checks the checkbox &quot;Remember my login&quot; on login screen of JBoss Enterprise Portal Platform . Then submits the form. + User checks the checkbox &quot;Remember my login&quot; on login screen of JBoss Portal Platform . Then submits the form. </para> </listitem> <listitem> @@ -461,7 +461,7 @@ <section id="sect-Authentication_Authorization_Intro-BASICAuthentication"> <title>BASIC authentication</title> <para> - JBoss Enterprise Portal Platform is using FORM based authentication by default but it is not a problem with switch to different authentication type like BASIC. Only needed thing is to configure it properly in <filename>deploy/gatein.ear/02portal.war/WEB-INF/web.xml</filename> like this: +JBoss Portal Platform is using FORM based authentication by default but it is not a problem with switch to different authentication type like BASIC. Only needed thing is to configure it properly in <filename>deploy/gatein.ear/02portal.war/WEB-INF/web.xml</filename> like this: </para> <programlisting language="XML" role="XML"> <![CDATA[ @@ -482,13 +482,13 @@ ]]> </programlisting> <para> - In this case user will see login dialog from browser instead of JBoss Enterprise Portal Platform login.jsp page. JAAS authentication will be performed with real credentials of user (<emphasis>root</emphasis>/<emphasis>gtn</emphasis>). WCI ticket is not used with BASIC authentication. + In this case user will see login dialog from browser instead of JBoss Portal Platform login.jsp page. JAAS authentication will be performed with real credentials of user (<emphasis>root</emphasis>/<emphasis>gtn</emphasis>). WCI ticket is not used with BASIC authentication. </para> </section> <section id="sect-Authentication_Authorization_Intro-ClusterLogin"> <title>Cluster login</title> <para> - JBoss Enterprise Portal Platform supports automatic login propagation in cluster environment. Cluster login relies on HTTP session replication. It&apos;s useful for situations like this: +JBoss Portal Platform supports automatic login propagation in cluster environment. Cluster login relies on HTTP session replication. It&apos;s useful for situations like this: </para> <procedure> <step> @@ -533,14 +533,13 @@ <section id="sect-Authentication_Authorization_Intro-SSOLogin"> <title>SSO login</title> <para> - JBoss Enterprise Portal Platform also supports integration with couple of well-known SSO frameworks (CAS, JOSSO, OpenSSO). When user wants login, he is not redirected to portal login form but to SSO server login form. After successful login with SSO server, he gains ticket represented by special cookie (name of cookie differs for each SSO server). Then user is redirected back to JBoss Enterprise Portal Platform, where we need to perform agent validation of SSO ticket against SSO server. We still need to create Identity object and bind it to IdentityRegistry (this is same as in default authentication), which is done thanks to Authenticator component. +JBoss Portal Platform also supports integration with couple of well-known SSO frameworks (CAS, JOSSO, OpenSSO). When user wants login, he is not redirected to portal login form but to SSO server login form. After successful login with SSO server, he gains ticket represented by special cookie (name of cookie differs for each SSO server). Then user is redirected back to JBoss Portal Platform, where we need to perform agent validation of SSO ticket against SSO server. We still need to create Identity object and bind it to IdentityRegistry (this is same as in default authentication), which is done thanks to Authenticator component. </para> <para> - In other words, you need to ensure that users, which are logged successfully through SSO, needs to be also in JBoss Enterprise Portal Platform identity database because SSO server is used only for authentication, but authorization is handled completely by JBoss Enterprise Portal Platform, which assumes that user exists in portal DB. If users are not in DB, Identity object won&apos;t be created and you will have 403 Forbidden errors even if you authenticate successfully. For details about SSO integration, see <xref linkend="sect-Reference_Guide-SSO_Single_Sign_On"/>. + In other words, you need to ensure that users, which are logged successfully through SSO, needs to be also in JBoss Portal Platform identity database because SSO server is used only for authentication, but authorization is handled completely by JBoss Portal Platform, which assumes that user exists in portal DB. If users are not in DB, Identity object won&apos;t be created and you will have 403 Forbidden errors even if you authenticate successfully. For details about SSO integration, see <xref linkend="sect-Reference_Guide-SSO_Single_Sign_On"/>. </para> <para> - Same applies for SPNEGO authentication (See <xref linkend="sect-Reference_Guide-SSO_Single_Sign_On_-SPNEGO_Simple_and_Protected_GSSAPI_Negotiation_Mechanism"/>). In this case, you need to ensure that your Kerberos users are also created in JBoss Enterprise Portal Platform database. - </para> + Same applies for SPNEGO authentication (See <xref linkend="sect-Reference_Guide-SSO_Single_Sign_On_-SPNEGO_Simple_and_Protected_GSSAPI_Negotiation_Mechanism"/>). In this case, you need to ensure that your Kerberos users are also created in JBoss Portal Platform </para> </section> </section> <!-- Ending section different authentication workflows --> <section id="sect-Authentication_Authorization_Intro-authorization"> @@ -561,7 +560,7 @@ </listitem> </itemizedlist> <para> - Authorization in JBoss Enterprise Portal Platform actually happens on two levels: + Authorization in JBoss Portal Platform actually happens on two levels: </para> <section id="sect-Authentication_Authorization_Intro-servletContainerAuthorization"> <title>Servlet container authorization</title> @@ -573,10 +572,10 @@ <role-name>users</role-name> </auth-constraint>]]></programlisting> <para> - This actually means that our user needs to be in JBoss Enterprise Portal Platform role <emphasis>/platform/users</emphasis> (For details see <xref linkend="sect-Authentication_Authorization_Intro-authenticatorAndRolesExtractor"/>). In other words, if we successfully authenticate but our user is not in group <emphasis>/platform/users</emphasis>, then it means that he is not in JAAS role <emphasis>users</emphasis>, which in next turn means that he will have authorization error <emphasis role="bold">403 Forbidden</emphasis> thrown by servlet container. + This actually means that our user needs to be in JBoss Portal Platform role <emphasis>/platform/users</emphasis> (For details see <xref linkend="sect-Authentication_Authorization_Intro-authenticatorAndRolesExtractor"/>). In other words, if we successfully authenticate but our user is not in group <emphasis>/platform/users</emphasis>, then it means that he is not in JAAS role <emphasis>users</emphasis>, which in next turn means that he will have authorization error <emphasis role="bold">403 Forbidden</emphasis> thrown by servlet container. </para> <para> - You can change the behavior and possibly add some more <emphasis>auth-constraint</emphasis> elements into <filename>web.xml</filename>. However this protection of resources based on web.xml is not standard JBoss Enterprise Portal Platform way and it is mentioned here mainly for illustration purposes. + You can change the behavior and possibly add some more <emphasis>auth-constraint</emphasis> elements into <filename>web.xml</filename>. However this protection of resources based on web.xml is not standard JBoss Portal Platform way and it is mentioned here mainly for illustration purposes. </para> </section> <section id="sect-Authentication_Authorization_Intro-gateInAuthorization"> Modified: epp/docs/branches/6.0/Reference_Guide/en-US/modules/AuthenticationAndIdentity/AuthenticationTokenConfiguration.xml =================================================================== --- epp/docs/branches/6.0/Reference_Guide/en-US/modules/AuthenticationAndIdentity/AuthenticationTokenConfiguration.xml 2012-10-24 06:12:02 UTC (rev 8938) +++ epp/docs/branches/6.0/Reference_Guide/en-US/modules/AuthenticationAndIdentity/AuthenticationTokenConfiguration.xml 2012-10-25 06:01:34 UTC (rev 8939) @@ -20,7 +20,7 @@ <section id="sect-Reference_Guide-Authentication_Token_Configuration-Implementing_the_Token_Service_API"> <title>Implementing the Token Service API</title> <para> - All token services used in JBoss Enterprise Portal Platform authentication must be implemented by subclassing an <emphasis role="bold">AbstractTokenService</emphasis> abstract class. + All token services used in JBoss Portal Platform authentication must be implemented by subclassing an <emphasis role="bold">AbstractTokenService</emphasis> abstract class. </para> <para> The following <emphasis role="bold">AbstractTokenService</emphasis> methods represent the contract between authentication runtime, and a token service implementation. @@ -44,12 +44,12 @@ <para> This property must have three values. </para> - <programlisting language="XML" role="XML"><xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="../../extras/Authentication_Identity_AuthenticationTokenConfiguration/default95.xml" parse="text"/></programlisting> + <programlisting language="XML" role="XML"><xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="../../extras/Authentication_Identity_AuthenticationTokenConfiguration/default95.xml" parse="text"/></programlisting> <para> In this case, the service name is <emphasis role="bold">jcr-token</emphasis> and the token expiration time is one week. </para> <para> - JBoss Enterprise Portal Platform supports <emphasis>four</emphasis> time units: +JBoss Portal Platform supports <emphasis>four</emphasis> time units: </para> <orderedlist numeration="arabic"> <listitem> Modified: epp/docs/branches/6.0/Reference_Guide/en-US/modules/AuthenticationAndIdentity/BackendConfiguration.xml =================================================================== --- epp/docs/branches/6.0/Reference_Guide/en-US/modules/AuthenticationAndIdentity/BackendConfiguration.xml 2012-10-24 06:12:02 UTC (rev 8938) +++ epp/docs/branches/6.0/Reference_Guide/en-US/modules/AuthenticationAndIdentity/BackendConfiguration.xml 2012-10-25 06:01:34 UTC (rev 8939) @@ -6,7 +6,7 @@ <chapter id="sect-Reference_Guide-PicketLink_IDM_integration"> <title>PicketLink IDM integration</title> <para> - JBoss Enterprise Portal Platform uses the <literal>PicketLink IDM</literal> component to store necessary identity information about users, groups and memberships. While legacy interfaces are still used (<literal>org.exoplatform.services.organization</literal>) for identity management, there is a wrapper implementation that delegates to PicketLink IDM framework. +JBoss Portal Platform uses the <literal>PicketLink IDM</literal> component to store necessary identity information about users, groups and memberships. While legacy interfaces are still used (<literal>org.exoplatform.services.organization</literal>) for identity management, there is a wrapper implementation that delegates to PicketLink IDM framework. </para> <para> This section does not provide information about <literal>PicketLink IDM</literal> and its configuration. Please, refer to the appropriate project documentation (<ulink url="http://jboss.org/picketlink/IDM.html"/>) for further information. Modified: epp/docs/branches/6.0/Reference_Guide/en-US/modules/AuthenticationAndIdentity/LDAP.xml =================================================================== --- epp/docs/branches/6.0/Reference_Guide/en-US/modules/AuthenticationAndIdentity/LDAP.xml 2012-10-24 06:12:02 UTC (rev 8938) +++ epp/docs/branches/6.0/Reference_Guide/en-US/modules/AuthenticationAndIdentity/LDAP.xml 2012-10-25 06:01:34 UTC (rev 8939) @@ -7,7 +7,7 @@ <note> <title>Notational Device</title> <para> - For ease of readability the following section uses the notational device <replaceable>ID_HOME</replaceable> to represent the file path <filename><replaceable>EPP_DIST</replaceable>/jboss-as/server/<replaceable>PROFILE</replaceable>/deploy/gatein.ear/02portal.war/WEB-INF/conf/organization/</filename>, as this directory is the root of all JBoss Enterprise Portal Platform&apos;s identity-related configuration. + For ease of readability the following section uses the notational device <replaceable>ID_HOME</replaceable> to represent the file path <filename><replaceable>EPP_DIST</replaceable>/jboss-as/server/<replaceable>PROFILE</replaceable>/deploy/gatein.ear/02portal.war/WEB-INF/conf/organization/</filename>, as this directory is the root of all JBoss Portal Platform&apos;s identity-related configuration. </para> </note> <para> @@ -24,7 +24,7 @@ LDAP provides the protocols required to manage the data stored in a Directory Server. A Directory Server contains information about resources available (user accounts and printers for example) and their location on the network. </para> <para> - The following table is a list of Directory Servers that are supported and certified in JBoss Enterprise Portal Platform. + The following table is a list of Directory Servers that are supported and certified in JBoss Portal Platform. </para> <table> <title>Supported and Certified Directory Servers</title> @@ -71,7 +71,7 @@ --> <note> <title>Examples</title> <para> - JBoss Enterprise Portal Platform includes several example LDAP configuration <filename>.xml</filename> files and <filename>.ldif</filename> (LDAP Data Interchange Format) data files. +JBoss Portal Platform includes several example LDAP configuration <filename>.xml</filename> files and <filename>.ldif</filename> (LDAP Data Interchange Format) data files. </para> <para> These examples are in the <filename><replaceable>ID_HOME</replaceable>/picketlink-idm/examples</filename> directory and can be deployed in a testing environment to assist in configuring LDAP. @@ -192,7 +192,7 @@ <section id="sect-Reference_Guide_eXo_JCR_1.14-LDAP_Integration-LDAP_in_Read-only_Mode"> <title>LDAP in Read-only Mode</title> <para> - This section will show you how to add LDAP in read-only mode. This means that user data entries (both pre-existing, and newly added through the JBoss Enterprise Portal Platform User Interface) will be consumed though the Directory Server and LDAP services, but written to the underlying database. The only exception is that passwords updated via the UI will also be propagated into the appropriate LDAP entry. + This section will show you how to add LDAP in read-only mode. This means that user data entries (both pre-existing, and newly added through the JBoss Portal Platform User Interface) will be consumed though the Directory Server and LDAP services, but written to the underlying database. The only exception is that passwords updated via the UI will also be propagated into the appropriate LDAP entry. </para> <procedure id="proc-Reference_Guide-LDAP_Integration-LDAP_in_Read-only_mode-Set_up_LDAP_read-only_Mode"> <title>Set up LDAP read-only Mode</title> @@ -201,7 +201,7 @@ Open the <filename><replaceable>ID_HOME</replaceable>/idm-configuration.xml</filename> file. </para> <para> - JBoss Enterprise Portal Platform uses the PicketLink IDM framework as the underlying identity storage system, hence all the configurations use dedicated Picketlink settings. +JBoss Portal Platform uses the PicketLink IDM framework as the underlying identity storage system, hence all the configurations use dedicated Picketlink settings. </para> </step> <step> @@ -401,10 +401,10 @@ <section id="sect-Reference_Guide_eXo_JCR_1.14-LDAP_Integration-LDAP_as_Default_Store"> <title>LDAP as Default Store</title> <para> - Follow the procedure below to set LDAP up as the default identity store for JBoss Enterprise Portal Platform. All default accounts and some of groups that comes with JBoss Enterprise Portal Platform will be created in the LDAP store. + Follow the procedure below to set LDAP up as the default identity store for JBoss Portal Platform. All default accounts and some of groups that comes with JBoss Portal Platform will be created in the LDAP store. </para> <para> - The LDAP server will be configured to store part of the JBoss Enterprise Portal Platform group tree. This means that groups under specified part of the tree will be stored in directory server while all others will be stored in database. + The LDAP server will be configured to store part of the JBoss Portal Platform group tree. This means that groups under specified part of the tree will be stored in directory server while all others will be stored in database. </para> <procedure id="proc-Reference_Guide-LDAP_Integration-LDAP_as_Default_Store-Set_up_LDAP_as_Default_Indentity_Store"> <title>Set up LDAP as Default Indentity Store</title> @@ -418,7 +418,7 @@ Open the <filename><replaceable>ID_HOME</replaceable>/idm-configuration.xml</filename> file. </para> <para> - JBoss Enterprise Portal Platform uses the PicketLink IDM framework as the underlying identity storage system, hence all the configurations use dedicated Picketlink settings. +JBoss Portal Platform uses the PicketLink IDM framework as the underlying identity storage system, hence all the configurations use dedicated Picketlink settings. </para> </step> <step> @@ -686,11 +686,11 @@ <para> For RHDS, OpenDS and OpenLDAP the <filename>picketlink-idm-LDAP-acme-config.xml</filename> and <filename>picketlink-idm-openLDAP-acme-config.xml</filename> files contain the following values: </para> - <programlisting language="XML" role="XML"><xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="../../extras/Authentication_Identity_LDAP/readonly-opends.xml" parse="text"/></programlisting> - <para> + <programlisting language="XML" role="XML"><xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="../../extras/Authentication_Identity_LDAP/readonly-opends.xml" parse="text"/></programlisting> + <para> Comment #1: The PicketLink IDM configuration file dictates that users and those two group types be stored in LDAP. </para> - <para> + <para> Comment #2: An additional option defines that nothing else (except password updates) should be written there. </para> <para> @@ -712,11 +712,11 @@ <para> All of the supported LDAP configurations use the following values when implemented as the default identity store: </para> - <programlisting language="XML" role="XML"><xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="../../extras/Authentication_Identity_LDAP/default-ldap.xml" parse="text"/></programlisting> - <para> + <programlisting language="XML" role="XML"><xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="../../extras/Authentication_Identity_LDAP/default-ldap.xml" parse="text"/></programlisting> + <para> Comment #1: The <parameter>groupTypeMappings</parameter> define that all groups under <parameter>/platform</parameter> should be stored in PicketLink IDM with the <parameter>platform_type</parameter> group type name and groups under <parameter>/organization</parameter> should be stored in PicketLink IDM with <parameter>organization_type</parameter> group type name. </para> - <para> The PicketLink IDM configuration file repository maps users and those two group types as stored in LDAP. + <para> The PicketLink IDM configuration file repository maps users and those two group types as stored in LDAP. </para> </example> </section> Modified: epp/docs/branches/6.0/Reference_Guide/en-US/modules/AuthenticationAndIdentity/PasswordEncryption.xml =================================================================== --- epp/docs/branches/6.0/Reference_Guide/en-US/modules/AuthenticationAndIdentity/PasswordEncryption.xml 2012-10-24 06:12:02 UTC (rev 8938) +++ epp/docs/branches/6.0/Reference_Guide/en-US/modules/AuthenticationAndIdentity/PasswordEncryption.xml 2012-10-25 06:01:34 UTC (rev 8939) @@ -8,7 +8,7 @@ <warning> <title>Username and passwords stored in clear text</title> <para> - The <emphasis>Remember Me</emphasis> feature of JBoss Enterprise Portal Platform uses a token mechanism to be able to authenticate returning users without requiring an explicit login. However, to be able to authenticate these users, the token needs to store the username and password in clear text in the JCR. + The <emphasis>Remember Me</emphasis> feature of JBoss Portal Platform uses a token mechanism to be able to authenticate returning users without requiring an explicit login. However, to be able to authenticate these users, the token needs to store the username and password in clear text in the JCR. </para> </warning> <para> @@ -50,7 +50,7 @@ </step> <step> <para> - Start (or restart) your JBoss Enterprise Portal Platform. + Start (or restart) your JBoss Portal Platform. </para> <para> Any passwords written to the JCR will now be encoded and not plain text. Modified: epp/docs/branches/6.0/Reference_Guide/en-US/modules/AuthenticationAndIdentity/PredefinedUserConfiguration.xml =================================================================== --- epp/docs/branches/6.0/Reference_Guide/en-US/modules/AuthenticationAndIdentity/PredefinedUserConfiguration.xml 2012-10-24 06:12:02 UTC (rev 8938) +++ epp/docs/branches/6.0/Reference_Guide/en-US/modules/AuthenticationAndIdentity/PredefinedUserConfiguration.xml 2012-10-25 06:01:34 UTC (rev 8939) @@ -20,7 +20,7 @@ The <emphasis role="bold">checkDatabaseAlgorithm</emphasis> initialization parameter determines how the database update is performed. </para> <para> - If its value is set to <emphasis role="bold">entry</emphasis> it means that each user, group and membership listed in the configuration is checked each time JBoss Enterprise Portal Platform is started. If the entry does not yet exist in the database, it is created. + If its value is set to <emphasis role="bold">entry</emphasis> it means that each user, group and membership listed in the configuration is checked each time JBoss Portal Platform is started. If the entry does not yet exist in the database, it is created. </para> <para> If <emphasis role="bold">checkDatabaseAlgorithm</emphasis> parameter value is set to <emphasis role="bold">empty</emphasis>, the configuration data will be updated to the database only if the database is empty. Modified: epp/docs/branches/6.0/Reference_Guide/en-US/modules/AuthenticationAndIdentity/SAML2.xml =================================================================== (Binary files differ) Modified: epp/docs/branches/6.0/Reference_Guide/en-US/modules/AuthenticationAndIdentity/SSO.xml =================================================================== --- epp/docs/branches/6.0/Reference_Guide/en-US/modules/AuthenticationAndIdentity/SSO.xml 2012-10-24 06:12:02 UTC (rev 8938) +++ epp/docs/branches/6.0/Reference_Guide/en-US/modules/AuthenticationAndIdentity/SSO.xml 2012-10-25 06:01:34 UTC (rev 8939) @@ -8,7 +8,7 @@ <section id="sect-Reference_Guide-SSO_Single_Sign_On_-Overview"> <title>Overview and Configuration Assumptions</title> <para> - JBoss Enterprise Portal Platform provides an implementation of Single Sign On (<literal>SSO</literal>) as an integration and aggregation platform. +JBoss Portal Platform provides an implementation of Single Sign On (<literal>SSO</literal>) as an integration and aggregation platform. </para> <para> When logging into the portal users can access many systems through portlets using a single identity. In many cases, however, the portal infrastructure must be integrated with other SSO enabled systems. @@ -17,7 +17,7 @@ There are many different Identity Management solutions available. In most cases each SSO framework provides a unique way to plug into a Java EE application. </para> <para> - This section will cover the implementation of four different SSO plug-ins with JBoss Enterprise Portal Platform: + This section will cover the implementation of four different SSO plug-ins with JBoss Portal Platform: </para> <itemizedlist> <listitem> @@ -48,7 +48,7 @@ </para> </note> <para> - All the packages required for SSO setup can be found in a zip file located in the <filename><filename>EPP_DIST</filename>/gatein-sso</filename> directory of the JBoss Enterprise Portal Platform binary package. + All the packages required for SSO setup can be found in a zip file located in the <filename><filename>EPP_DIST</filename>/gatein-sso</filename> directory of the JBoss Portal Platform binary package. </para> <para> In the following scenarios this directory will be referred to as <replaceable>PORTAL_SSO</replaceable>. @@ -74,7 +74,7 @@ URL: https://issues.jboss.org/browse/JBEPP-615 Author [w/email]: Marek Posolda (mposolda(a)redhat.com) --> <para> - The JBoss SSO valve is useful to authenticate a user on one JBoss Enterprise Portal Platform node in a cluster and have that authentication automatically carry across to other nodes in the cluster. + The JBoss SSO valve is useful to authenticate a user on one JBoss Portal Platform node in a cluster and have that authentication automatically carry across to other nodes in the cluster. </para> <para> This authentication can also be used in any other web applications which may require authentication, <emphasis role="bold">provided that these applications use same roles as the main portal instance</emphasis>. Attempting to use an SSO authentication in an application that uses different roles may create authorization errors (<emphasis role="bold">403</emphasis> errors, for example). @@ -144,7 +144,7 @@ Another important thing is that both cluster nodes needs to be on same cluster (using same parameter <emphasis role="bold">-g</emphasis> and same parameter <emphasis role="bold">-u</emphasis> and also using parameter <emphasis role="bold">-Dexo.profiles=cluster</emphasis>). </para> <para> - They must also share the same NFS directory and the same database and apply all the configuration needed for JBoss Enterprise Portal Platform cluster. + They must also share the same NFS directory and the same database and apply all the configuration needed for JBoss Portal Platform cluster. </para> </step> </procedure> @@ -226,7 +226,7 @@ <formalpara id="form-Reference_Guide-Enabling_SSO_using_JBoss_SSO_Valve-Enabling_SSO_with_Other_Web_Applications"> <title>Enabling SSO with Other Web Applications</title> <para> - As mentioned earlier, in order to use SSO authentication between JBoss Enterprise Portal Platform instances and other web applications, the roles defined in the web application must match those used in the portal instance (unless you have the <parameter>requireReauthentication</parameter> parameter set to <literal>true</literal>). + As mentioned earlier, in order to use SSO authentication between JBoss Portal Platform instances and other web applications, the roles defined in the web application must match those used in the portal instance (unless you have the <parameter>requireReauthentication</parameter> parameter set to <literal>true</literal>). </para> </formalpara> <para> @@ -329,7 +329,7 @@ <section id="sect-Reference_Guide-SSO_Single_Sign_On_-Central_Authentication_Service"> <title>Central Authentication Service</title> <para> - This Single Sign On plug-in enables seamless integration between JBoss Enterprise Portal Platform and the Central Authentication Service (<emphasis role="bold">CAS</emphasis>) Single Sign On Framework. Details about CAS can be found <ulink url="http://www.ja-sig.org/cas/"> here </ulink> . + This Single Sign On plug-in enables seamless integration between JBoss Portal Platform and the Central Authentication Service (<emphasis role="bold">CAS</emphasis>) Single Sign On Framework. Details about CAS can be found <ulink url="http://www.ja-sig.org/cas/"> here </ulink> . </para> <para> The integration consists of two parts; the first part consists of installing or configuring a CAS server, the second part consists of setting up the portal to use the CAS server. @@ -371,11 +371,11 @@ </para> </step> <step> - <para> Edit <filename><replaceable>HTTPD_DIST</replaceable>/conf/httpd.conf</filename> and change the Listen 80 port to 8888 to avoid a conflict with the default JBoss Enterprise Portal Platform. + <para> Edit <filename><replaceable>HTTPD_DIST</replaceable>/conf/httpd.conf</filename> and change the Listen 80 port to 8888 to avoid a conflict with the default JBoss Portal Platform. <remark>NEEDINFO - this used to be HTTPD_DIST/conf/server.xml, but if you install httpd using RPM, this file doesn&apos;t seem to exist. I assumed the .conf file was the correct place to change the listen port.</remark> </para> <note> <para> - If JBoss Enterprise Portal Platform is running on the same machine as Apache Tomcat, other ports will need to be changed in addition to 8080 to avoid conflicts. They can be changed to any free port. For example; change the admin port from 8005 to 8805 and the AJP port from 8009 to 8809. + If JBoss Portal Platform is running on the same machine as Apache Tomcat, other ports will need to be changed in addition to 8080 to avoid conflicts. They can be changed to any free port. For example; change the admin port from 8005 to 8805 and the AJP port from 8009 to 8809. </para> </note> </step> @@ -551,7 +551,7 @@ <procedure> <step> <para> - Start (or restart) JBoss Enterprise Portal Platform and direct your web browser to <ulink url="http://localhost:8888/cas" type="http"> http://localhost:8888/cas </ulink> . + Start (or restart) JBoss Portal Platform and direct your web browser to <ulink url="http://localhost:8888/cas" type="http"> http://localhost:8888/cas </ulink> . </para> </step> <step> @@ -608,9 +608,9 @@ <title>Java Open Single Sign-On Project</title> <para>Configuring JOSSO for JBoss Enterprise Application Platform requires an Apache server instance to host JOSSO. JBoss Enterprise Application Platform communicates with the JOSSO Apache instance through the Single Sign On plug-in.</para> <para> - This Single Sign On plug-in enables seamless integration between JBoss Enterprise Portal Platform and the Java Open Single Sign-On Project (JOSSO) Single Sign On Framework. Details about JOSSO can be found at <ulink url="http://www.josso.org"/> . + This Single Sign On plug-in enables seamless integration between JBoss Portal Platform and the Java Open Single Sign-On Project (JOSSO) Single Sign On Framework. Details about JOSSO can be found at <ulink url="http://www.josso.org"/> . </para> - <para> The procedures in this section detail setting up the JOSSO server to authenticate against the JBoss Enterprise Portal Platform login module. + <para> The procedures in this section detail setting up the JOSSO server to authenticate against the JBoss Portal Platform login module. </para> <para>After completing all procedures in this section, all links redirecting to the user authentication pages will redirect to the JOSSO centralized authentication form. </para> @@ -651,11 +651,11 @@ <para>Copy <filename>PORTAL_SSO/josso/<replaceable>josso-18X</replaceable>/plugin/gatein.properties</filename> to the <filename><replaceable>JOSSO_HOME</replaceable>/webapps/josso/WEB-INF/classes/</filename> directory</para> </step> <step> - <para> Edit the <filename>JOSSO_HOME/conf/server.xml</filename> file and change all ports from 8080 to 8888. This port change prevents a conflict with the default JBoss Enterprise Portal Platform port. + <para> Edit the <filename>JOSSO_HOME/conf/server.xml</filename> file and change all ports from 8080 to 8888. This port change prevents a conflict with the default JBoss Portal Platform port. <note> <title>Port Conflicts</title> <para> - If JBoss Enterprise Portal Platform is running on the same machine as Apache, other ports need to be changed in addition to 8080 in order to avoid port conflicts. They can be changed to any free port. For example, you can change the <literal>admin</literal> port from 8005 to 8805, and the <literal>AJP</literal> port from 8009 to 8809. + If JBoss Portal Platform is running on the same machine as Apache, other ports need to be changed in addition to 8080 in order to avoid port conflicts. They can be changed to any free port. For example, you can change the <literal>admin</literal> port from 8005 to 8805, and the <literal>AJP</literal> port from 8009 to 8809. </para> </note> @@ -695,7 +695,7 @@ <title>Test the JOSSO Installation</title> <step> <para> - Start (or restart) JBoss Enterprise Portal Platform. + Start (or restart) JBoss Portal Platform. </para> </step> <step> @@ -712,7 +712,7 @@ <procedure id="proc-Reference_Guide-Java_Open_Single_Sign_On_Project-Setup_the_portal_to_redirect_to_JOSSO"> <title>Redirect portal authentication to JOSSO</title> <para>Redirect all user authentication to the JOSSO server. - Information about where the JOSSO server is hosted must be properly configured within the JBoss Enterprise Portal Platform instance. + Information about where the JOSSO server is hosted must be properly configured within the JBoss Portal Platform instance. </para> <step> <para> @@ -743,7 +743,7 @@ <section id="sect-Reference_Guide-SSO_Single_Sign_On_-OpenSSO"> <title>OpenSSO</title> <para> - This section details the setting up of OpenSSO server to authenticate against the JBoss Enterprise Portal Platform login module. + This section details the setting up of OpenSSO server to authenticate against the JBoss Portal Platform login module. </para> <procedure id="proc-Reference_Guide-OpenSSO-Obtaining_OpenSSO"> <title>Obtaining OpenSSO</title> @@ -772,10 +772,10 @@ To configure the web server as required, it is simpler to directly modify the source files. </para> <para> - The first step is to add the JBoss Enterprise Portal Platform Authentication Plugin. + The first step is to add the JBoss Portal Platform Authentication Plugin. </para> <para> - The plug-in makes secure callbacks to a RESTful service installed on the remote JBoss Enterprise Portal Platform server to authenticate a user. + The plug-in makes secure callbacks to a RESTful service installed on the remote JBoss Portal Platform server to authenticate a user. </para> <para> In order for the plug-in to function correctly, it needs to be properly configured to connect to this service. This configuration is done via the <filename>opensso.war/config/auth/default/AuthenticationPlugin.xml</filename> file. @@ -789,10 +789,10 @@ </step> <step> <para> - Edit <filename>TOMCAT_HOME/conf/server.xml</filename> and change the 8080 port to 8888 to avoid a conflict with the default JBoss Enterprise Portal Platform port. + Edit <filename>TOMCAT_HOME/conf/server.xml</filename> and change the 8080 port to 8888 to avoid a conflict with the default JBoss Portal Platform port. <note> <para> - If JBoss Enterprise Portal Platform is running on the same machine as Tomcat, other ports need to be changed in addition to 8080 in order to avoid port conflicts. They can be changed to any free port. For example, you can change the admin port from 8005 to 8805 and the AJP port from 8009 to 8809. + If JBoss Portal Platform is running on the same machine as Tomcat, other ports need to be changed in addition to 8080 in order to avoid port conflicts. They can be changed to any free port. For example, you can change the admin port from 8005 to 8805 and the AJP port from 8009 to 8809. </para> </note> @@ -990,7 +990,7 @@ <procedure> <step> <para> - Access JBoss Enterprise Portal Platform by going to <ulink url="http://localhost:8888/opensso/UI/Login?realm=gatein" type="http"> http://localhost:8888/opensso/UI/Login?realm=gatein </ulink> (assuming that the OpenSSO server using Tomcat is still running). + Access JBoss Portal Platform by going to <ulink url="http://localhost:8888/opensso/UI/Login?realm=gatein" type="http"> http://localhost:8888/opensso/UI/Login?realm=gatein </ulink> (assuming that the OpenSSO server using Tomcat is still running). </para> </step> <step> @@ -1058,7 +1058,7 @@ </step> <step> <para> - The user then launches a web browser to access a web application (that uses JBoss Negotiation) hosted on JBoss Enterprise Portal Platform. + The user then launches a web browser to access a web application (that uses JBoss Negotiation) hosted on JBoss Portal Platform. </para> </step> <step> @@ -1080,12 +1080,12 @@ <section id="sect-Reference_Guide-SPNEGO_Simple_and_Protected_GSSAPI_Negotiation_Mechanism-SPNEGO_Server_Configuration"> <title>SPNEGO Server Configuration</title> <para> - In this section, we will describe some necessary steps for setup Kerberos server on Linux. This server will then be used for SPNEGO authentication against JBoss Enterprise Portal Platform. + In this section, we will describe some necessary steps for setup Kerberos server on Linux. This server will then be used for SPNEGO authentication against JBoss Portal Platform. </para> <note> <title>SPNEGO Basics</title> <para> - The procedure below only describes the basic steps to configure the SPNEGO server in a Linux environment. If you are already familiar with SPNEGO, or if you are using Windows and Active Directory domain, you can jump to the <xref linkend="proc-Reference_Guide-JBoss_Enterprise_Portal_Platform_Configuration-Advanced_SPNEGO_Configuration"/> to see how to integrate SPNEGO with JBoss Enterprise Portal Platform. + The procedure below only describes the basic steps to configure the SPNEGO server in a Linux environment. If you are already familiar with SPNEGO, or if you are using Windows and Active Directory domain, you can jump to the <xref linkend="proc-Reference_Guide-JBoss_Enterprise_Portal_Platform_Configuration-Advanced_SPNEGO_Configuration"/> to see how to integrate SPNEGO with JBoss Portal Platform. </para> <para> Please note that Kerberos setup is also dependent on your Linux distribution and so steps can be slightly different in your environment. @@ -1095,7 +1095,7 @@ <title>SPNEGO Basics</title> <step> <para> - Correct the setup of network on the machine. For example, if you are using the &quot;server.local.network&quot; domain as your machine where Kerberos and JBoss Enterprise Portal Platform are localed, add the line containing the machine&apos;s IP address to the <emphasis role="bold">/etc/host </emphasis> file. + Correct the setup of network on the machine. For example, if you are using the &quot;server.local.network&quot; domain as your machine where Kerberos and JBoss Portal Platform are localed, add the line containing the machine&apos;s IP address to the <emphasis role="bold">/etc/host </emphasis> file. </para> <programlisting> 192.168.1.88 server.local.network @@ -1252,7 +1252,7 @@ </listitem> <listitem> <para> - Add the JBoss Enterprise Portal Platform machine and keytab file that need to be authenticated. + Add the JBoss Portal Platform machine and keytab file that need to be authenticated. </para> <programlisting> addprinc -randkey HTTP/server.local.network(a)LOCAL.NETWORK @@ -1261,7 +1261,7 @@ </listitem> <listitem> <para> - Add the default JBoss Enterprise Portal Platform user accounts and enter the password for each created user that will be authenticated. + Add the default JBoss Portal Platform user accounts and enter the password for each created user that will be authenticated. </para> <programlisting> addprinc john @@ -1307,7 +1307,7 @@ <section id="sect-Reference_Guide-SPNEGO_Simple_and_Protected_GSSAPI_Negotiation_Mechanism-SPNEGO_Server_Configuration-Clients"> <title>Clients</title> <para> - After performing all configurations above, you need to enable the <emphasis role="bold">Negotiate authentication </emphasis> of Firefox in client machines so that clients could be authenticated by JBoss Enterprise Portal Platform as follows: + After performing all configurations above, you need to enable the <emphasis role="bold">Negotiate authentication </emphasis> of Firefox in client machines so that clients could be authenticated by JBoss Portal Platform as follows: </para> <procedure> <step> @@ -1335,9 +1335,9 @@ </note> </section> <section id="sect-Reference_Guide-SPNEGO_Simple_and_Protected_GSSAPI_Negotiation_Mechanism-JBoss_Enterprise_Portal_Platform_Configuration"> - <title>JBoss Enterprise Portal Platform Configuration</title> + <title>JBoss Portal Platform Configuration</title> <para> - JBoss Enterprise Portal Platform uses JBoss Negotiation to enable SPNEGO-based desktop SSO for the portal. Here are the steps to integrate SPNEGO with JBoss Enterprise Portal Platform. +JBoss Portal Platform uses JBoss Negotiation to enable SPNEGO-based desktop SSO for the portal. Here are the steps to integrate SPNEGO with JBoss Portal Platform. </para> <procedure id="proc-Reference_Guide-JBoss_Enterprise_Portal_Platform_Configuration-Advanced_SPNEGO_Configuration"> <title>Advanced SPNEGO Configuration</title> @@ -1429,7 +1429,7 @@ </step> <step> <para> - Start the JBoss Enterprise Portal Platform; + Start the JBoss Portal Platform; </para> <programlisting language="Java" role="Java"><xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="../../extras/Authentication_Identity_SSO/default130.java" parse="text"/></programlisting> <note> @@ -1448,7 +1448,7 @@ </step> </procedure> <para> - Clicking the &apos;Sign In&apos; link on the JBoss Enterprise Portal Platform should automatically sign the &apos;demo&apos; user into the portal. + Clicking the &apos;Sign In&apos; link on the JBoss Portal Platform should automatically sign the &apos;demo&apos; user into the portal. </para> <para> If you destroy your kerberos ticket with command <command>kdestroy</command>, then try to login again, you will directed to the login screen of JBoss Enterprise Portal Product because you do not have active Kerberos ticket. You can login with predefined account and password &quot;demo&quot;/&quot;gtn&quot; . Modified: epp/docs/branches/6.0/Reference_Guide/en-US/modules/Introduction.xml =================================================================== --- epp/docs/branches/6.0/Reference_Guide/en-US/modules/Introduction.xml 2012-10-24 06:12:02 UTC (rev 8938) +++ epp/docs/branches/6.0/Reference_Guide/en-US/modules/Introduction.xml 2012-10-25 06:01:34 UTC (rev 8939) @@ -6,7 +6,7 @@ <chapter id="chap-Reference_Guide-Introduction"> <title>Introduction</title> <para> - JBoss Enterprise Portal Platform is based on the GateIn project, which is the merge of two mature Java projects: JBoss Portal and eXo Portal. This new community project takes the best of both offerings and incorporates them into a single portal framework. The aim is to provide an intuitive user-friendly portal, and a framework to address the needs of today&apos;s Web 2.0 applications. +JBoss Portal Platform is based on the GateIn project, which is the merge of two mature Java projects: JBoss Portal and eXo Portal. This new community project takes the best of both offerings and incorporates them into a single portal framework. The aim is to provide an intuitive user-friendly portal, and a framework to address the needs of today&apos;s Web 2.0 applications. </para> <mediaobject> <imageobject role="html"> @@ -17,7 +17,7 @@ </imageobject> </mediaobject> <para> - This book provides a deep-dive information about installation and configuration of the services provided by JBoss Enterprise Portal Platform. + This book provides a deep-dive information about installation and configuration of the services provided by JBoss Portal Platform. </para> <section id="sect-Reference_Guide-Introduction-Related_Links"> <title>Related Links</title> @@ -50,7 +50,7 @@ <term>Videos</term> <listitem> <para> - A link to <ulink url="http://vimeo.com/channels/gatein" type="http">videos</ulink> related to the JBoss Enterprise Portal Platform is also included on the front page: + A link to <ulink url="http://vimeo.com/channels/gatein" type="http">videos</ulink> related to the JBoss Portal Platform is also included on the front page: </para> <mediaobject> <imageobject role="html"> Modified: epp/docs/branches/6.0/Reference_Guide/en-US/modules/PortalDevelopment/DefaultPortalConfiguration.xml =================================================================== --- epp/docs/branches/6.0/Reference_Guide/en-US/modules/PortalDevelopment/DefaultPortalConfiguration.xml 2012-10-24 06:12:02 UTC (rev 8938) +++ epp/docs/branches/6.0/Reference_Guide/en-US/modules/PortalDevelopment/DefaultPortalConfiguration.xml 2012-10-25 06:01:34 UTC (rev 8939) @@ -1,43 +1,36 @@ -<?xml version='1.0' encoding='utf-8' ?> +<?xml version='1.0' encoding='UTF-8'?> <!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [ <!ENTITY % BOOK_ENTITIES SYSTEM "Reference_Guide.ent"> %BOOK_ENTITIES; ]> <chapter id="chap-Reference_Guide-Default_Portal_Configuration"> - <title>Default Portal Configuration</title> - <section id="sect-Reference_Guide-Default_Portal_Configuration-Overview"> - <title>Overview</title> - <para> - JBoss Enterprise Portal Platform's default home page URL is <literal>http://{hostname}:{port}/portal/</literal>. There may be multiple independent portal containers deployed in parallel at any given time, each of which has its root context (<literal>http://{hostname}:{port}/sample-portal/</literal>, for example). + <title>Default Portal Configuration</title> + <section id="sect-Reference_Guide-Default_Portal_Configuration-Overview"> + <title>Overview</title> + <para> +JBoss Portal Platform&apos;s default home page URL is <literal>http://{hostname}:{port}/portal/</literal>. There may be multiple independent portal containers deployed in parallel at any given time, each of which has its root context (<literal>http://{hostname}:{port}/sample-portal/</literal>, for example). </para> - <para> - Each portal container is internally composed of one or more 'portals'. This is because there needs to be at least one such portal available. The default portal is called '<emphasis>Classic</emphasis>'. When accessing JBoss Enterprise Portal Platform's default URL, you are automatically directed to the '<emphasis>Classic</emphasis>' portal. + <para> + Each portal container is internally composed of one or more &apos;portals&apos;. This is because there needs to be at least one such portal available. The default portal is called &apos;<emphasis>Classic</emphasis>&apos;. When accessing JBoss Portal Platform&apos;s default URL, you are automatically directed to the &apos;<emphasis>Classic</emphasis>&apos; portal. </para> - <para> - The default portal performs another important task. When starting up JBoss Enterprise Portal Platform for the first time, its JCR database (where portal runtime-configurable settings are stored) will be empty . The default portal detects this and triggers automatic data initialization. + <para> + The default portal performs another important task. When starting up JBoss Portal Platform for the first time, its JCR database (where portal runtime-configurable settings are stored) will be empty . The default portal detects this and triggers automatic data initialization. </para> - - </section> - - <section id="sect-Reference_Guide-Default_Portal_Configuration-Configuration"> - <title>Configuration</title> - <para> - The following example configuration can be found at: "<filename>02portal.war:/WEB-INF/conf/portal/portal-configuration.xml</filename>". + </section> + <section id="sect-Reference_Guide-Default_Portal_Configuration-Configuration"> + <title>Configuration</title> + <para> + The following example configuration can be found at: &quot;<filename>02portal.war:/WEB-INF/conf/portal/portal-configuration.xml</filename>&quot;. </para> - -<programlisting language="XML" role="XML"><xi:include href="../../extras/PortalDevelopment_DefaultPortalConfiguration/default143.xml" parse="text" xmlns:xi="http://www.w3.org/2001/XInclude" /></programlisting> - <para> + <programlisting language="XML" role="XML"><xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="../../extras/PortalDevelopment_DefaultPortalConfiguration/default143.xml" parse="text"/></programlisting> + <para> In this example the <emphasis>Classic</emphasis> portal has been set as the default. </para> - <para> + <para> Notice that the <literal>NewPortalConfigListener</literal> <parameter>component-plugin</parameter> is used to add configuration to <literal>UserPortalConfigService</literal>, which is designed in this way to allow other components to add configuration to it. </para> - <para> + <para> <emphasis>Components</emphasis>, <emphasis>component-plugins</emphasis>, and <emphasis>init-params</emphasis> are explained in a later chapter of this document. </para> - - </section> - - + </section> </chapter> - Modified: epp/docs/branches/6.0/Reference_Guide/en-US/modules/PortalDevelopment/DefaultPortalNavigationConfiguration.xml =================================================================== --- epp/docs/branches/6.0/Reference_Guide/en-US/modules/PortalDevelopment/DefaultPortalNavigationConfiguration.xml 2012-10-24 06:12:02 UTC (rev 8938) +++ epp/docs/branches/6.0/Reference_Guide/en-US/modules/PortalDevelopment/DefaultPortalNavigationConfiguration.xml 2012-10-25 06:01:34 UTC (rev 8939) @@ -40,8 +40,8 @@ <!-- DOC NOTE: Added based on Gatein revision 6987 --> <para> Each portal, groups and users navigation is indicated by a configuration paragraph, for example: </para> -<example> -<title>Navigation Configuration Paragraph Example</title> + <example> + <title>Navigation Configuration Paragraph Example</title> <programlisting language="XML" role="XML">&lt;object-param&gt; &lt;name&gt;portal.configuration&lt;/name&gt; &lt;description&gt;description&lt;/description&gt; @@ -63,41 +63,41 @@ &lt;/object&gt; &lt;/object-param&gt; </programlisting> - <para> + <para> <parameter>predefinedOwner</parameter> defines the navigation owner, portal will look for the configuration files in folder with this name, if there is no suitable folder, a default portal will be created with name is this value. </para> - <para> + <para> <parameter>ownerType</parameter> defines the type of portal navigation. It may be a portal, group, or user. </para> - <para> + <para> <parameter>templateLocation</parameter> defines the classpath to all portal configuration files </para> - <para> + <para> <parameter>importMode</parameter> is the mode for navigation import. There are 4 types of import mode: </para> - <itemizedlist> - <listitem> - <para> + <itemizedlist> + <listitem> + <para> <parameter>conserve</parameter>: Import data when it does not exist, otherwise do nothing. </para> - </listitem> - <listitem> - <para> + </listitem> + <listitem> + <para> <parameter>insert</parameter>: Import data when it does not exist, otherwise performs a strategy that adds new data only. </para> - </listitem> - <listitem> - <para> + </listitem> + <listitem> + <para> <parameter>merge</parameter>: Import data when it does not exist, update data when it exists. </para> - </listitem> - <listitem> - <para> + </listitem> + <listitem> + <para> <parameter>rewrite</parameter>: Overwrite data whatsoever. </para> - </listitem> - </itemizedlist> -</example> + </listitem> + </itemizedlist> + </example> <para> Based on these parameters, the portal will look for the configuration files and create a relevant portal navigation, pages and data import strategy. </para> @@ -121,7 +121,7 @@ <term>portal.xml</term> <listitem> <para> - This file describes the layout and portlets that will be shown on all pages. Usually the layout contains the banner, footer, menu and breadcrumbs portlets. JBoss Enterprise Portal Platform is extremely configurable as every view element (even the banner and footer) is a portlet. + This file describes the layout and portlets that will be shown on all pages. Usually the layout contains the banner, footer, menu and breadcrumbs portlets. JBoss Portal Platform is extremely configurable as every view element (even the banner and footer) is a portlet. </para> <programlisting language="XML" role="XML"><xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="../../extras/PortalDevelopment_DefaultPortalNavigationConfiguration/portal.xml" parse="text"/></programlisting> <para> @@ -131,7 +131,7 @@ Each application references a portlet using the id <literal>portal#{portalName}:/{portletWarName}/{portletName}/{uniqueId}</literal>. </para> <para> - Use the <literal>page-body</literal> tag to define where JBoss Enterprise Portal Platform should render the current page. + Use the <literal>page-body</literal> tag to define where JBoss Portal Platform should render the current page. </para> <para> The defined <emphasis>classic</emphasis> portal is accessible to &quot;Everyone&quot; (at <literal>/portal/classic</literal>) but only members of the group <literal>/platform/administrators</literal> can edit it. @@ -172,7 +172,7 @@ <para> Subnodes can also be created using the following XML structure </para> - <programlisting language="XML" role="XML"><xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="../../extras/PortalDevelopment_DefaultPortalNavigationConfiguration/subpage.xml" parse="text"/></programlisting> + <programlisting language="XML" role="XML"><xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="../../extras/PortalDevelopment_DefaultPortalNavigationConfiguration/subpage.xml" parse="text"/></programlisting> </listitem> </varlistentry> <varlistentry> Modified: epp/docs/branches/6.0/Reference_Guide/en-US/modules/PortalDevelopment/InternationalizationConfiguration.xml =================================================================== --- epp/docs/branches/6.0/Reference_Guide/en-US/modules/PortalDevelopment/InternationalizationConfiguration.xml 2012-10-24 06:12:02 UTC (rev 8938) +++ epp/docs/branches/6.0/Reference_Guide/en-US/modules/PortalDevelopment/InternationalizationConfiguration.xml 2012-10-25 06:01:34 UTC (rev 8939) @@ -10,14 +10,14 @@ <note> <title>Assumed Knowledge</title> <para> - JBoss Enterprise Portal Platform is fully configurable for internationalization, however users should have a general knowledge of Internationalization in Java products before attempting these configurations. +JBoss Portal Platform is fully configurable for internationalization, however users should have a general knowledge of Internationalization in Java products before attempting these configurations. </para> <para> Sun Java hosts a comprehensive guide to internationalizing Java products at <ulink url="http://java.sun.com/docs/books/tutorial/i18n/TOC.html"/>;. </para> </note> <para> - All JBoss Enterprise Portal Platform applications contain property files for various languages. They are packaged with the portlets applications in a <filename>WEB-INF/classes/locale/</filename> directory. + All JBoss Portal Platform applications contain property files for various languages. They are packaged with the portlets applications in a <filename>WEB-INF/classes/locale/</filename> directory. </para> <para> These files are located in the <filename>classes</filename> folder of the <filename>WEB-INF</filename> directory, so as to be loaded by the <literal>ClassLoader</literal>. @@ -70,20 +70,20 @@ <example> <title>The locales-config.xml File Explanation</title> <programlisting language="XML" role="XML"><xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="../../extras/PortalDevelopment_InternationalizationConfiguration/default150.xml" parse="text"/></programlisting> - <para> + <para> <literal>locale</literal>: The locale has to be defined as per the codes defined <ulink url="http://ftp.ics.uci.edu/pub/ietf/http/related/iso639.txt" type="http">here</ulink>. In this example &quot;<emphasis>ar</emphasis>&quot; is Arabic. </para> - <para> + <para> <literal>output-encoding</literal>: deals with character encoding. It is recommended that UTF-8 be used. </para> - <para> + <para> <literal>input-encoding</literal>: In the Java implementation, the encoding parameters will be used for the request response stream. The input-encoding parameter will be used for request <literal>setCharacterEncoding(..)</literal>. </para> - <para> + <para> <literal>description</literal>: A description of the language. </para> - <para> - <literal>orientation</literal>: Although the default orientation of text and images is Left-To-Right, JBoss Enterprise Portal Platform supports <emphasis>Right-To-Left</emphasis> orientation. Modifying text orientation is explained in <xref linkend="chap-Reference_Guide-Right_To_Left_RTL_Framework"/>. + <para> + <literal>orientation</literal>: Although the default orientation of text and images is Left-To-Right, JBoss Portal Platform supports <emphasis>Right-To-Left</emphasis> orientation. Modifying text orientation is explained in <xref linkend="chap-Reference_Guide-Right_To_Left_RTL_Framework"/>. </para> </example> </section> @@ -93,13 +93,13 @@ The resource bundle service is configured in: <filename>02portal.war:/WEB-INF/conf/common/common-configuration.xml</filename>: </para> <example> - <title>The common-configuration.xml file explained</title> + <title>The common-configuration.xml file explained</title> <programlisting language="XML" role="XML"><xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="../../extras/PortalDevelopment_InternationalizationConfiguration/default151.xml" parse="text"/></programlisting> - <para> + <para> Comment #1: resources whose package name starts with the name specified in the <emphasis>classpath.resources</emphasis> parameter are loaded from the file system. Detailed information can be found in a later section of this chapter. </para> - <para> - Comment #2: the <emphasis>portal.resource.names</emphasis> parameter defines all resources that belong to the <emphasis>Portal Resource Bundle</emphasis>. These resources are merged to a single resource bundle which is accessible from anywhere in JBoss Enterprise Portal Platform. All these keys are located in the same bundle, which is separated from the navigation resource bundles. + <para> + Comment #2: the <emphasis>portal.resource.names</emphasis> parameter defines all resources that belong to the <emphasis>Portal Resource Bundle</emphasis>. These resources are merged to a single resource bundle which is accessible from anywhere in JBoss Portal Platform. All these keys are located in the same bundle, which is separated from the navigation resource bundles. </para> </example> </section> Modified: epp/docs/branches/6.0/Reference_Guide/en-US/modules/PortalDevelopment/LocalizationConfiguration.xml =================================================================== --- epp/docs/branches/6.0/Reference_Guide/en-US/modules/PortalDevelopment/LocalizationConfiguration.xml 2012-10-24 06:12:02 UTC (rev 8938) +++ epp/docs/branches/6.0/Reference_Guide/en-US/modules/PortalDevelopment/LocalizationConfiguration.xml 2012-10-25 06:01:34 UTC (rev 8939) @@ -17,13 +17,13 @@ The exact algorithm for determining the current <literal>Locale</literal> is not specified by Portlet Specification. Portlet containers implement this the way they deem most appropriate. </para> <para> - In JBoss Enterprise Portal Platform, each portal instance has a default language which can be used to present content for new users. Another option is to use each user’s browser language preference, provided it matches one of the available localizations that JBoss Enterprise Portal Platform supports, and only fallback to the portal&apos;s default language if no match is found. + In JBoss Portal Platform, each portal instance has a default language which can be used to present content for new users. Another option is to use each user’s browser language preference, provided it matches one of the available localizations that JBoss Portal Platform supports, and only fallback to the portal&apos;s default language if no match is found. </para> <para> Every user, while visiting a portal, has an option to change the language of the user interface by using a Language chooser. The choice can be remembered for the duration of the session, or it can be remembered for a longer period using a browser cookie, or, for registered and logged-in users, it can be saved into the user’s profile. </para> <para> - As there is more than one way to determine the <literal>Locale</literal> to be used for displaying a portal page, the mechanism for determining the current <literal>Locale</literal> of the request is pluggable in JBoss Enterprise Portal Platform, and the exact algorithm can be customized. + As there is more than one way to determine the <literal>Locale</literal> to be used for displaying a portal page, the mechanism for determining the current <literal>Locale</literal> of the request is pluggable in JBoss Portal Platform, and the exact algorithm can be customized. </para> <section id="sect-Reference_Guide-Pluggable_Locale_Policy-LocalePolicy_API"> <title>LocalePolicy API</title> @@ -278,7 +278,7 @@ By default, <literal>LocalizationFilter</literal> is applied very broadly to cover all the resources automatically. </para> <para> - JBoss Enterprise Portal Platform uses some non-bridged .jsps that require <literal>LocalizationFilter</literal>, so narrowing the mapping to *.jsp is enough for JBoss Enterprise Portal Platform to function correctly. +JBoss Portal Platform uses some non-bridged .jsps that require <literal>LocalizationFilter</literal>, so narrowing the mapping to *.jsp is enough for JBoss Portal Platform to function correctly. </para> <para> Additionally deployed portlets, and portal applications, however, may require broader mapping to cover their non-bridged resources. Modified: epp/docs/branches/6.0/Reference_Guide/en-US/modules/PortalDevelopment/NavigationController.xml =================================================================== --- epp/docs/branches/6.0/Reference_Guide/en-US/modules/PortalDevelopment/NavigationController.xml 2012-10-24 06:12:02 UTC (rev 8938) +++ epp/docs/branches/6.0/Reference_Guide/en-US/modules/PortalDevelopment/NavigationController.xml 2012-10-25 06:01:34 UTC (rev 8939) @@ -8,7 +8,7 @@ <section id="sect-Reference_Guide-Navigation_Controller_-Description"> <title>Description</title> <para> - The navigation controller is a major enhancement of JBoss Enterprise Portal Platform that has several goals: + The navigation controller is a major enhancement of JBoss Portal Platform that has several goals: </para> <itemizedlist> <listitem> @@ -33,7 +33,7 @@ <section id="sect-Reference_Guide-Controller_in_Action-Controller"> <title>Controller</title> <para> - The <application>WebAppController</application> is the component of JBoss Enterprise Portal Platform that processes <literal>http</literal> invocations and transforms them into a portal request. It has been improved with the addition of a request mapping engine (<emphasis role="bold">controller</emphasis>) whose role is to make the decoupling of the <literal>http</literal> request and create a portal request. + The <application>WebAppController</application> is the component of JBoss Portal Platform that processes <literal>http</literal> invocations and transforms them into a portal request. It has been improved with the addition of a request mapping engine (<emphasis role="bold">controller</emphasis>) whose role is to make the decoupling of the <literal>http</literal> request and create a portal request. </para> <para> The mapping engine performs two essential tasks: @@ -51,10 +51,10 @@ </listitem> </itemizedlist> <para> - The goal of the controller (mapping engine) is to <emphasis role="bold">decouple</emphasis> the request processed by JBoss Enterprise Portal Platform from the incoming <literal>HTTP</literal> request. + The goal of the controller (mapping engine) is to <emphasis role="bold">decouple</emphasis> the request processed by JBoss Portal Platform from the incoming <literal>HTTP</literal> request. </para> <para> - Indeed a request contains data that determines how the request will be processed and such data can be encoded in various places in the request such as the request path or a query parameter. The controller allows JBoss Enterprise Portal Platform route a request according to a set of parameters (a map) instead of the servlet request. + Indeed a request contains data that determines how the request will be processed and such data can be encoded in various places in the request such as the request path or a query parameter. The controller allows JBoss Portal Platform route a request according to a set of parameters (a map) instead of the servlet request. </para> <para> The controller configuration is declarative in an XML file, allowing easy reconfiguration of the routing table and it is processed into an internal data structure that is used to perform resolution (routing or rendering) @@ -63,7 +63,7 @@ <section id="sect-Reference_Guide-Controller_in_Action-Building_Controller"> <title>Building Controller</title> <para> - The controller configuration that contains the routing rules is loaded from a file named <filename>controller.xml</filename> that is retrieved in the JBoss Enterprise Portal Platform configuration directory. Its location is determined by the <parameter>gatein.controller.config</parameter> property. + The controller configuration that contains the routing rules is loaded from a file named <filename>controller.xml</filename> that is retrieved in the JBoss Portal Platform configuration directory. Its location is determined by the <parameter>gatein.controller.config</parameter> property. </para> <para> <application>WebAppController</application> loads and initializes the mapping engine. @@ -81,7 +81,7 @@ &lt;/component&gt; </programlisting> <para> - JBoss Enterprise Portal Platform&apos;s extension project can define their own routing table, because of the extension mechanism. +JBoss Portal Platform&apos;s extension project can define their own routing table, because of the extension mechanism. </para> <para> The <filename>controller.xml</filename> can be changed and reloaded at runtime. This helps testing different configurations easily (configuration loading operations) and provides more insight into the routing engine (the <literal>findRoutes</literal> operation). </para> @@ -394,11 +394,11 @@ </section> </section> <section id="sect-Reference_Guide-Navigation_Controller_-Integrate_to_JBoss_Enterprise_Portal_Platform_WebUI_framework"> - <title>Integrate to JBoss Enterprise Portal Platform WebUI framework</title> + <title>Integrate to JBoss Portal Platform WebUI framework</title> <section id="sect-Reference_Guide-Integrate_to_JBoss_Enterprise_Portal_Platform_WebUI_framework-Routing"> <title>Routing</title> <para> - JBoss Enterprise Portal Platform defines a set of parameters in its routing table, for each client request, the mapping engine processes the request path and returns the defined parameters with their values as a Map&lt;QualifiedName, String&gt; +JBoss Portal Platform defines a set of parameters in its routing table, for each client request, the mapping engine processes the request path and returns the defined parameters with their values as a Map&lt;QualifiedName, String&gt; </para> <para> <emphasis role="bold">gtn:handler</emphasis> @@ -455,7 +455,7 @@ <section id="sect-Reference_Guide-Integrate_to_JBoss_Enterprise_Portal_Platform_WebUI_framework-Rendering"> <title>Rendering</title> <para> - The <emphasis role="bold">controller</emphasis> is designed to render a Map&lt;QualifiedName, String&gt; as an <literal>http</literal> URL according to its routing table. But to integrate it for using easily in WebUI Framework of JBoss Enterprise Portal Platform, we need some more components + The <emphasis role="bold">controller</emphasis> is designed to render a Map&lt;QualifiedName, String&gt; as an <literal>http</literal> URL according to its routing table. But to integrate it for using easily in WebUI Framework of JBoss Portal Platform, we need some more components </para> <section id="sect-Reference_Guide-Rendering-_PortalURL_"> <title> Modified: epp/docs/branches/6.0/Reference_Guide/en-US/modules/PortalDevelopment/PortalLifecycle.xml =================================================================== --- epp/docs/branches/6.0/Reference_Guide/en-US/modules/PortalDevelopment/PortalLifecycle.xml 2012-10-24 06:12:02 UTC (rev 8938) +++ epp/docs/branches/6.0/Reference_Guide/en-US/modules/PortalDevelopment/PortalLifecycle.xml 2012-10-25 06:01:34 UTC (rev 8939) @@ -1,62 +1,48 @@ -<?xml version='1.0' encoding='utf-8' ?> +<?xml version='1.0' encoding='UTF-8'?> <!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [ <!ENTITY % BOOK_ENTITIES SYSTEM "Reference_Guide.ent"> %BOOK_ENTITIES; ]> - <chapter id="chap-Reference_Guide-Portal_Life_cycle"> - <title>Portal Life-cycle</title> - - <section id="sect-Reference_Guide-Portal_Life_cycle-Overview"> - <title>Overview</title> - - <para> +<chapter id="chap-Reference_Guide-Portal_Life_cycle"> + <title>Portal Life-cycle</title> + <section id="sect-Reference_Guide-Portal_Life_cycle-Overview"> + <title>Overview</title> + <para> This chapter describes the portal life-cycle from the application server start to its stop including how requests are handled. </para> - </section> - - <section id="sect-Reference_Guide-Portal_Life_cycle-Application_Server_start_and_stop"> - <title>Application Server start and stop</title> - - <para> + </section> + <section id="sect-Reference_Guide-Portal_Life_cycle-Application_Server_start_and_stop"> + <title>Application Server start and stop</title> + <para> A portal instance is simply a set of web applications deployed as <filename>EAR</filename> and <filename>WAR</filename> archives. Portlets are also part of an enhanced WAR called a portlet application. </para> - - <para> - JBoss Enterprise Portal Platform does not require any particular setup for your portlet in most common scenarios and the <filename>web.xml</filename> file can remain without any JBoss Enterprise Portal Platform specific configuration. + <para> +JBoss Portal Platform does not require any particular setup for your portlet in most common scenarios and the <filename>web.xml</filename> file can remain without any JBoss Portal Platform specific configuration. </para> - - <para> - During deployment, JBoss Enterprise Portal Platform will automatically and transparently inject a servlet into the portlet application to be able to interact with it. This feature is dependent on the underlying servlet container but will work out of the box on the proposed bundles. + <para> + During deployment, JBoss Portal Platform will automatically and transparently inject a servlet into the portlet application to be able to interact with it. This feature is dependent on the underlying servlet container but will work out of the box on the proposed bundles. </para> - </section> + </section> <!-- TODO: Define the added listener - --> -<!-- + --><!-- <section id="sect-Reference_Guide-Portal_Lifecycle-The_Listener"> <title>The Listener</title> <para> In the web.xml we can find servlet listener: -</para> --> -<!-- <programlisting language="Java" role="Java"><xi:include parse="text" href="../../extras/PortalDevelopment_PortalLifecycle/default158.java" xmlns:xi="http://www.w3.org/2001/XInclude" /></programlisting> --> -<!-- <programlisting> &lt;!- ================================================================== -&gt; +</para> --><!-- <programlisting language="Java" role="Java"><xi:include parse="text" href="../../extras/PortalDevelopment_PortalLifecycle/default158.java" xmlns:xi="http://www.w3.org/2001/XInclude" /></programlisting> --><!-- <programlisting> &lt;!- ================================================================== -&gt; &lt;!- LISTENER -&gt; &lt;!- ================================================================== -&gt; &lt;listener&gt; &lt;listener-class&gt;org.exoplatform.portal.application.PortalSessionListener&lt;/listener-class&gt; &lt;/listener&gt; -</programlisting> --> -<!-- <para> +</programlisting> --><!-- <para> That listener implements the HttpSessionListener which means it is called each time a session is created or destroyed; in other words, a session is created each time a user send a first request to the portal. That session is destroyed when he has not sent request to the portal for a long time or when he closes his browser. </para> -<programlisting language="Java" role="Java"><xi:include parse="text" href="../../extras/PortalDevelopment_PortalLifecycle/PortalSessionListener.java" xmlns:xi="http://www.w3.org/2001/XInclude" /></programlisting> --> -<!-- <programlisting>public class PortalSessionListener implements HttpSessionListener -</programlisting> --> -<!-- <para> +<programlisting language="Java" role="Java"><xi:include parse="text" href="../../extras/PortalDevelopment_PortalLifecycle/PortalSessionListener.java" xmlns:xi="http://www.w3.org/2001/XInclude" /></programlisting> --><!-- <programlisting>public class PortalSessionListener implements HttpSessionListener +</programlisting> --><!-- <para> Only the destroy method of the Listener object is implemented and it is used to flush resources when a user portal session expires. Here is the code: -</para> --> -<!-- <programlisting language="Java" role="Java"><xi:include parse="text" href="../../extras/PortalDevelopment_PortalLifecycle/default159.java" xmlns:xi="http://www.w3.org/2001/XInclude" /></programlisting> --> -<!-- <programlisting> /** +</para> --><!-- <programlisting language="Java" role="Java"><xi:include parse="text" href="../../extras/PortalDevelopment_PortalLifecycle/default159.java" xmlns:xi="http://www.w3.org/2001/XInclude" /></programlisting> --><!-- <programlisting> /** * This method is called when a HTTP session of a Portal instance is destroyed. * By default the session time is 30 minutes. * @@ -91,54 +77,45 @@ } } </programlisting> - --> - <section id="sect-Reference_Guide-Portal_Life_cycle-The_Command_Servlet"> - <title>The Command Servlet</title> - - <para> + --> <section id="sect-Reference_Guide-Portal_Life_cycle-The_Command_Servlet"> + <title>The Command Servlet</title> + <para> The CommandServlet is called by the portlet container for requests to particular portlets, it also includes some <literal>init</literal> code when the portal is launched. This servlet (<literal>org.gatein.wci.api.GateInServlet</literal>) is automatically added during the deployment of each portlet application and mapped to <literal>/gateinservlet</literal>. </para> - - <para> + <para> This is equivalent to adding the following into <filename>web.xml</filename>. </para> - - <note> - <title>Servlet Configuration</title> - - <para> + <note> + <title>Servlet Configuration</title> + <para> <emphasis role="bold">As the servlet is already configured this example is for information only.</emphasis> </para> - </note> -<programlisting language="XML" role="XML"><xi:include href="../../extras/PortalDevelopment_PortalLifecycle/default160.xml" parse="text" xmlns:xi="http://www.w3.org/2001/XInclude" /></programlisting> - <para> + </note> + <programlisting language="XML" role="XML"><xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="../../extras/PortalDevelopment_PortalLifecycle/default160.xml" parse="text"/></programlisting> + <para> It is possible to filter on the <literal>GateInServlet</literal> by filtering the URL pattern used by the servlet mapping. </para> - - <para> + <para> The example below would create a servlet filter that calculates the time of execution of a portlet request. </para> - - <para> + <para> The filter class: </para> -<programlisting language="Java" role="Java"><xi:include href="../../extras/PortalDevelopment_PortalLifecycle/MyFilter.java" parse="text" xmlns:xi="http://www.w3.org/2001/XInclude" /></programlisting> - <para> + <programlisting language="Java" role="Java"><xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="../../extras/PortalDevelopment_PortalLifecycle/MyFilter.java" parse="text"/></programlisting> + <para> The Java EE web application configuration file (<filename>web.xml</filename>) of the portlet is the file on which we want to know the time to serve a portlet request. </para> - - <para> - As mentioned above nothing specific to JBoss Enterprise Portal Platform needs to be included, only the URL pattern to set has to be known. + <para> + As mentioned above nothing specific to JBoss Portal Platform needs to be included, only the URL pattern to set has to be known. </para> -<programlisting language="XML" role="XML"><xi:include href="../../extras/PortalDevelopment_PortalLifecycle/default161.xml" parse="text" xmlns:xi="http://www.w3.org/2001/XInclude" /></programlisting> - <note> - <title>INCLUDE dispatcher</title> - - <para> + <programlisting language="XML" role="XML"><xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="../../extras/PortalDevelopment_PortalLifecycle/default161.xml" parse="text"/></programlisting> + <note> + <title>INCLUDE dispatcher</title> + <para> It is important to set <literal>INCLUDE</literal> as dispatcher as the portal will always hit the <literal>GateInServlet</literal> through a request dispatcher. Without this, the filter will not be triggered, unless direct access to a resource (such as an image) is set. </para> - </note> - </section> + </note> + </section> <!-- <para> Here is its definition in the web.xml file: @@ -943,5 +920,4 @@ } } </programlisting> ---> - </chapter> +--></chapter> Modified: epp/docs/branches/6.0/Reference_Guide/en-US/modules/PortalDevelopment/Skinning.xml =================================================================== --- epp/docs/branches/6.0/Reference_Guide/en-US/modules/PortalDevelopment/Skinning.xml 2012-10-24 06:12:02 UTC (rev 8938) +++ epp/docs/branches/6.0/Reference_Guide/en-US/modules/PortalDevelopment/Skinning.xml 2012-10-25 06:01:34 UTC (rev 8939) @@ -8,7 +8,7 @@ <section id="sect-Reference_Guide-Skinning_the_Portal-Overview"> <title>Overview</title> <para> - JBoss Enterprise Portal Platform provides robust skinning support for the entire portal User Interface (UI). This includes support for skinning all of the common portal elements as well as being able to provide custom skins and window decoration for individual portlets. This has been designed with common graphic resource reuse and ease of development in mind. +JBoss Portal Platform provides robust skinning support for the entire portal User Interface (UI). This includes support for skinning all of the common portal elements as well as being able to provide custom skins and window decoration for individual portlets. This has been designed with common graphic resource reuse and ease of development in mind. </para> </section> <section id="sect-Reference_Guide-Skinning_the_Portal-Skin_Components"> @@ -44,7 +44,7 @@ <term>Portlet Specification CSS Classes</term> <listitem> <para> - The portlet specification defines a set of CSS classes that should be available to portlets. JBoss Enterprise Portal Platform provides these classes as part of the portal skin. This allows each portal skin to define its own look and feel for these default values. + The portlet specification defines a set of CSS classes that should be available to portlets. JBoss Portal Platform provides these classes as part of the portal skin. This allows each portal skin to define its own look and feel for these default values. </para> </listitem> </varlistentry> @@ -52,7 +52,7 @@ <term>Portlet Skins</term> <listitem> <para> - JBoss Enterprise Portal Platform provides a means for portlet CSS files to be loaded based on the current portal skin. This allows a portlet to provide different CSS styles to better match the current portal look and feel. Portlet skins provide a much more customizable CSS experience than just using the portlet specification CSS classes. +JBoss Portal Platform provides a means for portlet CSS files to be loaded based on the current portal skin. This allows a portlet to provide different CSS styles to better match the current portal look and feel. Portlet skins provide a much more customizable CSS experience than just using the portlet specification CSS classes. </para> </listitem> </varlistentry> @@ -84,7 +84,7 @@ <section id="sect-Reference_Guide-Skin_Selection-Setting_the_Default_Skin_within_the_Configuration_Files"> <title>Setting the Default Skin within the Configuration Files</title> <para> - The default skin can also be configured using the portal configuration files. This allows the portal to have the new default skin ready for use when JBoss Enterprise Portal Platform is first started. + The default skin can also be configured using the portal configuration files. This allows the portal to have the new default skin ready for use when JBoss Portal Platform is first started. </para> <para> The default skin of the portal is called <literal>Default</literal>. To change this value add a <literal>skin</literal> tag in the <literal>02portal.war/WEB-INF/conf/portal/portal/classic/portal.xml</literal> configuration file. @@ -98,7 +98,7 @@ <section id="sect-Reference_Guide-Skinning_the_Portal-Skins_in_Page_Markups"> <title>Skins in Page Markups</title> <para> - A JBoss Enterprise Portal Platform skin contains CSS styles for the portal&apos;s components but also shares components that may be reused in portlets. When JBoss Enterprise Portal Platform generates a portal page markup, it inserts stylesheet links in the page&apos;s <literal>head</literal> tag. + A JBoss Portal Platform skin contains CSS styles for the portal&apos;s components but also shares components that may be reused in portlets. When JBoss Portal Platform generates a portal page markup, it inserts stylesheet links in the page&apos;s <literal>head</literal> tag. </para> <para> There are two main types of CSS links that will appear in the <literal>head</literal> tag: a link to the portal skin CSS file and a link to the portlet skin CSS files. @@ -140,7 +140,7 @@ <section id="sect-Reference_Guide-The_Skin_Service-Skin_configuration"> <title>Skin configuration</title> <para> - JBoss Enterprise Portal Platform automatically discovers web archives that contain a file descriptor for skins (<filename>WEB-INF/gatein-resources.xml</filename>). This file is responsible for specifying the portal, portlet and window decorators to be deployed into the skin service. +JBoss Portal Platform automatically discovers web archives that contain a file descriptor for skins (<filename>WEB-INF/gatein-resources.xml</filename>). This file is responsible for specifying the portal, portlet and window decorators to be deployed into the skin service. </para> <para> The full schema can be found at: <ulink url="http://www.gatein.org/xml/ns/gatein_resources_1_2" type="http"/>. @@ -153,7 +153,7 @@ <section id="sect-Reference_Guide-The_Skin_Service-Resource_Request_Filter"> <title>Resource Request Filter</title> <para> - Because of JBoss Enterprise Portal Platform&apos;s Right-To-Left support, all CSS files need to be retrieved through a Servlet filter and the web application needs to be configured to activate this filter. This is already done for <literal>01eXoResources.war</literal> web application which contains the default skin. + Because of JBoss Portal Platform&apos;s Right-To-Left support, all CSS files need to be retrieved through a Servlet filter and the web application needs to be configured to activate this filter. This is already done for <literal>01eXoResources.war</literal> web application which contains the default skin. </para> <para> Any new web applications containing skinning CSS files will need to have the following added to their <filename>web.xml</filename> : @@ -170,7 +170,7 @@ <section id="sect-Reference_Guide-Skinning_the_Portal-The_Default_Skin"> <title>The Default Skin</title> <para> - The default skin for JBoss Enterprise Portal Platform is located as part of the <literal>01eXoResources.war</literal>. The main files associated with the skin are: + The default skin for JBoss Portal Platform is located as part of the <literal>01eXoResources.war</literal>. The main files associated with the skin are: </para> <variablelist> <varlistentry> @@ -332,7 +332,7 @@ <section id="sect-Reference_Guide-Creating_New_Skins-How_to_Create_New_Portlet_Skins"> <title>How to Create New Portlet Skins</title> <para> - Portlets often require additional styles that may not be defined by the portal skin. JBoss Enterprise Portal Platform allows portlets to define additional stylesheets for each portlet and will append the corresponding <literal>link</literal> tags to the <literal>head</literal>. + Portlets often require additional styles that may not be defined by the portal skin. JBoss Portal Platform allows portlets to define additional stylesheets for each portlet and will append the corresponding <literal>link</literal> tags to the <literal>head</literal>. </para> <para> The link ID will be of the form <parameter>{portletAppName}{PortletName}</parameter>. @@ -356,7 +356,7 @@ <section id="sect-Reference_Guide-How_to_Create_New_Portlet_Skins-Define_a_Custom_CSS_File"> <title>Define a Custom CSS File</title> <para> - JBoss Enterprise Portal Platform &VX; does not serve CSS files directly, but uses a filter as well as a skin service in order to: +JBoss Portal Platform &VX; does not serve CSS files directly, but uses a filter as well as a skin service in order to: </para> <itemizedlist> <listitem> @@ -376,7 +376,7 @@ </listitem> </itemizedlist> <para> - This causes JBoss Enterprise Portal Platform to create a non-functioning CSS link in html-src-code. + This causes JBoss Portal Platform to create a non-functioning CSS link in html-src-code. </para> <procedure> <title>To Resolve This:</title> @@ -532,7 +532,7 @@ Although the optimization is useful for a production environment, it may be easier to deactivate this optimization while debugging stylesheets. Set the Java system property <literal>exo.product.developing</literal> to <literal>true</literal> to disable the optimization. </para> <para> - For example, the property can be passed as a JVM parameter with <literal>-D</literal> option when running JBoss Enterprise Portal Platform. + For example, the property can be passed as a JVM parameter with <literal>-D</literal> option when running JBoss Portal Platform. </para> <programlisting><command>sh jboss-as/bin/run.sh -Dexo.product.developing=true</command></programlisting> <!-- <programlisting language="Java" role="Java"><xi:include parse="text" href="../../extras/PortalDevelopment_Skinning/default192.java" xmlns:xi="http://www.w3.org/2001/XInclude" /></programlisting> --> <warning> @@ -544,10 +544,10 @@ <section id="sect-Reference_Guide-Tips_and_Tricks-Some_CSS_Techniques"> <title>Some CSS Techniques</title> <para> - It is recommended that users have some experience with CSS before studying JBoss Enterprise Portal Platform CSS. + It is recommended that users have some experience with CSS before studying JBoss Portal Platform CSS. </para> <para> - JBoss Enterprise Portal Platform relies heavily on CSS to create the layout and effects for the UI. Some common techniques for customizing JBoss Enterprise Portal Platform CSS are explained below. +JBoss Portal Platform relies heavily on CSS to create the layout and effects for the UI. Some common techniques for customizing JBoss Portal Platform CSS are explained below. </para> <section id="sect-Reference_Guide-Some_CSS_Techniques-Border_Pattern"> <title>Border Pattern</title> Modified: epp/docs/branches/6.0/Reference_Guide/en-US/modules/PortletDevelopment/Standard.xml =================================================================== --- epp/docs/branches/6.0/Reference_Guide/en-US/modules/PortletDevelopment/Standard.xml 2012-10-24 06:12:02 UTC (rev 8938) +++ epp/docs/branches/6.0/Reference_Guide/en-US/modules/PortletDevelopment/Standard.xml 2012-10-25 06:01:34 UTC (rev 8939) @@ -14,13 +14,13 @@ The Portlet Specifications aim at defining portlets that can be used by any <ulink url="http://www.jcp.org/en/jsr/detail?id=168">JSR-168 (Portlet 1.0)</ulink> or <ulink url="http://www.jcp.org/en/jsr/detail?id=286">JSR-286 (Portlet 2.0)</ulink> portlet container. </para> <para> - Most Java EE (Enterprise Edition) portals include at least one compliant portlet container, and JBoss Enterprise Portal Platform is no exception. In fact, JBoss Enterprise Portal Platform includes a container that supports both versions. + Most Java EE (Enterprise Edition) portals include at least one compliant portlet container, and JBoss Portal Platform is no exception. In fact, JBoss Portal Platform includes a container that supports both versions. </para> <para> This chapter gives a brief overview of the Portlet Specifications but portlet developers are strongly encouraged to read the <ulink url="http://www.jcp.org/en/jsr/detail?id=286">JSR-286 Portlet Specification</ulink> . </para> <para> - JBoss Enterprise Portal Platform is fully JSR-286 compliant. Any JSR-168 or JSR-286 portlet operates as it is mandated by the respective specifications inside the portal. +JBoss Portal Platform is fully JSR-286 compliant. Any JSR-168 or JSR-286 portlet operates as it is mandated by the respective specifications inside the portal. </para> <section id="sect-Reference_Guide-JSR_168_and_JSR_286_overview-Portal_Pages"> <title>Portal Pages</title> @@ -118,10 +118,10 @@ <section id="sect-Reference_Guide-Tutorials-Deploying_your_first_Portlet"> <title>Deploying your first portlet</title> <para> - This section describes how to deploy a portlet in JBoss Enterprise Portal Platform. + This section describes how to deploy a portlet in JBoss Portal Platform. </para> <para> - An example portlet called <filename>SimplestHelloWorld</filename> is available in the <filename>/jboss-epp-<replaceable>VERSION</replaceable>-src/portal/examples/portlets/</filename> directory of the JBoss Enterprise Portal Platform sources package. + An example portlet called <filename>SimplestHelloWorld</filename> is available in the <filename>/jboss-epp-<replaceable>VERSION</replaceable>-src/portal/examples/portlets/</filename> directory of the JBoss Portal Platform sources package. </para> <section id="sect-Reference_Guide-Deploying_your_first_Portlet-Compiling"> <title>Compiling</title> @@ -173,7 +173,7 @@ <section id="sect-Reference_Guide-Deploying_your_first_Portlet-Package_Structure"> <title>Package Structure</title> <para> - Like other Java EE applications, JBoss Enterprise Portal Platform portlets are packaged in <literal>WAR</literal> files. A typical portlet <literal>WAR</literal> file can include servlets, resource bundles, images, HTML, JavaServer Pages (JSP), and other static or dynamic files. + Like other Java EE applications, JBoss Portal Platform portlets are packaged in <literal>WAR</literal> files. A typical portlet <literal>WAR</literal> file can include servlets, resource bundles, images, HTML, JavaServer Pages (JSP), and other static or dynamic files. </para> <para> The following is an example of the directory structure of the <filename>SimplestHelloWorld</filename> portlet. @@ -182,14 +182,14 @@ <title>Portlet Directory Structure Explanation</title> <programlisting language="Java" role="Java"><xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="../../extras/PortletDevelopment_Standard/default244.java" parse="text"/></programlisting> <para> - <filename>SimplestHelloWorldPortlet.class</filename>: The compiled Java class implementing <emphasis>javax.portlet.Portlet</emphasis> (through <emphasis>javax.portlet.GenericPortlet</emphasis>). + <filename>SimplestHelloWorldPortlet.class</filename>: The compiled Java class implementing <emphasis>javax.portlet.Portlet</emphasis> (through <emphasis>javax.portlet.GenericPortlet</emphasis>). </para> <para> - <filename>portlet.xml</filename>: This is the mandatory descriptor file for portlets. It is used during deployment. + <filename>portlet.xml</filename>: This is the mandatory descriptor file for portlets. It is used during deployment. </para> <para> - <filename>web.xml</filename>: This is the mandatory descriptor for web applications. - </para> + <filename>web.xml</filename>: This is the mandatory descriptor for web applications. + </para> </example> </section> <section id="sect-Reference_Guide-Deploying_your_first_Portlet-Portlet_Class"> @@ -197,31 +197,31 @@ <para> Below is the Java source for an example portlet named <filename>SimplestHelloWorldPortlet</filename>. </para> - <example> - <title>SimplestHelloWorldPortlet Explanation</title> - <programlisting language="Java" role="Java"><xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="../../extras/PortletDevelopment_Standard/SimplestHelloWorldPortlet.java" parse="text"/></programlisting> - <para> - Comment #1: All portlets must implement the <literal>javax.portlet.Portlet</literal> interface. The <classname>GenericPortlet</classname> class provides a default implementation for the Portlet interface. + <example> + <title>SimplestHelloWorldPortlet Explanation</title> + <programlisting language="Java" role="Java"><xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="../../extras/PortletDevelopment_Standard/SimplestHelloWorldPortlet.java" parse="text"/></programlisting> + <para> + Comment #1: All portlets must implement the <literal>javax.portlet.Portlet</literal> interface. The <classname>GenericPortlet</classname> class provides a default implementation for the Portlet interface. </para> - <para> - The <classname>javax.portlet.GenericPortlet</classname> class implements the <methodname>render</methodname> method to dispatch to abstract mode-specific methods. This makes it easier to support the standard portlet modes. + <para> + The <classname>javax.portlet.GenericPortlet</classname> class implements the <methodname>render</methodname> method to dispatch to abstract mode-specific methods. This makes it easier to support the standard portlet modes. </para> - <para> - <classname>GenericPortlet</classname> also provides a default implementation for the <methodname>processAction</methodname>, <methodname>init</methodname> and <methodname>destroy</methodname> methods. It is recommended to extend <literal>GenericPortlet</literal> for most cases. + <para> + <classname>GenericPortlet</classname> also provides a default implementation for the <methodname>processAction</methodname>, <methodname>init</methodname> and <methodname>destroy</methodname> methods. It is recommended to extend <literal>GenericPortlet</literal> for most cases. </para> - <para> - Comment #2: If only the <literal>view</literal> mode is required, then only the <literal>doView</literal> method needs to be implemented. The <classname>GenericPortlet</classname> render implementation calls our implementation when the <literal>view</literal> mode is requested. + <para> + Comment #2: If only the <literal>view</literal> mode is required, then only the <literal>doView</literal> method needs to be implemented. The <classname>GenericPortlet</classname> render implementation calls our implementation when the <literal>view</literal> mode is requested. </para> - <para> - Comment #3: Use the <methodname>RenderResponse</methodname> method to obtain a writer to be used to produce content. + <para> + Comment #3: Use the <methodname>RenderResponse</methodname> method to obtain a writer to be used to produce content. </para> - <para> - Comment #4: Write the markup to display. + <para> + Comment #4: Write the markup to display. </para> - <para> - Comment #5: Closing the writer. + <para> + Comment #5: Closing the writer. </para> - </example> + </example> <para> <note> <title>Markup Fragments</title> @@ -235,7 +235,7 @@ <section id="sect-Reference_Guide-Deploying_your_first_Portlet-Application_Descriptors"> <title>Application Descriptors</title> <para> - JBoss Enterprise Portal Platform requires certain descriptors to be included in a portlet <literal>WAR</literal> file. These descriptors are defined by the Java EE (<filename>web.xml</filename>) and Portlet Specification (<filename>portlet.xml</filename>). +JBoss Portal Platform requires certain descriptors to be included in a portlet <literal>WAR</literal> file. These descriptors are defined by the Java EE (<filename>web.xml</filename>) and Portlet Specification (<filename>portlet.xml</filename>). </para> <para> Below is an example of the <filename>SimplestHelloWorldPortlet/WEB-INF/portlet.xml</filename> file. This file must adhere to its definition in the JSR-286 Portlet Specification. More than one portlet application may be defined in this file. @@ -243,22 +243,22 @@ <example> <title>The portlet.xml File Explanation</title> <programlisting language="XML" role="XML"><xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="../../extras/PortletDevelopment_Standard/default245.xml" parse="text"/></programlisting> - <para> - Comment #1: Define the portlet name. It does not have to be the class name. + <para> + Comment #1: Define the portlet name. It does not have to be the class name. </para> - <para> + <para> Comment #2: The Fully Qualified Name (<literal>FQN</literal>) of your portlet class must be declared here. </para> - <para> + <para> Comment #3: The <literal>&lt;supports&gt;</literal> element declares all of the markup types that a portlet supports in the <literal>render</literal> method. This is accomplished via the <literal>&lt;mime-type&gt;</literal> element, which is required for every portlet. </para> - <para> - The declared MIME types must match the capability of the portlet. It allows administrators to pair which modes and window states are supported for each markup type. This does not have to be declared as all portlets must support the <literal>view</literal> portlet mode. + <para> + The declared MIME types must match the capability of the portlet. It allows administrators to pair which modes and window states are supported for each markup type. This does not have to be declared as all portlets must support the <literal>view</literal> portlet mode. </para> - <para> - Use the <literal>&lt;mime-type&gt;</literal> element to define which markup type the portlet supports. In the example above this is <literal>text/html</literal>. This section tells the portal to only output <literal>HTML</literal>. + <para> + Use the <literal>&lt;mime-type&gt;</literal> element to define which markup type the portlet supports. In the example above this is <literal>text/html</literal>. This section tells the portal to only output <literal>HTML</literal>. </para> - <para> + <para> Comment #4: When rendered, the portlet&apos;s title is displayed as the header in the portlet window, unless it is overridden programmatically. In the example above the title would be <literal>Simplest Hello World Portlet</literal> . </para> </example> @@ -294,7 +294,7 @@ <formalpara id="form-Reference_Guide-JavaServer_Pages_Portlet_Example-Compiling_the_example"> <title>Compiling the example</title> <para> - The example used in this section is available in the directory of the JBoss Enterprise Portal Platform sources package. + The example used in this section is available in the directory of the JBoss Portal Platform sources package. </para> </formalpara> <para> @@ -303,7 +303,7 @@ <procedure> <title>Compile JavaServer Pages Portlet</title> <step> - <para>Obtain the JBoss Enterprise Portal Platform sources package from the Customer Support portal.</para> + <para>Obtain the JBoss Portal Platform sources package from the Customer Support portal.</para> </step> <step> <para>Move to <filename>/jboss-epp-<replaceable>VERSION</replaceable>-src/portal/examples/portlets/jsphellouser</filename> </para> @@ -414,11 +414,11 @@ <para> The landing page contains the links and form to call our portlet. </para> - <example> - <title>Landing Page Explanation</title> + <example> + <title>Landing Page Explanation</title> <programlisting language="XML" role="XML"><xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="../../extras/PortletDevelopment_Standard/default252.xml" parse="text"/></programlisting> <para> - Comment #1: The portlet taglib. This needs to be declared. + Comment #1: The portlet taglib. This needs to be declared. </para> <para> Comment #2: The first method showed here is the simplest one. <literal>portlet:renderURL</literal> will create a URL that calls the render phase of the current portlet and append the result at the place of the markup (within a tag). A parameter is also added directly to the URL. @@ -427,10 +427,10 @@ Comment #3: In this method the <literal>var</literal> attribute is used. This avoids having one XML tag within another. Instead of printing the url the <literal>portlet:renderURL</literal> tag will store the result in the referenced variable ( <literal>myRenderURL</literal>). </para> <para> - Comment #4: The variable <literal>myRenderURL</literal> is used like any other JSP variable. + Comment #4: The variable <literal>myRenderURL</literal> is used like any other JSP variable. </para> <para> - Comment #5: The third method mixes form submission and action request. Again, a temporary variable is used to put the created URL into. + Comment #5: The third method mixes form submission and action request. Again, a temporary variable is used to put the created URL into. </para> <para> Comment #6: The action URL is used in HTML form. @@ -455,7 +455,7 @@ In order to write a portlet using JSF a &apos;bridge&apos; is needed. This software allows developers to write a portlet application as if it was a JSF application. The bridge then negotiates the interactions between the two layers. </para> <para> - An example using the JBoss Portlet Bridge is available in the <filename>/jboss-epp-<replaceable>VERSION</replaceable>-src/portal/examples/portlets/</filename> directory of the JBoss Enterprise Portal Platform sources package. The configuration is slightly different from a JSP application. This example can be used as a base to configure instead of creating a new application. + An example using the JBoss Portlet Bridge is available in the <filename>/jboss-epp-<replaceable>VERSION</replaceable>-src/portal/examples/portlets/</filename> directory of the JBoss Portal Platform sources package. The configuration is slightly different from a JSP application. This example can be used as a base to configure instead of creating a new application. </para> <para> As in any JSF application, the file <literal>faces-config.xml</literal> is required. It must contain the following information: @@ -471,7 +471,7 @@ <title>Portlet Descriptor Explanation</title> <programlisting language="XML" role="XML"><xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="../../extras/PortletDevelopment_Standard/default254.xml" parse="text"/></programlisting> <para> - Comment #1: All JSF portlets define <literal>javax.portlet.faces.GenericFacesPortlet</literal> as a portlet class. This class is part of the JBoss Portlet Bridge. + Comment #1: All JSF portlets define <literal>javax.portlet.faces.GenericFacesPortlet</literal> as a portlet class. This class is part of the JBoss Portlet Bridge. </para> <para> Comment #2: This is a mandatory parameter to define what&apos;s the default page to display. Modified: epp/docs/branches/6.0/Reference_Guide/en-US/modules/WSRP.xml =================================================================== --- epp/docs/branches/6.0/Reference_Guide/en-US/modules/WSRP.xml 2012-10-24 06:12:02 UTC (rev 8938) +++ epp/docs/branches/6.0/Reference_Guide/en-US/modules/WSRP.xml 2012-10-25 06:01:34 UTC (rev 8939) @@ -34,22 +34,22 @@ </para> </section> <section id="wsrp_support"> - <title>Level of support in JBoss Enterprise Portal Platform</title> + <title>Level of support in JBoss Portal Platform</title> <para>The WSRP Technical Committee defined <ulink url="http://www.oasis-open.org/committees/download.php/3073">... Use Profiles</ulink> to help with WSRP interoperability. This section will refer to terms defined in that document. </para> - <para>JBoss Enterprise Portal Platform provides a Simple level of support for the WSRP Producer except that out-of-band registration + <para>JBoss Portal Platform provides a Simple level of support for the WSRP Producer except that out-of-band registration is not currently handled. In-band registration and persistent local state (which are defined at the Complex level) are supported. </para> - <para>On the Consumer side, JBoss Enterprise Portal Platform provides a Medium level of support for WSRP, except that the consumer only handles - HTML markup (as JBoss Enterprise Portal Platform itself does not handle other markup types). It does support explicit portlet + <para>On the Consumer side, JBoss Portal Platform provides a Medium level of support for WSRP, except that the consumer only handles + HTML markup (as JBoss Portal Platform itself does not handle other markup types). It does support explicit portlet cloning and it fully supports the PortletManagement interface. </para> <para>As far as caching goes, the component has Level 1 Producer and Consumer. Cookie handling is supported properly on the Consumer and the Producer requires initialization of cookies (it has been found that it improves interoperability - with some consumers). The component does not support custom window states or modes, as JBoss Enterprise Portal Platform does not. The component does, + with some consumers). The component does not support custom window states or modes, as JBoss Portal Platform does not. The component does, however, support CSS on both the Producer (though it is more a function of the portlets than inherent Producer capability) and Consumer. </para> @@ -58,22 +58,22 @@ and perform more interoperability testing (an area that needs to be better supported by the WSRP Technical Committee and Community at large). </para> - <para>JBoss Enterprise Portal Platform supports WSRP 2.0 with a complete implementation of the non-optional features. The only + <para>JBoss Portal Platform supports WSRP 2.0 with a complete implementation of the non-optional features. The only features not implemented are support for lifetimes and leasing support. </para> <note> <title>Note</title> - <para>As of version &VZ; of JBoss Enterprise Portal Platform, WSRP is only activated and supported - when JBoss Enterprise Portal Platform is deployed on JBoss Application Server. + <para>As of version &VZ; of JBoss Portal Platform, WSRP is only activated and supported + when JBoss Portal Platform is deployed on JBoss Application Server. </para> </note> </section> <section> - <title><remark>BZ#839355</remark>Deploying JBoss Enterprise Portal Platform&apos;s WSRP services</title> + <title><remark>BZ#839355</remark>Deploying JBoss Portal Platform&apos;s WSRP services</title> <para> - JBoss Enterprise Portal Platform provides complete support for WSRP 1.0 and 2.0 standard interfaces, and offers both consumer and - producer services. Starting with version 2.1.0-GA of the component, WSRP is packaged as a JBoss Enterprise Portal Platform +JBoss Portal Platform provides complete support for WSRP 1.0 and 2.0 standard interfaces, and offers both consumer and + producer services. Starting with version 2.1.0-GA of the component, WSRP is packaged as a JBoss Portal Platform extension, and is self-contained in a package named <filename><replaceable>EPP_DIST</replaceable>/jboss-as/server/<replaceable>PROFILE</replaceable>/deploy/gatein-wsrp-integration.ear</filename> . @@ -106,7 +106,7 @@ <listitem> <para> The <filename>extension-component-&VZ;.jar</filename>, which contains the components needed to - integrate the WSRP component into JBoss Enterprise Portal Platform. It also includes the default configuration files for + integrate the WSRP component into JBoss Portal Platform. It also includes the default configuration files for the WSRP producer and the default WSRP consumers. </para> </listitem> @@ -123,7 +123,7 @@ <filename>wsrp-configuration.xml</filename> which, in particular, configures several options for the <code>WSRPServiceIntegration</code> - component at the heart of the WSRP integration in JBoss Enterprise Portal Platform. + component at the heart of the WSRP integration in JBoss Portal Platform. </para> </listitem> <listitem> @@ -146,20 +146,20 @@ </listitem> </itemizedlist> <para> - If you are not going to use WSRP in JBoss Enterprise Portal Platform, it will not adversely affect your installation to leave it + If you are not going to use WSRP in JBoss Portal Platform, it will not adversely affect your installation to leave it as is. Otherwise, you can just remove the <filename>gatein-wsrp-integration.ear</filename> file from your AS deploy directory. </para> <section id="wsrp-ports"> - <title>Considerations to use WSRP when running JBoss Enterprise Portal Platform on a non-default port or hostname</title> + <title>Considerations to use WSRP when running JBoss Portal Platform on a non-default port or hostname</title> <para> - The web service stack that JBoss Enterprise Portal Platform uses is based on JBoss WS. It updates the port and host name used in WSDL (for further details refer to the <citetitle>Web Services</citetitle> chapter in the <citetitle>JBoss Enterprise Application Platform Administration and Configuration User Guide</citetitle>). + The web service stack that JBoss Portal Platform uses is based on JBoss WS. It updates the port and host name used in WSDL (for further details refer to the <citetitle>Web Services</citetitle> chapter in the <citetitle>JBoss Enterprise Application Platform Administration and Configuration User Guide</citetitle>). </para> <para> Of course, if you have modified the host name and port on which your server runs, you will need to - update the configuration for the consumer used to consume JBoss Enterprise Portal Platform&apos;s &apos;self&apos; producer. Please refer to + update the configuration for the consumer used to consume JBoss Portal Platform&apos;s &apos;self&apos; producer. Please refer to the <xref linkend="consumer_configuration"/> to learn how to do so. @@ -183,7 +183,7 @@ </para> <note> <title>Web Container Compatibility</title> - <para>WSRP and WS-Security is currently only supported on JBoss Enterprise Portal Platform when running on top of JBoss + <para>WSRP and WS-Security is currently only supported on JBoss Portal Platform when running on top of JBoss AS 5. </para> </note> @@ -204,7 +204,7 @@ that the username and password must be the same and valid on both servers. </para> <para>The recommended approach for this situation would be to use a common LDAP configuration. Please - see the user guide on how to configure LDAP for use with JBoss Enterprise Portal Platform + see the user guide on how to configure LDAP for use with JBoss Portal Platform </para> </important> <para>The GateIn Wiki article, <ulink url="http://community.jboss.org/wiki/GateInWSRPAndWebServiceSecurity... GateIn WSRP and Web Service Security</ulink>, also provides a step-by-step example on how to configure @@ -213,7 +213,7 @@ <section id="wss_configuration"> <title><remark>BZ#839355</remark>WS-Security Configuration</title> <para> - JBoss Enterprise Portal Platform uses JBossWS Native to handle ws-security (refer to the <citetitle>Web Services</citetitle> section of the +JBoss Portal Platform uses JBossWS Native to handle ws-security (refer to the <citetitle>Web Services</citetitle> section of the <citetitle>JBoss Enterprise Application Platform 5 Administration and Configuration Guide</citetitle>. Note that since the consumer passes its credentials to the producer, the consumer acts as the wss client and the producer acts as the wss server. </para> <para> The following are the JBossWS Native configuration files which need to be configure for WSRP: @@ -319,7 +319,7 @@ <code>true</code> at the <code>portlet-app</code> - level, all portlets defined in this particular portlet application are exposed remotely by JBoss Enterprise Portal Platform&apos;s + level, all portlets defined in this particular portlet application are exposed remotely by JBoss Portal Platform&apos;s WSRP producer. </para> @@ -371,11 +371,11 @@ <title>Consuming WSRP portlets from a remote Consumer</title> <para>WSRP Producers vary a lot as far as how they are configured. Most of them require that you specify the URL for the Producer&apos;s WSDL definition. Please refer to the remote producer&apos;s documentation for specific - instructions. For instructions on how to do so in JBoss Enterprise Portal Platform, please refer to + instructions. For instructions on how to do so in JBoss Portal Platform, please refer to <xref linkend="consumer_configuration"/>. </para> <para> - JBoss Enterprise Portal Platform&apos;s Producer is automatically set up when you deploy a portal instance with the WSRP service. +JBoss Portal Platform&apos;s Producer is automatically set up when you deploy a portal instance with the WSRP service. You can access the WSDL file at <filename>http://{hostname}:{port}/wsrp-producer/v2/MarkupService?wsdl</filename>. If you wish to use only the WSRP 1 compliant version of the producer, please use the WSDL file found at @@ -386,11 +386,11 @@ </para> </section> <section id="consumer_configuration"> - <title>Consuming remote WSRP portlets in JBoss Enterprise Portal Platform</title> + <title>Consuming remote WSRP portlets in JBoss Portal Platform</title> <section> <title>Overview</title> <para> - To be able to consume WSRP portlets exposed by a remote producer, JBoss Enterprise Portal Platform&apos;s WSRP consumer needs to + To be able to consume WSRP portlets exposed by a remote producer, JBoss Portal Platform&apos;s WSRP consumer needs to know how to access that remote producer. You can configure access to a remote producer using the provided configuration portlet. Alternatively, it is also possible to configure access to remote producers using an XML descriptor, though it is recommended (and easier) to do so via the configuration portlet. @@ -404,7 +404,7 @@ <title>Configuring a remote producer using the configuration portlet</title> <para> This section will cover the steps of defining access to a remote producer using the configuration portlet so that its portlets can be - consumed within JBoss Enterprise Portal Platform. We will configure access to NetUnity&apos;s public WSRP producer. + consumed within JBoss Portal Platform. We will configure access to NetUnity&apos;s public WSRP producer. </para> <note> <para> @@ -417,7 +417,7 @@ </para> </note> <para> - JBoss Enterprise Portal Platform provides a portlet to configure access (among other functions) to remote WSRP Producers +JBoss Portal Platform provides a portlet to configure access (among other functions) to remote WSRP Producers graphically. Starting with &VZ;, the WSRP configuration portlet is installed by default. You can find it at <ulink url="http://localhost:8080/portal/login?initialURI=%2Fportal%2Fprivate%2Fclassic%2FwsrpConfiguration&amp;username=root&amp;password=gtn"> http://localhost:8080/portal/login?initialURI=%2Fportal%2Fprivate%2Fclass... </ulink> @@ -441,7 +441,7 @@ <note> <title>Note</title> <para> - The WSRP configuration was not installed by default in previous versions of JBoss Enterprise Portal Platform. + The WSRP configuration was not installed by default in previous versions of JBoss Portal Platform. We include here the legacy instructions on how to install this portlet in case you ever need to re-install it. </para> @@ -515,7 +515,7 @@ If you had been dealing with a producer which required registration but did not require any registration properties, as is the case for the <literal>selfv2</literal> - consumer (the consumer that accesses the portlets made remotely available by JBoss Enterprise Portal Platform&apos;s producer via + consumer (the consumer that accesses the portlets made remotely available by JBoss Portal Platform&apos;s producer via WSRP 2), you would have seen something similar to the screenshot below, after pressing the &quot;Refresh &amp; Save&quot; button: <mediaobject> <imageobject> @@ -574,7 +574,7 @@ <literal>&lt;wsrp-producer&gt;</literal> element. </para> - <para>JBoss Enterprise Portal Platform also needs to learn about the remote producer&apos;s endpoints to be able to connect to the + <para>JBoss Portal Platform also needs to learn about the remote producer&apos;s endpoints to be able to connect to the remote web services and perform WSRP invocations. This is accomplished by specifying the URL for the WSDL description for the remote WSRP service, using the <literal>&lt;endpoint-wsdl-url&gt;</literal> @@ -602,7 +602,7 @@ <literal>&lt;wsrp-producer&gt;</literal> element which specifies the refreshing period in seconds. For example, providing a value of 120 for expiration-cache means that the producer information will not be refreshed for 2 minutes after it has - been somehow accessed. If no value is provided, JBoss Enterprise Portal Platform will always access the remote producer + been somehow accessed. If no value is provided, JBoss Portal Platform will always access the remote producer regardless of whether the remote information has changed or not. Since, in most instances, the information provided by the producer does not change often, it is recommended that you use this caching facility to minimize bandwidth usage. @@ -628,14 +628,14 @@ </note> <para>Registration configuration is done via the <literal>&lt;registration-data&gt;</literal> - element. Since JBoss Enterprise Portal Platform can generate the mandatory information for you, if the remote producer does + element. Since JBoss Portal Platform can generate the mandatory information for you, if the remote producer does not require any registration properties, you only need to provide an empty <literal>&lt;registration-data&gt;</literal> element. Values for the registration properties required by the remote producer can be provided via <literal>&lt;property&gt;</literal> elements. See the example below for more details. Additionally, you can override the default consumer - name automatically provided by JBoss Enterprise Portal Platform via the + name automatically provided by JBoss Portal Platform via the <literal>&lt;consumer-name&gt;</literal> element. If you choose to provide a consumer name, please remember that this should uniquely identify your consumer. @@ -747,7 +747,7 @@ so. </para> <para> - Of note, though, is that, starting with version 5.2 of JBoss Enterprise Portal Platform, it is now possible to also add a + Of note, though, is that, starting with version 5.2 of JBoss Portal Platform, it is now possible to also add a remote portlet to a <filename>pages.xml</filename> configuration file. @@ -778,7 +778,7 @@ </para> <note> <para> - For remote portlets published by JBoss Enterprise Portal Platform&apos;s WSRP producer, the portlet handles are, at + For remote portlets published by JBoss Portal Platform&apos;s WSRP producer, the portlet handles are, at the time of this writing, following the <literal>/&lt;portlet application name&gt;.&lt;portlet name&gt;</literal> format. @@ -795,7 +795,7 @@ other one accessing it via the <literal>selfv2</literal> - consumer which consumes JBoss Enterprise Portal Platform&apos;s WSRP producer. You can see that the first one is local (the + consumer which consumes JBoss Portal Platform&apos;s WSRP producer. You can see that the first one is local (the <code>&lt;portlet-application&gt;</code> with the &apos;<literal>Added locally</literal>&apos; @@ -807,7 +807,7 @@ <code>&lt;wsrp&gt;</code> element instead of <code>&lt;portlet&gt;</code> - element and follows the format for portlets coming from the JBoss Enterprise Portal Platform&apos;s WSRP producer. + element and follows the format for portlets coming from the JBoss Portal Platform&apos;s WSRP producer. </para> <example> <title>Example</title> @@ -900,7 +900,7 @@ <title>Registration modification on producer error</title> <para> It can also happen that a producer administrator decided to change its requirement for registered - consumers. JBoss Enterprise Portal Platform will attempt to help you in this situation. This section will walk through an example using + consumers. JBoss Portal Platform will attempt to help you in this situation. This section will walk through an example using the <literal>selfv2</literal> consumer (assuming that registration is requiring a valid value for an <literal>email</literal> registration property). If you go to the configuration screen for this consumer, you should see: @@ -913,7 +913,7 @@ <para>Now suppose that the administrator of the producer now additionally requires a value to be provided for a <literal>name</literal> registration property. Steps on how to do perform this operation - in JBoss Enterprise Portal Platform are outlined in the section on how to configure JBoss Enterprise Portal Platform&apos;s producer + in JBoss Portal Platform are outlined in the section on how to configure JBoss Portal Platform&apos;s producer (<xref linkend="producer_config"/>). Operations with this producer will now fail. If you suspect that a registration modification is required, you should go to the configuration screen for this remote producer and refresh the information held by @@ -1008,11 +1008,11 @@ <title>Importing and exporting portlets</title> <para>Import and export are new functionalities added in WSRP 2. Exporting a portlet allows a consumer to get an opaque representation of the portlet which can then be use by the corresponding import operation to - reconstitute it. It is mostly used in migration scenarios during batch operations. Since JBoss Enterprise Portal Platform + reconstitute it. It is mostly used in migration scenarios during batch operations. Since JBoss Portal Platform does not currently support automated migration of portal data, the functionality that is provided as part of WSRP 2 is necessarily less complete than it could be with full portal support. </para> - <para>The import/export implementation in JBoss Enterprise Portal Platform allows users to export portlets + <para>The import/export implementation in JBoss Portal Platform allows users to export portlets from a given consumer. These portlets can then be used to replace existing content on pages. This is accomplished by assigning previously exported portlets to replace the content displayed by windows on the portal&apos;s pages. Below is an example to make things clearer. @@ -1150,7 +1150,7 @@ </section> </section> <section id="producer_config"> - <title>Configuring JBoss Enterprise Portal Platform&apos;s WSRP Producer</title> + <title>Configuring JBoss Portal Platform&apos;s WSRP Producer</title> <section> <title>Overview</title> <para> @@ -1203,7 +1203,7 @@ is valid or not. </para> <para> - JBoss Enterprise Portal Platform provides a web interface to configure the producer&apos;s behavior. You can access it +JBoss Portal Platform provides a web interface to configure the producer&apos;s behavior. You can access it by clicking on the &quot;Producer Configuration&quot; tab of the &quot;WSRP&quot; page of the &quot;admin&quot; portal. The image below is what you should see with the default configuration: </para> @@ -1219,7 +1219,7 @@ <classname>RegistrationPropertyValidator</classname>), along with required registration property description for which consumers must provide acceptable values to successfully register.</para> - <para>New in JBoss Enterprise Portal Platform, the WSDL URLs to access the Portal&apos;s WSRP producer are now displayed either in WSRP 1 + <para>New in JBoss Portal Platform, the WSDL URLs to access the Portal&apos;s WSRP producer are now displayed either in WSRP 1 or WSRP 2 mode. </para> </section> Modified: epp/docs/branches/6.0/Reference_Guide/en-US/modules/eXoJCR/jcr/configuration/jdbc-data-container-config.xml =================================================================== --- epp/docs/branches/6.0/Reference_Guide/en-US/modules/eXoJCR/jcr/configuration/jdbc-data-container-config.xml 2012-10-24 06:12:02 UTC (rev 8938) +++ epp/docs/branches/6.0/Reference_Guide/en-US/modules/eXoJCR/jcr/configuration/jdbc-data-container-config.xml 2012-10-25 06:01:34 UTC (rev 8939) @@ -32,8 +32,7 @@ URL: NA (email from Nicholas Filetto to jbossexoD(a)googlegroups.com on 10/18/2011 Author [w/email]: Nicholas Filetto: nicolas.filotto(a)exoplatform.com License: NA - --> - <table id="tabl-Reference_Guide-Introduction-Supported-databases"> + --> <table id="tabl-Reference_Guide-Introduction-Supported-databases"> <title>Supported databases</title> <tgroup cols="2"> <thead> @@ -252,7 +251,7 @@ <programlisting><code>jdbc:mysql://exoua.dnsalias.net/portal?char... </example> <para> - The configuration files are located in service jars <filename>/conf/portal/configuration.xml</filename> (eXo services including JCR Repository Service) and <filename>exo-jcr-config.xml</filename> (repositories configuration) by default. In JBoss Enterprise Portal Platform, the JCR is configured in portal web application <filename>portal/WEB-INF/conf/jcr/jcr-configuration.xml</filename> (JCR Repository Service and related services) and <filename>repository-configuration.xml</filename> (repositories configuration). + The configuration files are located in service jars <filename>/conf/portal/configuration.xml</filename> (eXo services including JCR Repository Service) and <filename>exo-jcr-config.xml</filename> (repositories configuration) by default. In JBoss Portal Platform, the JCR is configured in portal web application <filename>portal/WEB-INF/conf/jcr/jcr-configuration.xml</filename> (JCR Repository Service and related services) and <filename>repository-configuration.xml</filename> (repositories configuration). </para> <para> Read more about <xref linkend="chap-Reference_Guide-JCR_configuration"/>. Modified: epp/docs/branches/6.0/Reference_Guide/en-US/modules/eXoJCR/jcr/intro.xml =================================================================== --- epp/docs/branches/6.0/Reference_Guide/en-US/modules/eXoJCR/jcr/intro.xml 2012-10-24 06:12:02 UTC (rev 8938) +++ epp/docs/branches/6.0/Reference_Guide/en-US/modules/eXoJCR/jcr/intro.xml 2012-10-25 06:01:34 UTC (rev 8939) @@ -1,129 +1,111 @@ -<?xml version='1.0' encoding='utf-8' ?> +<?xml version='1.0' encoding='UTF-8'?> <!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [ <!ENTITY % BOOK_ENTITIES SYSTEM "Reference_Guide.ent"> %BOOK_ENTITIES; ]> <chapter id="chap-Reference_Guide-eXoJCR-Introduction"> - <title>Introduction</title> - <warning> - <title>eXo JCR usage</title> - <para> - The JBoss Enterprise Portal Platform is using a JCR API to store its information for internal usage. We do not support usage of the JCR to store application information. + <title>Introduction</title> + <warning> + <title>eXo JCR usage</title> + <para> + The JBoss Portal Platform is using a JCR API to store its information for internal usage. We do not support usage of the JCR to store application information. </para> - <para> - The information below is intended to assist users to understand particular low level details on how the JBoss Enterprise Portal Platform works and how it can be fine-tuned. + <para> + The information below is intended to assist users to understand particular low level details on how the JBoss Portal Platform works and how it can be fine-tuned. </para> - - </warning> - <para> - The term <emphasis role="bold">JCR</emphasis> refers to the Java Content Repository. The JCR is the data store of JBoss Enterprise Portal Platform. All content is stored and managed via the JCR. + </warning> + <para> + The term <emphasis role="bold">JCR</emphasis> refers to the Java Content Repository. The JCR is the data store of JBoss Portal Platform. All content is stored and managed via the JCR. </para> - <para> - The eXo JCR included with JBoss Enterprise Portal Platform &VY; is a (<ulink type="http" url="http://www.jcp.org/en/jsr/detail?id=170">JSR-170</ulink>) compliant implementation of the JCR 1.0 specification. The JCR provides versioning, textual search, access control, content event monitoring, and is used to storing text and binary data for the portal internal usage. The back-end storage of the JCR is configurable and can be a file system or a database. + <para> + The eXo JCR included with JBoss Portal Platform &VY; is a (<ulink url="http://www.jcp.org/en/jsr/detail?id=170" type="http">JSR-170</ulink>) compliant implementation of the JCR 1.0 specification. The JCR provides versioning, textual search, access control, content event monitoring, and is used to storing text and binary data for the portal internal usage. The back-end storage of the JCR is configurable and can be a file system or a database. </para> - <section id="sect-Reference_Guide-Introduction-Concepts"> - <title>Concepts</title> - <variablelist> - <varlistentry> - <term>Repository</term> - <listitem> - <para> - A repository is a form of data storage device. A 'repository' differs from a 'database' in the nature of the information contained. While a database holds hard data in rigid tables, a repository may access the data on a database by using less rigid <emphasis>meta</emphasis>-data. In this sense a repository operates as an 'interpreter' between the database(s) and the user. + <section id="sect-Reference_Guide-Introduction-Concepts"> + <title>Concepts</title> + <variablelist> + <varlistentry> + <term>Repository</term> + <listitem> + <para> + A repository is a form of data storage device. A &apos;repository&apos; differs from a &apos;database&apos; in the nature of the information contained. While a database holds hard data in rigid tables, a repository may access the data on a database by using less rigid <emphasis>meta</emphasis>-data. In this sense a repository operates as an &apos;interpreter&apos; between the database(s) and the user. </para> - <note> - <para> - The data model for the interface (the repository) is rarely the same as the data model used by the repository's underlying storage subsystems (such as a database), however the repository is able to make persistent data changes in the storage subsystem. + <note> + <para> + The data model for the interface (the repository) is rarely the same as the data model used by the repository&apos;s underlying storage subsystems (such as a database), however the repository is able to make persistent data changes in the storage subsystem. </para> - - </note> - - </listitem> - - </varlistentry> - <varlistentry> - <term>Workspace</term> - <listitem> - <para> - The eXo JCR uses 'workspaces' as the main data abstraction in its data model. The content is stored in a workspace as a hierarchy of <emphasis>items</emphasis> and each workspace has its own hierarchy of items. + </note> + </listitem> + </varlistentry> + <varlistentry> + <term>Workspace</term> + <listitem> + <para> + The eXo JCR uses &apos;workspaces&apos; as the main data abstraction in its data model. The content is stored in a workspace as a hierarchy of <emphasis>items</emphasis> and each workspace has its own hierarchy of items. </para> - <para> + <para> Repositories access one or more workspaces. Persistent JCR workspaces consist of a directed acyclic graph of <emphasis>items</emphasis> where the edges represent the parent-child relation. </para> - - </listitem> - - </varlistentry> - <varlistentry> - <term>Items</term> - <listitem> - <para> + </listitem> + </varlistentry> + <varlistentry> + <term>Items</term> + <listitem> + <para> An <emphasis>item</emphasis> is either a <emphasis>node</emphasis> or a <emphasis>property</emphasis>. Properties contain the data (either simple values or binary data). The nodes of a workspace give it its structure while the properties hold the data itself. </para> - <variablelist> - <varlistentry> - <term>Nodes</term> - <listitem> - <para> + <variablelist> + <varlistentry> + <term>Nodes</term> + <listitem> + <para> Nodes are identified using accepted <emphasis>namespacing</emphasis> conventions. Changed nodes may be versioned through an associated version graph to preserve data integrity. </para> - <para> + <para> Nodes can have various properties or child nodes associated to them. </para> - - </listitem> - - </varlistentry> - <varlistentry> - <term>Properties</term> - <listitem> - <para> + </listitem> + </varlistentry> + <varlistentry> + <term>Properties</term> + <listitem> + <para> Properties hold data as values of predefined types, such as: <emphasis role="bold">String</emphasis>, <emphasis role="bold">Binary</emphasis>, <emphasis role="bold">Long</emphasis>, <emphasis role="bold">Boolean</emphasis>, <emphasis role="bold">Double</emphasis>, <emphasis role="bold">Date</emphasis>, <emphasis role="bold">Reference</emphasis> and <emphasis role="bold">Path</emphasis>. </para> - - </listitem> - - </varlistentry> - - </variablelist> - - </listitem> - + </listitem> </varlistentry> - <varlistentry> - <term>The Data Model</term> - <listitem> - <para> - The core of any Content Repository is the data model. The data model defines the 'data elements' (fields, columns, attributes, etc.) that are stored in the CR and the relationships between these elements. + </variablelist> + </listitem> + </varlistentry> + <varlistentry> + <term>The Data Model</term> + <listitem> + <para> + The core of any Content Repository is the data model. The data model defines the &apos;data elements&apos; (fields, columns, attributes, etc.) that are stored in the CR and the relationships between these elements. </para> - <para> - Data elements can be singular pieces of information (the value 3.14, for example), or compound values ('<emphasis>pi</emphasis>' = 3.14). A data model uses concepts like 'nodes', 'arrays' and 'links' to define relationships between data elements. + <para> + Data elements can be singular pieces of information (the value 3.14, for example), or compound values (&apos;<emphasis>pi</emphasis>&apos; = 3.14). A data model uses concepts like &apos;nodes&apos;, &apos;arrays&apos; and &apos;links&apos; to define relationships between data elements. </para> - <para> - The use and structure of these elements forms the content repository's 'data model'. + <para> + The use and structure of these elements forms the content repository&apos;s &apos;data model&apos;. </para> - - </listitem> - - </varlistentry> - <varlistentry> - <term>Data Abstraction</term> - <listitem> - <para> + </listitem> + </varlistentry> + <varlistentry> + <term>Data Abstraction</term> + <listitem> + <para> Data abstraction describes the separation between <emphasis>abstract</emphasis> and <emphasis>concrete</emphasis> properties of data stored in a repository. The <emphasis>concrete</emphasis> properties of the data refer to its implementation details. </para> - <para> + <para> The <emphasis>concrete</emphasis> properties of the data implementation may be changed without affecting the <emphasis>abstract</emphasis> properties of the data itself, which are read by the data client. </para> - <para> + <para> Consider the presentation of data in a list, graph or table. While the information <emphasis>implementation</emphasis> may change, the data itself is unaffected, and readers to whom the data is presented can perform a mental abstraction to interpret it correctly, regardless of the implementation. </para> - - </listitem> - - </varlistentry> - - </variablelist> - <!-- Commented until image can be redrawn for RedHat. + </listitem> + </varlistentry> + </variablelist> +<!-- Commented until image can be redrawn for RedHat. <mediaobject> <imageobject role="html"> <imagedata fileref="images/Advanced/JCR/repository_diagram.png" format="PNG" align="center" scale="90" /> @@ -145,9 +127,5 @@ Source URL: http://www.day.com/specs/jcr/2.0/3_Repository_Model.html Source Author: Day Management AG Source Author email: -Source License: http://www.day.com/specs/jcr/2.0/license.html] --> - </section> - - +Source License: http://www.day.com/specs/jcr/2.0/license.html] --> </section> </chapter> - Modified: epp/docs/branches/6.0/Reference_Guide/en-US/modules/eXoJCR/jcr/lock-manager-config.xml =================================================================== --- epp/docs/branches/6.0/Reference_Guide/en-US/modules/eXoJCR/jcr/lock-manager-config.xml 2012-10-24 06:12:02 UTC (rev 8938) +++ epp/docs/branches/6.0/Reference_Guide/en-US/modules/eXoJCR/jcr/lock-manager-config.xml 2012-10-25 06:01:34 UTC (rev 8939) @@ -9,7 +9,7 @@ The LockManager stores lock objects. It can lock or release objects as required. It is also responsible for removing stale locks. </para> <para> - The LockManager in JBoss Enterprise Portal Platform is implemented with <classname>org.exoplatform.services.jcr.impl.core.lock.jbosscache.CacheableLockManagerImpl</classname>. + The LockManager in JBoss Portal Platform is implemented with <classname>org.exoplatform.services.jcr.impl.core.lock.jbosscache.CacheableLockManagerImpl</classname>. </para> <para> It is enabled by adding <literal>lock-manager-configuration</literal> to <literal>workspace-configuration</literal>. @@ -93,20 +93,20 @@ <para> The required configuration is shown in the example below: </para> - <programlisting language="XML" role="XML"><xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="../../../extras/Advanced_Development_JCR_lock-manager-config/default49.xml" parse="text"/></programlisting> - <para> + <programlisting language="XML" role="XML"><xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="../../../extras/Advanced_Development_JCR_lock-manager-config/default49.xml" parse="text"/></programlisting> + <para> Sample content of the <replaceable>jbosscache-lock-config.xml</replaceable> file specified in the <replaceable>jbosscache-configuration</replaceable> property is shown in the code example below. </para> - <example> + <example> <title>Sample Content of the jbosscache-lock-config.xml File</title> <programlisting language="XML" role="XML"><xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="../../../extras/Advanced_Development_JCR_lock-manager-config/default50.xml" parse="text"/></programlisting> - <para> + <para> Comment #1: The cluster name at <parameter>clustering mode=&quot;replication&quot; clusterName=&quot;JBoss-Cache-Lock-Cluster_Name&quot;</parameter> must be unique; </para> - <para> + <para> Comment #2: The <parameter>cache.jdbc.table.name</parameter> must be unique per datasource. </para> - <para> + <para> Comment #3: The <parameter>cache.jdbc.node.type</parameter> and <parameter>cache.jdbc.fqn.type</parameter> parameters must be configured according to the database in use. Refer to the table below for information about data types. </para> </example> @@ -173,21 +173,21 @@ <para> Below is an example <filename>test-jbosscache-lock.xml</filename> template file: </para> - <programlisting language="XML" role="XML"><xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="../../../extras/Advanced_Development_JCR_lock-manager-config/you.xml" parse="text"/></programlisting> + <programlisting language="XML" role="XML"><xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="../../../extras/Advanced_Development_JCR_lock-manager-config/you.xml" parse="text"/></programlisting> <para> The parameters that will populate the above file are shown below: </para> <example> <title>JBoss Cache Configuration Parameters</title> <programlisting language="XML" role="XML"><xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="../../../extras/Advanced_Development_JCR_lock-manager-config/default51.xml" parse="text"/></programlisting> - <para> + <para> Comment #1: The <literal>jgroups-configuration</literal> has been moved to a separate configuration file (<filename>udp-mux.xml</filename>, shown below). In this case the <filename>udp-mux.xml</filename> is a common configuration for all JGroup components (QueryHandler, cache, LockManager), but this is not a requirement of the configuration method. </para> - <para> + <para> Comment #2: The <parameter>jbosscache-cl-cache.jdbc.fqn.column</parameter> and <parameter>jbosscache-cl-cache.jdbc.node.type</parameter> parameters are not explicitly defined as <parameter>cache.jdbc.fqn.type</parameter> and <parameter>cache.jdbc.node.type</parameter> are defined in the JBoss Cache configuration. </para> - </example> - <para> + </example> + <para> Refer to <xref linkend="tabl-Reference_Guide-Simple_JBoss_Cache_Configuration-Data_Types_in_Different_Databases"/> for information about setting these parameters or set them as <parameter>AUTO</parameter> and the data type will by detected automatically. </para> <para> Modified: epp/docs/branches/6.0/Reference_Guide/en-US/modules/eXoJCR/jcr/query-handler-config.xml =================================================================== --- epp/docs/branches/6.0/Reference_Guide/en-US/modules/eXoJCR/jcr/query-handler-config.xml 2012-10-24 06:12:02 UTC (rev 8938) +++ epp/docs/branches/6.0/Reference_Guide/en-US/modules/eXoJCR/jcr/query-handler-config.xml 2012-10-25 06:01:34 UTC (rev 8939) @@ -220,7 +220,7 @@ If a new node joins a cluster, without an index it is retrieved or recreated. Nodes can be also be restarted and thus the index is not empty. By default, even though the existing index is thought to be up to date, it can be outdated. </para> <para> - The JBoss Enterprise Portal Platform JCR offers a mechanism called <literal>RecoveryFilters</literal> that will automatically retrieve index for the joining node on start up. This feature is a set of filters that can be defined via <literal>QueryHandler</literal> configuration: + The JBoss Portal Platform JCR offers a mechanism called <literal>RecoveryFilters</literal> that will automatically retrieve index for the joining node on start up. This feature is a set of filters that can be defined via <literal>QueryHandler</literal> configuration: </para> <programlisting language="XML">&lt;property name=&quot;index-recovery-filter&quot; value=&quot;org.exoplatform.services.jcr.impl.core.query.lucene.DocNumberRecoveryFilter&quot; /&gt;</programlisting> <para> Modified: epp/docs/branches/6.0/Reference_Guide/en-US/modules/eXoJCR/jcr/repository-check-controller.xml =================================================================== --- epp/docs/branches/6.0/Reference_Guide/en-US/modules/eXoJCR/jcr/repository-check-controller.xml 2012-10-24 06:12:02 UTC (rev 8938) +++ epp/docs/branches/6.0/Reference_Guide/en-US/modules/eXoJCR/jcr/repository-check-controller.xml 2012-10-25 06:01:34 UTC (rev 8939) @@ -8,7 +8,7 @@ <section id="sect-Reference_Guide-Checking_repository_integrity_and_consistency-JMX_based_consistency_tool"> <title>JMX-based consistency tool</title> <para> - It is important to check the integrity and consistency of system regularly, especially if there is no, or stale, backups. The JBoss Enterprise Portal Platform JCR implementation offers an innovative JMX-based complex checking tool. + It is important to check the integrity and consistency of system regularly, especially if there is no, or stale, backups. The JBoss Portal Platform JCR implementation offers an innovative JMX-based complex checking tool. </para> <para> During an inspection, the tool checks every major JCR component, such as persistent data layer and the index. The persistent layer includes JDBC Data Container and Value-Storages if they are configured. Modified: epp/docs/branches/6.0/Reference_Guide/en-US/modules/eXoJCR/jcr/searching/fulltext-search-and-settings.xml =================================================================== --- epp/docs/branches/6.0/Reference_Guide/en-US/modules/eXoJCR/jcr/searching/fulltext-search-and-settings.xml 2012-10-24 06:12:02 UTC (rev 8938) +++ epp/docs/branches/6.0/Reference_Guide/en-US/modules/eXoJCR/jcr/searching/fulltext-search-and-settings.xml 2012-10-25 06:01:34 UTC (rev 8939) @@ -98,7 +98,7 @@ </table> <note> <para> - <literal>StandardAnalyzer</literal> is the default analyzer in the JBoss Enterprise Portal Platform JCR search engine. But it does not use stop words. + <literal>StandardAnalyzer</literal> is the default analyzer in the JBoss Portal Platform JCR search engine. But it does not use stop words. </para> </note> <para> Modified: epp/docs/branches/6.0/Reference_Guide/en-US/modules/eXoJCR/jcr/searching/searching-repository-content.xml =================================================================== --- epp/docs/branches/6.0/Reference_Guide/en-US/modules/eXoJCR/jcr/searching/searching-repository-content.xml 2012-10-24 06:12:02 UTC (rev 8938) +++ epp/docs/branches/6.0/Reference_Guide/en-US/modules/eXoJCR/jcr/searching/searching-repository-content.xml 2012-10-25 06:01:34 UTC (rev 8939) @@ -64,7 +64,7 @@ <section id="sect-Reference_Guide-Searching_Repository_Content-Fuzzy_Searches"> <title>Fuzzy Searches</title> <para> - The JBoss Enterprise Portal Platform JCR supports features such as Lucene Fuzzy Searches. To perform a fuzzy search, form your query like the one below: + The JBoss Portal Platform JCR supports features such as Lucene Fuzzy Searches. To perform a fuzzy search, form your query like the one below: </para> <programlisting language="Java" role="Java">QueryManager qman = session.getWorkspace().getQueryManager(); Query q = qman.createQuery(&quot;select * from nt:base where contains(field, &apos;ccccc~&apos;)&quot;, Query.SQL); Modified: epp/docs/branches/6.0/Reference_Guide/en-US/modules/eXoJCR/jcr-with-gtn/managed-datasources-under-jboss-as.xml =================================================================== --- epp/docs/branches/6.0/Reference_Guide/en-US/modules/eXoJCR/jcr-with-gtn/managed-datasources-under-jboss-as.xml 2012-10-24 06:12:02 UTC (rev 8938) +++ epp/docs/branches/6.0/Reference_Guide/en-US/modules/eXoJCR/jcr-with-gtn/managed-datasources-under-jboss-as.xml 2012-10-25 06:01:34 UTC (rev 8939) @@ -13,7 +13,7 @@ To declare the datasources using a JBoss application server, deploy a <literal>ds</literal> file (<filename><replaceable>XXX</replaceable>-ds.xml</filename>) into the <emphasis>deploy</emphasis> directory of the appropriate server profile (<filename>/server/<replaceable>PROFILE</replaceable>/deploy</filename>, for example). </para> <para> - This file configures all datasources which JBoss Enterprise Portal Platform will need (there should be four specifically named: <emphasis>jdbcjcr_portal</emphasis>, <emphasis>jdbcjcr_portal-sample</emphasis>, <emphasis>jdbcidm_portal</emphasis> and <emphasis>jdbcidm_sample-portal</emphasis>). + This file configures all datasources which JBoss Portal Platform will need (there should be four specifically named: <emphasis>jdbcjcr_portal</emphasis>, <emphasis>jdbcjcr_portal-sample</emphasis>, <emphasis>jdbcidm_portal</emphasis> and <emphasis>jdbcidm_sample-portal</emphasis>). </para> <para> For example: Modified: epp/docs/branches/6.0/User_Guide/en-US/Book_Info.xml =================================================================== --- epp/docs/branches/6.0/User_Guide/en-US/Book_Info.xml 2012-10-24 06:12:02 UTC (rev 8938) +++ epp/docs/branches/6.0/User_Guide/en-US/Book_Info.xml 2012-10-25 06:01:34 UTC (rev 8939) @@ -5,14 +5,14 @@ ]> <bookinfo id="book-User_Guide-User_Guide"> <title>User Guide</title> - <subtitle>for JBoss Enterprise Portal Platform 6, and its patch releases.</subtitle> - <productname>JBoss Enterprise Portal Platform</productname> - <productnumber>6.0</productnumber> + <subtitle>for JBoss Portal Platform 6, and its patch releases.</subtitle> + <productname>JBoss Portal Platform</productname> + <productnumber>6</productnumber> <edition>6.0.0</edition> <abstract> <para> This document provides an easy to follow guide to the functions and -options available in JBoss Enterprise Portal Platform. It is intended to +options available in JBoss Portal Platform. It is intended to be accessible and useful to both experienced and novice portal users. </para> Modified: epp/docs/branches/6.0/User_Guide/en-US/Revision_History.xml =================================================================== --- epp/docs/branches/6.0/User_Guide/en-US/Revision_History.xml 2012-10-24 06:12:02 UTC (rev 8938) +++ epp/docs/branches/6.0/User_Guide/en-US/Revision_History.xml 2012-10-25 06:01:34 UTC (rev 8939) @@ -8,6 +8,20 @@ <simpara> <revhistory> <revision> + <revnumber>6.0.0-5</revnumber> + <date>Thu Oct 25 2012</date> + <author> + <firstname>Jared</firstname> + <surname>Morgan</surname> + <email></email> + </author> + <revdescription> + <simplelist> + <member>Rebuilt book so it would appear under the JBoss Portal Platform banner.</member> + </simplelist> + </revdescription> + </revision> + <revision> <revnumber>6.0.0-4</revnumber> <date>Wed Oct 17 2012</date> <author> Modified: epp/docs/branches/6.0/User_Guide/en-US/User_Guide.ent =================================================================== --- epp/docs/branches/6.0/User_Guide/en-US/User_Guide.ent 2012-10-24 06:12:02 UTC (rev 8938) +++ epp/docs/branches/6.0/User_Guide/en-US/User_Guide.ent 2012-10-25 06:01:34 UTC (rev 8939) @@ -1,13 +1,13 @@ <!-- Product Specifics: --> -<!ENTITY PRODUCT "JBoss Enterprise Portal Platform"> +<!ENTITY PRODUCT "JBoss Portal Platform"> <!-- Book specifics: --> <!ENTITY BOOKID "User Guide"> <!-- Bugzilla Specifics --> -<!ENTITY BZPRODUCT "JBoss Enterprise Portal Platform 6"> +<!ENTITY BZPRODUCT "JBoss Portal Platform 6"> <!ENTITY BZCOMPONENT "docs-User_Guide"> -<!ENTITY BZURL "<ulink url='https://bugzilla.redhat.com/enter_bug.cgi?product=JBoss&perc... +<!ENTITY BZURL "<ulink url='https://bugzilla.redhat.com/enter_bug.cgi?product=JBoss&perc... <!-- Corporate Specifics: --> <!ENTITY YEAR "2012"> Modified: epp/docs/branches/6.0/User_Guide/en-US/modules/Further_Documentation.xml =================================================================== --- epp/docs/branches/6.0/User_Guide/en-US/modules/Further_Documentation.xml 2012-10-24 06:12:02 UTC (rev 8938) +++ epp/docs/branches/6.0/User_Guide/en-US/modules/Further_Documentation.xml 2012-10-25 06:01:34 UTC (rev 8939) @@ -1,12 +1,11 @@ -<?xml version='1.0' encoding='utf-8' ?> +<?xml version='1.0' encoding='UTF-8'?> <!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [ <!ENTITY % BOOK_ENTITIES SYSTEM "../User_Guide.ent"> %BOOK_ENTITIES; ]> <chapter id="chap-User_Guide-Futher_Documentation"> - <title>Further Documentation</title> - <para> - Further documentation about using and configuring the JBoss Enterprise Portal Platform can be found in the JBoss Enterprise Portal Platform Install Guide or the JBoss Enterprise Portal Platform Reference Guide which are hosted at <ulink type="http" url="http://www.redhat.com/docs/en-US/JBoss_Enterprise_Portal_Platfo...;. - </para> + <title>Further Documentation</title> + <para> + Further documentation about using and configuring the JBoss Portal Platform can be found in the JBoss Portal Platform Installation Guide or the JBoss Portal Platform Reference Guide which are hosted at <ulink url="http://www.redhat.com/docs/en-US/JBoss_Enterprise_Portal_Platfo... type="http">www.redhat.com</ulink>. + </para> </chapter> - Modified: epp/docs/branches/6.0/User_Guide/en-US/modules/Introduction.xml =================================================================== --- epp/docs/branches/6.0/User_Guide/en-US/modules/Introduction.xml 2012-10-24 06:12:02 UTC (rev 8938) +++ epp/docs/branches/6.0/User_Guide/en-US/modules/Introduction.xml 2012-10-25 06:01:34 UTC (rev 8939) @@ -1,14 +1,14 @@ -<?xml version='1.0' encoding='utf-8' ?> +<?xml version='1.0' encoding='UTF-8'?> <!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [ <!ENTITY % BOOK_ENTITIES SYSTEM "../User_Guide.ent"> %BOOK_ENTITIES; ]> <chapter id="chap-User_Guide-Introduction"> - <title>Introduction</title> - <para> - JBoss Enterprise Portal Platform is the merge of two mature Java projects; JBoss Portal and eXo Portal. This new community project takes the best of both offerings and incorporates them into a single J2EE deployment archive. The aim is to provide an intuitive user-friendly portal and a framework to address the needs of today's Web 2.0 applications. + <title>Introduction</title> + <para> +JBoss Portal Platform is the merge of two mature Java projects; JBoss Portal and eXo Portal. This new community project takes the best of both offerings and incorporates them into a single J2EE deployment archive. The aim is to provide an intuitive user-friendly portal and a framework to address the needs of today&apos;s Web 2.0 applications. </para> - <!-- DOCS NOTE: BZ#856442: This image may not be necessary in this book. +<!-- DOCS NOTE: BZ#856442: This image may not be necessary in this book. <mediaobject> <imageobject role="html"> <imagedata fileref="images/Frontpage.png" format="PNG" align="center" scale="130" /> @@ -17,39 +17,37 @@ <imagedata fileref="images/Frontpage.png" format="PNG" align="center" contentwidth="150mm" /> </imageobject> </mediaobject> - --> - <para> - This book introduces and provides detailed information about most features and capabilities of JBoss Enterprise Portal Platform such as user/group management and access permissions, using portlets and changing basic interface objects such as skins, language and page orientation. + --> <para> + This book introduces and provides detailed information about most features and capabilities of JBoss Portal Platform such as user/group management and access permissions, using portlets and changing basic interface objects such as skins, language and page orientation. </para> - - <section id="sect-Install_Guide-Introduction-Related_Links"> - <title>Related Links</title> - <variablelist> - <varlistentry> - <term>Technical documentation</term> - <listitem> - <para> - Other technical documentation, including an <emphasis role="bold">Installation Guide</emphasis>, a <emphasis role="bold">Reference Guide</emphasis> and component specific documentation, can be found at <ulink type="http" url="http://www.redhat.com/docs">www.redhat.com/docs</uli... + <section id="sect-Install_Guide-Introduction-Related_Links"> + <title>Related Links</title> + <variablelist> + <varlistentry> + <term>Technical documentation</term> + <listitem> + <para> + Other technical documentation, including an <emphasis role="bold">Installation Guide</emphasis>, a <emphasis role="bold">Reference Guide</emphasis> and component specific documentation, can be found at <ulink url="http://www.redhat.com/docs" type="http">www.redhat.com/docs</ulink> </para> - </listitem> - </varlistentry> - <varlistentry> - <term>Non-technical documentation</term> - <listitem> - <para> + </listitem> + </varlistentry> + <varlistentry> + <term>Non-technical documentation</term> + <listitem> + <para> Links to non-technical documents are included on the front page of the portal: </para> - <mediaobject> - <imageobject role="html"> - <imagedata fileref="images/Non-tech-docs.png" format="PNG" align="center" scale="90" /> - </imageobject> - <imageobject role="fo"> - <imagedata fileref="images/Non-tech-docs.png" format="PNG" align="center" contentwidth="120mm" /> - </imageobject> - </mediaobject> - </listitem> - </varlistentry> - <!-- Text below removed as the videos page linked to is inappropriate for EPP. Note that as at 9 Jan 2012, the link is still present in the product itself. + <mediaobject> + <imageobject role="html"> + <imagedata align="center" scale="90" fileref="images/Non-tech-docs.png" format="PNG"/> + </imageobject> + <imageobject role="fo"> + <imagedata contentwidth="120mm" align="center" fileref="images/Non-tech-docs.png" format="PNG"/> + </imageobject> + </mediaobject> + </listitem> + </varlistentry> +<!-- Text below removed as the videos page linked to is inappropriate for EPP. Note that as at 9 Jan 2012, the link is still present in the product itself. <varlistentry> <term>Videos</term> <listitem> @@ -65,8 +63,6 @@ </imageobject> </mediaobject> </listitem> - </varlistentry> --> - </variablelist> - </section> + </varlistentry> --> </variablelist> + </section> </chapter> - Modified: epp/docs/branches/6.0/User_Guide/en-US/modules/Supported_Browsers.xml =================================================================== --- epp/docs/branches/6.0/User_Guide/en-US/modules/Supported_Browsers.xml 2012-10-24 06:12:02 UTC (rev 8938) +++ epp/docs/branches/6.0/User_Guide/en-US/modules/Supported_Browsers.xml 2012-10-25 06:01:34 UTC (rev 8939) @@ -1,43 +1,40 @@ -<?xml version='1.0' encoding='utf-8' ?> +<?xml version='1.0' encoding='UTF-8'?> <!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [ <!ENTITY % BOOK_ENTITIES SYSTEM "../User_Guide.ent"> %BOOK_ENTITIES; ]> - <chapter> - <title>Supported Browsers</title> - <para> - JBoss Enterprise Portal Platform has been tested, and is supported, on the following web browsers: + <title>Supported Browsers</title> + <para> +JBoss Portal Platform has been tested, and is supported, on the following web browsers: </para> <!-- Source Metadata URL: https://jira.exoplatform.org/browse/WCM-1371 Author [w/email]: Benjamin Paillereau (benjamin.paillereau(a)exoplatform.com) License: ---> - <itemizedlist> - <listitem> - <para> - <ulink type="http" url="http://www.mozilla.com/en-US/firefox/new/">Firefox</... (versions 3.5 to 7). +--> <itemizedlist> + <listitem> + <para> + <ulink url="http://www.mozilla.com/en-US/firefox/new/" type="http">Firefox</ulink> (versions 3.5 to 7). </para> - </listitem> - <listitem> - <para> - <ulink type="http" url="http://windows.microsoft.com/en-AU/internet-explorer/downloads/... Explorer</ulink> (versions 7 to 9). + </listitem> + <listitem> + <para> + <ulink url="http://windows.microsoft.com/en-AU/internet-explorer/downloads/... type="http">Internet Explorer</ulink> (versions 7 to 9). </para> - </listitem> - <listitem> - <para> - <ulink type="http" url="http://www.google.com/chrome/">Google Chrome</ulink>. + </listitem> + <listitem> + <para> + <ulink url="http://www.google.com/chrome/" type="http">Google Chrome</ulink>. </para> - </listitem> - <listitem> - <para> - <ulink type="http" url="http://www.apple.com/safari/">Safari</ulink> (read-only). + </listitem> + <listitem> + <para> + <ulink url="http://www.apple.com/safari/" type="http">Safari</ulink> (read-only). </para> - </listitem> - - </itemizedlist> - <para> + </listitem> + </itemizedlist> + <para> This list will be expanded as newer browser versions are released and tested. </para> -</chapter> \ No newline at end of file +</chapter> Modified: epp/docs/branches/6.0/User_Guide/en-US/modules/account/Account_and_Password_Retrieval.xml =================================================================== --- epp/docs/branches/6.0/User_Guide/en-US/modules/account/Account_and_Password_Retrieval.xml 2012-10-24 06:12:02 UTC (rev 8938) +++ epp/docs/branches/6.0/User_Guide/en-US/modules/account/Account_and_Password_Retrieval.xml 2012-10-25 06:01:34 UTC (rev 8939) @@ -1,19 +1,19 @@ -<?xml version='1.0' encoding='utf-8' ?> +<?xml version='1.0' encoding='UTF-8'?> <!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [ <!ENTITY % BOOK_ENTITIES SYSTEM "../../User_Guide.ent"> %BOOK_ENTITIES; ]> <section id="sect-User_Guide-Account_and_Password_Retrieval"> - <title>Account and Password Retrieval</title> - <para> + <title>Account and Password Retrieval</title> + <para> You can recover your username or password should you forget them by following these steps: </para> - <procedure> - <step> - <para> - Click the link '<emphasis role="bold">Forgot your User Name/Password?</emphasis>' + <procedure> + <step> + <para> + Click the link &apos;<emphasis role="bold">Forgot your User Name/Password?</emphasis>&apos; </para> - <!-- DOCS NOTE: BZ#856442: This image may not be required. +<!-- DOCS NOTE: BZ#856442: This image may not be required. <mediaobject> <imageobject role="html"> <imagedata fileref="images/SignIn1.png" format="PNG" align="center" scale="100"/> @@ -22,78 +22,74 @@ <imagedata fileref="images/SignIn1.png" format="PNG" align="center" scalefit="1" contentwidth="100mm" /> </imageobject> </mediaobject> - --> - </step> - - <step> - <para> + --> </step> + <step> + <para> The next screen offers two options: </para> - <itemizedlist> - <listitem> - <para> + <itemizedlist> + <listitem> + <para> <emphasis role="bold">Forgot my password</emphasis>. </para> - </listitem> - <listitem> - <para> + </listitem> + <listitem> + <para> <emphasis role="bold">Forgot my username</emphasis>. </para> - </listitem> - </itemizedlist> - <mediaobject> - <imageobject role="html"> - <imagedata fileref="images/Forgot1.png" format="PNG" align="center" scale="100"/> - </imageobject> - <imageobject role="fo"> - <imagedata fileref="images/Forgot1.png" format="PNG" align="center" scalefit="1" contentwidth="100mm" /> - </imageobject> - </mediaobject> - <para> + </listitem> + </itemizedlist> + <mediaobject> + <imageobject role="html"> + <imagedata align="center" scale="100" fileref="images/Forgot1.png" format="PNG"/> + </imageobject> + <imageobject role="fo"> + <imagedata contentwidth="100mm" align="center" scalefit="1" fileref="images/Forgot1.png" format="PNG"/> + </imageobject> + </mediaobject> + <para> Select the appropriate option and click <emphasis role="bold">Next</emphasis>. </para> - </step> - <step> - <para> + </step> + <step> + <para> You will be prompted to provide identification information depending on which option you selected: </para> - <itemizedlist> - <listitem> - <para> + <itemizedlist> + <listitem> + <para> If you selected the <emphasis role="bold">Forgot my password</emphasis> option you will be prompted for your username. </para> - </listitem> - <listitem> - <para> + </listitem> + <listitem> + <para> If you selected <emphasis role="bold">Forgot my username</emphasis> you will be prompted for your email address. </para> - </listitem> - </itemizedlist> - </step> - </procedure> - <para> + </listitem> + </itemizedlist> + </step> + </procedure> + <para> After you submit the form an email will be send to your email address to assist you. </para> - <para> + <para> If you forgot your password you will be sent a link to application that will allow you to edit your password. Your original password will not be valid after this email is sent. </para> - <important> - <title>Email Error</title> - <para> + <important> + <title>Email Error</title> + <para> If you receive an error message advising that the email could not be sent, you may need to configure (or reconfigure) your email settings in the <filename>configuration.properties</filename> file. </para> - <mediaobject> - <imageobject role="html"> - <imagedata fileref="images/EmailError.png" format="PNG" align="center" scale="90" /> - </imageobject> - <imageobject role="fo"> - <imagedata fileref="images/EmailError.png" format="PNG" align="center" contentwidth="120mm" /> - </imageobject> - </mediaobject> - <para> - More information about this configuration can be found in <emphasis role="bold">Section 5.2.2</emphasis> of the <emphasis role="bold">JBoss Enterprise Portal Platform Installation Guide</emphasis> at <ulink type="http" url="http://www.redhat.com/docs/en-US/JBoss_Enterprise_Portal_Platfo...;. + <mediaobject> + <imageobject role="html"> + <imagedata align="center" scale="90" fileref="images/EmailError.png" format="PNG"/> + </imageobject> + <imageobject role="fo"> + <imagedata contentwidth="120mm" align="center" fileref="images/EmailError.png" format="PNG"/> + </imageobject> + </mediaobject> + <para> + More information about this configuration can be found in <emphasis role="bold">Section 5.2.2</emphasis> of the <emphasis role="bold">JBoss Portal Platform Installation Guide</emphasis> at <ulink url="http://www.redhat.com/docs/en-US/JBoss_Enterprise_Portal_Platfo... type="http">www.redhat.com</ulink>. </para> - </important> + </important> </section> - - Modified: epp/docs/branches/6.0/User_Guide/en-US/modules/account/Remember_User_Account.xml =================================================================== --- epp/docs/branches/6.0/User_Guide/en-US/modules/account/Remember_User_Account.xml 2012-10-24 06:12:02 UTC (rev 8938) +++ epp/docs/branches/6.0/User_Guide/en-US/modules/account/Remember_User_Account.xml 2012-10-25 06:01:34 UTC (rev 8939) @@ -1,42 +1,39 @@ -<?xml version='1.0' encoding='utf-8' ?> +<?xml version='1.0' encoding='UTF-8'?> <!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [ <!ENTITY % BOOK_ENTITIES SYSTEM "../../User_Guide.ent"> %BOOK_ENTITIES; ]> <section id="sect-User_Guide-Remember_User_Account"> - <title>Remember User Account</title> - <para> - Users who return to JBoss Enterprise Portal Platform regularly can be automatically authenticated to avoid performing an explicit authentication each time they access the portal. - </para> - <mediaobject> - <imageobject role="html"> - <imagedata fileref="images/RememberMe.png" format="PNG" align="center" scale="110"/> - </imageobject> - <imageobject role="fo"> - <imagedata fileref="images/RememberMe.png" format="PNG" align="center" scalefit="1" contentwidth="150mm" /> - </imageobject> - </mediaobject> - <procedure> - <step> - <para> - Input your registered user name and password. - </para> - </step> - <step> - <para> - Select the <emphasis role="bold">Remember My Login</emphasis> check box when logging in JBoss Enterprise Portal Platform at the first time. - </para> - </step> - <step> - <para> - Click the <emphasis role="bold">Sign in</emphasis> button to sign in the portal. - </para> - </step> - </procedure> - <para> - Do not sign out when you leave the portal and you will be automatically authenticated next time you visit it. - </para> - + <title>Remember User Account</title> + <para> + Users who return to JBoss Portal Platform regularly can be automatically authenticated to avoid performing an explicit authentication each time they access the portal. + </para> + <mediaobject> + <imageobject role="html"> + <imagedata align="center" scale="110" fileref="images/RememberMe.png" format="PNG"/> + </imageobject> + <imageobject role="fo"> + <imagedata contentwidth="150mm" align="center" scalefit="1" fileref="images/RememberMe.png" format="PNG"/> + </imageobject> + </mediaobject> + <procedure> + <step> + <para> + Input your registered user name and password. + </para> + </step> + <step> + <para> + Select the <emphasis role="bold">Remember My Login</emphasis> check box when logging in JBoss Portal Platform at the first time. + </para> + </step> + <step> + <para> + Click the <emphasis role="bold">Sign in</emphasis> button to sign in the portal. + </para> + </step> + </procedure> + <para> + Do not sign out when you leave the portal and you will be automatically authenticated next time you visit it. + </para> </section> - - Modified: epp/docs/branches/6.0/User_Guide/en-US/modules/account/Sign_in_and_Sign_out.xml =================================================================== --- epp/docs/branches/6.0/User_Guide/en-US/modules/account/Sign_in_and_Sign_out.xml 2012-10-24 06:12:02 UTC (rev 8938) +++ epp/docs/branches/6.0/User_Guide/en-US/modules/account/Sign_in_and_Sign_out.xml 2012-10-25 06:01:34 UTC (rev 8939) @@ -1,18 +1,17 @@ -<?xml version='1.0' encoding='utf-8' ?> +<?xml version='1.0' encoding='UTF-8'?> <!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [ <!ENTITY % BOOK_ENTITIES SYSTEM "../../User_Guide.ent"> %BOOK_ENTITIES; ]> <section id="sect-User_Guide-Sign_In_and_Sign_Out"> - <title>Sign In and Sign Out</title> - - <para> + <title>Sign In and Sign Out</title> + <para> In order to enter the portal in private mode, you should use the account previously registered. </para> - <para> + <para> To sign in to a portal, users must complete the <emphasis role="bold">Sign in</emphasis> form: </para> - <!-- DOCS NOTE: BZ#856442: This image may no longer be required +<!-- DOCS NOTE: BZ#856442: This image may no longer be required <mediaobject> <imageobject role="html"> <imagedata fileref="images/Signin.png" format="PNG" align="center" scale="110"/> @@ -21,138 +20,131 @@ <imagedata fileref="images/Signin.png" format="PNG" align="center" scalefit="1" contentwidth="150mm"/> </imageobject> </mediaobject> - --> - <para> + --> <para> This form contains the following elements: </para> - <variablelist> - <varlistentry> - <term> - <emphasis role="bold">User name</emphasis> - </term> - <listitem> - <para> + <variablelist> + <varlistentry> + <term> + <emphasis role="bold">User name</emphasis> + </term> + <listitem> + <para> The registered user name. </para> - </listitem> - </varlistentry> - <varlistentry> - <term> - <emphasis role="bold">Password</emphasis> - </term> - <listitem> - <para> + </listitem> + </varlistentry> + <varlistentry> + <term> + <emphasis role="bold">Password</emphasis> + </term> + <listitem> + <para> The registered password. </para> - </listitem> - </varlistentry> - <varlistentry> - <term> - <emphasis role="bold">Remember My Login</emphasis> - </term> - <listitem> - <para> + </listitem> + </varlistentry> + <varlistentry> + <term> + <emphasis role="bold">Remember My Login</emphasis> + </term> + <listitem> + <para> Check this box to avoid log in every time </para> - </listitem> - </varlistentry> - <varlistentry> - <term> - <emphasis role="bold">Forgot your User Name/Password?</emphasis> - </term> - <listitem> - <para> + </listitem> + </varlistentry> + <varlistentry> + <term> + <emphasis role="bold">Forgot your User Name/Password?</emphasis> + </term> + <listitem> + <para> To follow some steps to get the forgotten user name or password. Please refer to <xref linkend="sect-User_Guide-Account_and_Password_Retrieval"/> for more details. </para> - </listitem> - </varlistentry> - <varlistentry> - <term> - <emphasis role="bold">Sign in</emphasis> - </term> - <listitem> - <para> - To sign into JBoss Enterprise Portal Platform with user name and password. + </listitem> + </varlistentry> + <varlistentry> + <term> + <emphasis role="bold">Sign in</emphasis> + </term> + <listitem> + <para> + To sign into JBoss Portal Platform with user name and password. </para> - </listitem> - </varlistentry> - <varlistentry> - <term> - <emphasis role="bold">Discard</emphasis> - </term> - <listitem> - <para> + </listitem> + </varlistentry> + <varlistentry> + <term> + <emphasis role="bold">Discard</emphasis> + </term> + <listitem> + <para> Close the Sign In form without logging in. </para> - </listitem> - </varlistentry> - </variablelist> - - <section id="sect-User_Guide-Sign_In"> - <title>Sign In</title> - <procedure> - <step> - <para> + </listitem> + </varlistentry> + </variablelist> + <section id="sect-User_Guide-Sign_In"> + <title>Sign In</title> + <procedure> + <step> + <para> Go to your portal by entering the URL into the address bar of your browser (For example <emphasis role="bold">http://localhost:8080/portal</emphasis>). </para> - </step> - <step> - <para> + </step> + <step> + <para> Click the <emphasis role="bold">Sign in</emphasis> link at the top right of the page if you are current in the Classic portal. The <emphasis role="bold">Sign in</emphasis> form appears. </para> - </step> - <step> - <para> + </step> + <step> + <para> Input your registered <emphasis role="bold">User name</emphasis> and <emphasis role="bold">Password</emphasis> . </para> - </step> - <step> - <para> - Select the <emphasis role="bold">Remember My Login</emphasis> check box when you sign in JBoss Enterprise Portal Platform at the first time if you want to automatically return to JBoss Enterprise Portal Platform without signing in again. You can see <xref linkend="sect-User_Guide-Remember_User_Account" /> for more details. + </step> + <step> + <para> + Select the <emphasis role="bold">Remember My Login</emphasis> check box when you sign in JBoss Portal Platform at the first time if you want to automatically return to JBoss Portal Platform without signing in again. You can see <xref linkend="sect-User_Guide-Remember_User_Account"/> for more details. </para> - </step> - <step> - <para> + </step> + <step> + <para> Click the <emphasis role="bold">Sign in</emphasis> button to submit the form or <emphasis role="bold">Discard</emphasis> to escape. </para> - </step> - </procedure> - <para> + </step> + </procedure> + <para> If the user name does not exist or the user name and/or password is invalid you will be redirected to the GateIn Sign In form. Enter a correct user name and password. </para> - <para> + <para> After signing in, you will be redirected to the homepage and welcomed with your full name in the top right corner of the page. </para> - </section> - - <section id="sect-User_Guide-Sign_Out"> - <title>Sign Out</title> - <para> + </section> + <section id="sect-User_Guide-Sign_Out"> + <title>Sign Out</title> + <para> This feature ends the authenticated session and returns the user to the anonymous portal. </para> - <procedure> - <step> - <para> - In the upper left corner of the screen, hover your cursor over the JBoss Enterprise Portal Platform icon. A drop down menu will appear. + <procedure> + <step> + <para> + In the upper left corner of the screen, hover your cursor over the JBoss Portal Platform icon. A drop down menu will appear. </para> - </step> - <step> - <para> + </step> + <step> + <para> Click <emphasis role="bold">Sign out</emphasis> : </para> - </step> - </procedure> - <mediaobject> - <imageobject role="html"> - <imagedata fileref="images/StarPortlet.png" format="PNG" align="center" scale="100" /> - </imageobject> - <imageobject role="fo"> - <imagedata fileref="images/StarPortlet.png" format="PNG" align="center" scalefit="1" contentwidth="130mm"/> - </imageobject> - </mediaobject> - - </section> - + </step> + </procedure> + <mediaobject> + <imageobject role="html"> + <imagedata align="center" scale="100" fileref="images/StarPortlet.png" format="PNG"/> + </imageobject> + <imageobject role="fo"> + <imagedata contentwidth="130mm" align="center" scalefit="1" fileref="images/StarPortlet.png" format="PNG"/> + </imageobject> + </mediaobject> + </section> </section> - - Modified: epp/docs/branches/6.0/User_Guide/en-US/modules/gadgetsAdmin/Manage_Portlets_and_Gadgets.xml =================================================================== --- epp/docs/branches/6.0/User_Guide/en-US/modules/gadgetsAdmin/Manage_Portlets_and_Gadgets.xml 2012-10-24 06:12:02 UTC (rev 8938) +++ epp/docs/branches/6.0/User_Guide/en-US/modules/gadgetsAdmin/Manage_Portlets_and_Gadgets.xml 2012-10-25 06:01:34 UTC (rev 8939) @@ -1,126 +1,123 @@ -<?xml version='1.0' encoding='utf-8' ?> +<?xml version='1.0' encoding='UTF-8'?> <!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [ <!ENTITY % BOOK_ENTITIES SYSTEM "../../User_Guide.ent"> %BOOK_ENTITIES; ]> <section id="sect-User_Guide-Manage_Portlets_and_Gadgets"> - <title>Manage Portlets and Gadgets</title> - <para> + <title>Manage Portlets and Gadgets</title> + <para> Portlets and gadgets are organized in different categories. Each category contains one or several portlets or gadgets. You can also mix portlets and gadgets into one category. By default all gadgets are placed in the <emphasis>Gadgets</emphasis> category. </para> - <important> - <title>Gadget Preference Persistence</title> - <para> + <important> + <title>Gadget Preference Persistence</title> + <para> Administrators and users should be aware that adding a gadget to any portal page other than the dashboard, will result in any user set preferences or modifications (adding entries to the TODO gadget, for example) <emphasis role="bold">not</emphasis> being saved in a persistent manner. </para> - <para> - This limitation will be corrected in a later version of JBoss Enterprise Portal Platform. + <para> + This limitation will be corrected in a later version of JBoss Portal Platform. </para> - </important> - <section id="sect-User_Guide-Dashboard_Portlet-Display_Gadgets"> - <title>Display Gadgets</title> - <para> + </important> + <section id="sect-User_Guide-Dashboard_Portlet-Display_Gadgets"> + <title>Display Gadgets</title> + <para> You can change the number of columns available in the Dashboard. </para> - <procedure> - <step> - <para> + <procedure> + <step> + <para> Go to the Dashboard (by clicking <emphasis role="bold">Dashboard</emphasis> in the Toolbar) </para> - </step> - <step> - <para> + </step> + <step> + <para> Hover over <emphasis role="bold">Dashboard Editor</emphasis> and click <emphasis role="bold">Edit Page</emphasis> in the drop-down menu. </para> - </step> - <step> - <para> + </step> + <step> + <para> The Page editor will appear. </para> - </step> - <step> - <para> - Hover over the <emphasis role="bold">Dashboard Portlet</emphasis> and click on the <emphasis role="bold">Edit</emphasis> icon (the 'pencil'). + </step> + <step> + <para> + Hover over the <emphasis role="bold">Dashboard Portlet</emphasis> and click on the <emphasis role="bold">Edit</emphasis> icon (the &apos;pencil&apos;). </para> - <mediaobject> - <imageobject role="html"> - <imagedata fileref="images/Column.png" format="PNG" align="center" scale="100"/> - </imageobject> - <imageobject role="fo"> - <imagedata fileref="images/Column.png" format="PNG" align="center" scalefit="1" contentwidth="120mm" /> - </imageobject> - </mediaobject> - </step> - <step> - <para> + <mediaobject> + <imageobject role="html"> + <imagedata align="center" scale="100" fileref="images/Column.png" format="PNG"/> + </imageobject> + <imageobject role="fo"> + <imagedata contentwidth="120mm" align="center" scalefit="1" fileref="images/Column.png" format="PNG"/> + </imageobject> + </mediaobject> + </step> + <step> + <para> Change the number of columns in the <emphasis role="bold">Number of columns</emphasis> field. The maximum number of columns is four (4). </para> - </step> - <step> - <para> + </step> + <step> + <para> Click the <emphasis role="bold">Save</emphasis> button to accept the change. </para> - </step> - <step> - <para> + </step> + <step> + <para> Click <emphasis role="bold">Close</emphasis> and then click <emphasis role="bold">Finish</emphasis>. </para> - </step> - </procedure> - - </section> - - <section id="sect-User_Guide-Manage_Portlets_and_Gadgets-Add_a_new_Category"> - <title>Add a new Category</title> - <para> + </step> + </procedure> + </section> + <section id="sect-User_Guide-Manage_Portlets_and_Gadgets-Add_a_new_Category"> + <title>Add a new Category</title> + <para> You easily add a new category by following this guide: </para> - <procedure> - <step> - <para> + <procedure> + <step> + <para> Hover over the <emphasis role="bold">Group</emphasis> menu, then <emphasis role="bold">Administration</emphasis> and click on <emphasis role="bold">Application Registry</emphasis>. </para> - </step> - <step> - <para> + </step> + <step> + <para> Click the <emphasis role="bold">Add Category</emphasis> button on the action bar: </para> - <para> + <para> The <emphasis role="bold">Category Setting</emphasis> tab: includes common information about a category. </para> - - <variablelist> - <varlistentry> - <term>Category name</term> - <listitem> - <para> + <variablelist> + <varlistentry> + <term>Category name</term> + <listitem> + <para> The name of the category. This field is required and its length must be between 3 and 30 characters. Only alpha, digit, dash and underscore characters are allowed. </para> - </listitem> - </varlistentry> - <varlistentry> - <term>Display name</term> - <listitem> - <para> + </listitem> + </varlistentry> + <varlistentry> + <term>Display name</term> + <listitem> + <para> The display name of the category and its length must be between 3 and 30 characters. </para> - </listitem> - </varlistentry> - <varlistentry> - <term>Description</term> - <listitem> - <para> + </listitem> + </varlistentry> + <varlistentry> + <term>Description</term> + <listitem> + <para> A brief description of the category. Any length from 0 to 255 characters is allowed. </para> - </listitem> - </varlistentry> - </variablelist> - <para> + </listitem> + </varlistentry> + </variablelist> + <para> The <emphasis role="bold">Permission Setting</emphasis> tab provides access to the Permission manager. </para> - <para>The permission criteria are used whenever a user creates or modifies a page. In that case the user can only see and use portlets in those categories on which he or she has access to (as defined by groups and memberships). + <para>The permission criteria are used whenever a user creates or modifies a page. In that case the user can only see and use portlets in those categories on which he or she has access to (as defined by groups and memberships). </para> - </step> + </step> <!-- <step> <para> @@ -132,251 +129,242 @@ Click the <emphasis role="bold">Save</emphasis> button to accept adding a new category into a category list. The new category will be added into a list on the left pane. </para> </step> ---> - </procedure> - </section> - - <section id="sect-User_Guide-Manage_Portlets_and_Gadgets-Edit_a_Category"> - <title>Edit a Category</title> - <procedure> - <step> - <para> +--> </procedure> + </section> + <section id="sect-User_Guide-Manage_Portlets_and_Gadgets-Edit_a_Category"> + <title>Edit a Category</title> + <procedure> + <step> + <para> Click the Edit icon located next to the title bar. </para> - </step> - <step> - <para> + </step> + <step> + <para> Update the category information. </para> - </step> - <step> - <para> + </step> + <step> + <para> Click the <emphasis role="bold">Save</emphasis> button to apply changes. </para> - </step> - </procedure> - </section> - - <section id="sect-User_Guide-Manage_Portlets_and_Gadgets-Delete_a_Category"> - <title>Delete a Category</title> - <procedure> - <step> - <para> + </step> + </procedure> + </section> + <section id="sect-User_Guide-Manage_Portlets_and_Gadgets-Delete_a_Category"> + <title>Delete a Category</title> + <procedure> + <step> + <para> Click the Trash can icon located next to the title bar. </para> - </step> - <step> - <para> + </step> + <step> + <para> Accept the deletion by clicking <emphasis role="bold">OK</emphasis> </para> - </step> - </procedure> - </section> - - <section id="sect-User_Guide-Manage_Portlets_and_Gadgets-Add_PortletsGadgets_to_the_specific_Category"> - <title>Add Applications to a Category</title> - <procedure> - <step> - <para> - Click the "Plus" icon located next to the category (in the list on the left) to which you want to add an application. + </step> + </procedure> + </section> + <section id="sect-User_Guide-Manage_Portlets_and_Gadgets-Add_PortletsGadgets_to_the_specific_Category"> + <title>Add Applications to a Category</title> + <procedure> + <step> + <para> + Click the &quot;Plus&quot; icon located next to the category (in the list on the left) to which you want to add an application. </para> - <para> - The image below shows the available application. You will see this list when you click the "Plus" icon. + <para> + The image below shows the available application. You will see this list when you click the &quot;Plus&quot; icon. </para> - <mediaobject> - <imageobject role="html"> - <imagedata fileref="images/AddPortlet2.png" format="PNG" align="center" scale="100" /> - </imageobject> - <imageobject role="fo"> - <imagedata fileref="images/AddPortlet2.png" format="PNG" align="center" scalefit="1" contentwidth="140mm" /> - </imageobject> - </mediaobject> - <variablelist> - <varlistentry> - <term>Display name</term> - <listitem> - <para> + <mediaobject> + <imageobject role="html"> + <imagedata align="center" scale="100" fileref="images/AddPortlet2.png" format="PNG"/> + </imageobject> + <imageobject role="fo"> + <imagedata contentwidth="140mm" align="center" scalefit="1" fileref="images/AddPortlet2.png" format="PNG"/> + </imageobject> + </mediaobject> + <variablelist> + <varlistentry> + <term>Display name</term> + <listitem> + <para> The display name of a portlet/gadget. </para> - </listitem> - </varlistentry> - <varlistentry> - <term>Application Type</term> - <listitem> - <para> + </listitem> + </varlistentry> + <varlistentry> + <term>Application Type</term> + <listitem> + <para> Either Portlet, Gadget or WSRP application. </para> - </listitem> - </varlistentry> - </variablelist> - </step> - <step> - <para> + </listitem> + </varlistentry> + </variablelist> + </step> + <step> + <para> Enter the display name and select a type </para> - </step> - <step> - <para> + </step> + <step> + <para> Select an application by checking the radio button. Note that there several pages of Portlet applications to choose from and that the content of the list changes when you select a different type of application from the <emphasis role="bold">Application Type</emphasis> drop-down menu. </para> - </step> - <step> - <para> + </step> + <step> + <para> Click the <emphasis role="bold">Save</emphasis> button to add the selected application to the category. </para> - </step> - </procedure> - </section> - - <section id="sect-User_Guide-Manage_Portlets_and_Gadgets-Set_Access_Permission_on_Portlets"> - <title>Set Access Permission on Portlets</title> - - <procedure> - <step> - <para> + </step> + </procedure> + </section> + <section id="sect-User_Guide-Manage_Portlets_and_Gadgets-Set_Access_Permission_on_Portlets"> + <title>Set Access Permission on Portlets</title> + <procedure> + <step> + <para> In the <emphasis role="bold">Group</emphasis> menu, select <emphasis role="bold">Administration</emphasis> and then <emphasis role="bold">Application Registry</emphasis>. </para> - </step> - <step> - <para> + </step> + <step> + <para> Select a category in the Category pane that includes the portlet you want to set permissions on. All portlets of that category will be listed underneath. </para> - </step> - <step> - <para> + </step> + <step> + <para> To set permission for a portlet: </para> - <itemizedlist> - <listitem> - <para> + <itemizedlist> + <listitem> + <para> Click the <emphasis role="bold">Add Permission</emphasis> button to add access permissions to more groups. </para> - </listitem> - <listitem> - <para> + </listitem> + <listitem> + <para> Or check <emphasis role="bold">Make it public</emphasis> to allow everyone to access. </para> - </listitem> - </itemizedlist> - <para> + </listitem> + </itemizedlist> + <para> Whenever the user creates or modifies a page, he or she can only see and use gadgets/portlets that fulfill two conditions: the portlet is in a <emphasis role="bold">category</emphasis> which the user has access permission too and the user has access permission on the <emphasis role="bold">portlet</emphasis> </para> - </step> - </procedure> - </section> - - <section id="sect-User_Guide-Manage_Portlets_and_Gadgets-View_detail_information_of_the_specific_Portlets"> - <title>View/Edit portlet/gadget information</title> - <para> + </step> + </procedure> + </section> + <section id="sect-User_Guide-Manage_Portlets_and_Gadgets-View_detail_information_of_the_specific_Portlets"> + <title>View/Edit portlet/gadget information</title> + <para> In the <emphasis role="bold">Group</emphasis> menu, select <emphasis role="bold">Administration</emphasis> then <emphasis role="bold">Application Registry</emphasis>. </para> - <variablelist> - <varlistentry> - <term><emphasis role="bold">Left pane</emphasis></term> - <listitem> - <para> + <variablelist> + <varlistentry> + <term> + <emphasis role="bold">Left pane</emphasis> + </term> + <listitem> + <para> All portlets and gadgets grouped by categories </para> - </listitem> - </varlistentry> - <varlistentry> - <term><emphasis role="bold">Right pane</emphasis></term> - <listitem> - <para> + </listitem> + </varlistentry> + <varlistentry> + <term> + <emphasis role="bold">Right pane</emphasis> + </term> + <listitem> + <para> shows detail information about a portlet: Name, Display name, Description and Portlet preferences. </para> - </listitem> - </varlistentry> - </variablelist> - <para> + </listitem> + </varlistentry> + </variablelist> + <para> To see the details of any portlet select it from the list on the left. </para> - <para> - To edit a portlet, click the edit button to the right of the portlet's name: + <para> + To edit a portlet, click the edit button to the right of the portlet&apos;s name: </para> - </section> - - <section id="sect-User_Guide-Manage_Portlets_and_Gadgets-Add_a_Gadget"> - <title>Add a Gadget</title> - <para> + </section> + <section id="sect-User_Guide-Manage_Portlets_and_Gadgets-Add_a_Gadget"> + <title>Add a Gadget</title> + <para> In the <emphasis role="bold">Group</emphasis> menu, select <emphasis role="bold">Administration</emphasis> then <emphasis role="bold">Application Registry</emphasis>. Click on the <emphasis role="bold">Gadget</emphasis> icon. </para> - <para> + <para> You may add a remote gadget using its URL or create a brand-new one: </para> - - <procedure> - <title>Add a Remote Gadget</title> - <step> - <para> + <procedure> + <title>Add a Remote Gadget</title> + <step> + <para> Click on <emphasis role="bold">Add a remote gadget</emphasis>: </para> - <mediaobject> - <imageobject role="html"> - <imagedata fileref="images/AddGadgetnew.png" format="PNG" align="center" scale="100" /> - </imageobject> - <imageobject role="fo"> - <imagedata fileref="images/AddGadgetnew.png" format="PNG" align="center" contentwidth="150mm" /> - </imageobject> - </mediaobject> - </step> - <step> - <para> + <mediaobject> + <imageobject role="html"> + <imagedata align="center" scale="100" fileref="images/AddGadgetnew.png" format="PNG"/> + </imageobject> + <imageobject role="fo"> + <imagedata contentwidth="150mm" align="center" fileref="images/AddGadgetnew.png" format="PNG"/> + </imageobject> + </mediaobject> + </step> + <step> + <para> Enter the url of the remote gadget in the <emphasis role="bold">URL</emphasis> field. </para> - </step> - <step> - <para> + </step> + <step> + <para> Click <emphasis role="bold">Add</emphasis>. The new remote gadget will be appear in gadget list on left pane. </para> - </step> - </procedure> - <procedure> - <title>Create a new Gadget</title> - <step> - <para> + </step> + </procedure> + <procedure> + <title>Create a new Gadget</title> + <step> + <para> Click on <emphasis role="bold">Create a new gadget</emphasis>: </para> - </step> - <step> - <para> + </step> + <step> + <para> Populate the <literal>Source</literal> field with the xml code of the new gadget. </para> - </step> - </procedure> - </section> - - <section id="sect-User_Guide-Manage_Portlets_and_Gadgets-Add_a_new_Gadget_to_the_Dashboard_Portlet"> - <title>Add a new Gadget to the Dashboard Portlet</title> - <para> + </step> + </procedure> + </section> + <section id="sect-User_Guide-Manage_Portlets_and_Gadgets-Add_a_new_Gadget_to_the_Dashboard_Portlet"> + <title>Add a new Gadget to the Dashboard Portlet</title> + <para> See <xref linkend="sect-User_Guide-Dashboard_Portlet-Add_Gadgets"/> for instructions on how to add new gadgets to the dashboard. </para> - </section> - - <section id="sect-User_Guide-Manage_Portlets_and_Gadgets-Manage_Gadgets"> - <title>Manage Gadgets</title> - <para> + </section> + <section id="sect-User_Guide-Manage_Portlets_and_Gadgets-Manage_Gadgets"> + <title>Manage Gadgets</title> + <para> You can edit or refresh a gadget using the icons in the top right of the <emphasis role="bold">Gadget Details</emphasis> pane. </para> - <para> + <para> You can delete a local gadget using the trashcan icon to the right of the appropriate gadget in the gadget list. </para> - - <section id="sect-User_Guide-Manage_Gadgets-Edit_a_Gadget"> - <title>Edit a Gadget</title> - <para> + <section id="sect-User_Guide-Manage_Gadgets-Edit_a_Gadget"> + <title>Edit a Gadget</title> + <para> Click the <emphasis role="bold">Edit Gadget</emphasis> icon located in the header of the <emphasis role="bold">Gadget Details</emphasis> page to display the following window: </para> - <mediaobject> - <imageobject role="html"> - <imagedata fileref="images/Source.png" format="PNG" align="center" scale="100" /> - </imageobject> - <imageobject role="fo"> - <imagedata fileref="images/Source.png" format="PNG" align="center" contentwidth="150mm" /> - </imageobject> - </mediaobject> - </section> - + <mediaobject> + <imageobject role="html"> + <imagedata align="center" scale="100" fileref="images/Source.png" format="PNG"/> + </imageobject> + <imageobject role="fo"> + <imagedata contentwidth="150mm" align="center" fileref="images/Source.png" format="PNG"/> + </imageobject> + </mediaobject> + </section> <!--Covered in section above SM <section id="sect-User_Guide-Manage_Gadgets-Refresh_a_Gadget"> <title>Refresh a Gadget</title> @@ -397,10 +385,5 @@ <imagedata fileref="images/Delete.png" format="PNG" align="center" /> </imageobject> </mediaobject> - </section> --> - - </section> - + </section> --> </section> </section> - - Modified: epp/docs/branches/6.0/User_Guide/en-US/modules/language/Change_Interface_Language.xml =================================================================== --- epp/docs/branches/6.0/User_Guide/en-US/modules/language/Change_Interface_Language.xml 2012-10-24 06:12:02 UTC (rev 8938) +++ epp/docs/branches/6.0/User_Guide/en-US/modules/language/Change_Interface_Language.xml 2012-10-25 06:01:34 UTC (rev 8939) @@ -1,103 +1,104 @@ -<?xml version='1.0' encoding='utf-8' ?> +<?xml version='1.0' encoding='UTF-8'?> <!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [ <!ENTITY % BOOK_ENTITIES SYSTEM "../../User_Guide.ent"> %BOOK_ENTITIES; ]> <section id="sect-User_Guide-Change_Interface_Language"> - <title>Change Interface Language</title> - <para> - JBoss Enterprise Portal Platform allows users to pick the language of the user interface. - </para> - <para> - The priority of the interface language setting follows this hierarchy: - </para> - <orderedlist numeration="arabic"> - <listitem> - <para> - User's language - </para> - </listitem> - <listitem> - <para> - Browser's language - </para> - </listitem> - <listitem> - <para> - Portal's language - </para> - </listitem> - </orderedlist> - <para> - Note that users should pay attention to this order in order to change the language type appropriately. - </para> - - <para> - You may switch the interface language in various places as follows: - </para> - <section id="sect-User_Guide-Change_Interface_Language_User"> - <title>Language for a user</title> - <para> - You may set the interface language for your account alone and not for the entire Portal as follows: - </para> - <procedure> - <step> - <para> - Open up the Start menu and click on <emphasis role="bold">Change Language</emphasis> : - </para> - </step> - <step> - <para> - The <emphasis role="bold">Interface Language Setting</emphasis> window lists all available languages installed in the Portal: - </para> - <mediaobject> - <imageobject role="html"> - <imagedata fileref="images/InterfaceLanguage.png" format="PNG" align="center" scale="110"/> - </imageobject> - <imageobject role="fo"> - <imagedata fileref="images/InterfaceLanguage.png" format="PNG" align="center" scalefit="1" contentwidth="150mm" /> - </imageobject> - </mediaobject> - </step> - <step> - <para> - Click on the desired language. The associated native word is highlighted. - </para> - </step> - <step> - <para> - Click <emphasis role="bold">Apply</emphasis> to save your change. The site should refresh and display its attributes in the language you've just chosen. - </para> - </step> - </procedure> - </section> - - <section id="sect-User_Guide-Change_Interface_Language-Set_language_for_a_user"> - <title>Set language for a user</title> - <para> - There are two modes to set the interface language for a specific user. - </para> - <variablelist> - <varlistentry> - <term><emphasis role="bold">Public Mode</emphasis></term> - <listitem> - <para> - When accessing the portal in <emphasis role="bold">Public Mode</emphasis>, the interface language is dictated by the language setting of your web browser. - </para> - <para> - If you have set the language of your browser to one that JBoss Enterprise Portal Platform does not support, the displaying language will be the language set at the Portal level (see above). - </para> - </listitem> - </varlistentry> - <varlistentry> - <term><emphasis role="bold">Private Mode</emphasis></term> - <listitem> - <para> - The interface language in <emphasis role="bold">Private Mode</emphasis> is set when registering each user. See step four of the process to register a new account <xref linkend="sect-User_Guide-Register_New_Accounts" />. - </para> - </listitem> - </varlistentry> - </variablelist> - </section> - + <title>Change Interface Language</title> + <para> +JBoss Portal Platform allows users to pick the language of the user interface. + </para> + <para> + The priority of the interface language setting follows this hierarchy: + </para> + <orderedlist numeration="arabic"> + <listitem> + <para> + User&apos;s language + </para> + </listitem> + <listitem> + <para> + Browser&apos;s language + </para> + </listitem> + <listitem> + <para> + Portal&apos;s language + </para> + </listitem> + </orderedlist> + <para> + Note that users should pay attention to this order in order to change the language type appropriately. + </para> + <para> + You may switch the interface language in various places as follows: + </para> + <section id="sect-User_Guide-Change_Interface_Language_User"> + <title>Language for a user</title> + <para> + You may set the interface language for your account alone and not for the entire Portal as follows: + </para> + <procedure> + <step> + <para> + Open up the Start menu and click on <emphasis role="bold">Change Language</emphasis> : + </para> + </step> + <step> + <para> + The <emphasis role="bold">Interface Language Setting</emphasis> window lists all available languages installed in the Portal: + </para> + <mediaobject> + <imageobject role="html"> + <imagedata align="center" scale="110" fileref="images/InterfaceLanguage.png" format="PNG"/> + </imageobject> + <imageobject role="fo"> + <imagedata contentwidth="150mm" align="center" scalefit="1" fileref="images/InterfaceLanguage.png" format="PNG"/> + </imageobject> + </mediaobject> + </step> + <step> + <para> + Click on the desired language. The associated native word is highlighted. + </para> + </step> + <step> + <para> + Click <emphasis role="bold">Apply</emphasis> to save your change. The site should refresh and display its attributes in the language you&apos;ve just chosen. + </para> + </step> + </procedure> + </section> + <section id="sect-User_Guide-Change_Interface_Language-Set_language_for_a_user"> + <title>Set language for a user</title> + <para> + There are two modes to set the interface language for a specific user. + </para> + <variablelist> + <varlistentry> + <term> + <emphasis role="bold">Public Mode</emphasis> + </term> + <listitem> + <para> + When accessing the portal in <emphasis role="bold">Public Mode</emphasis>, the interface language is dictated by the language setting of your web browser. + </para> + <para> + If you have set the language of your browser to one that JBoss Portal Platform does not support, the displaying language will be the language set at the Portal level (see above). + </para> + </listitem> + </varlistentry> + <varlistentry> + <term> + <emphasis role="bold">Private Mode</emphasis> + </term> + <listitem> + <para> + The interface language in <emphasis role="bold">Private Mode</emphasis> is set when registering each user. See step four of the process to register a new account <xref linkend="sect-User_Guide-Register_New_Accounts"/>. + </para> + </listitem> + </varlistentry> + </variablelist> + </section> </section> Modified: epp/docs/branches/6.0/User_Guide/en-US/modules/language/Multi-Language_Navigation_Nodes.xml =================================================================== --- epp/docs/branches/6.0/User_Guide/en-US/modules/language/Multi-Language_Navigation_Nodes.xml 2012-10-24 06:12:02 UTC (rev 8938) +++ epp/docs/branches/6.0/User_Guide/en-US/modules/language/Multi-Language_Navigation_Nodes.xml 2012-10-25 06:01:34 UTC (rev 8939) @@ -1,102 +1,94 @@ -<?xml version='1.0' encoding='utf-8' ?> +<?xml version='1.0' encoding='UTF-8'?> <!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [ <!ENTITY % BOOK_ENTITIES SYSTEM "../../User_Guide.ent"> %BOOK_ENTITIES; ]> <section id="sect-User_Guide-Multi_Language_Navigation_Nodes"> - <title>Multi-Language Navigation Nodes</title> - <para> - JBoss Enterprise Portal Platform supports a multi-language environment for your portal allowing you to internationalize any menu entry on the navigation. + <title>Multi-Language Navigation Nodes</title> + <para> +JBoss Portal Platform supports a multi-language environment for your portal allowing you to internationalize any menu entry on the navigation. </para> - <para> - As the navigation bar is composed of nodes, you have to modify the display names of the nodes to enable this. Instead of entering the display name of the node in a defined language (English, for example) you have to use a language-neutral 'resource key'. + <para> + As the navigation bar is composed of nodes, you have to modify the display names of the nodes to enable this. Instead of entering the display name of the node in a defined language (English, for example) you have to use a language-neutral &apos;resource key&apos;. </para> - <para> + <para> This resource key is then used to define the label that is shown for that node on the navigation bar, the menu and the breadcrumb. </para> - <note> - <title>Extended Label Mode</title> - <para> - In JBoss Enterprise Portal Platform &VZ; a new localization functionality called Extended Label Mode has been implemented. This function allows Site Administrators to add labels to nodes and pages in multiple supported languages. When the language of the site is changed, the nodes will display the appropriate localized label. + <note> + <title>Extended Label Mode</title> + <para> + In JBoss Portal Platform &VZ; a new localization functionality called Extended Label Mode has been implemented. This function allows Site Administrators to add labels to nodes and pages in multiple supported languages. When the language of the site is changed, the nodes will display the appropriate localized label. </para> - </note> - - <section id="sect-User_Guide-Multi_Language_Navigation_Nodes-Key_Format"> - <title>Key Format</title> - <para> + </note> + <section id="sect-User_Guide-Multi_Language_Navigation_Nodes-Key_Format"> + <title>Key Format</title> + <para> The resource key format is: <emphasis role="bold">#{key}</emphasis> </para> - <para> + <para> The resource key can contain any text that you consider appropriate to satisfy your business needs. It should, however, be human-readable and must not contain spaces. </para> - </section> - - <section id="sect-User_Guide-Multi_Language_Navigation_Nodes-Creating_Keys"> - <title>Creating Keys</title> - <para> + </section> + <section id="sect-User_Guide-Multi_Language_Navigation_Nodes-Creating_Keys"> + <title>Creating Keys</title> + <para> There are two <!--three--> ways to create a key for a node: </para> - <orderedlist numeration="arabic"> - <listitem> - <para> + <orderedlist numeration="arabic"> + <listitem> + <para> <xref linkend="sect-User_Guide-Multi_Language_Navigation_Nodes-Creating_Keys_using_the_Create_Page_Wizard"/> - </para> - </listitem> + </para> + </listitem> <!-- <listitem> <para> <xref linkend="sect-User_Guide-Multi_Language_Navigation_Nodes-CreatingEditing_Keys_by_Edit_Page_Wizard"/> </para> - </listitem> --> - <listitem> - <para> + </listitem> --> <listitem> + <para> <xref linkend="sect-User_Guide-Multi_Language_Navigation_Nodes-CreatingEditing_Keys_using_the_Edit_Page_and_Navigation"/> </para> - </listitem> - </orderedlist> - - </section> - - <section id="sect-User_Guide-Multi_Language_Navigation_Nodes-Creating_Keys_using_the_Create_Page_Wizard"> - <title>Creating Keys using <emphasis role="bold">Create Page Wizard</emphasis></title> - - <procedure> - <step> - <para> + </listitem> + </orderedlist> + </section> + <section id="sect-User_Guide-Multi_Language_Navigation_Nodes-Creating_Keys_using_the_Create_Page_Wizard"> + <title>Creating Keys using <emphasis role="bold">Create Page Wizard</emphasis></title> + <procedure> + <step> + <para> Open the <emphasis role="bold">Site Editor</emphasis> menu and pick <emphasis role="bold">Add New Page</emphasis>. </para> - </step> - <step> - <para> + </step> + <step> + <para> Enter a name for this new page </para> - </step> - <step> - <para> + </step> + <step> + <para> Enter a resource key in the <emphasis role="bold">Display Name</emphasis> field. </para> - <mediaobject> - <imageobject role="html"> - <imagedata fileref="images/PageWizard.png" format="PNG" align="center" scale="110" /> - </imageobject> - <imageobject role="fo"> - <imagedata fileref="images/PageWizard.png" format="PNG" align="center" scalefit="1" contentwidth="160mm" /> - </imageobject> - </mediaobject> - </step> - <step> - <para> + <mediaobject> + <imageobject role="html"> + <imagedata align="center" scale="110" fileref="images/PageWizard.png" format="PNG"/> + </imageobject> + <imageobject role="fo"> + <imagedata contentwidth="160mm" align="center" scalefit="1" fileref="images/PageWizard.png" format="PNG"/> + </imageobject> + </mediaobject> + </step> + <step> + <para> Click <emphasis role="bold">Next</emphasis>. On the next screen you may define a page layout out of existing templates. </para> - </step> - <step> - <para> + </step> + <step> + <para> Click <emphasis role="bold">Next</emphasis> to finalize the page creation with portlets for instance. </para> - </step> - </procedure> - - </section> - + </step> + </procedure> + </section> <!-- <section id="sect-User_Guide-Multi_Language_Navigation_Nodes-CreatingEditing_Keys_by_Edit_Page_Wizard"> <title>Creating/Editing Keys using <emphasis role="bold">Edit Page Wizard</emphasis></title> @@ -126,47 +118,43 @@ </para> </step> </procedure> - </section> --> - - <section id="sect-User_Guide-Multi_Language_Navigation_Nodes-CreatingEditing_Keys_using_the_Edit_Page_and_Navigation"> - <title>Creating/Editing Keys using <emphasis role="bold">Navigation Management</emphasis></title> - <procedure> - <step> - <para> + </section> --> <section id="sect-User_Guide-Multi_Language_Navigation_Nodes-CreatingEditing_Keys_using_the_Edit_Page_and_Navigation"> + <title>Creating/Editing Keys using <emphasis role="bold">Navigation Management</emphasis></title> + <procedure> + <step> + <para> Click on <emphasis role="bold">Site</emphasis> in the Toolbar then <emphasis role="bold">Edit Navigation</emphasis> </para> - </step> - <step> - <para> + </step> + <step> + <para> Click on <emphasis role="bold">Add Node</emphasis> </para> - </step> - <step> - <para> + </step> + <step> + <para> The Create/Edit node dialog appears. Enter a resource key in the <emphasis role="bold">Label</emphasis> field </para> - </step> - </procedure> - <note> - <title>Reusing Keys</title> - <para> + </step> + </procedure> + <note> + <title>Reusing Keys</title> + <para> You can reuse the same resource key in several nodes. </para> - </note> - </section> - - <section> - <title>Providing translation</title> - <para> + </note> + </section> + <section> + <title>Providing translation</title> + <para> To provide a translation for the resource key used as page name, resource bundles must be provided within the web archive. </para> - <para> + <para> Property files (or XML resource bundles) must be located in: <filename>/jboss-as/server/<replaceable>&lt;PROFILE&gt;</replaceable>/deploy/gatein.ear/02portal.war/WEB-INF/classes/locale/navigation/portal/<replaceable>&lt;PORTAL_NAME&gt;</replaceable>_<replaceable>&lt;LANGUAGE_CODE&gt;</replaceable>.properties</filename> </para> - </section> - - <!-- + </section> +<!-- <section id="sect-User_Guide-Multi_Language_Navigation_Nodes-Internationalize_Resource_Keys"> <title>Internationalize Resource Keys</title> <para> @@ -339,7 +327,4 @@ </imageobject> </mediaobject> </step> - </procedure> --> -</section> - - + </procedure> --></section> Modified: epp/docs/branches/6.0/User_Guide/en-US/modules/language/Right_To_Left_Support_(RTL).xml =================================================================== --- epp/docs/branches/6.0/User_Guide/en-US/modules/language/Right_To_Left_Support_(RTL).xml 2012-10-24 06:12:02 UTC (rev 8938) +++ epp/docs/branches/6.0/User_Guide/en-US/modules/language/Right_To_Left_Support_(RTL).xml 2012-10-25 06:01:34 UTC (rev 8939) @@ -1,74 +1,70 @@ -<?xml version='1.0' encoding='utf-8' ?> +<?xml version='1.0' encoding='UTF-8'?> <!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [ <!ENTITY % BOOK_ENTITIES SYSTEM "../../User_Guide.ent"> %BOOK_ENTITIES; ]> <section id="sect-User_Guide-RTL_Support_Right_To_Left"> - <title>Right To Left Support</title> - <para> - JBoss Enterprise Portal Platform supports Right to Left (RTL) languages. - </para> - <mediaobject> - <imageobject role="html"> - <imagedata fileref="images/HomePage2.png" format="PNG" align="center" scale="130" /> - </imageobject> - <imageobject role="fo"> - <imagedata fileref="images/HomePage2.png" format="PNG" align="center" scalefit="1" contentwidth="150mm" /> - </imageobject> - </mediaobject> + <title>Right To Left Support</title> + <para> +JBoss Portal Platform supports Right to Left (RTL) languages. + </para> + <mediaobject> + <imageobject role="html"> + <imagedata align="center" scale="130" fileref="images/HomePage2.png" format="PNG"/> + </imageobject> + <imageobject role="fo"> + <imagedata contentwidth="150mm" align="center" scalefit="1" fileref="images/HomePage2.png" format="PNG"/> + </imageobject> + </mediaobject> <!-- DOCS NOTE: BZ#856442: Commented out the following images and formalparas as they add nothing to the manual. - <formalpara> - <title>The Account Portlet</title> - <para> - <mediaobject> - <imageobject role="html"> - <imagedata fileref="images/NewAccount3.png" format="PNG" align="center" scale="100" /> - </imageobject> - <imageobject role="fo"> - <imagedata fileref="images/NewAccount3.png" format="PNG" align="center" scalefit="1" contentwidth="150mm" /> - </imageobject> - </mediaobject> - </para> - </formalpara> - - <formalpara> - <title>The Application Registry Portlet</title> - <para> - <mediaobject> - <imageobject role="html"> - <imagedata fileref="images/ApplicationRegistry2.png" format="PNG" align="center" scale="100"/> - </imageobject> - <imageobject role="fo"> - <imagedata fileref="images/ApplicationRegistry2.png" format="PNG" align="center" scalefit="1" contentwidth="150mm" /> - </imageobject> - </mediaobject> - </para> - </formalpara> - + <formalpara> + <title>The Account Portlet</title> + <para> + <mediaobject> + <imageobject role="html"> + <imagedata fileref="images/NewAccount3.png" format="PNG" align="center" scale="100" /> + </imageobject> + <imageobject role="fo"> + <imagedata fileref="images/NewAccount3.png" format="PNG" align="center" scalefit="1" contentwidth="150mm" /> + </imageobject> + </mediaobject> + </para> + </formalpara> + + <formalpara> + <title>The Application Registry Portlet</title> + <para> + <mediaobject> + <imageobject role="html"> + <imagedata fileref="images/ApplicationRegistry2.png" format="PNG" align="center" scale="100"/> + </imageobject> + <imageobject role="fo"> + <imagedata fileref="images/ApplicationRegistry2.png" format="PNG" align="center" scalefit="1" contentwidth="150mm" /> + </imageobject> + </mediaobject> + </para> + </formalpara> + - <formalpara> - <title>The Organization Portlet:</title> - <para> - <mediaobject> - <imageobject role="html"> - <imagedata fileref="images/Organization5.png" format="PNG" align="center" scale="120" /> - </imageobject> - <imageobject role="fo"> - <imagedata fileref="images/Organization5.png" format="PNG" align="center" scalefit="1" contentwidth="150mm" /> - </imageobject> - </mediaobject> - </para> - </formalpara> - - Deprecated <section id="sect-User_Guide-RTL_Support_Right_To_Left-The_User_Workspace"> - <title>The User Workspace</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/UserWorkspace2.png" format="PNG" align="center" width="444" /> - </imageobject> - </mediaobject> - </section> --> - -</section> - - + <formalpara> + <title>The Organization Portlet:</title> + <para> + <mediaobject> + <imageobject role="html"> + <imagedata fileref="images/Organization5.png" format="PNG" align="center" scale="120" /> + </imageobject> + <imageobject role="fo"> + <imagedata fileref="images/Organization5.png" format="PNG" align="center" scalefit="1" contentwidth="150mm" /> + </imageobject> + </mediaobject> + </para> + </formalpara> + + Deprecated <section id="sect-User_Guide-RTL_Support_Right_To_Left-The_User_Workspace"> + <title>The User Workspace</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/UserWorkspace2.png" format="PNG" align="center" width="444" /> + </imageobject> + </mediaobject> + </section> --></section> Modified: epp/docs/branches/6.0/User_Guide/en-US/modules/portal/EPP_Roles.xml =================================================================== --- epp/docs/branches/6.0/User_Guide/en-US/modules/portal/EPP_Roles.xml 2012-10-24 06:12:02 UTC (rev 8938) +++ epp/docs/branches/6.0/User_Guide/en-US/modules/portal/EPP_Roles.xml 2012-10-25 06:01:34 UTC (rev 8939) @@ -1,13 +1,12 @@ -<?xml version='1.0' encoding='utf-8' ?> +<?xml version='1.0' encoding='UTF-8'?> <!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [ <!ENTITY % BOOK_ENTITIES SYSTEM "../../User_Guide.ent"> %BOOK_ENTITIES; ]> - <section> - <title>Roles</title> - - <para> - Effective user management in JBoss Enterprise Portal Platform relies on an understanding of the rights and responsibilities of the various user roles available. +<section> + <title>Roles</title> + <para> + Effective user management in JBoss Portal Platform relies on an understanding of the rights and responsibilities of the various user roles available. </para> <!-- DOCS NOTE: Removed as SP is not shipped in 6.0. Retaining in case this changes. @@ -17,222 +16,160 @@ </para> </note> - --> - <itemizedlist> - <title>Core Portal Memberships</title> - - <listitem> - <para> + --> <itemizedlist> + <title>Core Portal Memberships</title> + <listitem> + <para> Member </para> - </listitem> - - <listitem> - <para> + </listitem> + <listitem> + <para> Manager </para> - </listitem> - - <listitem> - <para> + </listitem> + <listitem> + <para> Validator </para> - </listitem> - </itemizedlist> - - <table> - <title>Role Attributes of Example Users</title> - - <tgroup cols="2"> - <thead> - <row> - <entry> - User - </entry> - - <entry> - Roles - </entry> - </row> - </thead> - - <tbody> - <row> - <entry> - root - </entry> - - <entry> - manager:/platform/administrators,member:/platform/users,member:/organization/management/executive-board - </entry> - </row> - - <row> - <entry> - john - </entry> - - <entry> - member:/platform/administrators,member:/platform/users,manager:/organization/management/executive-board - </entry> - </row> - - <row> - <entry> - mary - </entry> - - <entry> - member:/platform/users - </entry> - </row> - - <row> - <entry> - demo - </entry> - - <entry> - member:/platform/guests,member:/platform/users - </entry> - </row> - </tbody> - </tgroup> - </table> - - <variablelist> - <title>Roles</title> - - <varlistentry> - <term>manager:/platform/administrators</term> - - <listitem> - <para> + </listitem> + </itemizedlist> + <table> + <title>Role Attributes of Example Users</title> + <tgroup cols="2"> + <thead> + <row> + <entry> User </entry> + <entry> Roles </entry> + </row> + </thead> + <tbody> + <row> + <entry> root </entry> + <entry> manager:/platform/administrators,member:/platform/users,member:/organization/management/executive-board </entry> + </row> + <row> + <entry> john </entry> + <entry> member:/platform/administrators,member:/platform/users,manager:/organization/management/executive-board </entry> + </row> + <row> + <entry> mary </entry> + <entry> member:/platform/users </entry> + </row> + <row> + <entry> demo </entry> + <entry> member:/platform/guests,member:/platform/users </entry> + </row> + </tbody> + </tgroup> + </table> + <variablelist> + <title>Roles</title> + <varlistentry> + <term>manager:/platform/administrators</term> + <listitem> + <para> This role is for users to have access and edit administrators pages. Examples are the New Account, Community Management, Registry, Page Management, New Staff, Organization Management and WSRP Admin pages. </para> - </listitem> - </varlistentry> - - <varlistentry> - <term>member:/platform/administrators</term> - - <listitem> - <para> + </listitem> + </varlistentry> + <varlistentry> + <term>member:/platform/administrators</term> + <listitem> + <para> This role is similar to the manager role above. The main difference is that it does not have access to the administrators pages, but can access and edit everything that falls under the <literal>*:/platform/administrators</literal> pages. </para> - </listitem> - </varlistentry> - - <varlistentry> - <term>*:/platform/administrators</term> - - <listitem> - <para> + </listitem> + </varlistentry> + <varlistentry> + <term>*:/platform/administrators</term> + <listitem> + <para> This role has edit permissions for everything. This includes; the Home Page, Group Navigation, Portal Navigation, Register and Site Map (in the <emphasis>classic</emphasis> portal). This membership also has permission to create and manage portals and has full permission with group navigation. </para> - </listitem> - </varlistentry> - - <varlistentry> - <term>member:/platform/users</term> - - <listitem> - <para> + </listitem> + </varlistentry> + <varlistentry> + <term>member:/platform/users</term> + <listitem> + <para> This role allows standard users to log in. </para> - </listitem> - </varlistentry> - - <varlistentry> - <term>*:/platform/users</term> - - <listitem> - <para> + </listitem> + </varlistentry> + <varlistentry> + <term>*:/platform/users</term> + <listitem> + <para> This role has access to portal toolbars, dashboard, default gadgets (todo, rss, calculator and calendar) and basic portlets (sitemap and iframe). In general it can access but cannot edit these areas. </para> - </listitem> - </varlistentry> - - <varlistentry> - <term>member:/organization/management/executive-board</term> - - <listitem> - <para> - This role can edit New Staff and Organization Management pages. <remark>DOCS NOTE: I didn't see it in our EPP</remark> + </listitem> + </varlistentry> + <varlistentry> + <term>member:/organization/management/executive-board</term> + <listitem> + <para> + This role can edit New Staff and Organization Management pages. <remark>DOCS NOTE: I didn&apos;t see it in our EPP</remark> </para> - </listitem> - </varlistentry> - - <varlistentry> - <term>member:/platform/guests</term> - - <listitem> - <para> + </listitem> + </varlistentry> + <varlistentry> + <term>member:/platform/guests</term> + <listitem> + <para> Members of this role can access the Register and Site Map pages. </para> - </listitem> - </varlistentry> - - <varlistentry> - <term>*:/platform/web-contributors</term> - - <listitem> - <para> + </listitem> + </varlistentry> + <varlistentry> + <term>*:/platform/web-contributors</term> + <listitem> + <para> This role can edit the Contact Us page, has taxonomies permission to read, add nodes, set and remove properties in <emphasis>acme</emphasis>, <emphasis>classic</emphasis> and <emphasis>events</emphasis> and is the newsletter marketing moderator, general moderator and subscription redactor. They have access to the <literal>ManageDrivePlugin</literal> for Collaboration and Events. This role also has access to toolbars. </para> - </listitem> - </varlistentry> - - <varlistentry> - <term>*:/platform/administrators</term> - - <listitem> - <para> + </listitem> + </varlistentry> + <varlistentry> + <term>*:/platform/administrators</term> + <listitem> + <para> This role grants access to the edit mode drop-down in toolbar visible (<literal>WCMAdminToolbarPortlet</literal>) </para> - </listitem> - </varlistentry> - - <varlistentry> - <term>validator:*</term> - - <listitem> - <para> + </listitem> + </varlistentry> + <varlistentry> + <term>validator:*</term> + <listitem> + <para> This role is not used. It can be removed if it is present in your instance. </para> - </listitem> - </varlistentry> - </variablelist> - - <itemizedlist> - <title>Mandatory groups (groups that can not be deleted)</title> - - <listitem> - <para> + </listitem> + </varlistentry> + </variablelist> + <itemizedlist> + <title>Mandatory groups (groups that can not be deleted)</title> + <listitem> + <para> /platform/administrators </para> - </listitem> - - <listitem> - <para> + </listitem> + <listitem> + <para> /platform/users </para> - </listitem> - - <listitem> - <para> + </listitem> + <listitem> + <para> /platform/guests </para> - </listitem> - </itemizedlist> - - <itemizedlist> - <title>Mandatory membership types (Membership type that can not be deleted)</title> - - <listitem> - <para> + </listitem> + </itemizedlist> + <itemizedlist> + <title>Mandatory membership types (Membership type that can not be deleted)</title> + <listitem> + <para> member </para> - </listitem> - </itemizedlist> - </section> + </listitem> + </itemizedlist> +</section> Modified: epp/docs/branches/6.0/User_Guide/en-US/modules/portal/Manage_Pages.xml =================================================================== --- epp/docs/branches/6.0/User_Guide/en-US/modules/portal/Manage_Pages.xml 2012-10-24 06:12:02 UTC (rev 8938) +++ epp/docs/branches/6.0/User_Guide/en-US/modules/portal/Manage_Pages.xml 2012-10-25 06:01:34 UTC (rev 8939) @@ -22,7 +22,7 @@ <para> The wizard window is divided into two sections: the left pane contains the existing page/node hierarchy and the right pane displays the <emphasis role="bold">Page Editor</emphasis>. </para> - <mediaobject> + <mediaobject> <imageobject role="html"> <imagedata align="center" scale="100" fileref="images/Wizard1.png" format="PNG"/> </imageobject> @@ -33,12 +33,11 @@ <para> In the left pane, you can navigate up and down the node/page structure. </para> - <para> + <para> In the right pane are the required parameters for a new page. </para> </step> <step> - <variablelist> <varlistentry> <term> @@ -153,12 +152,11 @@ You can set date and time by clicking the <emphasis role="bold">Start Publication Date</emphasis> field and <emphasis role="bold">End Publication Date</emphasis> field and select a date in the calendar pop up. </para> </note> - </step> + </step> <step> <para> Click <emphasis role="bold">Next</emphasis> or number &apos;2&apos; of the wizard steps to go to step 2. </para> - </step> <step> <para> @@ -169,7 +167,6 @@ <para> Click the <emphasis role="bold">Next</emphasis> button or number &apos;3&apos; of the wizard step to go to step 3. You can drag portlets from the pop-up panel into the main pane to create the content of this page. </para> - <variablelist> <varlistentry> <term>Applications</term> @@ -486,7 +483,7 @@ <section id="sect-User_Guide-Drag_and_Drop_the_Page_Body"> <title>Drag and Drop the Page Body</title> <para> - To assist administrators to modify or personalize their portal JBoss Enterprise Portal Platform allows you to easily drag and drop page content within the page. + To assist administrators to modify or personalize their portal JBoss Portal Platform allows you to easily drag and drop page content within the page. </para> <procedure> <step> @@ -498,7 +495,6 @@ <para> Click on the <emphasis role="bold">Portal Page</emphasis>, drag and drop within the portal page. </para> - </step> </procedure> </section> Modified: epp/docs/branches/6.0/User_Guide/en-US/modules/portal/Manage_Portals.xml =================================================================== --- epp/docs/branches/6.0/User_Guide/en-US/modules/portal/Manage_Portals.xml 2012-10-24 06:12:02 UTC (rev 8938) +++ epp/docs/branches/6.0/User_Guide/en-US/modules/portal/Manage_Portals.xml 2012-10-25 06:01:34 UTC (rev 8939) @@ -25,7 +25,6 @@ <para> The first tab in the window is the <emphasis role="bold">Portal Templates</emphasis> tab. This tab lets you choose a template for the new portal from templates that are saved in the installation. </para> - <para> Click this tab if you have custom templates stored, or if you wish to use a default template for your portal. </para> @@ -132,7 +131,7 @@ <section id="sect-User_Guide-Manage_Portals-Access_a_Portal"> <title>Access a Portal</title> <para> - An administrator can easily access numerous portals running in the JBoss Enterprise Portal Platform instance. + An administrator can easily access numerous portals running in the JBoss Portal Platform instance. </para> <para> To access a portal, click <emphasis role="bold">Site</emphasis> on the Toolbar. You will be taken to the Site Management page, which shows a list of portals and possible actions: @@ -183,7 +182,7 @@ <note> <title>Custom Portlets</title> <para> - If you want to include a custom portlet or gadget on a page, you may wish to refer to the <emphasis>JBoss Portlet Tools User Guide</emphasis> in the JBoss Developer Studio documentation (<ulink url="http://docs.redhat.com/docs/en-US/JBoss_Developer_Studio/" type="http"/>) and/or the <emphasis role="bold">Portlet development</emphasis> section of the <emphasis>JBoss Enterprise Portal Platform Reference Guide</emphasis> (<ulink url="http://docs.redhat.com/docs/en-US/JBoss_Enterprise_Portal_Platf... type="http"/>) for more information about creating and deploying portlets. + If you want to include a custom portlet or gadget on a page, you may wish to refer to the <emphasis>JBoss Portlet Tools User Guide</emphasis> in the JBoss Developer Studio documentation (<ulink url="http://docs.redhat.com/docs/en-US/JBoss_Developer_Studio/" type="http"/>) and/or the <emphasis role="bold">Portlet development</emphasis> section of the <emphasis>JBoss Portal Platform Reference Guide</emphasis> (<ulink url="http://docs.redhat.com/docs/en-US/JBoss_Enterprise_Portal_Platf... type="http"/>) for more information about creating and deploying portlets. </para> </note> </section> @@ -195,7 +194,6 @@ <para> The <emphasis>Navigation Management</emphasis> window appears: </para> - <para> More information about actions possible in this window can be found in <xref linkend="sect-User_Guide-Manage_Navigation_Nodes"/> </para> @@ -368,7 +366,7 @@ <title>Prerequisites</title> <itemizedlist> <listitem> - <para>JBoss Enterprise Portal Platform is running. </para> + <para>JBoss Portal Platform is running. </para> </listitem> <listitem> <para>You are authenticated with administrator privileges.</para> @@ -413,7 +411,7 @@ <title>Prerequisites</title> <itemizedlist> <listitem> - <para>JBoss Enterprise Portal Platform is running. </para> + <para>JBoss Portal Platform is running. </para> </listitem> <listitem> <para>You are authenticated with administrator privileges.</para> @@ -476,7 +474,6 @@ <para> The confirmation message will appear: </para> - </step> <step> <para> @@ -542,7 +539,6 @@ <para> Select a new skin from the Skin list. By clicking on the skin name a picture will appear in the preview pane. </para> - </step> <step> <para> Modified: epp/docs/branches/6.0/User_Guide/en-US/modules/portletsUser/Dashboard_Portlet.xml =================================================================== --- epp/docs/branches/6.0/User_Guide/en-US/modules/portletsUser/Dashboard_Portlet.xml 2012-10-24 06:12:02 UTC (rev 8938) +++ epp/docs/branches/6.0/User_Guide/en-US/modules/portletsUser/Dashboard_Portlet.xml 2012-10-25 06:01:34 UTC (rev 8939) @@ -1,29 +1,28 @@ -<?xml version='1.0' encoding='utf-8' ?> +<?xml version='1.0' encoding='UTF-8'?> <!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [ <!ENTITY % BOOK_ENTITIES SYSTEM "../../User_Guide.ent"> %BOOK_ENTITIES; ]> <section id="sect-User_Guide-Dashboard_Portlet"> - <title>The Dashboard</title> - <para> + <title>The Dashboard</title> + <para> The Dashboard is used for hosting mini-applications known as gadgets. The Dashboard uses a variety of graphical effects for displaying, opening and using gadgets. </para> - <para> - The active Dashboard can be individually named by double clicking on the default name ("<emphasis>Click and Type Page Name</emphasis>") and entering a new name: + <para> + The active Dashboard can be individually named by double clicking on the default name (&quot;<emphasis>Click and Type Page Name</emphasis>&quot;) and entering a new name: </para> - <mediaobject> - <imageobject role="html"> - <imagedata fileref="images/Dashname.png" format="PNG" align="center" scale="100"/> - </imageobject> - <imageobject role="fo"> - <imagedata fileref="images/Dashname.png" format="PNG" align="center" scalefit="1" contentwidth="120mm"/> - </imageobject> - </mediaobject> - - <para> + <mediaobject> + <imageobject role="html"> + <imagedata align="center" scale="100" fileref="images/Dashname.png" format="PNG"/> + </imageobject> + <imageobject role="fo"> + <imagedata contentwidth="120mm" align="center" scalefit="1" fileref="images/Dashname.png" format="PNG"/> + </imageobject> + </mediaobject> + <para> The Dashboard can also be tabbed to create multiple spaces. Open a new tab by clicking the <emphasis role="bold">+</emphasis> button beside the Dashboard name. </para> - <!-- DOCS NOTE: BZ#856442: This image may not be needed +<!-- DOCS NOTE: BZ#856442: This image may not be needed <mediaobject> <imageobject role="html"> <imagedata fileref="images/tabbed_dash.png" format="PNG" align="center" scale="100" /> @@ -32,27 +31,25 @@ <imagedata fileref="images/tabbed_dash.png" format="PNG" align="center" contentwidth="110mm" /> </imageobject> </mediaobject> - --> - <para> + --> <para> New tabs can also be individually named and managed. </para> - <para> + <para> Gadgets within the Dashboard can be moved and rearranged. New gadgets can be created and unnecessary ones deleted. More than one instance of the same gadget can be opened at the same time and each instance of the same gadget can have different settings. The gadgets instances are completely independent. </para> - - <section id="sect-User_Guide-Dashboard_Portlet-Using_the_Dashboard_Workspace"> - <title>Using the Dashboard Workspace</title> - <procedure> - <step> - <para> + <section id="sect-User_Guide-Dashboard_Portlet-Using_the_Dashboard_Workspace"> + <title>Using the Dashboard Workspace</title> + <procedure> + <step> + <para> Click on <emphasis role="bold">Dashboard</emphasis> in the toolbar to access the Dashboard. </para> - </step> - <step> - <para> + </step> + <step> + <para> Click on <emphasis role="bold">Add Gadgets</emphasis> to open the Dashboard Workspace. </para> - <!-- DOCS NOTE: BZ#856442: This image may not be needed. +<!-- DOCS NOTE: BZ#856442: This image may not be needed. <mediaobject> <imageobject role="html"> <imagedata fileref="images/Dashboard1.png" format="PNG" align="center" scale="100" /> @@ -61,133 +58,138 @@ <imagedata fileref="images/Dashboard1.png" format="PNG" align="center" scalefit="1" contentwidth="100mm" /> </imageobject> </mediaobject> - --> - </step> - </procedure> - <para> - The Dashboard Workspace lists all available gadgets. Seven gadgets are provided by default with JBoss Enterprise Portal Platform, however you can add many more. + --> </step> + </procedure> + <para> + The Dashboard Workspace lists all available gadgets. Seven gadgets are provided by default with JBoss Portal Platform, however you can add many more. </para> - <mediaobject> - <imageobject role="html"> - <imagedata fileref="images/Dash_Workspace.png" format="PNG" align="center" scale="100" /> - </imageobject> - <imageobject role="fo"> - <imagedata fileref="images/Dash_Workspace.png" format="PNG" align="center" contentwidth="70mm" /> - </imageobject> - </mediaobject> - <variablelist id="vari-User_Guide-Using_the_Dashboard_Workspace-Default_Gadgets"> - <title>Default Gadgets:</title> - <varlistentry> - <term><emphasis role="bold">Calendar</emphasis></term> - <listitem> - <para> + <mediaobject> + <imageobject role="html"> + <imagedata align="center" scale="100" fileref="images/Dash_Workspace.png" format="PNG"/> + </imageobject> + <imageobject role="fo"> + <imagedata contentwidth="70mm" align="center" fileref="images/Dash_Workspace.png" format="PNG"/> + </imageobject> + </mediaobject> + <variablelist id="vari-User_Guide-Using_the_Dashboard_Workspace-Default_Gadgets"> + <title>Default Gadgets:</title> + <varlistentry> + <term> + <emphasis role="bold">Calendar</emphasis> + </term> + <listitem> + <para> The calendar gadget helps track and plan your events and activities. </para> - <mediaobject> - <imageobject role="html"> - <imagedata fileref="images/Calendar.png" format="PNG" align="center" scale="100"/> - </imageobject> - <imageobject role="fo"> - <imagedata fileref="images/Calendar.png" format="PNG" align="center" scalefit="1" contentwidth="70mm"/> - </imageobject> - </mediaobject> - </listitem> - </varlistentry> - <varlistentry> - <term><emphasis role="bold">Todo</emphasis></term> - <listitem> - <para> + <mediaobject> + <imageobject role="html"> + <imagedata align="center" scale="100" fileref="images/Calendar.png" format="PNG"/> + </imageobject> + <imageobject role="fo"> + <imagedata contentwidth="70mm" align="center" scalefit="1" fileref="images/Calendar.png" format="PNG"/> + </imageobject> + </mediaobject> + </listitem> + </varlistentry> + <varlistentry> + <term> + <emphasis role="bold">Todo</emphasis> + </term> + <listitem> + <para> This application helps you organize your day and work group. It is designed to keep track of your tasks in a convenient and transparent way. </para> - <mediaobject> - <imageobject role="html"> - <imagedata fileref="images/Todo.png" format="PNG" align="center" scale="100"/> - </imageobject> - <imageobject role="fo"> - <imagedata fileref="images/Todo.png" format="PNG" align="center" scalefit="1" contentwidth="70mm"/> - </imageobject> - </mediaobject> - </listitem> - </varlistentry> - <varlistentry> - <term><emphasis role="bold">Calculator</emphasis></term> - <listitem> - <para> + <mediaobject> + <imageobject role="html"> + <imagedata align="center" scale="100" fileref="images/Todo.png" format="PNG"/> + </imageobject> + <imageobject role="fo"> + <imagedata contentwidth="70mm" align="center" scalefit="1" fileref="images/Todo.png" format="PNG"/> + </imageobject> + </mediaobject> + </listitem> + </varlistentry> + <varlistentry> + <term> + <emphasis role="bold">Calculator</emphasis> + </term> + <listitem> + <para> This mini-application lets you perform most basic arithmetic operations and can be themed to match the rest of your portal. </para> - <mediaobject> - <imageobject role="html"> - <imagedata fileref="images/Calculator.png" format="PNG" align="center" scale="100"/> - </imageobject> - <imageobject role="fo"> - <imagedata fileref="images/Calculator.png" format="PNG" align="center" scalefit="1" contentwidth="70mm"/> - </imageobject> - </mediaobject> - </listitem> - </varlistentry> - <varlistentry> - <term><emphasis role="bold">RSS Reader</emphasis></term> - <listitem> - <para> - An RSS reader, or aggregator, collates content from various, user-specified feed sources and displays them in one location. This content can include, but isn't limited to, news headlines, blog posts or email. The RSS Reader gadget displays this content in a single window on your Portal page. + <mediaobject> + <imageobject role="html"> + <imagedata align="center" scale="100" fileref="images/Calculator.png" format="PNG"/> + </imageobject> + <imageobject role="fo"> + <imagedata contentwidth="70mm" align="center" scalefit="1" fileref="images/Calculator.png" format="PNG"/> + </imageobject> + </mediaobject> + </listitem> + </varlistentry> + <varlistentry> + <term> + <emphasis role="bold">RSS Reader</emphasis> + </term> + <listitem> + <para> + An RSS reader, or aggregator, collates content from various, user-specified feed sources and displays them in one location. This content can include, but isn&apos;t limited to, news headlines, blog posts or email. The RSS Reader gadget displays this content in a single window on your Portal page. </para> - <mediaobject> - <imageobject role="html"> - <imagedata fileref="images/RSSReader.png" format="PNG" align="center" scale="100"/> - </imageobject> - <imageobject role="fo"> - <imagedata fileref="images/RSSReader.png" format="PNG" align="center" scalefit="1" contentwidth="70mm"/> - </imageobject> - </mediaobject> - </listitem> - </varlistentry> - </variablelist> - <para> + <mediaobject> + <imageobject role="html"> + <imagedata align="center" scale="100" fileref="images/RSSReader.png" format="PNG"/> + </imageobject> + <imageobject role="fo"> + <imagedata contentwidth="70mm" align="center" scalefit="1" fileref="images/RSSReader.png" format="PNG"/> + </imageobject> + </mediaobject> + </listitem> + </varlistentry> + </variablelist> + <para> To use one of the default gadgets, simply drag it from the <emphasis role="bold">Dashboard Workspace</emphasis> onto your Dashboard as illustrated below: </para> - </section> - - <section id="sect-User_Guide-Dashboard_Portlet-Add_Gadgets"> - <title>Add Gadgets</title> - <para> - Many more gadgets can be found at <ulink type="http" url="http://www.google.com/ig/directory?synd=open">Google Gadgets</ulink>. JBoss Enterprise Portal Platform is compatible with most of the gadgets available there. + </section> + <section id="sect-User_Guide-Dashboard_Portlet-Add_Gadgets"> + <title>Add Gadgets</title> + <para> + Many more gadgets can be found at <ulink url="http://www.google.com/ig/directory?synd=open" type="http">Google Gadgets</ulink>. JBoss Portal Platform is compatible with most of the gadgets available there. </para> - - <important> - <title>Gadget Whitelist</title> - <para> + <important> + <title>Gadget Whitelist</title> + <para> Only gadgets that have been added to the whitelist by the administrator can be used. </para> - <para> - For more information, refer to the <emphasis>Gadget Proxy Configuration</emphasis> Chapter of the JBoss Enterprise Portal Platform Installation Guide available at <ulink type="http" url="http://docs.redhat.com"></ulink>. + <para> + For more information, refer to the <emphasis>Gadget Proxy Configuration</emphasis> Chapter of the JBoss Portal Platform Installation Guide available at <ulink url="http://docs.redhat.com" type="http"/>. </para> - </important> - <para> + </important> + <para> To add gadgets from external sources: </para> - <procedure> - <step> - <para> + <procedure> + <step> + <para> Obtain the URL (<emphasis>.xml</emphasis> or <emphasis>.rss</emphasis>) of the gadget you wish to add from the gadget source. - </para> - <para> - The gadgets available at <ulink type="http" url="http://www.google.com/ig/directory?synd=open">Google Gadget</ulink> provide a link to <emphasis role="bold">View source</emphasis>. Clicking on this link will open a page showing the gadget's XML source. Use the URL of this page in the Dashboard Workspace. The URL should end with <literal>.xml</literal> </para> - <para> + <para> + The gadgets available at <ulink url="http://www.google.com/ig/directory?synd=open" type="http">Google Gadget</ulink> provide a link to <emphasis role="bold">View source</emphasis>. Clicking on this link will open a page showing the gadget&apos;s XML source. Use the URL of this page in the Dashboard Workspace. The URL should end with <literal>.xml</literal> + </para> + <para> For example: </para> -<programlisting> + <programlisting> http://www.donalobrien.net/apps/google/currency.xml </programlisting> - <note> - <title>URL Types</title> - <para> - Remote gadgets can be only created using an .xml link or RSS URL. However, if you use a link that generates an RSS feed (for example: <ulink type="http" url="http://feeds.feedburner.com/gatein">http://feeds.feedbu...>), a new RSS reader gadget will be created automatically even if the URL does not end with <literal>.rss</literal>. + <note> + <title>URL Types</title> + <para> + Remote gadgets can be only created using an .xml link or RSS URL. However, if you use a link that generates an RSS feed (for example: <ulink url="http://feeds.feedburner.com/gatein" type="http">http://feeds.feedburner.com/gatein</ulink>), a new RSS reader gadget will be created automatically even if the URL does not end with <literal>.rss</literal>. </para> - </note> - </step> - <step> - <para> + </note> + </step> + <step> + <para> Return to your portal and click <emphasis role="bold">Dashboard</emphasis> in the toolbar. </para> <!-- @@ -199,44 +201,38 @@ <imagedata fileref="images/DashboardLink.png" format="PNG" align="center" scalefit="1" contentwidth="150mm"/> </imageobject> </mediaobject> ---> - </step> - <step> - <para> +--> </step> + <step> + <para> Click on <emphasis role="bold">Add Gadgets</emphasis> in the Dashboard to open the Dashboard Workspace. </para> - </step> - <step> - <para> + </step> + <step> + <para> The Dashboard Workspace dialog appears. </para> - </step> - <step> - <para> + </step> + <step> + <para> Paste the URL obtained in step 1 into the text box above the gadget list. </para> - <mediaobject> - <imageobject role="html"> - <imagedata fileref="images/CodePaste.png" format="PNG" align="center" scale="100"/> - </imageobject> - <imageobject role="fo"> - <imagedata fileref="images/CodePaste.png" format="PNG" align="center" scalefit="1" contentwidth="100mm" /> - </imageobject> - </mediaobject> - - </step> - <step> - <para> + <mediaobject> + <imageobject role="html"> + <imagedata align="center" scale="100" fileref="images/CodePaste.png" format="PNG"/> + </imageobject> + <imageobject role="fo"> + <imagedata contentwidth="100mm" align="center" scalefit="1" fileref="images/CodePaste.png" format="PNG"/> + </imageobject> + </mediaobject> + </step> + <step> + <para> Click on the <emphasis role="bold">plus</emphasis> icon to add the new gadget to the page. </para> - <para> + <para> The new gadget will appear on the Dashboard alongside any other gadgets already in use. If required, the new gadget can be dragged to another position on the page. </para> - </step> - </procedure> - - </section> - + </step> + </procedure> + </section> </section> - - Modified: epp/docs/branches/6.0/User_Guide/en-US/modules/portletsUser/Functional_Portlets.xml =================================================================== --- epp/docs/branches/6.0/User_Guide/en-US/modules/portletsUser/Functional_Portlets.xml 2012-10-24 06:12:02 UTC (rev 8938) +++ epp/docs/branches/6.0/User_Guide/en-US/modules/portletsUser/Functional_Portlets.xml 2012-10-25 06:01:34 UTC (rev 8939) @@ -1,117 +1,119 @@ -<?xml version='1.0' encoding='utf-8' ?> +<?xml version='1.0' encoding='UTF-8'?> <!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [ <!ENTITY % BOOK_ENTITIES SYSTEM "../../User_Guide.ent"> %BOOK_ENTITIES; ]> <section id="sect-User_Guide-Functional_Portlets"> - <title>Functional Portlets</title> - <para> - Portlets are pluggable user interface components that are managed and displayed within a portal. Functional Portlets support all functions of a Portal. They are built into the portal and are accessed via toolbar links as required when undertaking portal tasks. - </para> - <para> - JBoss Enterprise Portal Platform provides the following portlets by default: - </para> - - <variablelist> - <varlistentry> - <term><emphasis role="bold">Account Portlet</emphasis></term> - <listitem> - <para> - The Account Portlet allows users to register a new account and choose a preferred language for displaying the Portal interface. - </para> - <mediaobject> - <imageobject> - <imagedata fileref="images/Account.png" format="PNG" align="center" scalefit="1" contentwidth="150mm" /> - </imageobject> - </mediaobject> - </listitem> - </varlistentry> - <varlistentry> - <term><emphasis role="bold">Organization Portlet</emphasis></term> - <listitem> - <para> - The Organization Portlet is used to manage user information, groups of users and groups memberships. - </para> - <mediaobject> - <imageobject> - <imagedata fileref="images/OrganizationPortlet1.png" format="PNG" align="center" scalefit="1" contentwidth="150mm"/> - </imageobject> - </mediaobject> - </listitem> - </varlistentry> - <varlistentry> - <term><emphasis role="bold">Application Registry Portlet</emphasis></term> - <listitem> - <para> - The Application Registry Portlet is used to manage different application categories. You can add, edit, set permissions and delete a category and its applications. - </para> - <mediaobject> - <imageobject> - <imagedata fileref="images/ApplicationRegistry.png" format="PNG" align="center" scalefit="1" contentwidth="150mm"/> - </imageobject> - </mediaobject> - </listitem> - </varlistentry> + <title>Functional Portlets</title> + <para> + Portlets are pluggable user interface components that are managed and displayed within a portal. Functional Portlets support all functions of a Portal. They are built into the portal and are accessed via toolbar links as required when undertaking portal tasks. + </para> + <para> +JBoss Portal Platform provides the following portlets by default: + </para> + <variablelist> + <varlistentry> + <term> + <emphasis role="bold">Account Portlet</emphasis> + </term> + <listitem> + <para> + The Account Portlet allows users to register a new account and choose a preferred language for displaying the Portal interface. + </para> + <mediaobject> + <imageobject> + <imagedata contentwidth="150mm" align="center" scalefit="1" fileref="images/Account.png" format="PNG"/> + </imageobject> + </mediaobject> + </listitem> + </varlistentry> + <varlistentry> + <term> + <emphasis role="bold">Organization Portlet</emphasis> + </term> + <listitem> + <para> + The Organization Portlet is used to manage user information, groups of users and groups memberships. + </para> + <mediaobject> + <imageobject> + <imagedata contentwidth="150mm" align="center" scalefit="1" fileref="images/OrganizationPortlet1.png" format="PNG"/> + </imageobject> + </mediaobject> + </listitem> + </varlistentry> + <varlistentry> + <term> + <emphasis role="bold">Application Registry Portlet</emphasis> + </term> + <listitem> + <para> + The Application Registry Portlet is used to manage different application categories. You can add, edit, set permissions and delete a category and its applications. + </para> + <mediaobject> + <imageobject> + <imagedata contentwidth="150mm" align="center" scalefit="1" fileref="images/ApplicationRegistry.png" format="PNG"/> + </imageobject> + </mediaobject> + </listitem> + </varlistentry> <!-- - <varlistentry> - <term><emphasis role="bold">Internationalization Portlet</emphasis></term> - <listitem> - <para> - This Portlet is used to translate a word or a phrase from the current language to another language. - </para> - <mediaobject> - <imageobject> - <imagedata fileref="images/InternationalizationPortlet1.png" format="PNG" align="center" contentwidth="400" align="center"/> - </imageobject> - </mediaobject> - </listitem> - </varlistentry> ---> - <!-- Doesn't exist anymore AFAIK - <varlistentry> - <term>Administration Toolbar Portlet</term> - <listitem> - <para> - This Portlet supports administration actions in JBoss Enterprise Portal Platform. - </para> - <mediaobject> - <imageobject> - <imagedata fileref="images/Administration.png" format="PNG" align="center" contentwidth="400" align="center"/> - </imageobject> - </mediaobject> - </listitem> - </varlistentry> - --> - <varlistentry> - <term><emphasis role="bold">Star Toolbar Portlet</emphasis></term> - <listitem> - <para> - The Star Toolbar Portlet is used to change the default language, the skin of the portal or to sign out. - </para> - <mediaobject> - <imageobject role="html"> - <imagedata fileref="images/StarPortlet.png" format="PNG" align="center" scale="100"/> - </imageobject> - <imageobject role="fo"> - <imagedata fileref="images/StarPortlet.png" format="PNG" align="center" scalefit="1" contentwidth="130mm"/> - </imageobject> - </mediaobject> - </listitem> - </varlistentry> - <!--<varlistentry> - <term>User Toolbar Portlet</term> - <listitem> - <para> - This Portlet supports all user actions in JBoss Enterprise Portal Platform. - </para> - <mediaobject> - <imageobject> - <imagedata fileref="images/UserToolbar.png" format="PNG" align="center"></imagedata> - </imageobject> - </mediaobject> - </listitem> - </varlistentry> --> - </variablelist> + <varlistentry> + <term><emphasis role="bold">Internationalization Portlet</emphasis></term> + <listitem> + <para> + This Portlet is used to translate a word or a phrase from the current language to another language. + </para> + <mediaobject> + <imageobject> + <imagedata fileref="images/InternationalizationPortlet1.png" format="PNG" align="center" contentwidth="400" align="center"/> + </imageobject> + </mediaobject> + </listitem> + </varlistentry> +--><!-- Doesn't exist anymore AFAIK + <varlistentry> + <term>Administration Toolbar Portlet</term> + <listitem> + <para> + This Portlet supports administration actions in JBoss Enterprise Portal Platform. + </para> + <mediaobject> + <imageobject> + <imagedata fileref="images/Administration.png" format="PNG" align="center" contentwidth="400" align="center"/> + </imageobject> + </mediaobject> + </listitem> + </varlistentry> + --> <varlistentry> + <term> + <emphasis role="bold">Star Toolbar Portlet</emphasis> + </term> + <listitem> + <para> + The Star Toolbar Portlet is used to change the default language, the skin of the portal or to sign out. + </para> + <mediaobject> + <imageobject role="html"> + <imagedata align="center" scale="100" fileref="images/StarPortlet.png" format="PNG"/> + </imageobject> + <imageobject role="fo"> + <imagedata contentwidth="130mm" align="center" scalefit="1" fileref="images/StarPortlet.png" format="PNG"/> + </imageobject> + </mediaobject> + </listitem> + </varlistentry> +<!--<varlistentry> + <term>User Toolbar Portlet</term> + <listitem> + <para> + This Portlet supports all user actions in JBoss Enterprise Portal Platform. + </para> + <mediaobject> + <imageobject> + <imagedata fileref="images/UserToolbar.png" format="PNG" align="center"></imagedata> + </imageobject> + </mediaobject> + </listitem> + </varlistentry> --> </variablelist> </section> - - Modified: epp/docs/branches/6.0/User_Guide/en-US/modules/portletsUser/Interface_Portlets.xml =================================================================== --- epp/docs/branches/6.0/User_Guide/en-US/modules/portletsUser/Interface_Portlets.xml 2012-10-24 06:12:02 UTC (rev 8938) +++ epp/docs/branches/6.0/User_Guide/en-US/modules/portletsUser/Interface_Portlets.xml 2012-10-25 06:01:34 UTC (rev 8939) @@ -1,92 +1,106 @@ -<?xml version='1.0' encoding='utf-8' ?> +<?xml version='1.0' encoding='UTF-8'?> <!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [ <!ENTITY % BOOK_ENTITIES SYSTEM "../../User_Guide.ent"> %BOOK_ENTITIES; ]> <section id="sect-User_Guide-Interface_Portlets"> - <title>Interface Portlets</title> - <para> - The Interface Portlets are the front-end components of the Portal. They provide ways for users to interact with the portal. JBoss Enterprise Portal Platform provides the following Interface Portlets: - </para> - - <variablelist> - <varlistentry> - <term><emphasis role="bold">Homepage Portlet</emphasis></term> - <listitem> - <para> - This Portlet is the home page for a portal. The home page is the first page displayed when you visit the site. - </para> - </listitem> - </varlistentry> - <varlistentry> - <term><emphasis role="bold">Banner Portlet</emphasis></term> - <listitem> - <para> - This Portlet contains the organization's slogan, logo, and icons. - </para> - </listitem> - </varlistentry> - <varlistentry> - <term><emphasis role="bold">Navigation Portlet</emphasis></term> - <listitem> - <para> - This Portlet provides a navigation bar. A navigation bar is a menu that helps users to visualize the structure of a site and provide links to quickly move from page to page. - </para> - </listitem> - </varlistentry> - <varlistentry> - <term><emphasis role="bold">Sitemap Portlet</emphasis></term> - <listitem> - <para> - This Portlet displays a site map page of a web site. It lists pages on a website, typically organized in hierarchical fashion. - </para> - </listitem> - </varlistentry> - <varlistentry> - <term><emphasis role="bold">Breadcrumbs Portlet</emphasis></term> - <listitem> - <para> - This Portlet displays the 'path' the user has taken from the home page to arrive at the current page. - </para> - </listitem> - </varlistentry> - <varlistentry> - <term><emphasis role="bold">Dashboard Portlet</emphasis></term> - <listitem> - <para> - This portlet is used for hosting mini-applications known as gadgets. The dashboard uses a variety of graphical effects for displaying, opening, and using gadgets. - </para> - <para> - Refer to <xref linkend="sect-User_Guide-Dashboard_Portlet" /> or <xref linkend="chap-User_Guide-Gadgets_Administration" /> for more information. - </para> - </listitem> - </varlistentry> - <varlistentry> - <term><emphasis role="bold">IFrame Portlet</emphasis></term> - <listitem> - <para> - This Portlet is used to create inline frames (IFrame) elements for a site. An IFrame is an HTML element which can embed another document into a parent HTML document. By using IFrames, embedded data is displayed inside a sub-window of browser. - </para> - </listitem> - </varlistentry> - <varlistentry> - <term><emphasis role="bold">Gadget Wrapper Portlet</emphasis></term> - <listitem> - <para> - This Portlet allows users to view a gadget in canvas mode. - </para> - </listitem> - </varlistentry> - <varlistentry> - <term><emphasis role="bold">Footer Portlet</emphasis></term> - <listitem> - <para> - This Portlet provides the footer for a site. This footer provides information or links about the site's author/institutional sponsor, the date of the last revision made to the site, copyright information, comments form and navigational links. - </para> - </listitem> - </varlistentry> - </variablelist> - + <title>Interface Portlets</title> + <para> + The Interface Portlets are the front-end components of the Portal. They provide ways for users to interact with the portal. JBoss Portal Platform provides the following Interface Portlets: + </para> + <variablelist> + <varlistentry> + <term> + <emphasis role="bold">Homepage Portlet</emphasis> + </term> + <listitem> + <para> + This Portlet is the home page for a portal. The home page is the first page displayed when you visit the site. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term> + <emphasis role="bold">Banner Portlet</emphasis> + </term> + <listitem> + <para> + This Portlet contains the organization&apos;s slogan, logo, and icons. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term> + <emphasis role="bold">Navigation Portlet</emphasis> + </term> + <listitem> + <para> + This Portlet provides a navigation bar. A navigation bar is a menu that helps users to visualize the structure of a site and provide links to quickly move from page to page. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term> + <emphasis role="bold">Sitemap Portlet</emphasis> + </term> + <listitem> + <para> + This Portlet displays a site map page of a web site. It lists pages on a website, typically organized in hierarchical fashion. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term> + <emphasis role="bold">Breadcrumbs Portlet</emphasis> + </term> + <listitem> + <para> + This Portlet displays the &apos;path&apos; the user has taken from the home page to arrive at the current page. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term> + <emphasis role="bold">Dashboard Portlet</emphasis> + </term> + <listitem> + <para> + This portlet is used for hosting mini-applications known as gadgets. The dashboard uses a variety of graphical effects for displaying, opening, and using gadgets. + </para> + <para> + Refer to <xref linkend="sect-User_Guide-Dashboard_Portlet"/> or <xref linkend="chap-User_Guide-Gadgets_Administration"/> for more information. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term> + <emphasis role="bold">IFrame Portlet</emphasis> + </term> + <listitem> + <para> + This Portlet is used to create inline frames (IFrame) elements for a site. An IFrame is an HTML element which can embed another document into a parent HTML document. By using IFrames, embedded data is displayed inside a sub-window of browser. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term> + <emphasis role="bold">Gadget Wrapper Portlet</emphasis> + </term> + <listitem> + <para> + This Portlet allows users to view a gadget in canvas mode. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term> + <emphasis role="bold">Footer Portlet</emphasis> + </term> + <listitem> + <para> + This Portlet provides the footer for a site. This footer provides information or links about the site&apos;s author/institutional sponsor, the date of the last revision made to the site, copyright information, comments form and navigational links. + </para> + </listitem> + </varlistentry> + </variablelist> </section> - - Modified: epp/docs/branches/6.0/User_Guide/en-US/modules/terms/Gadget_concept.xml =================================================================== --- epp/docs/branches/6.0/User_Guide/en-US/modules/terms/Gadget_concept.xml 2012-10-24 06:12:02 UTC (rev 8938) +++ epp/docs/branches/6.0/User_Guide/en-US/modules/terms/Gadget_concept.xml 2012-10-25 06:01:34 UTC (rev 8939) @@ -1,16 +1,14 @@ -<?xml version='1.0' encoding='utf-8' ?> +<?xml version='1.0' encoding='UTF-8'?> <!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [ <!ENTITY % BOOK_ENTITIES SYSTEM "../../User_Guide.ent"> %BOOK_ENTITIES; ]> <section id="sect-User_Guide-Gadgets"> - <title>Gadgets</title> - <para> - A gadget is a customizable mini web application that portal users may add to their web pages. - </para> - <para> - For more information about the gadgets shipped by default with JBoss Enterprise Portal Platform, please check out <xref linkend="sect-User_Guide-Dashboard_Portlet-Using_the_Dashboard_Workspace" /> - </para> + <title>Gadgets</title> + <para> + A gadget is a customizable mini web application that portal users may add to their web pages. + </para> + <para> + For more information about the gadgets shipped by default with JBoss Portal Platform, please check out <xref linkend="sect-User_Guide-Dashboard_Portlet-Using_the_Dashboard_Workspace"/> + </para> </section> - - Modified: epp/docs/branches/6.0/User_Guide/en-US/modules/terms/Navigation_concept.xml =================================================================== --- epp/docs/branches/6.0/User_Guide/en-US/modules/terms/Navigation_concept.xml 2012-10-24 06:12:02 UTC (rev 8938) +++ epp/docs/branches/6.0/User_Guide/en-US/modules/terms/Navigation_concept.xml 2012-10-25 06:01:34 UTC (rev 8939) @@ -1,92 +1,90 @@ -<?xml version='1.0' encoding='utf-8' ?> +<?xml version='1.0' encoding='UTF-8'?> <!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [ <!ENTITY % BOOK_ENTITIES SYSTEM "../../User_Guide.ent"> %BOOK_ENTITIES; ]> <section id="sect-User_Guide-Navigation"> - <title>Navigation</title> - <para> - Portal navigations are menus that contain hyperlinks to other parts of a Portal. They can help users to visualize the structure of a site. The default navigation menus in JBoss Enterprise Portal Platform are located in the Toolbar (<xref linkend="sect-User_Guide-Toolbar-Concept"/>). - </para> - <para> - There are three navigation types. - </para> - <variablelist> - <varlistentry> - <term>Site</term> - <listitem> - <para> - This navigation links to separate sites of the parent Portal. Each site has only one navigation and it is automatically generated when the site is created. - </para> - <para> - This functionality allows different sites to administer some Portal aspects (such as portlets) individually while maintaining other content standardized with the parent Portal. - </para> - </listitem> - </varlistentry> - <varlistentry> - <term>Group</term> - <listitem> - <para> - The content of this navigation differs depending on the type of account logged in. - </para> - <itemizedlist> - <listitem> - <para> - If a user account is active, this navigation holds personal links set up by that user. - </para> - </listitem> - <listitem> - <para> - When using a management account, this navigation contains links to pages for registered users as well as administrative tasks and personal links. - </para> - </listitem> - <listitem> - <para> - In an administrator account the navigation adds further management abilities, such as community and application management. - </para> - </listitem> - </itemizedlist> - </listitem> - </varlistentry> - <varlistentry> - <term>Dashboard</term> - <listitem> - <para> - Each user has own navigation 'Dashboard' that contains links and portlets (or gadgets) that the user has selected. A user's navigation is created automatically when user is registered. This navigation only can be deleted when the user is deleted. - </para> - </listitem> - </varlistentry> - <varlistentry> - <term>Dashboard Editor</term> - <listitem> + <title>Navigation</title> + <para> + Portal navigations are menus that contain hyperlinks to other parts of a Portal. They can help users to visualize the structure of a site. The default navigation menus in JBoss Portal Platform are located in the Toolbar (<xref linkend="sect-User_Guide-Toolbar-Concept"/>). + </para> + <para> + There are three navigation types. + </para> + <variablelist> + <varlistentry> + <term>Site</term> + <listitem> + <para> + This navigation links to separate sites of the parent Portal. Each site has only one navigation and it is automatically generated when the site is created. + </para> + <para> + This functionality allows different sites to administer some Portal aspects (such as portlets) individually while maintaining other content standardized with the parent Portal. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>Group</term> + <listitem> + <para> + The content of this navigation differs depending on the type of account logged in. + </para> + <itemizedlist> + <listitem> <para> + If a user account is active, this navigation holds personal links set up by that user. + </para> + </listitem> + <listitem> + <para> + When using a management account, this navigation contains links to pages for registered users as well as administrative tasks and personal links. + </para> + </listitem> + <listitem> + <para> + In an administrator account the navigation adds further management abilities, such as community and application management. + </para> + </listitem> + </itemizedlist> + </listitem> + </varlistentry> + <varlistentry> + <term>Dashboard</term> + <listitem> + <para> + Each user has own navigation &apos;Dashboard&apos; that contains links and portlets (or gadgets) that the user has selected. A user&apos;s navigation is created automatically when user is registered. This navigation only can be deleted when the user is deleted. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>Dashboard Editor</term> + <listitem> + <para> The <emphasis role="bold">Dashboard Editor</emphasis> navigation appears when a user is on their dashboard page. </para> - <para> + <para> The user can add multiple dashboard in new tabs and then edit the layout and content of those dashboards. </para> - </listitem> - </varlistentry> - </variablelist> - <para> - When logged in as an Administrator, a fourth navigation appears in the Toolbar: - </para> - <variablelist> - <varlistentry> - <term>Site/Group Editor</term> - <listitem> - <para> - This navigation appears as either <emphasis role="bold">Site Editor</emphasis> or <emphasis role="bold">Group Editor</emphasis> depending on the administrator's location within the portal. - </para> - <para> - When in areas of the portal displaying content, the navigation shows as <emphasis role="bold">Site Editor</emphasis> and in areas pertaining to users the navigation shows as <emphasis role="bold">Group Editor</emphasis>. - </para> - <para> - This navigation contains links to add a new pages to the portal, to edit a page or to change the portal's layout. Administrators can use these links to manage the portal. - </para> - </listitem> - </varlistentry> - </variablelist> + </listitem> + </varlistentry> + </variablelist> + <para> + When logged in as an Administrator, a fourth navigation appears in the Toolbar: + </para> + <variablelist> + <varlistentry> + <term>Site/Group Editor</term> + <listitem> + <para> + This navigation appears as either <emphasis role="bold">Site Editor</emphasis> or <emphasis role="bold">Group Editor</emphasis> depending on the administrator&apos;s location within the portal. + </para> + <para> + When in areas of the portal displaying content, the navigation shows as <emphasis role="bold">Site Editor</emphasis> and in areas pertaining to users the navigation shows as <emphasis role="bold">Group Editor</emphasis>. + </para> + <para> + This navigation contains links to add a new pages to the portal, to edit a page or to change the portal&apos;s layout. Administrators can use these links to manage the portal. + </para> + </listitem> + </varlistentry> + </variablelist> </section> - - Modified: epp/docs/branches/6.0/User_Guide/en-US/modules/terms/Portlet_concept.xml =================================================================== --- epp/docs/branches/6.0/User_Guide/en-US/modules/terms/Portlet_concept.xml 2012-10-24 06:12:02 UTC (rev 8938) +++ epp/docs/branches/6.0/User_Guide/en-US/modules/terms/Portlet_concept.xml 2012-10-25 06:01:34 UTC (rev 8939) @@ -1,16 +1,14 @@ -<?xml version='1.0' encoding='utf-8' ?> +<?xml version='1.0' encoding='UTF-8'?> <!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [ <!ENTITY % BOOK_ENTITIES SYSTEM "../../User_Guide.ent"> %BOOK_ENTITIES; ]> <section id="sect-User_Guide-Portlet"> - <title>Portlet</title> - <para> - A portlet is a small, self-contained web application. Portlets are managed and displayed within a Portal. Typically, a <emphasis>portal</emphasis> page is displayed as a collection of non-overlapping <emphasis>portlet</emphasis> windows, with each portlet window displaying a different portlet. Hence a portlet (or collection of portlets) resembles a web-based application hosted in a portal. - </para> - <para> - Portlets can be configured with differing content and JBoss Enterprise Portal Platform has a number of default portlets that can be used in any portal built in the application. - </para> + <title>Portlet</title> + <para> + A portlet is a small, self-contained web application. Portlets are managed and displayed within a Portal. Typically, a <emphasis>portal</emphasis> page is displayed as a collection of non-overlapping <emphasis>portlet</emphasis> windows, with each portlet window displaying a different portlet. Hence a portlet (or collection of portlets) resembles a web-based application hosted in a portal. + </para> + <para> + Portlets can be configured with differing content and JBoss Portal Platform has a number of default portlets that can be used in any portal built in the application. + </para> </section> - - Modified: epp/docs/branches/6.0/User_Guide/en-US/modules/terms/Public_mode_and_Private_mode.xml =================================================================== --- epp/docs/branches/6.0/User_Guide/en-US/modules/terms/Public_mode_and_Private_mode.xml 2012-10-24 06:12:02 UTC (rev 8938) +++ epp/docs/branches/6.0/User_Guide/en-US/modules/terms/Public_mode_and_Private_mode.xml 2012-10-25 06:01:34 UTC (rev 8939) @@ -1,31 +1,33 @@ -<?xml version='1.0' encoding='utf-8' ?> +<?xml version='1.0' encoding='UTF-8'?> <!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [ <!ENTITY % BOOK_ENTITIES SYSTEM "../../User_Guide.ent"> %BOOK_ENTITIES; ]> <section id="sect-User_Guide-Modes"> - <title>Modes</title> - <para> - By default JBoss Enterprise Portal Platform offers two access <emphasis role="bold">modes</emphasis>: - </para> - <variablelist> - <varlistentry> - <term><emphasis role="bold">Public</emphasis></term> - <listitem> - <para> - This mode is for guest users who are not registered with the Portal. It does not require a log in and restricts the visitor to the public pages in the portal. Visitors can register an account to gain access to the restricted pages. After being registered, they can use the Private mode but must still contact the Portal administrator to get more rights or a group manager to become a member and gain access to a group. - </para> - </listitem> - </varlistentry> - <varlistentry> - <term><emphasis role="bold">Private</emphasis></term> - <listitem> - <para> - This mode is for registered users only. Users set a username and password during registration which they can then use to sign in. This mode offers users more site privileges. Registered users can manage private resources (creating, editing or deleting private pages), "borrow" pages from other users by creating hyperlinks and change the language for individual needs. - </para> - </listitem> - </varlistentry> - </variablelist> + <title>Modes</title> + <para> + By default JBoss Portal Platform offers two access <emphasis role="bold">modes</emphasis>: + </para> + <variablelist> + <varlistentry> + <term> + <emphasis role="bold">Public</emphasis> + </term> + <listitem> + <para> + This mode is for guest users who are not registered with the Portal. It does not require a log in and restricts the visitor to the public pages in the portal. Visitors can register an account to gain access to the restricted pages. After being registered, they can use the Private mode but must still contact the Portal administrator to get more rights or a group manager to become a member and gain access to a group. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term> + <emphasis role="bold">Private</emphasis> + </term> + <listitem> + <para> + This mode is for registered users only. Users set a username and password during registration which they can then use to sign in. This mode offers users more site privileges. Registered users can manage private resources (creating, editing or deleting private pages), &quot;borrow&quot; pages from other users by creating hyperlinks and change the language for individual needs. + </para> + </listitem> + </varlistentry> + </variablelist> </section> - -