Author: smumford Date: 2010-11-02 03:36:22 -0400 (Tue, 02 Nov 2010) New Revision: 4897 Added: epp/docs/branches/EPP_5_1_Branch/Reference_Guide/en-US/extras/PortalDevelopment_JavascriptConfiguration/ epp/docs/branches/EPP_5_1_Branch/Reference_Guide/en-US/extras/PortalDevelopment_JavascriptConfiguration/01eXoResources.java Modified: epp/docs/branches/EPP_5_1_Branch/Reference_Guide/en-US/Book_Info.xml epp/docs/branches/EPP_5_1_Branch/Reference_Guide/en-US/Reference_Guide.ent epp/docs/branches/EPP_5_1_Branch/Reference_Guide/en-US/Revision_History.xml epp/docs/branches/EPP_5_1_Branch/Reference_Guide/en-US/extras/PortletBridge_Configuration/default216.java epp/docs/branches/EPP_5_1_Branch/Reference_Guide/en-US/modules/Advanced/Foundations.xml epp/docs/branches/EPP_5_1_Branch/Reference_Guide/en-US/modules/Advanced/JCR/jdbc-data-container-config.xml epp/docs/branches/EPP_5_1_Branch/Reference_Guide/en-US/modules/Advanced/JCR/lock-manager-config.xml epp/docs/branches/EPP_5_1_Branch/Reference_Guide/en-US/modules/Advanced/JCR/multilanguage-support.xml epp/docs/branches/EPP_5_1_Branch/Reference_Guide/en-US/modules/Advanced/JCR/search-configuration.xml epp/docs/branches/EPP_5_1_Branch/Reference_Guide/en-US/modules/AuthenticationAndIdentity/BackendConfiguration.xml epp/docs/branches/EPP_5_1_Branch/Reference_Guide/en-US/modules/AuthenticationAndIdentity/SSO.xml epp/docs/branches/EPP_5_1_Branch/Reference_Guide/en-US/modules/GadgetDevelopment/SetupGadgetServer.xml epp/docs/branches/EPP_5_1_Branch/Reference_Guide/en-US/modules/PortalDevelopment.xml epp/docs/branches/EPP_5_1_Branch/Reference_Guide/en-US/modules/PortalDevelopment/JavascriptConfiguration.xml epp/docs/branches/EPP_5_1_Branch/Reference_Guide/en-US/modules/PortletDevelopment/PortletBridge/configuration.xml epp/docs/branches/EPP_5_1_Branch/Reference_Guide/en-US/modules/PortletDevelopment/PortletBridge/portlet_development.xml epp/docs/branches/EPP_5_1_Branch/Reference_Guide/en-US/modules/WSRP.xml Log: JBEPP-517: Corrected numerous typos and grammatical errors from feedback in JIRA Modified: epp/docs/branches/EPP_5_1_Branch/Reference_Guide/en-US/Book_Info.xml =================================================================== --- epp/docs/branches/EPP_5_1_Branch/Reference_Guide/en-US/Book_Info.xml 2010-11-02 07:21:10 UTC (rev 4896) +++ epp/docs/branches/EPP_5_1_Branch/Reference_Guide/en-US/Book_Info.xml 2010-11-02 07:36:22 UTC (rev 4897) @@ -9,7 +9,7 @@ <productname>JBoss Enterprise Portal Platform</productname> <productnumber>5</productnumber> <edition>1</edition> - <pubsnumber>1.13</pubsnumber> + <pubsnumber>1.14</pubsnumber> <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 &PRODUCT; product. Its primary focus is on advanced use of the product and it assumes an intermediate or advanced knowledge of the technology and terms. Modified: epp/docs/branches/EPP_5_1_Branch/Reference_Guide/en-US/Reference_Guide.ent =================================================================== --- epp/docs/branches/EPP_5_1_Branch/Reference_Guide/en-US/Reference_Guide.ent 2010-11-02 07:21:10 UTC (rev 4896) +++ epp/docs/branches/EPP_5_1_Branch/Reference_Guide/en-US/Reference_Guide.ent 2010-11-02 07:36:22 UTC (rev 4897) @@ -1,9 +1,9 @@ <!ENTITY PRODUCT "JBoss Enterprise Portal Platform"> <!ENTITY PRODUCT_NAME "JBoss Enterprise Portal Platform"> -<!ENTITY PRODUCT_VERSION "5.0.1"> +<!ENTITY PRODUCT_VERSION "5.1.0"> <!ENTITY VERSION "5.0.1"> -<!ENTITY PORTAL_VERSION "5.0.1"> -<!ENTITY WSRP_VERSION "1.1.1-GA"> +<!ENTITY PORTAL_VERSION "5.1.0"> +<!ENTITY WSRP_VERSION "2.0.0"> <!ENTITY BOOKID "Reference Guide"> <!ENTITY YEAR "2010"> <!ENTITY HOLDER "Red Hat, Inc"> Modified: epp/docs/branches/EPP_5_1_Branch/Reference_Guide/en-US/Revision_History.xml =================================================================== --- epp/docs/branches/EPP_5_1_Branch/Reference_Guide/en-US/Revision_History.xml 2010-11-02 07:21:10 UTC (rev 4896) +++ epp/docs/branches/EPP_5_1_Branch/Reference_Guide/en-US/Revision_History.xml 2010-11-02 07:36:22 UTC (rev 4897) @@ -7,6 +7,20 @@ <title>Revision History</title> <simpara> <revhistory> + <revision> + <revnumber>1-1.14</revnumber> + <date>Tue Nov 02 2010</date> + <author> + <firstname>Scott</firstname> + <surname>Mumford</surname> + <email&gt;smumford(a)redhat.com&lt;/email&gt; + </author> + <revdescription> + <simplelist> + <member>Updated to remove numerous minor spelling and typographic errors.</member> + </simplelist> + </revdescription> + </revision> <revision> <revnumber>1-1.13</revnumber> <date>Tue Oct 26 2010</date> Added: epp/docs/branches/EPP_5_1_Branch/Reference_Guide/en-US/extras/PortalDevelopment_JavascriptConfiguration/01eXoResources.java =================================================================== --- epp/docs/branches/EPP_5_1_Branch/Reference_Guide/en-US/extras/PortalDevelopment_JavascriptConfiguration/01eXoResources.java (rev 0) +++ epp/docs/branches/EPP_5_1_Branch/Reference_Guide/en-US/extras/PortalDevelopment_JavascriptConfiguration/01eXoResources.java 2010-11-02 07:36:22 UTC (rev 4897) @@ -0,0 +1,42 @@ +JavascriptService.addJavascript("eXo", "/javascript/eXo.js", ServletContext); +/* Animation Javascripts */ +JavascriptService.addJavascript("eXo.animation.ImplodeExplode", "/javascript/eXo/animation/ImplodeExplode.js", ServletContext); +/* Application descriptor */ +JavascriptService.addJavascript("eXo.application.ApplicationDescriptor", "/javascript/eXo/application/ApplicationDescriptor.js", ServletContext); +/* CORE Javascripts */ +JavascriptService.addJavascript("eXo.core.Utils", "/javascript/eXo/core/Util.js", ServletContext); +JavascriptService.addJavascript("eXo.core.DOMUtil", "/javascript/eXo/core/DOMUtil.js", ServletContext); +JavascriptService.addJavascript("eXo.core.Browser", "/javascript/eXo/core/Browser.js", ServletContext); +JavascriptService.addJavascript("eXo.core.MouseEventManager", "/javascript/eXo/core/MouseEventManager.js", ServletContext); +JavascriptService.addJavascript("eXo.core.UIMaskLayer", "/javascript/eXo/core/UIMaskLayer.js", ServletContext); +JavascriptService.addJavascript("eXo.core.Skin", "/javascript/eXo/core/Skin.js", ServletContext); +JavascriptService.addJavascript("eXo.core.DragDrop", "/javascript/eXo/core/DragDrop.js", ServletContext); +JavascriptService.addJavascript("eXo.core.TemplateEngine", "/javascript/eXo/core/TemplateEngine.js", ServletContext); +/* Widget Javascripts */ +JavascriptService.addJavascript("eXo.widget.UIWidget", "/javascript/eXo/widget/UIWidget.js", ServletContext); +JavascriptService.addJavascript("eXo.widget.UIAddWidget", "/javascript/eXo/widget/UIAddWidget.js", ServletContext); +JavascriptService.addJavascript("eXo.widget.UIExoWidget", "/javascript/eXo/widget/UIExoWidget.js", ServletContext); +/* Desktop Javascripts */ +JavascriptService.addJavascript("eXo.desktop.UIDockbar", "/javascript/eXo/desktop/UIDockbar.js", ServletContext); +JavascriptService.addJavascript("eXo.desktop.UIDesktop", "/javascript/eXo/desktop/UIDesktop.js", ServletContext); +/* WebUI Javascripts */ +JavascriptService.addJavascript("eXo.webui.UIItemSelector", "/javascript/eXo/webui/UIItemSelector.js", ServletContext); +JavascriptService.addJavascript("eXo.webui.UIForm", "/javascript/eXo/webui/UIForm.js", ServletContext); +JavascriptService.addJavascript("eXo.webui.UIPopup", "/javascript/eXo/webui/UIPopup.js", ServletContext); +JavascriptService.addJavascript("eXo.webui.UIPopupSelectCategory", "/javascript/eXo/webui/UIPopupSelectCategory.js", ServletContext); +JavascriptService.addJavascript("eXo.webui.UIPopupWindow", "/javascript/eXo/webui/UIPopupWindow.js", ServletContext); +JavascriptService.addJavascript("eXo.webui.UIVerticalScroller", "/javascript/eXo/webui/UIVerticalScroller.js", ServletContext); +JavascriptService.addJavascript("eXo.webui.UIHorizontalTabs", "/javascript/eXo/webui/UIHorizontalTabs.js", ServletContext); +JavascriptService.addJavascript("eXo.webui.UIPopupMenu", "/javascript/eXo/webui/UIPopupMenu.js", ServletContext); +JavascriptService.addJavascript("eXo.webui.UIDropDownControl", "/javascript/eXo/webui/UIDropDownControl.js", ServletContext); +/* Portal Javascripts */ +JavascriptService.addJavascript("eXo.portal.PortalHttpRequest", "/javascript/eXo/portal/PortalHttpRequest.js", ServletContext); +JavascriptService.addJavascript("eXo.portal.UIPortal", "/javascript/eXo/portal/UIPortal.js", ServletContext); +JavascriptService.addJavascript("eXo.portal.UIWorkspace", "/javascript/eXo/portal/UIWorkspace.js", ServletContext); +JavascriptService.addJavascript("eXo.portal.UIPortalControl", "/javascript/eXo/portal/UIPortalControl.js", ServletContext); +JavascriptService.addJavascript("eXo.portal.PortalDragDrop", "/javascript/eXo/portal/PortalDragDrop.js", ServletContext); +JavascriptService.addJavascript("eXo.portal.UIPortalNavigation", "/javascript/eXo/portal/UIPortalNavigation.js", ServletContext); +JavascriptService.addJavascript("eXo.portal.UIMaskWorkspace", "/javascript/eXo/portal/UIMaskWorkspace.js", ServletContext); +JavascriptService.addJavascript("eXo.portal.UIExoStartMenu", "/javascript/eXo/portal/UIExoStartMenu.js", ServletContext); +/* Desktop Javascripts 2 */ +JavascriptService.addJavascript("eXo.desktop.UIWindow", "/javascript/eXo/desktop/UIWindow.js", ServletContext); \ No newline at end of file Modified: epp/docs/branches/EPP_5_1_Branch/Reference_Guide/en-US/extras/PortletBridge_Configuration/default216.java =================================================================== --- epp/docs/branches/EPP_5_1_Branch/Reference_Guide/en-US/extras/PortletBridge_Configuration/default216.java 2010-11-02 07:21:10 UTC (rev 4896) +++ epp/docs/branches/EPP_5_1_Branch/Reference_Guide/en-US/extras/PortletBridge_Configuration/default216.java 2010-11-02 07:36:22 UTC (rev 4897) @@ -1 +1 @@ - #{resource['/img/the-path-to-my-image.png']} +#{resource['/images/the-path-to-my-image.png']} Modified: epp/docs/branches/EPP_5_1_Branch/Reference_Guide/en-US/modules/Advanced/Foundations.xml =================================================================== --- epp/docs/branches/EPP_5_1_Branch/Reference_Guide/en-US/modules/Advanced/Foundations.xml 2010-11-02 07:21:10 UTC (rev 4896) +++ epp/docs/branches/EPP_5_1_Branch/Reference_Guide/en-US/modules/Advanced/Foundations.xml 2010-11-02 07:36:22 UTC (rev 4897) @@ -5,8 +5,8 @@ ]> <chapter id="chap-Reference_Guide-Foundations"> <title>Foundations</title> - <section id="sect-Reference_Guide-Foundations-The_Exo_Kernel"> - <title>The Exo Kernel</title> + <section id="sect-Reference_Guide-Foundations-The_eXo_Kernel"> + <title>The eXo Kernel</title> <para> &PRODUCT; is built as a set of services on top of a dependency injection kernel. The kernel provides configuration, lifecycle handling, component scopes, and some core services. </para> @@ -33,12 +33,12 @@ &PRODUCT; 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>. + Whenever your portal application has to be integrated more closely with eXo services, these services can be looked up through the <literal>PortalContainer</literal>. </para> <!-- This Note has been flagged in a review by Andrew Ross BNE QE. Currently unsure as to why. --> <important> <para> - Only officially documented services should be accessed this way, and used according to documentation, as most of the services are an implementation detail of Exo, and subject to change without notice. + Only officially documented services should be accessed this way, and used according to documentation, as most of the services are an implementation detail of eXo, and subject to change without notice. </para> </important> </section> @@ -47,7 +47,7 @@ <section id="sect-Reference_Guide-Foundations-Configuring_services"> <title>Configuring services</title> <para> - Exo Kernel uses dependency injection to create services based on <filename>configuration.xml</filename> configuration files. The location of the configuration files determines if services are placed into the <literal>RootContainer</literal> scope, or into the <literal>PortalContainer</literal> scope. + The eXo Kernel uses dependency injection to create services based on <filename>configuration.xml</filename> configuration files. The location of the configuration files determines if services are placed into the <literal>RootContainer</literal> scope, or into the <literal>PortalContainer</literal> scope. </para> <para> All <filename>configuration.xml</filename> files located at <filename>conf/configuration.xml</filename> in the classpath (any directory, or any jar in the classpath) will have their services configured in the <literal>RootContainer</literal> scope. All <filename>configuration.xml</filename> files located at <filename>conf/portal/configuration.xml</filename> in the classpath will have their services configured at the <literal>PortalContainer</literal> scope. @@ -87,7 +87,7 @@ <section id="sect-Reference_Guide-Configuration_syntax-External_Plugins"> <title>External Plugins</title> <para> - The Exo Kernel supports non-component objects that can be configured, instantiated, and injected into registered components using method calls. This &#39;<emphasis>plugin</emphasis>&#39; method allows portal extensions to add additional configurations to core services. + The eXo Kernel supports non-component objects that can be configured, instantiated, and injected into registered components using method calls. This &#39;<emphasis>plugin</emphasis>&#39; method allows portal extensions to add additional configurations to core services. </para> <para> An external plugin is defined by using the <literal>&#60;external-component-plugin&#62;</literal> wrapper element which contains one or more <literal>&#60;component-plugin&#62;</literal> definitions. @@ -96,10 +96,10 @@ The <literal>&#60;external-component-plugin&#62;</literal> element uses <literal>&#60;target-component&#62;</literal> to specify a target service component that will receive injected objects. </para> <para> - Every <literal>&#60;component-plugin&#62;</literal> defines an implementation type, and a method on target component to use for injection (<literal>&#60;set-method&#62;</literal>). + Every <literal>&#60;component-plugin&#62;</literal> defines an implementation type, and a method on the target component to use for injection (<literal>&#60;set-method&#62;</literal>). </para> <para> - A plugin implementation class has to implement the <emphasis role="bold">org.exoplatform.container.component. ComponentPlugin</emphasis> interface. + A plugin implementation class has to implement the <emphasis role="bold">org.eXoplatform.container.component. ComponentPlugin</emphasis> interface. </para> <para> In the following example the <literal>PortalContainerDefinitionPlugin</literal> implements the <literal>ComponentPlugin</literal>: @@ -182,7 +182,7 @@ If the service component&#39;s constructor takes <parameter>InitParams</parameter> as any of the parameters it will automatically be injected at component instantiation time. </para> <para> - The XML configuration for a service component that expects an <parameter>InitParams</parameter> element must have an <parameter>&#60;init-params&#62;</parameter> element present, however this element can be left empt + The XML configuration for a service component that expects an <parameter>InitParams</parameter> element must have an <parameter>&#60;init-params&#62;</parameter> element present, however this element can be left empty. </para> <para> Below is an example of how the kernel XML configuration syntax looks when creating <parameter>InitParams</parameter> instances: @@ -226,7 +226,7 @@ Each of these child elements takes a <parameter>&#60;name&#62;</parameter> that serves as a map entry key, and an optional <parameter>&#60;description&#62;</parameter>. It also takes a type-specific <emphasis role="bold">value</emphasis> specification. </para> <para> - The value specification for the <parameter>&#60;properties-param&#62;</parameter> defines one or more <parameter>&#60;property&#62;</parameter> element, each of which specifies two strings; a property name and a property value. This is evident in the two previous examples. + The value specification for the <parameter>&#60;properties-param&#62;</parameter> defines one or more <parameter>&#60;property&#62;</parameter> elements, each of which specifies two strings; a property name and a property value. This is evident in the two previous examples. </para> <para> Each <parameter>&#60;properties-params&#62;</parameter> defines one <literal>java.util.Properties</literal> instance. @@ -237,12 +237,12 @@ <programlisting language="XML" role="XML"><xi:include href="../../extras/Advanced_Development_Foundations/default5.xml" parse="text" xmlns:xi="http://www.w3.org/2001/XInclude" /></programlisting> <para> - The value specification for <parameter>&#60;values-param&#62;</parameter> requires one or more <parameter>&#60;value&#62;</parameter> element. Each <parameter>&#60;value&#62;</parameter> represents one <literal>String</literal> instance. All <literal>String</literal> values are then collected into a <literal>java.util.List</literal> instance. + The value specification for <parameter>&#60;values-param&#62;</parameter> requires one or more <parameter>&#60;value&#62;</parameter> elements. Each <parameter>&#60;value&#62;</parameter> represents one <literal>String</literal> instance. All <literal>String</literal> values are then collected into a <literal>java.util.List</literal> instance. </para> <programlisting language="XML" role="XML"><xi:include href="../../extras/Advanced_Development_Foundations/default6.xml" parse="text" xmlns:xi="http://www.w3.org/2001/XInclude" /></programlisting> <para> - For <parameter>&#60;object-param&#62;</parameter> entries, the value specification consists of an <parameter>&#60;object&#62;</parameter> element which is used for plain java style object specification (specifying an implementation <emphasis>class - <parameter>&#60;type&#62;</parameter></emphasis>, and <emphasis>property values - <parameter>&#60;field&#62;</parameter></emphasis>). + For <parameter>&#60;object-param&#62;</parameter> entries, the value specification consists of an <parameter>&#60;object&#62;</parameter> element which is used for plain Java style object specification (specifying an implementation <emphasis>class - <parameter>&#60;type&#62;</parameter></emphasis>, and <emphasis>property values - <parameter>&#60;field&#62;</parameter></emphasis>). </para> <para> The following section has an example of specifying a field of with a <literal>Collection</literal> type. @@ -302,7 +302,7 @@ </para> <variablelist> <varlistentry> - <term>ExoContainerContext</term> + <term>eXoContainerContext</term> <listitem> <para> This contains information about the portal. @@ -334,12 +334,11 @@ </varlistentry> </variablelist> <para> - The <emphasis role="bold">Unified servlet context</emphasis>, and <emphasis role="bold">unified classloader</emphasis> are part of the <emphasis role="bold">extension mechanism</emphasis> (which is detailed in the next section). + The <emphasis role="bold">Unified servlet context</emphasis> and <emphasis role="bold">unified classloader</emphasis> are part of the <emphasis role="bold">extension mechanism</emphasis> (which is detailed in the next section). </para> <para> - They provide the standard API (<literal>ServletContext</literal>, <literal>ClassLoader</literal>) with specific resource loading behavior, such as visibility into associated web application archives, configured with dependencies property of <literal>PortalContainerDefinition</literal>. + They provide the standard API (<literal>ServletContext</literal>, <literal>ClassLoader</literal>) with specific resource loading behavior, such as visibility into associated web application archives, configured with the dependencies property of <literal>PortalContainerDefinition</literal>. </para> - <!-- DOC TODO: Confirm if 'visibility into' is the approapriate phrase to use here --> <para> Resources from other web applications are queried in the order specified by the dependencies. The later entries in the list override the previous ones. </para> @@ -352,7 +351,7 @@ 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&#39;s classpath. Custom <code>.war</code> archives can be created with new resources that override the resources in the original archive. + 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&#39;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>. @@ -392,7 +391,6 @@ </note> </section> - <section id="sect-Reference_Guide-Foundations-Running_Multiple_Portals"> <title>Running Multiple Portals</title> <!-- DOC TODO: This section requires more work to structure the information effectively. Consider sub-sections --> @@ -409,22 +407,22 @@ 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>. + 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. + 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>. + 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&#39;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-Foundations-The_Extension_Mechanism_and_Portal_Extensions" />). </para> <para> - Filter classes need to extend the <literal>org.exoplatform.container.web. AbstractFilter</literal>. + 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>. @@ -440,7 +438,7 @@ </para> </note> <para> - An application may also need to access to portal information within the <emphasis role="bold">HttpSessionListener</emphasis>. Ensure the provided abstract class; <emphasis role="bold">org.exoplatform.container.web. AbstractHttpSessionListener</emphasis> is extended. + 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: @@ -496,7 +494,7 @@ <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>. + 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> Modified: epp/docs/branches/EPP_5_1_Branch/Reference_Guide/en-US/modules/Advanced/JCR/jdbc-data-container-config.xml =================================================================== --- epp/docs/branches/EPP_5_1_Branch/Reference_Guide/en-US/modules/Advanced/JCR/jdbc-data-container-config.xml 2010-11-02 07:21:10 UTC (rev 4896) +++ epp/docs/branches/EPP_5_1_Branch/Reference_Guide/en-US/modules/Advanced/JCR/jdbc-data-container-config.xml 2010-11-02 07:36:22 UTC (rev 4897) @@ -87,7 +87,7 @@ The data container uses the JDBC driver to communicate with the actual database software. That is, any JDBC-enabled data storage can be used with eXo JCR implementation. </para> <para> - Currently the data container is tested with the following Rational Database Management Systems (RDBMS): + Currently the data container is tested with the following Relational Database Management Systems (RDBMS): </para> <table id="tabl-Reference_Guide-Introduction-Database_Support_"> <title>Database Support </title> Modified: epp/docs/branches/EPP_5_1_Branch/Reference_Guide/en-US/modules/Advanced/JCR/lock-manager-config.xml =================================================================== --- epp/docs/branches/EPP_5_1_Branch/Reference_Guide/en-US/modules/Advanced/JCR/lock-manager-config.xml 2010-11-02 07:21:10 UTC (rev 4896) +++ epp/docs/branches/EPP_5_1_Branch/Reference_Guide/en-US/modules/Advanced/JCR/lock-manager-config.xml 2010-11-02 07:36:22 UTC (rev 4897) @@ -102,7 +102,7 @@ Refer to <ulink url="http://community.jboss.org/wiki/JBossCacheJDBCCacheLoader"... for more information about JBoss Cache and JDBCCacheLoader. </para> <section id="sect-Reference_Guide-CacheableLockManagerImpl-Simple_Jboss_Cache_Configuration"> - <title>Simple Jboss Cache Configuration</title> + <title>Simple JBoss Cache Configuration</title> <para> One method to configure the LockManager is to put a JBoss Cache configuration file path into <classname>CacheableLockManagerImpl</classname>. </para> Modified: epp/docs/branches/EPP_5_1_Branch/Reference_Guide/en-US/modules/Advanced/JCR/multilanguage-support.xml =================================================================== --- epp/docs/branches/EPP_5_1_Branch/Reference_Guide/en-US/modules/Advanced/JCR/multilanguage-support.xml 2010-11-02 07:21:10 UTC (rev 4896) +++ epp/docs/branches/EPP_5_1_Branch/Reference_Guide/en-US/modules/Advanced/JCR/multilanguage-support.xml 2010-11-02 07:36:22 UTC (rev 4897) @@ -37,7 +37,7 @@ <orderedlist> <listitem> <para> - The configuration file to be modified for these changes is:<filename>/webapps/portal/WEB-INF/conf/jcr/repository-configuration.xml</filename> + The configuration file to be modified for these changes is:<filename>/portal/WEB-INF/conf/jcr/repository-configuration.xml</filename> </para> </listitem> <listitem> Modified: epp/docs/branches/EPP_5_1_Branch/Reference_Guide/en-US/modules/Advanced/JCR/search-configuration.xml =================================================================== --- epp/docs/branches/EPP_5_1_Branch/Reference_Guide/en-US/modules/Advanced/JCR/search-configuration.xml 2010-11-02 07:21:10 UTC (rev 4896) +++ epp/docs/branches/EPP_5_1_Branch/Reference_Guide/en-US/modules/Advanced/JCR/search-configuration.xml 2010-11-02 07:36:22 UTC (rev 4897) @@ -633,7 +633,7 @@ </para> </formalpara> <para> - The <phrase>ISOLatin1AccentFilter</phrase> is not present in the current lucene version used by Exo. + The <phrase>ISOLatin1AccentFilter</phrase> is not present in the current lucene version used by eXo. </para> <para> In order to use a different filter, a new analyzer must be created, as well as new search index to use the analyzer. These are packaged into a jar file, which is then deployed with the application. Modified: epp/docs/branches/EPP_5_1_Branch/Reference_Guide/en-US/modules/AuthenticationAndIdentity/BackendConfiguration.xml =================================================================== --- epp/docs/branches/EPP_5_1_Branch/Reference_Guide/en-US/modules/AuthenticationAndIdentity/BackendConfiguration.xml 2010-11-02 07:21:10 UTC (rev 4896) +++ epp/docs/branches/EPP_5_1_Branch/Reference_Guide/en-US/modules/AuthenticationAndIdentity/BackendConfiguration.xml 2010-11-02 07:36:22 UTC (rev 4897) @@ -31,7 +31,7 @@ <section id="sect-Reference_Guide-PicketLink_IDM_integration-Configuration_files"> <title>Configuration files</title> <para> - The main configuration file is <emphasis role="bold">idm-configuration.xml</emphasis>: + The main configuration file is <filename>02portal.war/WEB-INF/conf/organization/idm-configuration.xml</filename>: </para> <programlistingco> <areaspec> @@ -169,7 +169,7 @@ <term>associationMembershipType</term> <listitem> <para> - If this option is used, then each Membership, created with MembrshipType that is equal to the value specified here, will be stored in PicketLink IDM as simple Group-User association. + If this option is used, then each Membership, created with MembershipType that is equal to the value specified here, will be stored in PicketLink IDM as simple Group-User association. </para> </listitem> </varlistentry> Modified: epp/docs/branches/EPP_5_1_Branch/Reference_Guide/en-US/modules/AuthenticationAndIdentity/SSO.xml =================================================================== --- epp/docs/branches/EPP_5_1_Branch/Reference_Guide/en-US/modules/AuthenticationAndIdentity/SSO.xml 2010-11-02 07:21:10 UTC (rev 4896) +++ epp/docs/branches/EPP_5_1_Branch/Reference_Guide/en-US/modules/AuthenticationAndIdentity/SSO.xml 2010-11-02 07:36:22 UTC (rev 4897) @@ -388,7 +388,7 @@ </step> <step> <para> - modify the &#39;<emphasis role="bold">Sign In</emphasis>&#39; link in the <filename>gatein.ear/web.war/groovy/portal/webui/component/UILogoPortlet.gtmpl</filename> file as follows: + Modify the &#39;<emphasis role="bold">Sign In</emphasis>&#39; link in the <filename>gatein.ear/web.war/groovy/portal/webui/component/UILogoPortlet.gtmpl</filename> file as follows: </para> <programlisting language="XML" role="XML"><xi:include href="../../extras/Authentication_Identity_SSO/default113.xml" parse="text" xmlns:xi="http://www.w3.org/2001/XInclude" /></programlisting> @@ -778,7 +778,7 @@ </step> <step> <para> - Extend the core authentication mechanisms to support SPNEGO Under <filename>deployers/jbossweb.deployer/META-INF/war-deployers-jboss-beans.xml</filename>, add a &#39;<literal>SPNEGO</literal>&#39; authenticators property + Extend the core authentication mechanisms to support SPNEGO. Under <filename>deployers/jbossweb.deployer/META-INF/war-deployers-jboss-beans.xml</filename>, add a &#39;<literal>SPNEGO</literal>&#39; authenticators property </para> <programlisting language="XML" role="XML"><xi:include href="../../extras/Authentication_Identity_SSO/default125.xml" parse="text" xmlns:xi="http://www.w3.org/2001/XInclude" /></programlisting> @@ -800,7 +800,7 @@ <programlisting language="XML" role="XML"><xi:include href="../../extras/Authentication_Identity_SSO/default126.xml" parse="text" xmlns:xi="http://www.w3.org/2001/XInclude" /></programlisting> <para> - This activate the SPNEGO <literal>LoginModule</literal> for use with &PRODUCT;. + This activates the SPNEGO <literal>LoginModule</literal> for use with &PRODUCT;. </para> </step> <step> Modified: epp/docs/branches/EPP_5_1_Branch/Reference_Guide/en-US/modules/GadgetDevelopment/SetupGadgetServer.xml =================================================================== --- epp/docs/branches/EPP_5_1_Branch/Reference_Guide/en-US/modules/GadgetDevelopment/SetupGadgetServer.xml 2010-11-02 07:21:10 UTC (rev 4896) +++ epp/docs/branches/EPP_5_1_Branch/Reference_Guide/en-US/modules/GadgetDevelopment/SetupGadgetServer.xml 2010-11-02 07:36:22 UTC (rev 4897) @@ -11,7 +11,7 @@ &PRODUCT; recommends using two virtual hosts for security. If the gadget is running on a different domain than the container, it is unable to interfere with the portal by modifying code or cookies. </para> <para> - An example would hosting the portal from <emphasis role="bold">http://www.sample.com</emphasis> and the gadgets from <emphasis role="bold">http://www.samplemodules.com</emphasis>. + An example would be hosting the portal from <emphasis role="bold">http://www.sample.com</emphasis> and the gadgets from <emphasis role="bold">http://www.samplemodules.com</emphasis>. </para> <para> To do this, configure the <emphasis>gadgets.hostName</emphasis> parameter in the <filename>server/<replaceable>PROFILE</replaceable>/deploy/gatein.ear/02portal.war/WEB-INF/conf/portal/application-registry-configuration.xml</filename> file. The value is the <emphasis role="bold">path/to/gadgetServer</emphasis> in <literal>GadgetRegisteryService</literal>: @@ -43,15 +43,19 @@ <section id="sect-Reference_Guide-Configuration-Security_key"> <title>Security key</title> <para> - A file called <emphasis role="bold">key.txt</emphasis> has to be generated for every installation of &PRODUCT; to be secure. This file contains a secret key used to encrypt the security token used for authenticating the user. + A specific file called <emphasis role="bold">key.txt</emphasis> has to be generated for each installation of &PRODUCT; to be secure. This file contains a secret key used to encrypt the security token used for authenticating the user. </para> <para> In Linux systems this file can be generated with: </para> <programlisting language="XML" role="XML"><xi:include href="../../extras/Gadget_Development_SetupGadgetServer/default140.xml" parse="text" xmlns:xi="http://www.w3.org/2001/XInclude" /></programlisting> - <!-- <programlisting><command>dd if=/dev/random bs=32 count=1 | openssl base64 &gt; /tmp/key.txt</command> -</programlisting> --> + <important> + <title><emphasis role="bold">DOCS NOTE: Technical verification required</emphasis></title> + <para> + This <filename>key.txt </filename> file should be placed in the <filename>/conf/gatein/gadgets</filename> folder of your profile. + </para> + </important> </section> Modified: epp/docs/branches/EPP_5_1_Branch/Reference_Guide/en-US/modules/PortalDevelopment/JavascriptConfiguration.xml =================================================================== --- epp/docs/branches/EPP_5_1_Branch/Reference_Guide/en-US/modules/PortalDevelopment/JavascriptConfiguration.xml 2010-11-02 07:21:10 UTC (rev 4896) +++ epp/docs/branches/EPP_5_1_Branch/Reference_Guide/en-US/modules/PortalDevelopment/JavascriptConfiguration.xml 2010-11-02 07:36:22 UTC (rev 4897) @@ -3,8 +3,8 @@ <!ENTITY % BOOK_ENTITIES SYSTEM "Reference_Guide.ent"> %BOOK_ENTITIES; ]> -<chapter id="chap-Reference_Guide-Javascript_Configuration_PLEASE_REVIEW"> - <title>Javascript Configuration - PLEASE REVIEW</title> +<chapter id="chap-Reference_Guide-Javascript_Configuration-Please_Review"> + <title>Javascript Configuration - Please Review</title> <para> Managing Javascript scripts in an application like &PRODUCT; is a critical part of the configuration work. Configuring the scripts correctly will result in a faster response time from the portal. </para> @@ -12,54 +12,19 @@ Every portlet can have its own javscript code but in many cases it is more convenient to reuse some existing shared libraries. For that reason, &PRODUCT; has a mechanism to easily register the libraries that will be loaded when the first page is rendered. </para> <para> - To do so, every WAR deployed in &PRODUCT; can register the <filename>.js</filename> files with the groovy script <filename>WEB-INF/conf/script/groovy/JavascriptScript.groovy</filename>. (TODO: this file doesn&#39;t seem to exist) + To do so, every WAR deployed in &PRODUCT; can register the <filename>.js</filename> files with the groovy script <filename>WEB-INF/conf/script/groovy/JavascriptScript.groovy</filename>. </para> + <important> + <title><emphasis role="bold">DOC NOTE:</emphasis></title> + <para> + <filename>WEB-INF/conf/script/groovy/JavascriptScript.groovy</filename> doesn't seem to exist + </para> + </important> <para> The example file below is found in the <literal>01eXoResources.war</literal> </para> -<programlisting role="JAVA">JavascriptService.addJavascript(&#34;eXo&#34;, &#34;/javascript/eXo.js&#34;, ServletContext); -/* Animation Javascripts */ -JavascriptService.addJavascript(&#34;eXo.animation.ImplodeExplode&#34;, &#34;/javascript/eXo/animation/ImplodeExplode.js&#34;, ServletContext); -/* Application descriptor */ -JavascriptService.addJavascript(&#34;eXo.application.ApplicationDescriptor&#34;, &#34;/javascript/eXo/application/ApplicationDescriptor.js&#34;, ServletContext); -/* CORE Javascripts */ -JavascriptService.addJavascript(&#34;eXo.core.Utils&#34;, &#34;/javascript/eXo/core/Util.js&#34;, ServletContext); -JavascriptService.addJavascript(&#34;eXo.core.DOMUtil&#34;, &#34;/javascript/eXo/core/DOMUtil.js&#34;, ServletContext); -JavascriptService.addJavascript(&#34;eXo.core.Browser&#34;, &#34;/javascript/eXo/core/Browser.js&#34;, ServletContext); -JavascriptService.addJavascript(&#34;eXo.core.MouseEventManager&#34;, &#34;/javascript/eXo/core/MouseEventManager.js&#34;, ServletContext); -JavascriptService.addJavascript(&#34;eXo.core.UIMaskLayer&#34;, &#34;/javascript/eXo/core/UIMaskLayer.js&#34;, ServletContext); -JavascriptService.addJavascript(&#34;eXo.core.Skin&#34;, &#34;/javascript/eXo/core/Skin.js&#34;, ServletContext); -JavascriptService.addJavascript(&#34;eXo.core.DragDrop&#34;, &#34;/javascript/eXo/core/DragDrop.js&#34;, ServletContext); -JavascriptService.addJavascript(&#34;eXo.core.TemplateEngine&#34;, &#34;/javascript/eXo/core/TemplateEngine.js&#34;, ServletContext); -/* Widget Javascripts */ -JavascriptService.addJavascript(&#34;eXo.widget.UIWidget&#34;, &#34;/javascript/eXo/widget/UIWidget.js&#34;, ServletContext); -JavascriptService.addJavascript(&#34;eXo.widget.UIAddWidget&#34;, &#34;/javascript/eXo/widget/UIAddWidget.js&#34;, ServletContext); -JavascriptService.addJavascript(&#34;eXo.widget.UIExoWidget&#34;, &#34;/javascript/eXo/widget/UIExoWidget.js&#34;, ServletContext); -/* Desktop Javascripts */ -JavascriptService.addJavascript(&#34;eXo.desktop.UIDockbar&#34;, &#34;/javascript/eXo/desktop/UIDockbar.js&#34;, ServletContext); -JavascriptService.addJavascript(&#34;eXo.desktop.UIDesktop&#34;, &#34;/javascript/eXo/desktop/UIDesktop.js&#34;, ServletContext); -/* WebUI Javascripts */ -JavascriptService.addJavascript(&#34;eXo.webui.UIItemSelector&#34;, &#34;/javascript/eXo/webui/UIItemSelector.js&#34;, ServletContext); -JavascriptService.addJavascript(&#34;eXo.webui.UIForm&#34;, &#34;/javascript/eXo/webui/UIForm.js&#34;, ServletContext); -JavascriptService.addJavascript(&#34;eXo.webui.UIPopup&#34;, &#34;/javascript/eXo/webui/UIPopup.js&#34;, ServletContext); -JavascriptService.addJavascript(&#34;eXo.webui.UIPopupSelectCategory&#34;, &#34;/javascript/eXo/webui/UIPopupSelectCategory.js&#34;, ServletContext); -JavascriptService.addJavascript(&#34;eXo.webui.UIPopupWindow&#34;, &#34;/javascript/eXo/webui/UIPopupWindow.js&#34;, ServletContext); -JavascriptService.addJavascript(&#34;eXo.webui.UIVerticalScroller&#34;, &#34;/javascript/eXo/webui/UIVerticalScroller.js&#34;, ServletContext); -JavascriptService.addJavascript(&#34;eXo.webui.UIHorizontalTabs&#34;, &#34;/javascript/eXo/webui/UIHorizontalTabs.js&#34;, ServletContext); -JavascriptService.addJavascript(&#34;eXo.webui.UIPopupMenu&#34;, &#34;/javascript/eXo/webui/UIPopupMenu.js&#34;, ServletContext); -JavascriptService.addJavascript(&#34;eXo.webui.UIDropDownControl&#34;, &#34;/javascript/eXo/webui/UIDropDownControl.js&#34;, ServletContext); -/* Portal Javascripts */ -JavascriptService.addJavascript(&#34;eXo.portal.PortalHttpRequest&#34;, &#34;/javascript/eXo/portal/PortalHttpRequest.js&#34;, ServletContext); -JavascriptService.addJavascript(&#34;eXo.portal.UIPortal&#34;, &#34;/javascript/eXo/portal/UIPortal.js&#34;, ServletContext); -JavascriptService.addJavascript(&#34;eXo.portal.UIWorkspace&#34;, &#34;/javascript/eXo/portal/UIWorkspace.js&#34;, ServletContext); -JavascriptService.addJavascript(&#34;eXo.portal.UIPortalControl&#34;, &#34;/javascript/eXo/portal/UIPortalControl.js&#34;, ServletContext); -JavascriptService.addJavascript(&#34;eXo.portal.PortalDragDrop&#34;, &#34;/javascript/eXo/portal/PortalDragDrop.js&#34;, ServletContext); -JavascriptService.addJavascript(&#34;eXo.portal.UIPortalNavigation&#34;, &#34;/javascript/eXo/portal/UIPortalNavigation.js&#34;, ServletContext); -JavascriptService.addJavascript(&#34;eXo.portal.UIMaskWorkspace&#34;, &#34;/javascript/eXo/portal/UIMaskWorkspace.js&#34;, ServletContext); -JavascriptService.addJavascript(&#34;eXo.portal.UIExoStartMenu&#34;, &#34;/javascript/eXo/portal/UIExoStartMenu.js&#34;, ServletContext); -/* Desktop Javascripts 2 */ -JavascriptService.addJavascript(&#34;eXo.desktop.UIWindow&#34;, &#34;/javascript/eXo/desktop/UIWindow.js&#34;, ServletContext); +<programlisting role="JAVA"><xi:include href="../../extras/PortalDevelopment_JavascriptConfiguration/01eXoResources.java" parse="text" xmlns:xi="http://www.w3.org/2001/XInclude" /> </programlisting> <para> Note that even registered dedicated javascripts will be merged into a single <literal>merged.js</literal> file when the server loads. This reduces the number of HTTP calls as seen in the home page source code: Modified: epp/docs/branches/EPP_5_1_Branch/Reference_Guide/en-US/modules/PortalDevelopment.xml =================================================================== --- epp/docs/branches/EPP_5_1_Branch/Reference_Guide/en-US/modules/PortalDevelopment.xml 2010-11-02 07:21:10 UTC (rev 4896) +++ epp/docs/branches/EPP_5_1_Branch/Reference_Guide/en-US/modules/PortalDevelopment.xml 2010-11-02 07:36:22 UTC (rev 4897) @@ -14,5 +14,5 @@ <xi:include href="PortalDevelopment/RTLFramework.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> <xi:include href="PortalDevelopment/XMLResourceBundles.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> <xi:include href="PortalDevelopment/JavascriptInterApplicationCommunication.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> - <!-- <xi:include href="PortalDevelopment/JavascriptConfiguration.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> File has not been edited. Noted for later release --> + <xi:include href="PortalDevelopment/JavascriptConfiguration.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> </part> Modified: epp/docs/branches/EPP_5_1_Branch/Reference_Guide/en-US/modules/PortletDevelopment/PortletBridge/configuration.xml =================================================================== --- epp/docs/branches/EPP_5_1_Branch/Reference_Guide/en-US/modules/PortletDevelopment/PortletBridge/configuration.xml 2010-11-02 07:21:10 UTC (rev 4896) +++ epp/docs/branches/EPP_5_1_Branch/Reference_Guide/en-US/modules/PortletDevelopment/PortletBridge/configuration.xml 2010-11-02 07:36:22 UTC (rev 4897) @@ -25,7 +25,7 @@ When <parameter>preserveActionParams</parameter> is set to <parameter>TRUE</parameter>, the bridge must maintain any request parameters assigned during the portlet&#39;s action request. </para> <para> - The request parameters are maintained in the<emphasis>&#34;bridge request scope&#34;</emphasis>. When this attribute is not present or is <parameter>FALSE</parameter> the action&#39;s request parameters are only maintained for the duration of the <emphasis>portlet request scope</emphasis>. + The request parameters are maintained in the <emphasis>&#34;bridge request scope&#34;</emphasis>. When this attribute is not present or is <parameter>FALSE</parameter> the action&#39;s request parameters are only maintained for the duration of the <emphasis>portlet request scope</emphasis>. </para> <programlisting language="XML" role="XML"><xi:include href="../../../extras/PortletBridge_Configuration/default198.xml" parse="text" xmlns:xi="http://www.w3.org/2001/XInclude" /></programlisting> @@ -77,7 +77,7 @@ <term>DEFAULT</term> <listitem> <para> - Directs the bridge to first delegate the render and if and only if an Exception is thrown then render the view based on its own logic. If the configuration parameter is not present or has an invalid value the bridge renders using default behavior. I.e. as if DEFAULT is set. + Directs the bridge to first delegate the render only if an Exception is thrown then render the view based on its own logic. If the configuration parameter is not present or has an invalid value the bridge renders using default behavior as it would if DEFAULT was set. </para> </listitem> </varlistentry> @@ -105,7 +105,7 @@ <section id="sect-Reference_Guide-Core_Setup_and_Configuration-JSR_329"> <title>JSR-329</title> <para> - The Jboss Portlet Bridge can be used with a any compatible implementation (for example, <literal>MyFaces</literal> implementation). Simply put the following into <filename>web.xml</filename>: + The JBoss Portlet Bridge can be used with any compatible implementation (for example, <literal>MyFaces</literal> implementation). Simply put the following into <filename>web.xml</filename>: </para> <programlisting language="XML" role="XML"><xi:include href="../../../extras/PortletBridge_Configuration/default203.xml" parse="text" xmlns:xi="http://www.w3.org/2001/XInclude" /></programlisting> @@ -222,7 +222,7 @@ <programlisting language="XML" role="XML"><xi:include href="../../../extras/PortletBridge_Configuration/default210.xml" parse="text" xmlns:xi="http://www.w3.org/2001/XInclude" /></programlisting> <para> - While future versions on the 2.0 bridge will automate the dispatching and consuming of events, at the moments you must dispatch the event in the JSF or Seam backing bean. + While future versions of the 2.0 bridge will automate the dispatching and consuming of events, at the moment you must dispatch the event in the JSF or Seam backing bean. </para> <programlisting language="Java" role="Java"><xi:include href="../../../extras/PortletBridge_Configuration/default211.java" parse="text" xmlns:xi="http://www.w3.org/2001/XInclude" /></programlisting> @@ -243,7 +243,7 @@ <section id="sect-Reference_Guide-Public_Render_Parameters-Configuration"> <title>Configuration</title> <para> - Public Render Parameters (or PRPs) are one of the most powerful and simple Portlet 2.0 features. Several portlets (JSF or otherwise) can share the same render parameters. This feature can be use to present a cohesive UI to the user across all portlets on the page. An example would be using an employee ID to display relative data. + Public Render Parameters (or PRPs) are one of the most powerful and simple Portlet 2.0 features. Several portlets (JSF or otherwise) can share the same render parameters. This feature can be used to present a cohesive UI to the user across all portlets on the page. An example would be using an employee ID to display relative data. </para> <para> The bridge maps a render parameter to a backing bean using settings in your <filename>faces-config.xml</filename> and <filename>portlet.xml</filename>. @@ -287,7 +287,7 @@ We have setup a few examples to show you how to use <literal>EL</literal> and a simple bean that will allow you to use the portlet resource serving mechanism within a JSF portlet. </para> <para> - In <ulink url="http://anonsvn.jboss.org/repos/portletbridge/tags/2.0.0.CR1/exa...;, you can see a very simple implementations of a Map object that uses the bridge to get and encode a resource url served from the portlets web application. + In <ulink url="http://anonsvn.jboss.org/repos/portletbridge/tags/2.0.0.CR1/exa...;, you can see a very simple implementation of a Map object that uses the bridge to get and encode a resource url served from the portlets web application. </para> <para> So, when you have the normal &#34;<filename>/images</filename>&#34;, &#34;<filename>/styles</filename>&#34; and other resource folders in your web application, you can use the following <literal>EL</literal> expression to serve them in your JSF application. Modified: epp/docs/branches/EPP_5_1_Branch/Reference_Guide/en-US/modules/PortletDevelopment/PortletBridge/portlet_development.xml =================================================================== --- epp/docs/branches/EPP_5_1_Branch/Reference_Guide/en-US/modules/PortletDevelopment/PortletBridge/portlet_development.xml 2010-11-02 07:21:10 UTC (rev 4896) +++ epp/docs/branches/EPP_5_1_Branch/Reference_Guide/en-US/modules/PortletDevelopment/PortletBridge/portlet_development.xml 2010-11-02 07:36:22 UTC (rev 4897) @@ -118,16 +118,7 @@ </note> <programlisting language="XML" role="XML"><xi:include href="../../../extras/PortletBridge_Portlet_Development/default231.xml" parse="text" xmlns:xi="http://www.w3.org/2001/XInclude" /></programlisting> - <!-- <programlisting language="XML" role="XML"><![CDATA[ -<error-page> -<exception-type>javax.servlet.ServletException</exception-type> -<location>/faces/error.xhtml</location> -</error-page> -<error-page> -<exception-type>javax.faces.application.ViewExpiredException</exception-type> -<location>/faces/error.xhtml</location> -</error-page> -]]></programlisting> --> + </section> @@ -138,31 +129,13 @@ </para> <programlisting language="XML" role="XML"><xi:include href="../../../extras/PortletBridge_Portlet_Development/default232.xml" parse="text" xmlns:xi="http://www.w3.org/2001/XInclude" /></programlisting> - <!-- <programlisting language="XML" role="XML"><![CDATA[ -<script type="text/javascript"> -A4J.AJAX.onError = function(req,status,message){ -window.alert("Custom onError handler "+message); -} -A4J.AJAX.onExpired = function(loc,expiredMsg){ -if(window.confirm("Custom onExpired handler "+expiredMsg+" for a location: "+loc)){ -return loc; -} else { -return false; -} -} -</script> -]]></programlisting> --> + <para> Also, add the following to <filename>web.xml</filename>. </para> <programlisting language="XML" role="XML"><xi:include href="../../../extras/PortletBridge_Portlet_Development/default233.xml" parse="text" xmlns:xi="http://www.w3.org/2001/XInclude" /></programlisting> - <!-- <programlisting language="XML" role="XML"><![CDATA[ -<context-param> -<param-name>org.ajax4jsf.handleViewExpiredOnClient</param-name> -<param-value>true</param-value> -</context-param> -]]></programlisting> --> + <para> Read more about these settings here <ulink url="http://docs.jboss.org/richfaces/3.3.3.BETA1/en/devguide/html/Ar... Errors and Session Expiration Handling</ulink> </para> @@ -198,13 +171,11 @@ <programlisting language="Java" role=&quot;JAVA&quot;&gt;(a)PortletScope(PortletScope.ScopeType.APPLICATION_SCOPE) </programlisting> <para> - Then you would pull the statefull object from the session: + Then you would pull the stateful object from the session: </para> <programlisting language="Java" role="Java"><xi:include href="../../../extras/PortletBridge_Portlet_Development/default235.java" parse="text" xmlns:xi="http://www.w3.org/2001/XInclude" /></programlisting> - <!-- <programlisting language="Java" role="JAVA"><![CDATA[ -YourSessionClass yourSessionClass = (YourSessionClass)getRenderRequest().getAttribute("javax.portlet.p./default/seamproject/seamprojectPortletWindow?textHolder"); -]]></programlisting> --> + <para> This method is demonstrated in this video: <ulink url="http://www.vimeo.com/4521877">Lesson 2: Portlet 1.0 Advanced Seam and RichFaces</ulink> </para> @@ -218,16 +189,7 @@ </para> <programlisting language="Java" role="Java"><xi:include href="../../../extras/PortletBridge_Portlet_Development/default236.java" parse="text" xmlns:xi="http://www.w3.org/2001/XInclude" /></programlisting> - <!-- <programlisting language="Java" role="JAVA"><![CDATA[ -Object objSession = FacesContext.getCurrentInstance().getExternalContext().getSession(false); -try -{ -if (objSession instanceof PortletSession) -{ -PortletSession portalSession = (PortletSession)objSession; -portalSession.setAttribute("your parameter name","parameter value",PortletSession.APPLICATION_SCOPE); -... -]]></programlisting> --> + <para> Then, in your JSP or Facelets page, you can use: </para> @@ -255,28 +217,18 @@ </para> <programlisting language="XML" role="XML"><xi:include href="../../../extras/PortletBridge_Portlet_Development/default238.xml" parse="text" xmlns:xi="http://www.w3.org/2001/XInclude" /></programlisting> - <!-- <programlisting language="Java" role="JAVA"><![CDATA[ -<h:outputLink value="#{facesContext.externalContext.requestContextPath}/home.xhtml"> -<f:param name="javax.portlet.faces.ViewLink" value="true"/> -navigate to the test page -</h:outputLink> -]]></programlisting> --> + </section> <section id="sect-Reference_Guide-Developing_Portlets_with_the_Bridge-Redirecting_to_an_External_Page_or_Resource"> <title>Redirecting to an External Page or Resource</title> <para> - To link to a non JSF view (that is, jboss.org) you can use the following parameter. + To link to a non JSF view, <emphasis>jboss.org</emphasis> for example, you can use the following parameter. </para> <programlisting language="XML" role="XML"><xi:include href="../../../extras/PortletBridge_Portlet_Development/default239.xml" parse="text" xmlns:xi="http://www.w3.org/2001/XInclude" /></programlisting> - <!-- <programlisting language="Java" role="JAVA"><![CDATA[ -<h:commandLink actionListener="#{yourBean.yourListenr}"> -<f:param name="javax.portlet.faces.DirectLink" value="true"/> -navigate to the test page -</h:commandLink> -]]></programlisting> --> + <para> Then in your backing bean, you must call a <parameter>redirect()</parameter>. </para> @@ -293,33 +245,15 @@ </para> <programlisting language="XML" role="XML"><xi:include href="../../../extras/PortletBridge_Portlet_Development/default241.xml" parse="text" xmlns:xi="http://www.w3.org/2001/XInclude" /></programlisting> - <!-- <programlisting language="XML" role="XML"><![CDATA[ <h:form> -<h:inputText id="pref" required="true" value="#{mutablePortletPreferencesValues['userName'].value}" /> -<h:commandButton actionListener="#{myBean.savePref}" value="Save Preferences" /> -</h:form> -]]></programlisting> --> + <para> Then in your backing bean, you must call the PortletPreferences.store() method. </para> <programlisting language="Java" role="Java"><xi:include href="../../../extras/PortletBridge_Portlet_Development/default242.java" parse="text" xmlns:xi="http://www.w3.org/2001/XInclude" /></programlisting> - <!-- <programlisting language="Java" role="JAVA"><![CDATA[ Object request = FacesContext.getCurrentInstance().getExternalContext().getRequest(); -PortletRequest portletRequest = (PortletRequest)request; -if (request instanceof PortletRequest) { -try { -PortletPreferences portletPreferences = portletRequest.getPreferences(); -portletPreferences.store(); -]]></programlisting> --> + </section> - - <!-- DO NOT UNCOMMENT!! EL variables --><!-- using sendRedirect --><!-- FacesContext.getCurrentInstance().getExternalContext().redirect("http://www.google.com"); --><!-- and adding the <f:param name="javax.portlet.faces.DirectLink" value="true"/> to the commandButton, all seems fine. --><!-- <section> -<title>Integrations with JBoss Tools IDE</title> -<para> -</para> -<programlisting role="XML"><![CDATA[ -]]></programlisting> -</section> --> </section> Modified: epp/docs/branches/EPP_5_1_Branch/Reference_Guide/en-US/modules/WSRP.xml =================================================================== --- epp/docs/branches/EPP_5_1_Branch/Reference_Guide/en-US/modules/WSRP.xml 2010-11-02 07:21:10 UTC (rev 4896) +++ epp/docs/branches/EPP_5_1_Branch/Reference_Guide/en-US/modules/WSRP.xml 2010-11-02 07:36:22 UTC (rev 4897) @@ -195,7 +195,7 @@ In order to make a portlet remotely available, it must be made &#34;remotable&#34; by marking it as such in the associated <filename>portlet.xml</filename>. </para> <para> - A specific <code>org.gatein.pc.remotable container-runtime-option</code> is used to accomplished this. Setting its value to <code>true</code> makes the portlet available for remote consumption, while setting its value to <code>false</code> will not publish it remotely. + A specific <code>org.gatein.pc.remotable container-runtime-option</code> is used to accomplish this. Setting its value to <code>true</code> makes the portlet available for remote consumption, while setting its value to <code>false</code> will not publish it remotely. </para> <para> As specifying the remotable status for a portlet is optional, nothing need be done if portlets do not need to be remotely available. @@ -223,7 +223,7 @@ It is possible to override this default behavior. Specifying a value for the <code>org.gatein.pc.remotable container-runtime-option</code> at the <code>portlet</code> level will take precedence over the default. </para> <para> - In the example above, the <varname>RemotelyExposedPortlet</varname> inherits the remotable status defined at the <code>portlet-app</code> level since it does not specify a value for the<code>org.gatein.pc.remotable container-runtime-option</code>. + In the example above, the <varname>RemotelyExposedPortlet</varname> inherits the remotable status defined at the <code>portlet-app</code> level since it does not specify a value for the <code>org.gatein.pc.remotable container-runtime-option</code>. </para> <para> The <varname>NotRemotelyExposedPortlet</varname>, however, overrides the default behavior and is not remotely exposed. @@ -414,11 +414,11 @@ <note> <title>Values</title> <para> - As at this release there is no automated way to learn about which possible values (if any) are expected by the remote Producer. Possible values may be indicated in the registration property description but this is not always the case... Please refer to the specific Producer&#39;s documentation. + As at this release there is no automated way to learn about which possible values (if any) are expected by the remote Producer. Possible values may be indicated in the registration property description but this is not always the case. Refer to the specific Producer&#39;s documentation. </para> </note> <para> - Entered an address for the registration property (&amp;#34;&lt;literal&gt;example(a)example.com&lt;/literal&gt;&amp;#34;) and press &#34;<emphasis role="bold">Save &amp; Refresh</emphasis>&#34; once more: + Enter an address for the registration property (&amp;#34;&lt;literal&gt;example(a)example.com&lt;/literal&gt;&amp;#34;) and press &#34;<emphasis role="bold">Save &amp; Refresh</emphasis>&#34; once more: </para> <mediaobject> <imageobject role="html"> @@ -480,15 +480,11 @@ </section> - <section id="sect-Reference_Guide-Consuming_remote_WSRP_portlets_in_PRODUCT_NAME-Configuring_access_to_remote_Producers_via_XML"> <title>Configuring access to remote Producers via XML</title> <para> - Although using the WSRP Configuration portlet to configure Consumers is recommended, the WSRP component provides an alternative way to configure consumers. + Again, configuring consumers via XML is done by editing <filename><replaceable>PORTAL_HOME</replaceable>/lib/wsrp-consumer-<replaceable>WSRP_VERSION</replaceable>.jar/conf/wsrp-consumers-config.xml</filename>. </para> - <para> - This is done by editing the XML file located at <filename><replaceable>PORTAL_HOME</replaceable>/lib/wsrp-consumer-<replaceable>WSRP_VERSION</replaceable>.jar/conf/wsrp-consumers-config.xml</filename>. - </para> <note> <title>XML Elements</title> <para> @@ -624,7 +620,7 @@ Producers often offer several levels of service depending on consumers&#39; subscription levels (for example). This is implemented at the WSRP level with the registration concept: producers can assert which level of service to provide to consumers based on the values of given registration properties. </para> <para> - There may also be cases where the registration information has changed and must be updated. For example, the producer required you to provide a valid email and the previously email address is not valid anymore and needs to be updated. + There may also be cases where the registration information has changed and must be updated. For example, the producer required you to provide a valid email and the previous email address is not valid anymore and needs to be updated. </para> <para> Therefore at times it may be necessary to modify the registration that sets the service agreement between a consumer and a producer. @@ -857,7 +853,7 @@ The behavior of the Portal&#39;s WSRP Producer can be configured using the WSRP administration interface, (this is the recommended method), or by editing the <filename><replaceable>PORTAL_HOME</replaceable>/wsrp-producer.war/WEB-INF/conf/producer/config.xml</filename> file. </para> <para> - Several aspects can be modified with respects to whether registration is required for consumers to access the Producer&#39;s services. An XML Schema for the configuration format is available at <filename> <replaceable>PORTAL_HOME</replaceable>/lib/wsrp-integration-api-<replaceable>WSRP_VERSION</replaceable>.jar/xsd/gatein_wsrp_producer_1_0.xsd </filename>. + Several aspects can be modified with respect to whether registration is required for consumers to access the Producer&#39;s services. An XML Schema for the configuration format is available at <filename> <replaceable>PORTAL_HOME</replaceable>/lib/wsrp-integration-api-<replaceable>WSRP_VERSION</replaceable>.jar/xsd/gatein_wsrp_producer_1_0.xsd </filename>. </para> </section> @@ -865,7 +861,7 @@ <section id="sect-Reference_Guide-Configuring_PRODUCT_NAMEs_WSRP_Producer-Default_configuration"> <title>Default configuration</title> <para> - The default producer configuration requires that consumers register with it before providing access its services. However it does not require any specific registration properties (excepting those mandated by the WSRP standard). + The default producer configuration requires that consumers register with it before providing access to its services. However it does not require any specific registration properties (excepting those mandated by the WSRP standard). </para> <para> It does, however, require consumers to be registered before sending them a full service description. This means that the WSRP producer will not provide the list of offered portlets and other capabilities to unregistered consumers. @@ -947,7 +943,7 @@ </step> <step> <para> - To add a registration property called <literal>email</literal> click &#34;A<emphasis role="bold">dd property</emphasis>&#34; and enter the appropriate information in the fields, providing a description for the registration property that can be used by consumers to determine its purpose: + To add a registration property called <literal>email</literal> click &#34;<emphasis role="bold">Add property</emphasis>&#34; and enter the appropriate information in the fields, providing a description for the registration property that can be used by consumers to determine its purpose: </para> <mediaobject> <imageobject role="html"> @@ -997,7 +993,7 @@ </para> <note> <para> - Since the policy or the validator are defined via their class name and dynamically loaded, it is important to ensure that the identified class is available to the application server. One way to accomplish that is to deploy the policy implementation as JAR file in the AS instance deploy directory. Note also that, since both policies and validators are dynamically instantiated, they must provide a default, no-argument constructor. + Since the policy or the validator are defined via their class name and dynamically loaded, it is important to ensure that the identified class is available to the application server. One way to accomplish that is to deploy the policy implementation as a JAR file in the AS instance deploy directory. Note also that, since both policies and validators are dynamically instantiated, they must provide a default, no-argument constructor. </para> </note> </section>