[gatein-commits] gatein SVN: r8274 - in epp/docs/branches/5.2/Reference_Guide: en-US and 6 other directories.

Author: smumford Date: 2012-01-02 22:42:16 -0500 (Mon, 02 Jan 2012) New Revision: 8274 Modified: epp/docs/branches/5.2/Reference_Guide/en-US/Book_Info.xml epp/docs/branches/5.2/Reference_Guide/en-US/Revision_History.xml epp/docs/branches/5.2/Reference_Guide/en-US/extras/PortalDevelopment_DefaultPortalNavigationConfiguration/navigation.xml epp/docs/branches/5.2/Reference_Guide/en-US/images/DataImportStrategy/navigation1.png epp/docs/branches/5.2/Reference_Guide/en-US/images/DataImportStrategy/navigation2.png epp/docs/branches/5.2/Reference_Guide/en-US/modules/AuthenticationAndIdentity.xml epp/docs/branches/5.2/Reference_Guide/en-US/modules/AuthenticationAndIdentity/BackendConfiguration.xml epp/docs/branches/5.2/Reference_Guide/en-US/modules/AuthenticationAndIdentity/SSO.xml epp/docs/branches/5.2/Reference_Guide/en-US/modules/PortalDevelopment/DataImportStrategy.xml epp/docs/branches/5.2/Reference_Guide/en-US/modules/PortalDevelopment/Skinning.xml epp/docs/branches/5.2/Reference_Guide/en-US/modules/RH-WSRP.xml epp/docs/branches/5.2/Reference_Guide/en-US/modules/WSRP.xml epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR.xml epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/jcr/configuration/exo-jcr-configuration.xml epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/jcr/configuration/jdbc-data-container-config.xml epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/jcr/configuration/search-configuration.xml epp/docs/branches/5.2/Reference_Guide/publican.cfg Log: JBEPP-1468: Port GTNPORTAL-2315 to EPP Modified: epp/docs/branches/5.2/Reference_Guide/en-US/Book_Info.xml =================================================================== --- epp/docs/branches/5.2/Reference_Guide/en-US/Book_Info.xml 2012-01-03 01:03:48 UTC (rev 8273) +++ epp/docs/branches/5.2/Reference_Guide/en-US/Book_Info.xml 2012-01-03 03:42:16 UTC (rev 8274) @@ -9,7 +9,7 @@ <productname>JBoss Enterprise Portal Platform</productname> <productnumber>5.2</productnumber> <edition>5.2.0</edition> - <pubsnumber>18</pubsnumber> + <pubsnumber>100</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 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. Modified: epp/docs/branches/5.2/Reference_Guide/en-US/Revision_History.xml =================================================================== --- epp/docs/branches/5.2/Reference_Guide/en-US/Revision_History.xml 2012-01-03 01:03:48 UTC (rev 8273) +++ epp/docs/branches/5.2/Reference_Guide/en-US/Revision_History.xml 2012-01-03 03:42:16 UTC (rev 8274) @@ -8,7 +8,21 @@ <simpara> <revhistory> <revision> - <revnumber>5.2.0-18</revnumber> + <revnumber>5.2.0-100</revnumber> + <date>Wed Dec 14 2011</date> + <author> + <firstname>Scott</firstname> + <surname>Mumford</surname> + <email></email> + </author> + <revdescription> + <simplelist> + <member>Publication build.</member> + </simplelist> + </revdescription> + </revision> + <revision> + <revnumber>5.2.0-19</revnumber> <date>Fri Dec 9 2011</date> <author> <firstname>Scott</firstname> Modified: epp/docs/branches/5.2/Reference_Guide/en-US/extras/PortalDevelopment_DefaultPortalNavigationConfiguration/navigation.xml =================================================================== --- epp/docs/branches/5.2/Reference_Guide/en-US/extras/PortalDevelopment_DefaultPortalNavigationConfiguration/navigation.xml 2012-01-03 01:03:48 UTC (rev 8273) +++ epp/docs/branches/5.2/Reference_Guide/en-US/extras/PortalDevelopment_DefaultPortalNavigationConfiguration/navigation.xml 2012-01-03 03:42:16 UTC (rev 8274) @@ -1,4 +1,4 @@ -<?xml version="1.0" encoding="ISO-8859-1"?> +<?xml version="1.0" encoding="UTF-8"?> <node-navigation xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.gatein.org/xml/ns/gatein_objects_1_2 http://www.gatein.org/xml/ns/gatein_objects_1_2" Modified: epp/docs/branches/5.2/Reference_Guide/en-US/images/DataImportStrategy/navigation1.png =================================================================== (Binary files differ) Modified: epp/docs/branches/5.2/Reference_Guide/en-US/images/DataImportStrategy/navigation2.png =================================================================== (Binary files differ) Modified: epp/docs/branches/5.2/Reference_Guide/en-US/modules/AuthenticationAndIdentity/BackendConfiguration.xml =================================================================== --- epp/docs/branches/5.2/Reference_Guide/en-US/modules/AuthenticationAndIdentity/BackendConfiguration.xml 2012-01-03 01:03:48 UTC (rev 8273) +++ epp/docs/branches/5.2/Reference_Guide/en-US/modules/AuthenticationAndIdentity/BackendConfiguration.xml 2012-01-03 03:42:16 UTC (rev 8274) @@ -4,7 +4,7 @@ %BOOK_ENTITIES; ]> <section id="sect-Reference_Guide-PicketLink_IDM_integration"> - <title><remark>PicketLink IDM integration</remark></title> + <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. </para> @@ -26,10 +26,11 @@ <para> Additionally, <literal>org.exoplatform.services.organization</literal> <emphasis>membership</emphasis> concept needs to be translated into the IDM <emphasis>Role</emphasis> concept. Therefore <literal>PicketLink IDM</literal> model is used in a limited way. All these translations are applied by the integration layer. </para> - <remark>The "Configuration Files" section has been commented out as the configuration parameters require more work than time allows before the 5.2.0 release.</remark> - <!-- - DOCS NOTE: The content of this section are entirely wrong and needs to be rewritten. The config file in the first programlisting has been updated to the version in EPP 5.2.0, however time constraints prevented this from being actioned before the 5.2.0 GA release. + + <!-- DOCS NOTE: The "Configuration Files" section has been commented out as the configuration parameters require more work than time allows before the 5.2.0 release. + The content of this section are entirely wrong and needs to be rewritten. The config file in the first programlisting has been updated to the version in EPP 5.2.0, however time constraints prevented this from being actioned before the 5.2.0 GA release. + The section above notes that this document does not go into Picketlink IDM Config, so perhaps this section can remain hidden... <section id="sect-Reference_Guide-PicketLink_IDM_integration-Configuration_Files"> Modified: epp/docs/branches/5.2/Reference_Guide/en-US/modules/AuthenticationAndIdentity/SSO.xml =================================================================== --- epp/docs/branches/5.2/Reference_Guide/en-US/modules/AuthenticationAndIdentity/SSO.xml 2012-01-03 01:03:48 UTC (rev 8273) +++ epp/docs/branches/5.2/Reference_Guide/en-US/modules/AuthenticationAndIdentity/SSO.xml 2012-01-03 03:42:16 UTC (rev 8274) @@ -3,8 +3,8 @@ <!ENTITY % BOOK_ENTITIES SYSTEM "Reference_Guide.ent"> %BOOK_ENTITIES; ]> -<section id="sect-Reference_Guide-SSO_Single_Sign_On_"> - <title><remark>SSO - Single Sign On</remark></title> +<section id="sect-Reference_Guide-SSO_Single_Sign_On"> + <title>SSO - Single Sign On</title> <section id="sect-Reference_Guide-SSO_Single_Sign_On_-Overview"> <title>Overview</title> <para> Modified: epp/docs/branches/5.2/Reference_Guide/en-US/modules/AuthenticationAndIdentity.xml =================================================================== --- epp/docs/branches/5.2/Reference_Guide/en-US/modules/AuthenticationAndIdentity.xml 2012-01-03 01:03:48 UTC (rev 8273) +++ epp/docs/branches/5.2/Reference_Guide/en-US/modules/AuthenticationAndIdentity.xml 2012-01-03 03:42:16 UTC (rev 8274) @@ -4,85 +4,15 @@ %BOOK_ENTITIES; ]> <chapter id="chap-Reference_Guide-Authentication_and_Identity"> - <title>Authentication and Identity</title> - <section id="sect-Reference_Guide-Authentication_and_Identity-Password_Encryption"> - <title>Password Encryption</title> - <!-- The warning and first listitem below were relocated from sect-Reference_Guide-Authentication_Token_Configuration as security and plain-text password issues were being expanded on (from JBEPP-610) --> <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. - </para> - - </warning> - <para> - Administrators have two options available to ameliorate this risk: - </para> - <orderedlist> - <listitem> - <para> - The <emphasis>Remember Me</emphasis> feature can be disabled by removing the corresponding checkbox in: <filename><replaceable>&lt;JBOSS_HOME&gt;</replaceable>/server/<replaceable>&lt;PROFILE&gt;</replaceable>/deploy/gatein.ear/02portal.war/login/jsp/login.jsp</filename> and <filename><replaceable>&lt;JBOSS_HOME&gt;</replaceable>/server/<replaceable>&lt;PROFILE&gt;</replaceable>/deploy/gatein.ear/02portal.war/groovy/portal/webui/UILoginForm.gtmpl</filename>. - </para> - - </listitem> - <listitem> - <para> - Passwords can be encoded prior to being saved to the JCR. This option requires administrators to provide a custom subclass of <parameter>org.exoplatform.web.security.security.AbstractCodec</parameter> and set up a codec implementation with <parameter>CookieTokenService</parameter>: - </para> - <procedure id="proc-Reference_Guide-Password_Encryption-Encrypt_Password_in_JCR"> - <title>Encrypt Password in JCR</title> - <step> - <para> - Create a javaclass similar to: - </para> - -<programlisting language="Java" role="Java"><xi:include href="../extras/Authentication_Identity/ExampleCodec.java" parse="text" xmlns:xi="http://www.w3.org/2001/XInclude" /></programlisting> - - </step> - <step> - <para> - Compile the class and package it into a jar file. For this example we will call the jar file <filename>codec-example.jar</filename>. - </para> - - </step> - <step> - <para> - Create a <filename>conf/portal/configuration.xml</filename> file within the <filename>codec-example.jar</filename> similar to the example below. This allows the portal kernel to find and use the new codec implementation. - </para> - -<programlisting language="XML" role="XML"><xi:include href="../extras/Authentication_Identity/configuration.xml" parse="text" xmlns:xi="http://www.w3.org/2001/XInclude" /></programlisting> - - </step> - <step> - <para> - Deploy the <filename>codec-example.jar</filename> into your <filename><replaceable>&lt;JBOSS_HOME&gt;</replaceable>/server/<replaceable>&lt;PROFILE&gt;</replaceable>/deploy/gatein.ear/lib/</filename> directory. - </para> - - </step> - <step> - <para> - Start (or restart) your JBoss Enterprise Portal Platform. - </para> - <para> - Any passwords written to the JCR will now be encoded and not plain text. - </para> - - </step> - - </procedure> - - - </listitem> - - </orderedlist> - - </section> - - <xi:include href="AuthenticationAndIdentity/PredefinedUserConfiguration.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> - <xi:include href="AuthenticationAndIdentity/AuthenticationTokenConfiguration.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> - <xi:include href="AuthenticationAndIdentity/BackendConfiguration.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> - <xi:include href="AuthenticationAndIdentity/OrganizationAPI.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> - <xi:include href="AuthenticationAndIdentity/AccessingUserProfile.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> - <xi:include href="AuthenticationAndIdentity/SSO.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> - <xi:include href="AuthenticationAndIdentity/LDAP.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> + <title>Authentication and Identity</title> + <xi:include href="AuthenticationAndIdentity/AuthenticationAuthorizationOverview.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> + <xi:include href="AuthenticationAndIdentity/PasswordEncryption.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> + <xi:include href="AuthenticationAndIdentity/PredefinedUserConfiguration.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> + <xi:include href="AuthenticationAndIdentity/AuthenticationTokenConfiguration.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> + <xi:include href="AuthenticationAndIdentity/BackendConfiguration.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> + <xi:include href="AuthenticationAndIdentity/OrganizationAPI.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> + <xi:include href="AuthenticationAndIdentity/AccessingUserProfile.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> + <xi:include href="AuthenticationAndIdentity/SSO.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> + <xi:include href="AuthenticationAndIdentity/LDAP.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> </chapter> Modified: epp/docs/branches/5.2/Reference_Guide/en-US/modules/PortalDevelopment/DataImportStrategy.xml =================================================================== --- epp/docs/branches/5.2/Reference_Guide/en-US/modules/PortalDevelopment/DataImportStrategy.xml 2012-01-03 01:03:48 UTC (rev 8273) +++ epp/docs/branches/5.2/Reference_Guide/en-US/modules/PortalDevelopment/DataImportStrategy.xml 2012-01-03 03:42:16 UTC (rev 8274) @@ -4,54 +4,54 @@ %BOOK_ENTITIES; ]> <chapter id="chap-Reference_Guide-Data_Import_Strategy"> - <title>Data Import Strategy</title> - <section id="sect-Reference_Guide-Data_Import_Strategy-Introduction"> - <title>Introduction</title> - <para> - In the Portal extension mechanism, developers can define an extension that Portal data can be customized by configurations in the extension. There are several cases which an extension developer wants to define how to customize the Portal data, for example modifying, overwriting or just inserting a bit into the data defined by the portal. Therefore, GateIn also defines several modes for each case and the only thing which a developer has to do is to clarify the usecase and reasonably configure extensions. - </para> - <para> - This section shows you how data are changes in each mode. - </para> + <title>Data Import Strategy</title> + <section id="sect-Reference_Guide-Data_Import_Strategy-Introduction"> + <title>Introduction</title> + <para> + In the Portal extension mechanism, developers can define an extension that Portal data can be customized by configurations in the extension. There are several cases which an extension developer wants to define how to customize the Portal data, for example modifying, overwriting or just inserting a bit into the data defined by the portal. Therefore, GateIn also defines several modes for each case and the only thing which a developer has to do is to clarify the usecase and reasonably configure extensions. + </para> + <para> + This section shows you how data are changes in each mode. + </para> - </section> - - <section id="sect-Reference_Guide-Data_Import_Strategy-Import_Mode"> - <title>Import Mode</title> - <para> - In this section, the following modes for the import strategy are introduced: - </para> - <itemizedlist> - <listitem> - <para> - <literal>CONSERVE</literal> - </para> + </section> + + <section id="sect-Reference_Guide-Data_Import_Strategy-Import_Mode"> + <title>Import Mode</title> + <para> + In this section, the following modes for the import strategy are introduced: + </para> + <itemizedlist> + <listitem> + <para> + <literal>CONSERVE</literal> + </para> - </listitem> - <listitem> - <para> - <literal>MERGE</literal> - </para> + </listitem> + <listitem> + <para> + <literal>MERGE</literal> + </para> - </listitem> - <listitem> - <para> - <literal>INSERT</literal> - </para> + </listitem> + <listitem> + <para> + <literal>INSERT</literal> + </para> - </listitem> - <listitem> - <para> - <literal>OVERWRITE</literal> - </para> + </listitem> + <listitem> + <para> + <literal>OVERWRITE</literal> + </para> - </listitem> + </listitem> - </itemizedlist> - <para> - Each mode indicates how the Portal data are imported. The import mode value is set whenever <literal>NewPortalConfigListener</literal> is initiated. If the mode is not set, the default value will be used in this case. The default value is configurable as a UserPortalConfigService initial param. For example, the bellow configuration means that default value is <literal>MERGE</literal>. - </para> - + </itemizedlist> + <para> + Each mode indicates how the Portal data are imported. The import mode value is set whenever <literal>NewPortalConfigListener</literal> is initiated. If the mode is not set, the default value will be used in this case. The default value is configurable as a UserPortalConfigService initial param. For example, the bellow configuration means that default value is <literal>MERGE</literal>. + </para> + <programlisting language="XML" role="XML"> &lt;component&gt; &lt;key&gt;org.exoplatform.portal.config.UserPortalConfigService&lt;/key&gt; @@ -68,81 +68,81 @@ &lt;/component&gt; </programlisting> - <para> - The way that the import strategy works with the import mode will be clearly demonstrated in next sections for each type of data. - </para> + <para> + The way that the import strategy works with the import mode will be clearly demonstrated in next sections for each type of data. + </para> - </section> - - <section id="sect-Reference_Guide-Data_Import_Strategy-Data_Import_Strategy"> - <title>Data Import Strategy</title> - <para> - The 'Portal Data' term which has been referred in the previous sections can be classified into three types of object data: Portal Config, Page Data and Navigation Data; each of which has some differences in the import strategy. - </para> - <section id="sect-Reference_Guide-Data_Import_Strategy-Navigation_Data"> - <title>Navigation Data</title> - <para> - The navigation data import strategy will be processed to the import mode level as the followings: - </para> - <itemizedlist> - <listitem> - <para> - <literal>CONSERVE</literal>: If the navigation exists, leave it untouched. Otherwise, import data. - </para> + </section> + + <section id="sect-Reference_Guide-Data_Import_Strategy-Data_Import_Strategy"> + <title>Data Import Strategy</title> + <para> + The 'Portal Data' term which has been referred in the previous sections can be classified into three types of object data: Portal Config, Page Data and Navigation Data; each of which has some differences in the import strategy. + </para> + <section id="sect-Reference_Guide-Data_Import_Strategy-Navigation_Data"> + <title>Navigation Data</title> + <para> + The navigation data import strategy will be processed to the import mode level as the followings: + </para> + <itemizedlist> + <listitem> + <para> + <literal>CONSERVE</literal>: If the navigation exists, leave it untouched. Otherwise, import data. + </para> - </listitem> - <listitem> - <para> - <literal>INSERT</literal>: Insert the missing description data, but add only new nodes. Other modifications remains untouched. - </para> + </listitem> + <listitem> + <para> + <literal>INSERT</literal>: Insert the missing description data, but add only new nodes. Other modifications remains untouched. + </para> - </listitem> - <listitem> - <para> - <literal>MERGE</literal>: Merge the description data, add missing nodes and update same name nodes. - </para> + </listitem> + <listitem> + <para> + <literal>MERGE</literal>: Merge the description data, add missing nodes and update same name nodes. + </para> - </listitem> - <listitem> - <para> - <literal>OVERWRITE</literal>: Always destroy the previous data and recreate it. - </para> + </listitem> + <listitem> + <para> + <literal>OVERWRITE</literal>: Always destroy the previous data and recreate it. + </para> - </listitem> + </listitem> - </itemizedlist> - <para> - In the GateIn navigation structure, each navigation can be referred to a tree which each node links to a page content. Each node contains some description data, such as label, icon, page reference, and more. Therefore, GateIn provides a way to insert or merge new data to the initiated navigation tree or a sub-tree. - </para> - <para> - The merge strategy performs the recursive comparison of child nodes between the existing persistent nodes of a navigation and the transient nodes provided by a descriptor: - </para> - <procedure> - <step> - <para> - Start with the root nodes (which is the effective root node or another node if the parent URI is specified). - </para> + </itemizedlist> + <para> + In the GateIn navigation structure, each navigation can be referred to a tree which each node links to a page content. Each node contains some description data, such as label, icon, page reference, and more. Therefore, GateIn provides a way to insert or merge new data to the initiated navigation tree or a sub-tree. + </para> + <para> + The merge strategy performs the recursive comparison of child nodes between the existing persistent nodes of a navigation and the transient nodes provided by a descriptor: + </para> + <procedure> + <step> + <para> + Start with the root nodes (which is the effective root node or another node if the parent URI is specified). + </para> - </step> - <step> - <para> - Compare the set of child nodes and insert the missing nodes in the persistent nodes. - </para> + </step> + <step> + <para> + Compare the set of child nodes and insert the missing nodes in the persistent nodes. + </para> - </step> - <step> - <para> - Proceed recursively for each child having the same name. - </para> + </step> + <step> + <para> + Proceed recursively for each child having the same name. + </para> - </step> + </step> - </procedure> - - <para> - Let's see the example with two navigation nodes in each import mode. In this case, there are 2 navigation definitions: - </para> - + </procedure> + + <para> + Let's see the example with two navigation nodes in each import mode. In this case, there are 2 navigation definitions: + </para> + <programlisting language="XML" role="XML">&lt;node-navigation&gt; &lt;page-nodes&gt; &lt;node&gt; @@ -159,13 +159,13 @@ &lt;/node&gt; &lt;/page-nodes&gt; &lt;/node-navigation&gt;</programlisting> - <mediaobject> - <imageobject> - <imagedata align="center" fileref="images/DataImportStrategy/navigation1.png" format="PNG" width="444" /> - </imageobject> + <mediaobject> + <imageobject> + <imagedata align="center" fileref="images/DataImportStrategy/navigation1.png" format="PNG" width="444" /> + </imageobject> - </mediaobject> - + </mediaobject> + <programlisting language="XML" role="XML">&lt;node-navigation&gt; &lt;page-nodes&gt; &lt;node&gt; @@ -178,135 +178,137 @@ &lt;/node&gt; &lt;/page-nodes&gt; &lt;/node-navigation&gt;</programlisting> - <mediaobject> - <imageobject> - <imagedata align="center" fileref="images/DataImportStrategy/navigation2.png" format="PNG" width="444" /> - </imageobject> + <mediaobject> + <imageobject> + <imagedata align="center" fileref="images/DataImportStrategy/navigation2.png" format="PNG" width="444" /> + </imageobject> - </mediaobject> - <para> - For example, the <emphasis>navigation1</emphasis> is loaded before <emphasis>navigation2</emphasis>. The Navigation Importer processes on two navigation definitions, depending on the Import Mode defined in portal configuration. - </para> - <variablelist id="vari-Reference_Guide-Navigation_Data-Import_Mode_Cases"> - <title>Import Mode Cases</title> - <varlistentry> - <term>Case 1: <literal>CONSERVE</literal></term> - <listitem> - <para> - With the <literal>CONSERVE</literal> mode, data are only imported when they do not exist. So, if the navigation has been created by the <emphasis>navigation1</emphasis> definition, the <emphasis>navigation2</emphasis> definition does not affect anything on it. We have the result as following - </para> - <mediaobject> - <imageobject> - <imagedata align="center" fileref="images/DataImportStrategy/navigation1.png" format="PNG" width="444" /> - </imageobject> + </mediaobject> + <para> + For example, the <emphasis>navigation1</emphasis> is loaded before <emphasis>navigation2</emphasis>. The Navigation Importer processes on two navigation definitions, depending on the Import Mode defined in portal configuration. + </para> + <variablelist id="vari-Reference_Guide-Navigation_Data-Import_Mode_Cases"> + <title>Import Mode Cases</title> + <varlistentry> + <term>Case 1: <literal>CONSERVE</literal></term> + <listitem> + <para> + With the <literal>CONSERVE</literal> mode, data are only imported when they do not exist. So, if the navigation has been created by the <emphasis>navigation1</emphasis> definition, the <emphasis>navigation2</emphasis> definition does not affect anything on it. We have the result as following + </para> + <mediaobject> + <imageobject role="html"> + <imagedata fileref="images/DataImportStrategy/navigation1.png" format="PNG" align="center"/> + </imageobject> + <imageobject role="fo"> + <imagedata fileref="images/DataImportStrategy/navigation1.png" format="PNG" align="center" width="100mm"/> + </imageobject> + </mediaobject> - </mediaobject> + </listitem> - </listitem> + </varlistentry> + <varlistentry> + <term>Case 2: <literal>INSERT</literal></term> + <listitem> + <para> + If a node does not exist, the importer will add new nodes to the navigation tree. You will see the following result: + </para> + <mediaobject> + <imageobject> + <imagedata align="center" fileref="images/DataImportStrategy/navigation_insert.png" format="PNG" width="444" /> + </imageobject> - </varlistentry> - <varlistentry> - <term>Case 2: <literal>INSERT</literal></term> - <listitem> - <para> - If a node does not exist, the importer will add new nodes to the navigation tree. You will see the following result: - </para> - <mediaobject> - <imageobject> - <imagedata align="center" fileref="images/DataImportStrategy/navigation_insert.png" format="PNG" width="444" /> - </imageobject> + </mediaobject> + <para> + Hereafter, the node 'bar' is added to the navigation tree, because it does not exist in the initiated data. Other nodes are kept in the import process. + </para> - </mediaobject> - <para> - Hereafter, the node 'bar' is added to the navigation tree, because it does not exist in the initiated data. Other nodes are kept in the import process. - </para> + </listitem> - </listitem> + </varlistentry> + <varlistentry> + <term>Case 3: <literal>MERGE</literal></term> + <listitem> + <para> + The <literal>MERGE</literal> mode indicates that a new node is added to the navigation tree, and updates the node data (such node label and node icon in the example) if it exists. + </para> + <mediaobject> + <imageobject> + <imagedata align="center" fileref="images/DataImportStrategy/navigation_merge.png" format="PNG" width="444" /> + </imageobject> - </varlistentry> - <varlistentry> - <term>Case 3: <literal>MERGE</literal></term> - <listitem> - <para> - The <literal>MERGE</literal> mode indicates that a new node is added to the navigation tree, and updates the node data (such node label and node icon in the example) if it exists. - </para> - <mediaobject> - <imageobject> - <imagedata align="center" fileref="images/DataImportStrategy/navigation_merge.png" format="PNG" width="444" /> - </imageobject> + </mediaobject> - </mediaobject> + </listitem> - </listitem> + </varlistentry> + <varlistentry> + <term>Case 4: <literal>OVERWRITE</literal></term> + <listitem> + <para> + Everything will be destroyed and replaced with new data if the <literal>OVERWRITE</literal> mode is used. + </para> + <mediaobject> + <imageobject> + <imagedata align="center" fileref="images/DataImportStrategy/navigation2.png" format="PNG" width="444" /> + </imageobject> - </varlistentry> - <varlistentry> - <term>Case 4: <literal>OVERWRITE</literal></term> - <listitem> - <para> - Everything will be destroyed and replaced with new data if the <literal>OVERWRITE</literal> mode is used. - </para> - <mediaobject> - <imageobject> - <imagedata align="center" fileref="images/DataImportStrategy/navigation2.png" format="PNG" width="444" /> - </imageobject> + </mediaobject> - </mediaobject> + </listitem> - </listitem> + </varlistentry> - </varlistentry> + </variablelist> - </variablelist> + </section> + + <section id="sect-Reference_Guide-Data_Import_Strategy-Portal_Config"> + <title>Portal Config</title> + <para> + PortalConfig defines the portal name, permission, layout and some properties of a site. These information are configured in the <emphasis>portal.xml</emphasis>, <emphasis>group.xml</emphasis> or <emphasis>user.xml</emphasis>, depending on the site type. The PortalConfig importer performs a strategy that is based on the mode defined in NewPortalConfigListener, including <literal>CONSERVE</literal>, <literal>INSERT</literal>, <literal>MERGE</literal> or <literal>OVERWRITE</literal>. Let's see how the import mode affects in the process of portal data performance: + </para> + <itemizedlist> + <listitem> + <para> + <literal>CONSERVE</literal>: There is nothing to be imported. The existing data will be kept without any changes. + </para> - </section> - - <section id="sect-Reference_Guide-Data_Import_Strategy-Portal_Config"> - <title>Portal Config</title> - <para> - PortalConfig defines the portal name, permission, layout and some properties of a site. These information are configured in the <emphasis>portal.xml</emphasis>, <emphasis>group.xml</emphasis> or <emphasis>user.xml</emphasis>, depending on the site type. The PortalConfig importer performs a strategy that is based on the mode defined in NewPortalConfigListener, including <literal>CONSERVE</literal>, <literal>INSERT</literal>, <literal>MERGE</literal> or <literal>OVERWRITE</literal>. Let's see how the import mode affects in the process of portal data performance: - </para> - <itemizedlist> - <listitem> - <para> - <literal>CONSERVE</literal>: There is nothing to be imported. The existing data will be kept without any changes. - </para> + </listitem> + <listitem> + <para> + <literal>INSERT</literal>: When the portal config does not exist, create the new portal defined by the portal config definition. Otherwise, do nothing. + </para> - </listitem> - <listitem> - <para> - <literal>INSERT</literal>: When the portal config does not exist, create the new portal defined by the portal config definition. Otherwise, do nothing. - </para> + </listitem> + <listitem> + <para> + <literal>MERGE</literal> and <literal>OVERWRITE</literal> have the same behavior. The new portal config will be created if it does not exist or update portal properties defined by the portal config definition. + </para> - </listitem> - <listitem> - <para> - <literal>MERGE</literal> and <literal>OVERWRITE</literal> have the same behavior. The new portal config will be created if it does not exist or update portal properties defined by the portal config definition. - </para> + </listitem> - </listitem> + </itemizedlist> - </itemizedlist> + </section> + + <section id="sect-Reference_Guide-Data_Import_Strategy-Page_Data"> + <title>Page Data</title> + <para> + The import mode affects the page data import as the same as Portal Config. + </para> + <note> + <para> + If the Import mode is <literal>CONSERVE</literal> or <literal>INSERT</literal>, the data import strategy always performs as the <literal>MERGE</literal> mode in the first data initialization of the Portal. + </para> - </section> - - <section id="sect-Reference_Guide-Data_Import_Strategy-Page_Data"> - <title>Page Data</title> - <para> - The import mode affects the page data import as the same as Portal Config. - </para> - <note> - <para> - If the Import mode is <literal>CONSERVE</literal> or <literal>INSERT</literal>, the data import strategy always performs as the <literal>MERGE</literal> mode in the first data initialization of the Portal. - </para> + </note> - </note> + </section> + - </section> - + </section> + - </section> - - </chapter> Modified: epp/docs/branches/5.2/Reference_Guide/en-US/modules/PortalDevelopment/Skinning.xml =================================================================== --- epp/docs/branches/5.2/Reference_Guide/en-US/modules/PortalDevelopment/Skinning.xml 2012-01-03 01:03:48 UTC (rev 8273) +++ epp/docs/branches/5.2/Reference_Guide/en-US/modules/PortalDevelopment/Skinning.xml 2012-01-03 03:42:16 UTC (rev 8274) @@ -462,7 +462,7 @@ </section> <section id="sect-Reference_Guide-Creating_New_Skins-How_to_Create_New_Portlet_Skins"> - <title><remark>How to Create New Portlet Skins</remark></title> + <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>. @@ -493,7 +493,7 @@ </note> <section id="sect-Reference_Guide-How_to_Create_New_Portlet_Skins-Define_a_Custom_CSS_File"> - <title><remark>Define a Custom CSS File</remark></title> + <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: @@ -538,7 +538,7 @@ <term><filename>WEB-INF/gatein-resources.xml</filename>:</term> <listitem> -<programlisting><![CDATA[<portlet-skin> +<programlisting language="XML" role="XML"><![CDATA[<portlet-skin> <application-name>custom</application-name> <portlet-name>test</portlet-name> <skin-name>Default</skin-name> @@ -569,7 +569,7 @@ <term><filename>WEB-INF/web.xml</filename>:</term> <listitem> -<programlisting><![CDATA[<display-name>custom</display-name> +<programlisting language="XML" role="XML"><![CDATA[<display-name>custom</display-name> <filter> <filter-name>ResourceRequestFilter</filter-name> @@ -605,7 +605,7 @@ <term><filename>WEB-INF/portlet.xml</filename>:</term> <listitem> -<programlisting><![CDATA[<portlet-name>test</portlet-name> +<programlisting language="XML" role="XML"><![CDATA[<portlet-name>test</portlet-name> ]]></programlisting> <note> <title>Note:</title> @@ -751,12 +751,14 @@ <para> Left margin left pattern is a technique to create two blocks side by side. The left block will have a fixed size and the right block will take the rest of the available space. When the user resizes the browser the added or removed space will be taken from the right block. </para> - - <mediaobject> - <imageobject> - <imagedata fileref="images/PortalDevelopment/Skinning/leftMarginPattern.png" format="PNG" width="303" /> - </imageobject> - </mediaobject> + <mediaobject> + <imageobject role="html"> + <imagedata fileref="images/PortalDevelopment/Skinning/leftMarginPattern.png" format="PNG" align="center"/> + </imageobject> + <imageobject role="fo"> + <imagedata fileref="images/PortalDevelopment/Skinning/leftMarginPattern.png" format="PNG" align="center" width="100mm"/> + </imageobject> + </mediaobject> <programlisting language="XML" role="XML"><xi:include href="../../extras/PortalDevelopment_Skinning/default194.xml" parse="text" xmlns:xi="http://www.w3.org/2001/XInclude" /></programlisting> </section> </section> Modified: epp/docs/branches/5.2/Reference_Guide/en-US/modules/RH-WSRP.xml =================================================================== --- epp/docs/branches/5.2/Reference_Guide/en-US/modules/RH-WSRP.xml 2012-01-03 01:03:48 UTC (rev 8273) +++ epp/docs/branches/5.2/Reference_Guide/en-US/modules/RH-WSRP.xml 2012-01-03 03:42:16 UTC (rev 8274) @@ -4,7 +4,7 @@ %BOOK_ENTITIES; ]> <chapter id="chap-Reference_Guide-Web_Services_for_Remote_Portlets_WSRP"> - <title><remark>Web Services for Remote Portlets (WSRP)</remark></title> + <title>Web Services for Remote Portlets (WSRP)</title> <section id="sect-Reference_Guide-Web_Services_for_Remote_Portlets_WSRP-Introduction"> <title>Introduction</title> <para> Modified: epp/docs/branches/5.2/Reference_Guide/en-US/modules/WSRP.xml =================================================================== --- epp/docs/branches/5.2/Reference_Guide/en-US/modules/WSRP.xml 2012-01-03 01:03:48 UTC (rev 8273) +++ epp/docs/branches/5.2/Reference_Guide/en-US/modules/WSRP.xml 2012-01-03 03:42:16 UTC (rev 8274) @@ -4,7 +4,7 @@ %BOOK_ENTITIES; ]> <chapter id="wsrp"> - <title><remark>Web Services for Remote Portlets (WSRP)</remark></title> + <title>Web Services for Remote Portlets (WSRP)</title> <section> <title>Introduction</title> Modified: epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/jcr/configuration/exo-jcr-configuration.xml =================================================================== --- epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/jcr/configuration/exo-jcr-configuration.xml 2012-01-03 01:03:48 UTC (rev 8273) +++ epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/jcr/configuration/exo-jcr-configuration.xml 2012-01-03 03:42:16 UTC (rev 8274) @@ -4,7 +4,7 @@ %BOOK_ENTITIES; ]> <chapter id="chap-Reference_Guide-JCR_configuration"> - <title><remark>JCR configuration</remark></title> + <title>JCR configuration</title> <para> The JCR configuration is defined in an XML file which is constructed as per the DTD below: </para> Modified: epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/jcr/configuration/jdbc-data-container-config.xml =================================================================== --- epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/jcr/configuration/jdbc-data-container-config.xml 2012-01-03 01:03:48 UTC (rev 8273) +++ epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/jcr/configuration/jdbc-data-container-config.xml 2012-01-03 03:42:16 UTC (rev 8274) @@ -342,7 +342,7 @@ </section> <section id="sect-Reference_Guide-JDBC_Data_Container_Config-Multi_database_Configuration"> - <title><remark>Multi-database Configuration</remark></title> + <title>Multi-database Configuration</title> <para> You need to configure each workspace in a repository as part of multi-database configuration. Databases may reside on remote servers as required. </para> @@ -366,7 +366,7 @@ <itemizedlist> <listitem> <para> - <parameter><remark>driverClassName</remark></parameter>, e.g. "org.hsqldb.jdbcDriver", "com.mysql.jdbc.Driver", "org.postgresql.Driver" + <parameter>driverClassName</parameter>, e.g. "org.hsqldb.jdbcDriver", "com.mysql.jdbc.Driver", "org.postgresql.Driver" </para> </listitem> Modified: epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/jcr/configuration/search-configuration.xml =================================================================== --- epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/jcr/configuration/search-configuration.xml 2012-01-03 01:03:48 UTC (rev 8273) +++ epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/jcr/configuration/search-configuration.xml 2012-01-03 03:42:16 UTC (rev 8274) @@ -4,7 +4,7 @@ %BOOK_ENTITIES; ]> <chapter id="chap-Reference_Guide-Search_Configuration"> - <title><remark>Search Configuration</remark></title> + <title>Search Configuration</title> <para> The search function in JCR can be configured to perform in specific ways. This section will discuss configuring the search function to improve search performance and results. </para> Modified: epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR.xml =================================================================== --- epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR.xml 2012-01-03 01:03:48 UTC (rev 8273) +++ epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR.xml 2012-01-03 03:42:16 UTC (rev 8274) @@ -4,7 +4,7 @@ %BOOK_ENTITIES; ]> <part id="part-Reference_Guide-The_Java_Content_Repository_"> - <title><remark>The Java Content Repository</remark></title> + <title>The Java Content Repository</title> <!-- <xi:include href="eXoJCR/eXoJCR/jcr.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> --> <xi:include href="eXoJCR/jcr/intro.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> <!--concepts --> Modified: epp/docs/branches/5.2/Reference_Guide/publican.cfg =================================================================== --- epp/docs/branches/5.2/Reference_Guide/publican.cfg 2012-01-03 01:03:48 UTC (rev 8273) +++ epp/docs/branches/5.2/Reference_Guide/publican.cfg 2012-01-03 03:42:16 UTC (rev 8274) @@ -3,7 +3,7 @@ cvs_root: ":ext:cvs.devel.redhat.com:/cvs/dist" cvs_branch: "DOCS-RHEL-6" -show_remarks: 1 +#show_remarks: 1 cvs_pkg: "JBoss_Enterprise_Portal_Platform-Reference_Guide-5.2-web-__LANG__" xml_lang: "en-US" brand: JBoss