[gatein-commits] gatein SVN: r5329 - in epp/docs/branches/EPP_5_1_Branch/Reference_Guide/en-US: extras/Authentication_Identity_PredefinedUserConfiguration and 7 other directories.

Author: smumford Date: 2010-11-29 00:53:36 -0500 (Mon, 29 Nov 2010) New Revision: 5329 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/Revision_History.xml epp/docs/branches/EPP_5_1_Branch/Reference_Guide/en-US/extras/Authentication_Identity_PredefinedUserConfiguration/default101.xml epp/docs/branches/EPP_5_1_Branch/Reference_Guide/en-US/extras/PortalDevelopment_DefaultPortalPermissionConfiguration/default145.xml epp/docs/branches/EPP_5_1_Branch/Reference_Guide/en-US/extras/PortalDevelopment_InternationalizationConfiguration/default148.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/configuration.xml epp/docs/branches/EPP_5_1_Branch/Reference_Guide/en-US/modules/Advanced/JCR/external-value-storages.xml epp/docs/branches/EPP_5_1_Branch/Reference_Guide/en-US/modules/Advanced/JCR/intro.xml epp/docs/branches/EPP_5_1_Branch/Reference_Guide/en-US/modules/Advanced/JCR/jbosscache-configuration-templates.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/AuthenticationTokenConfiguration.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/PredefinedUserConfiguration.xml epp/docs/branches/EPP_5_1_Branch/Reference_Guide/en-US/modules/PortalDevelopment/DefaultPortalConfiguration.xml epp/docs/branches/EPP_5_1_Branch/Reference_Guide/en-US/modules/PortalDevelopment/DefaultPortalNavigationConfiguration.xml epp/docs/branches/EPP_5_1_Branch/Reference_Guide/en-US/modules/PortalDevelopment/DefaultPortalPermissionConfiguration.xml epp/docs/branches/EPP_5_1_Branch/Reference_Guide/en-US/modules/PortalDevelopment/InternationalizationConfiguration.xml epp/docs/branches/EPP_5_1_Branch/Reference_Guide/en-US/modules/PortalDevelopment/RTLFramework.xml epp/docs/branches/EPP_5_1_Branch/Reference_Guide/en-US/modules/WSRP.xml Log: JBEPP-517: Updated based on QE feedback. 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-29 05:09:51 UTC (rev 5328) +++ epp/docs/branches/EPP_5_1_Branch/Reference_Guide/en-US/Book_Info.xml 2010-11-29 05:53:36 UTC (rev 5329) @@ -9,7 +9,7 @@ <productname>JBoss Enterprise Portal Platform</productname> <productnumber>5</productnumber> <edition>1</edition> - <pubsnumber>1.18</pubsnumber> + <pubsnumber>1.19</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/Revision_History.xml =================================================================== --- epp/docs/branches/EPP_5_1_Branch/Reference_Guide/en-US/Revision_History.xml 2010-11-29 05:09:51 UTC (rev 5328) +++ epp/docs/branches/EPP_5_1_Branch/Reference_Guide/en-US/Revision_History.xml 2010-11-29 05:53:36 UTC (rev 5329) @@ -8,6 +8,20 @@ <simpara> <revhistory> <revision> + <revnumber>1-1.19</revnumber> + <date>Mon Nov 29 2010</date> + <author> + <firstname>Scott</firstname> + <surname>Mumford</surname> + <email&gt;smumford(a)redhat.com&lt;/email&gt; + </author> + <revdescription> + <simplelist> + <member>Added Localization Configuration chapter. Incorporated QA feedback.</member> + </simplelist> + </revdescription> + </revision> + <revision> <revnumber>1-1.18</revnumber> <date>Wed Nov 17 2010</date> <author> Modified: epp/docs/branches/EPP_5_1_Branch/Reference_Guide/en-US/extras/Authentication_Identity_PredefinedUserConfiguration/default101.xml =================================================================== --- epp/docs/branches/EPP_5_1_Branch/Reference_Guide/en-US/extras/Authentication_Identity_PredefinedUserConfiguration/default101.xml 2010-11-29 05:09:51 UTC (rev 5328) +++ epp/docs/branches/EPP_5_1_Branch/Reference_Guide/en-US/extras/Authentication_Identity_PredefinedUserConfiguration/default101.xml 2010-11-29 05:53:36 UTC (rev 5329) @@ -12,7 +12,7 @@ <collection type="java.util.ArrayList"> <value> <object type="org.exoplatform.services.organization.impl.NewUserConfig$JoinGroup"> - <field name="groupId"><string>/user</string></field> + <field name="groupId"><string>/platform/users</string></field> <field name="membership"><string>member</string></field> </object> </value> Modified: epp/docs/branches/EPP_5_1_Branch/Reference_Guide/en-US/extras/PortalDevelopment_DefaultPortalPermissionConfiguration/default145.xml =================================================================== --- epp/docs/branches/EPP_5_1_Branch/Reference_Guide/en-US/extras/PortalDevelopment_DefaultPortalPermissionConfiguration/default145.xml 2010-11-29 05:09:51 UTC (rev 5328) +++ epp/docs/branches/EPP_5_1_Branch/Reference_Guide/en-US/extras/PortalDevelopment_DefaultPortalPermissionConfiguration/default145.xml 2010-11-29 05:53:36 UTC (rev 5329) @@ -24,10 +24,17 @@ <description>guests group</description> <value>/platform/guests</value> </value-param> - <value-param> - <name>access.control.workspace</name> - <description>groups with memberships that have the right to access the User Control Workspace</description> - <value>*:/platform/administrators,*:/organization/management/executive-board</value> - </value-param> + <values-param> + <name>mandatory.groups</name> + <description>Groups that can not be deleted.</description> + <value>/platform/administrators</value> + <value>/platform/users</value> + <value>/platform/guests</value> + </values-param> + <values-param> + <name>mandatory.mstypes</name> + <description>Membership type that can not be deleted.</description> + <value>member</value> + </values-param> </init-params> </component> Modified: epp/docs/branches/EPP_5_1_Branch/Reference_Guide/en-US/extras/PortalDevelopment_InternationalizationConfiguration/default148.java =================================================================== --- epp/docs/branches/EPP_5_1_Branch/Reference_Guide/en-US/extras/PortalDevelopment_InternationalizationConfiguration/default148.java 2010-11-29 05:09:51 UTC (rev 5328) +++ epp/docs/branches/EPP_5_1_Branch/Reference_Guide/en-US/extras/PortalDevelopment_InternationalizationConfiguration/default148.java 2010-11-29 05:53:36 UTC (rev 5329) @@ -1 +1 @@ -javax.portlet.title=Portlet Navigation +javax.portlet.title=Portlet de navegaci\u00f3n \ No newline at end of file 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-29 05:09:51 UTC (rev 5328) +++ epp/docs/branches/EPP_5_1_Branch/Reference_Guide/en-US/modules/Advanced/Foundations.xml 2010-11-29 05:53:36 UTC (rev 5329) @@ -35,7 +35,6 @@ <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>. </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. Modified: epp/docs/branches/EPP_5_1_Branch/Reference_Guide/en-US/modules/Advanced/JCR/configuration.xml =================================================================== --- epp/docs/branches/EPP_5_1_Branch/Reference_Guide/en-US/modules/Advanced/JCR/configuration.xml 2010-11-29 05:09:51 UTC (rev 5328) +++ epp/docs/branches/EPP_5_1_Branch/Reference_Guide/en-US/modules/Advanced/JCR/configuration.xml 2010-11-29 05:53:36 UTC (rev 5329) @@ -13,7 +13,7 @@ <programlisting language="Java" role="Java"><xi:include parse="text" href="../../../extras/Advanced_Development_JCR_Configuration/NMTOKEN.java" xmlns:xi="http://www.w3.org/2001/XInclude" /></programlisting> <para> - To modify the configuration of the JCR Service, you would need to modify the file found at <filename>/<replaceable>JBOSS_AS</replaceable>/server/<replaceable>PROFILE</replaceable>/deploy/gatein.ear/02portal.war/WEB-INF/conf/jcr/repository-configuration.xml</filename>. + To modify the configuration of the JCR Service, you would need to modify the file found at <filename><replaceable>JBOSS_HOME</replaceable>/server/<replaceable>PROFILE</replaceable>/deploy/gatein.ear/02portal.war/WEB-INF/conf/jcr/repository-configuration.xml</filename>. </para> <programlisting><![CDATA[ @@ -32,139 +32,131 @@ </repositories> </repository-service>]]> </programlisting> - <procedure> - <step> - <para> - In JBoss Enteprise Portal Platform you will see several configured workspaces required for the portal. - <itemizedlist> - <listitem> - <para> - <literal>system</literal> - </para> - </listitem> - <listitem> - <para> - <literal>portal-system</literal>: To store portal metadata such as page compositions - </para> - </listitem> - <listitem> - <para> - <literal>portal-work</literal>: To store elements that are temporary such as tokens - </para> - </listitem> - <listitem> - <para> - <literal>wsrp-system</literal>: To store WSRP related data - </para> - </listitem> - <listitem> - <para> - <literal>wsrp-system</literal>: To store Portlet Container related data (such as portlet preferences - </para> - </listitem> - - </itemizedlist> - </para> - </step> - <step> - <para> - Locate the workspace to modify. + <para> + In JBoss Enterprise Portal Platform you will see several configured workspaces required for the portal. + </para> + <orderedlist numeration="arabic"> + <listitem> + <para> + <literal>system</literal> + </para> + </listitem> + <listitem> + <para> + <literal>portal-system</literal>: To store portal metadata such as page compositions. </para> - </step> - <step> - <para> - The repository configuration supports human-readable values. They are not case-sensitive. - </para> - <para> - Complete the appropriate element fields using the following value formats: - </para> - <variablelist> - <varlistentry> - <term>Number formats:</term> - <listitem> - <para> - <itemizedlist> - <listitem> - <para> - <emphasis role="bold">K</emphasis> or <emphasis role="bold">KB</emphasis> for kiloBytes. - </para> - </listitem> - <listitem> - <para> - <emphasis role="bold">M</emphasis> or <emphasis role="bold">MB</emphasis> for megaBytes. - </para> - </listitem> - <listitem> - <para> - <emphasis role="bold">G</emphasis> or <emphasis role="bold">GB</emphasis> for gigaBytes. - </para> - </listitem> - <listitem> - <para> - <emphasis role="bold">T</emphasis> or <emphasis role="bold">TB</emphasis> for terraBytes. - </para> - </listitem> - <listitem> - <para> - Examples: 200k or 200 KBytes; 4m or 4 MBytes; 1.4G or 1.4 GBytes; 10T or 10 TBytes - </para> - </listitem> - </itemizedlist> - </para> - </listitem> - </varlistentry> - <varlistentry> - <term>Time formats:</term> - <listitem> - <para> - <itemizedlist> - <listitem> - <para> - <emphasis role="bold">ms</emphasis> for milliseconds. - </para> - </listitem> - <listitem> - <para> - <emphasis role="bold">s</emphasis> for seconds. - </para> - </listitem> - <listitem> - <para> - <emphasis role="bold">m</emphasis> for minutes. - </para> - </listitem> - <listitem> - <para> - <emphasis role="bold">h</emphasis> for hours. - </para> - </listitem> - <listitem> - <para> - <emphasis role="bold">d</emphasis> for days. - </para> - </listitem> - <listitem> - <para> - <emphasis role="bold">w</emphasis> for weeks. - </para> - </listitem> - <listitem> - <para> - The default time format is seconds if no other format is specified. - </para> - </listitem> - <listitem> - <para> - Examples: 500ms or 500 milliseconds; 20, 20s or 20 seconds; 30m or 30 minutes; 12h or 12 hours; 5d or 5 days; 4w or 4 weeks. - </para> - </listitem> - </itemizedlist> - </para> - </listitem> - </varlistentry> - </variablelist> - </step> - </procedure> + </listitem> + <listitem> + <para> + <literal>portal-work</literal>: To store elements that are temporary such as tokens + </para> + </listitem> + <listitem> + <para> + <literal>wsrp-system</literal>: To store WSRP related data + </para> + </listitem> + <listitem> + <para> + <literal>wsrp-system</literal>: To store Portlet Container related data (such as portlet preferences + </para> + </listitem> + </orderedlist> + <para> + Configure the workspaces by locating the workspace you need to modify in <filename><filename><replaceable>JBOSS_HOME</replaceable>/server/<replaceable>PROFILE</replaceable>/deploy/gatein.ear/02portal.war/WEB-INF/conf/jcr/repository-configuration.xml</filename></filename>. + </para> + <para> + The repository configuration supports human-readable values. They are not case-sensitive. + </para> + <para> + Complete the appropriate element fields using the following value formats: + </para> + <variablelist> + <varlistentry> + <term>Number formats:</term> + <listitem> + <para> + <itemizedlist> + <listitem> + <para> + <emphasis role="bold">K</emphasis> or <emphasis role="bold">KB</emphasis> for kiloBytes. + </para> + </listitem> + <listitem> + <para> + <emphasis role="bold">M</emphasis> or <emphasis role="bold">MB</emphasis> for megaBytes. + </para> + </listitem> + <listitem> + <para> + <emphasis role="bold">G</emphasis> or <emphasis role="bold">GB</emphasis> for gigaBytes. + </para> + </listitem> + <listitem> + <para> + <emphasis role="bold">T</emphasis> or <emphasis role="bold">TB</emphasis> for terraBytes. + </para> + </listitem> + <listitem> + <para> + Examples: 200K or 200KB; 4M or 4MB; 1.4G or 1.4GB; 10T or 10TB. + </para> + </listitem> + </itemizedlist> + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>Time formats:</term> + <listitem> + <para> + <itemizedlist> + <listitem> + <para> + <emphasis role="bold">ms</emphasis> for milliseconds. + </para> + </listitem> + <listitem> + <para> + <emphasis role="bold">s</emphasis> for seconds. + </para> + </listitem> + <listitem> + <para> + <emphasis role="bold">m</emphasis> for minutes. + </para> + </listitem> + <listitem> + <para> + <emphasis role="bold">h</emphasis> for hours. + </para> + </listitem> + <listitem> + <para> + <emphasis role="bold">d</emphasis> for days. + </para> + </listitem> + <listitem> + <para> + <emphasis role="bold">w</emphasis> for weeks. + </para> + </listitem> + <listitem> + <para> + The default time format is seconds if no other format is specified. + </para> + </listitem> + <listitem> + <para> + Examples: 500ms or 500 milliseconds; 20, 20s or 20 seconds; 30m or 30 minutes; 12h or 12 hours; 5d or 5 days; 4w or 4 weeks. + </para> + </listitem> + </itemizedlist> + </para> + </listitem> + </varlistentry> + </variablelist> + <section id="sect-Reference_Guide-Portal_and_Standalone_configuration-Repository_service_configuration"> <title>Example of the portal-system workspace</title> <!--DOCS NOTE: The callout configuration below is not rerndering correctly in Publican builds. The callout list icons do not rener from number 15 onwards. --> Modified: epp/docs/branches/EPP_5_1_Branch/Reference_Guide/en-US/modules/Advanced/JCR/external-value-storages.xml =================================================================== --- epp/docs/branches/EPP_5_1_Branch/Reference_Guide/en-US/modules/Advanced/JCR/external-value-storages.xml 2010-11-29 05:09:51 UTC (rev 5328) +++ epp/docs/branches/EPP_5_1_Branch/Reference_Guide/en-US/modules/Advanced/JCR/external-value-storages.xml 2010-11-29 05:53:36 UTC (rev 5329) @@ -27,7 +27,7 @@ <section id="sect-Reference_Guide-External_Value_Storages-Tree_File_Value_Storage"> <title>Tree File Value Storage</title> <para> - Tree File Value Storage holds values in tree-like FileSystem files. <property>Path</property> property points to the root directory to store the files. + Tree File Value Storage holds values in tree-like file system files. <property>Path</property> property points to the root directory to store the files. </para> <para> This is a recommended type of external storage because it can contain large amount of files limited only by disk/volume free space. @@ -91,7 +91,7 @@ </para> </note> <para> -Holds Values in flat FileSystem files. <property>path</property> property points to root directory in order to store files +Holds Values in flat file system files. <property>path</property> property points to root directory in order to store files </para> <programlisting language="Java" role="Java"><xi:include parse="text" href="../../../extras/Advanced_Development_JCR_external-value-storages/default27.java" xmlns:xi="http://www.w3.org/2001/XInclude" /></programlisting> <programlisting>&lt;value-storage id="Storage #1" class="org.exoplatform.services.jcr.impl.storage.value.fs.SimpleFileValueStorage"&gt; @@ -161,8 +161,11 @@ <term>vcas-type</term> <listitem> <para> - Value CAS internal data type, JDBC backed is currently implemented <literal>org.exoplatform.services.jcr.impl.storage.value.cas.JDBCValueContentAddressStorageImpl</literal>. + Value CAS internal data type, JDBC backed is currently implemented: </para> + <para> + <literal>org.exoplatform.services.jcr.impl.storage.value.cas.JDBCValueContentAddressStorageImpl</literal> + </para> </listitem> </varlistentry> <varlistentry> Modified: epp/docs/branches/EPP_5_1_Branch/Reference_Guide/en-US/modules/Advanced/JCR/intro.xml =================================================================== --- epp/docs/branches/EPP_5_1_Branch/Reference_Guide/en-US/modules/Advanced/JCR/intro.xml 2010-11-29 05:09:51 UTC (rev 5328) +++ epp/docs/branches/EPP_5_1_Branch/Reference_Guide/en-US/modules/Advanced/JCR/intro.xml 2010-11-29 05:53:36 UTC (rev 5329) @@ -18,7 +18,7 @@ The term <emphasis role="bold">JCR</emphasis> refers to the Java Content Repository. The JCR is the data store of JBoss Enterprise Portal Platform. All content is stored and managed via the JCR. </para> <para> - The eXo JCR included with JBoss Enterprise Portal Platform 5.1 is a (<ulink type="http" url="http://www.jcp.org/en/jsr/detail?id=170">JSR-170</ulink>) compliant implementation of the JCR 1.0 specification. The JCR provides versioning, textual search, access control, content event monitoring, and is used to storing text and binary data for the portal internal usage. The backend storage of the JCR is configurable and can be a filesystem or a database. + The eXo JCR included with JBoss Enterprise Portal Platform 5.1 is a (<ulink type="http" url="http://www.jcp.org/en/jsr/detail?id=170">JSR-170</ulink>) compliant implementation of the JCR 1.0 specification. The JCR provides versioning, textual search, access control, content event monitoring, and is used to storing text and binary data for the portal internal usage. The backend storage of the JCR is configurable and can be a file system or a database. </para> <section id="sect-Reference_Guide-Introduction-Concepts"> <title>Concepts</title> Modified: epp/docs/branches/EPP_5_1_Branch/Reference_Guide/en-US/modules/Advanced/JCR/jbosscache-configuration-templates.xml =================================================================== --- epp/docs/branches/EPP_5_1_Branch/Reference_Guide/en-US/modules/Advanced/JCR/jbosscache-configuration-templates.xml 2010-11-29 05:09:51 UTC (rev 5328) +++ epp/docs/branches/EPP_5_1_Branch/Reference_Guide/en-US/modules/Advanced/JCR/jbosscache-configuration-templates.xml 2010-11-29 05:53:36 UTC (rev 5329) @@ -5,6 +5,54 @@ ]> <section id="sect-Reference_Guide-JBoss_Cache_configuration"> <title>JBoss Cache configuration</title> + <note> + <title>DOC REVIEW:</title> + <para> + The paragraphs below have been added based on QE feedback. Please review for technical accuracy. + </para> + </note> + <para> + JCR workspaces and their caches are configured in <filename>server/<replaceable>&lt;PROFILE&gt;</replaceable>/deploy/gatein.ear/02portal.war/WEB-INF/conf/jcr/repository-configuration.xml</filename>. + </para> + <para> + Parameterized properties will be replaced with actual parameters defined in <filename>jboss-as/server/<replaceable>&lt;PROFILE&gt;</replaceable>/conf/gatein/configuration.properties</filename> file. + </para> + <para> + Refer the examples below for an active illustration of this parameter handling: + </para> +<example> +<title><filename>repository-configuration.xml</filename></title> +<programlisting language="XML" role="XML"><![CDATA[<properties> + <property name="source-name" value="${gatein.jcr.datasource.name}${container.name.suffix}"/> + <property name="dialect" value="${gatein.jcr.datasource.dialect}"/> + <property name="multi-db" value="false"/> + <property name="update-storage" value="true"/> + <property name="max-buffer-size" value="204800"/> + <property name="swap-directory" value="${gatein.jcr.data.dir}/system${container.name.suffix}"/> +</properties>]]> +</programlisting> +</example> + +<example> +<title><filename>configuration.properties</filename></title> +<programlisting><![CDATA[# JCR +gatein.jcr.config.type=local +gatein.jcr.datasource.name=java:gatein-jcr +gatein.jcr.datasource.dialect=auto + +gatein.jcr.data.dir=${gatein.data.dir}/jcr +gatein.jcr.storage.data.dir=${gatein.jcr.data.dir}/values +gatein.jcr.index.data.dir=${gatein.jcr.data.dir}/lucene +gatein.jcr.index.changefilterclass=org.exoplatform.services.jcr.impl.core.query.DefaultChangesFilter +</properties>]]> +</programlisting> +</example> + <para> + The JBoss cache and jgroups configuration files are located inside the <filename>server/<replaceable>&lt;PROFILE&gt;</replaceable>/deploy/gatein.ear/lib/exo.portal.component.common-<replaceable>&lt;VERSION&gt;</replaceable>.jar</filename> file. + </para> + <para> + Within this jar the files are located at <filename>/conf/jcr/jbosscache/${gatein.jcr.config.type}</filename> (<literal>${gatein.jcr.config.type}</literal> is defined in <filename>configuration.properties</filename> and denotes either <filename>cluster</filename> or <filename>local</filename> directories). + </para> <section id="sect-Reference_Guide-JBoss_Cache_configuration-Indexer_Lock_Manager_and_Data_Container"> <title>Indexer, Lock Manager and Data Container</title> <para> @@ -16,7 +64,6 @@ <para> For example: </para> - <programlisting language="XML" role="XML"><xi:include href="../../../extras/Advanced_Development_JCR_jbosscache-configuration-templates/default29.xml" parse="text" xmlns:xi="http://www.w3.org/2001/XInclude" /></programlisting> <para> If there are many workspaces, however, configuring them in such a way can be hard to manage. Therefore the JCR offers a template-based configuration method for JBoss Cache instances. @@ -24,7 +71,8 @@ <para> Administrators can use one template for the lock manager, another for the indexer and a third for the data container and then use them in all the workspaces by defining the map of substitution parameters in the main configuration file. </para> - <para> + +<!-- <para> To do this, define <replaceable>${jbosscache-&#60;parameter name&#62;}</replaceable> inside an xml-template and list the correct value in the JCR configuration file (below the &#34;<parameter>jbosscache-configuration</parameter>&#34; entry) as shown below: </para> <para> @@ -36,8 +84,8 @@ The JCR configuration file: </para> -<programlisting language="XML" role="XML"><xi:include href="../../../extras/Advanced_Development_JCR_jbosscache-configuration-templates/default31.xml" parse="text" xmlns:xi="http://www.w3.org/2001/XInclude" /></programlisting> - </section> +<programlisting language="XML" role="XML"><xi:include href="../../../extras/Advanced_Development_JCR_jbosscache-configuration-templates/default31.xml" parse="text" xmlns:xi="http://www.w3.org/2001/XInclude" /></programlisting>--> + </section> <section id="sect-Reference_Guide-JBoss_Cache_configuration-JGroups_configuration"> @@ -68,8 +116,9 @@ &#60;property name=&#34;jgroups-multiplexer-stack&#34; value=&#34;true&#34; /&#62;</programlisting> </section> - - <section id="sect-Reference_Guide-JBoss_Cache_configuration-Templates"> +<!--DOC NOTE: Commented Templates section out as per feedback from Marek Posolda that users should not need to edit these files. + +<section id="sect-Reference_Guide-JBoss_Cache_configuration-Templates"> <title>Templates</title> <para> The eXo JCR implementation is shipped with ready-to-use JBoss Cache configuration templates for JCR components. They are located in the application package in the <filename>/conf/portal/</filename> directory. @@ -202,7 +251,7 @@ </callout> </calloutlist> </programlistingco> - </section> + </section> --> </section> 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-29 05:09:51 UTC (rev 5328) +++ epp/docs/branches/EPP_5_1_Branch/Reference_Guide/en-US/modules/Advanced/JCR/lock-manager-config.xml 2010-11-29 05:53:36 UTC (rev 5329) @@ -5,13 +5,18 @@ ]> <section id="sect-Reference_Guide-LockManager"> <title>LockManager</title> + <note> + <title>DOC REVIEW:</title> + <para> + Information regarding <emphasis role="bold">LockManagerImpl</emphasis> has been removed from this section based on QE feedback. Please review to ensure no impact on technical accuracy. + </para> + </note> <para> The LockManager stores lock objects. It can lock or release objects as required. It is also responsible for removing stale locks. </para> - <para> - The length of time LockManager allows a lock to remain in place can be configured with the &#34;<literal>time-out</literal>&#34; property. - </para> - <para> + + <!-- DOC NOTE: Below hidden as JCR standalone content (As per feedback from Marek Posolda + <para> JCR provides two base implementations of the LockManager: </para> <orderedlist> @@ -26,7 +31,7 @@ </para> </listitem> </orderedlist> - <para> + <para> <classname>LockManagerImpl</classname> is simple implementation of LockManager which is faster than <classname>CacheableLockManager</classname>. It stores lock objects in HashMap and can retain persistant locks if the <literal>LockPersister</literal> is configured. </para> <para> @@ -34,9 +39,12 @@ </para> <para> The second implementation (<classname>CacheableLockManagerImpl</classname>) will be the primary focus of this section. - </para> + </para> --> + <para> + The LockManager in &PRODUCT; is implemented with <classname>org.exoplatform.services.jcr.impl.core.lock.jbosscache.CacheableLockManagerImpl</classname>. + </para> <para> - LockManager is enabled by adding <literal>lock-manager-configuration</literal> to <literal>workspace-configuration</literal>. + It is is enabled by adding <literal>lock-manager-configuration</literal> to <literal>workspace-configuration</literal>. </para> <para> For example: @@ -48,8 +56,11 @@ <para> <classname>CacheableLockManagerImpl</classname> stores lock objects in JBoss-cache (which implements JDBCCacheLoader to store locks in a database). This means its locks are replicable and can affect an entire cluster rather than just a single node. </para> + <para> + The length of time LockManager allows a lock to remain in place can be configured with the &#34;<literal>time-out</literal>&#34; property. + </para> <para> - Both implementations support the removal of expired locks. The LockRemover thread periodically polls LockManager for locks that have passed the time-out limit and must be removed. + The LockRemover thread periodically polls LockManager for locks that have passed the time-out limit and must be removed. </para> <para> The time-out for LockRemover is set as follows (the default value is 30m): 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-29 05:09:51 UTC (rev 5328) +++ epp/docs/branches/EPP_5_1_Branch/Reference_Guide/en-US/modules/Advanced/JCR/multilanguage-support.xml 2010-11-29 05:53:36 UTC (rev 5329) @@ -72,11 +72,12 @@ <para> Below is an example of creating a UTF-8 database using the <parameter>db2</parameter> dialect for a workspace container with DB2 version 9 and higher: </para> - <!-- DOC TODO: Find out what programming language this is written in for syntax highlighting --> + <programlisting>DB2 CREATE DATABASE dbname USING CODESET UTF-8 TERRITORY US </programlisting> <programlisting language="XML" role="XML"><xi:include href="../../../extras/Advanced_Development_JCR_multilanguage-support/default56.xml" parse="text" xmlns:xi="http://www.w3.org/2001/XInclude" /></programlisting> + <note> <para> For DB2 version 8.<replaceable>x</replaceable> support change the property &#34;dialect&#34; to db2v8. 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-29 05:09:51 UTC (rev 5328) +++ epp/docs/branches/EPP_5_1_Branch/Reference_Guide/en-US/modules/Advanced/JCR/search-configuration.xml 2010-11-29 05:53:36 UTC (rev 5329) @@ -12,18 +12,25 @@ Below is an example of the configuration file that governs search behaviors. Refer to <xref linkend="sect-Reference_Guide-Search_Configuration-Global_Search_Index" /> for how searching operates in JCR and discussions about customized searches. </para> <para> - The JCR index configuration file is located at <filename>/portal/WEB-INF/conf/jcr/repository-configuration.xml</filename>. + The JCR index configuration file is located at <filename><replaceable>JBOSS_HOME</replaceable>/server/<replaceable>&lt;PROFILE&gt;</replaceable>/deploy/gatein.ear/02portal.war/WEB-INF/conf/jcr/repository-configuration.xml</filename>. </para> <para> A code example is included below with a list of the configuration parameters shown below that. </para> <programlisting language="XML" role="XML"><xi:include href="../../../extras/Advanced_Development_JCR_search-configuration/default61.xml" parse="text" xmlns:xi="http://www.w3.org/2001/XInclude" /></programlisting> - + <para> + The table below outlines the Configuration Parameters available, their default setting, which version of eXo JCR they were implemented in and other useful information: + </para> + <note> + <title>DOC REVIEW:</title> + <para> + The table below has been updated based on QE feedback. Please review for technical accuracy. + </para> +</note> <table align="left" id="tabl-Reference_Guide-Search_Configuration-Configuration_parameters" pgwide="1"> <title>Configuration parameters</title> - <!-- Removing 'version' column <tgroup cols="4"> --> - <tgroup cols="3"> + <tgroup cols="4"> <colspec colwidth="90pt"></colspec> <colspec colwidth="135pt"></colspec> <colspec colwidth="270pt"></colspec> @@ -44,9 +51,9 @@ Description </para> </entry> - <!-- <entry> -Version -</entry> --> + <entry> + Implemented in Version + </entry> </row> </thead> <tbody> @@ -63,12 +70,12 @@ </entry> <entry> <para> - The location of the index directory. This parameter is mandatory. It is called "<literal>indexDir</literal>" in versions prior to version 1.9. + The location of the index directory. This parameter is mandatory. It is called "<literal>indexDir</literal>" in versions prior to eXo JCR version 1.9. </para> </entry> - <!-- <entry> -1.0 -</entry> --> + <entry> + 1.0 + </entry> </row> <row> <entry> @@ -86,10 +93,9 @@ Advises lucene to use compound files for the index files. </para> </entry> - <!-- <entry> -1.9 -</entry> - --> + <entry> + 1.9 + </entry> </row> <row> <entry> @@ -107,10 +113,9 @@ The minimum number of nodes in an index until segments are merged. </para> </entry> - <!-- <entry> -1.9 -</entry> - --> + <entry> + 1.9 + </entry> </row> <row> <entry> @@ -126,10 +131,9 @@ Idle time in seconds until the volatile index part is moved to a persistent index even though <literal>minMergeDocs</literal> is not reached. </para> </entry> - <!-- <entry> -1.9 -</entry> - --> + <entry> + 1.9 + </entry> </row> <row> <entry> @@ -144,13 +148,12 @@ </entry> <entry> <para> - The maximum number of nodes in segments that will be merged. The default value changed to <literal>Integer.MAX_VALUE</literal> in JCR version 1.9. + The maximum number of nodes in segments that will be merged. The default value changed to <literal>Integer.MAX_VALUE</literal> in eXo JCR version 1.9. </para> </entry> - <!-- <entry> -1.9 -</entry> - --> + <entry> + 1.9 + </entry> </row> <row> <entry> @@ -168,10 +171,9 @@ Determines how often segment indices are merged. </para> </entry> - <!-- <entry> -1.9 -</entry> - --> + <entry> + 1.9 + </entry> </row> <row> <entry> @@ -189,10 +191,9 @@ The number of words that are fulltext indexed at most per property. </para> </entry> - <!-- <entry> -1.9 -</entry> - --> + <entry> + 1.9 + </entry> </row> <row> <entry> @@ -210,10 +211,9 @@ Size of the document number cache. This cache maps uuids to lucene document numbers </para> </entry> - <!-- <entry> -1.9 -</entry> - --> + <entry> + 1.9 + </entry> </row> <row> <entry> @@ -231,10 +231,9 @@ Runs a consistency check on every startup. If false, a consistency check is only performed when the search index detects a prior forced shutdown. </para> </entry> - <!-- <entry> -1.9 -</entry> - --> + <entry> + 1.9 + </entry> </row> <row> <entry> @@ -252,10 +251,9 @@ Errors detected by a consistency check are automatically repaired. If false, errors are only written to the log. </para> </entry> - <!-- <entry> -1.9 -</entry> - --> + <entry> + 1.9 + </entry> </row> <row> <entry> @@ -272,10 +270,9 @@ This class must also extend from the class: <literal>org.exoplatform.services.jcr.impl.core. query.AbstractQueryImpl</literal>. </para> </entry> - <!-- <entry> -1.9 -</entry> - --> + <entry> + 1.9 + </entry> </row> <row> <entry> @@ -293,10 +290,9 @@ If true and the query does not contain an 'order by' clause, result nodes will be in document order. For better performance set to 'false' when queries return many nodes. </para> </entry> - <!-- <entry> -1.9 -</entry> - --> + <entry> + 1.9 + </entry> </row> <row> <entry> @@ -314,10 +310,9 @@ The number of results when a query is executed. Default value: <literal>Integer.MAX_VALUE</literal>. </para> </entry> - <!-- <entry> -1.9 -</entry> - --> + <entry> + 1.9 + </entry> </row> <row> <entry> @@ -338,10 +333,9 @@ This should be used for the <literal>rep:excerpt()</literal> function in a query. </para> </entry> - <!-- <entry> -1.9 -</entry> - --> + <entry> + 1.9 + </entry> </row> <row> <entry> @@ -359,10 +353,9 @@ If set to true additional information is stored in the index to support highlighting using the <literal>rep:excerpt()</literal> function. </para> </entry> - <!-- <entry> -1.9 -</entry> - --> + <entry> + 1.9 + </entry> </row> <row> <entry> @@ -383,10 +376,9 @@ The default value is null. </para> </entry> - <!-- <entry> -1.9 -</entry> - --> + <entry> + 1.9 + </entry> </row> <row> <entry> @@ -404,10 +396,9 @@ The path to the synonym provider configuration file. This path is interpreted relative to the path parameter. If there is a path element inside the <literal>SearchIndex</literal> element, then this path is interpreted relative to the root path of the path. Whether this parameter is mandatory depends on the synonym provider implementation. The default value is null. </para> </entry> - <!-- <entry> -1.9 -</entry> - --> + <entry> + 1.9 + </entry> </row> <row> <entry> @@ -425,10 +416,9 @@ The path to the indexing configuration file. </para> </entry> - <!-- <entry> -1.9 -</entry> - --> + <entry> + 1.9 + </entry> </row> <row> <entry> @@ -446,10 +436,9 @@ The name of the class that implements <literal>org.exoplatform.services.jcr.impl.core. query.lucene.IndexingConfiguration</literal>. </para> </entry> - <!-- <entry> -1.9 -</entry> - --> + <entry> + 1.9 + </entry> </row> <row> <entry> @@ -467,10 +456,9 @@ If set to true a consistency check is performed depending on the parameter <literal>forceConsistencyCheck</literal>. If set to false no consistency check is performed on startup, even if a redo log had been applied. </para> </entry> - <!-- <entry> -1.9 -</entry> - --> + <entry> + 1.9 + </entry> </row> <row> <entry> @@ -488,10 +476,9 @@ The name of a class that implements <literal>org.exoplatform.services.jcr.impl.core. query.lucene.SpellChecker</literal>. </para> </entry> - <!-- <entry> -1.9 -</entry> - --> + <entry> + 1.9 + </entry> </row> <row> <entry> @@ -501,18 +488,17 @@ </entry> <entry> <para> - 50(Kb) + 50(KB) </para> </entry> <entry> <para> - The default size of error log file in Kb. + The default size of error log file in KB. </para> </entry> - <!-- <entry> -1.9 -</entry> - --> + <entry> + 1.9 + </entry> </row> <row> <entry> @@ -533,8 +519,13 @@ For example: <command>-Dupgrade-index=true</command> </para> <para> - Indexes before JCR 1.12 will not run with JCR 1.12. Hence you have to run an automatic migration: Start JCR with -Dupgrade-index=true. + Indexes prior to eXo JCR 1.12 will not run with eXo JCR 1.12. You must run an automatic migration. </para> + <para> + Start eXo JCR with: + </para> +<programlisting><command> -Dupgrade-index=true</command> +</programlisting> <para> The old index format is then converted in the new index format. After the conversion the new format is used. </para> @@ -545,10 +536,9 @@ It is reccommended that a backup of the index be made before conversion. (Only for migrations from JCR 1.9 and later.) </para> </entry> - <!-- <entry> -1.12 -</entry> - --> + <entry> + 1.12 + </entry> </row> <row> <entry> @@ -566,10 +556,9 @@ Class name of a lucene analyzer to use for fulltext indexing of text. </para> </entry> - <!-- <entry> -1.12 -</entry> - --> + <entry> + 1.12 + </entry> </row> </tbody> </tgroup> @@ -608,7 +597,7 @@ </programlistingco> <para> - The global search index is configured in the <filename>portal/WEB-INF/conf/jcr/repository-configuration.xml</filename> configuration file within the "query-handler" tag. + The global search index is configured in the <filename><replaceable>JBOSS_HOME</replaceable>/server/<replaceable>&lt;VERSION&gt;</replaceable>/deploy/gatein.ear/02portal.war/WEB-INF/conf/jcr/repository-configuration.xml</filename> configuration file within the "query-handler" tag. </para> <programlisting language="XML" role="XML"><![CDATA[<query-handler class="org.exoplatform.services.jcr.impl.core.query.lucene.SearchIndex"> @@ -676,7 +665,7 @@ <note> <para> - In JCR version 1.12 (and later) the analyzer can be directly set in the configuration. For users with this version the creation of a new SearchIndex for new analyzers is redundant. + In eXo JCR version 1.12 (and later) the analyzer can be directly set in the configuration. For users with this version the creation of a new SearchIndex for new analyzers is redundant. </para> </note> <para> @@ -687,14 +676,14 @@ ]]> </programlisting> <para> - in <filename>portal/WEB-INF/conf/jcr/repository-configuration.xml</filename> with the new class: + in <filename><replaceable>JBOSS_HOME</replaceable>/server/<replaceable>&lt;VERSION&gt;</replaceable>/deploy/gatein.ear/02portal.war/WEB-INF/conf/jcr/repository-configuration.xml</filename> with the new class: </para> <programlisting language="XML" role="XML"><![CDATA[<query-handler class="mypackage.indexation.MySearchIndex> ]]> </programlisting> <para> - To configure an application to use a new analyzer, add the <parameter>analyzer</parameter> parameter to each query-handler configuration in <filename>portal/WEB-INF/conf/jcr/repository-configuration.xml</filename>: + To configure an application to use a new analyzer, add the <parameter>analyzer</parameter> parameter to each query-handler configuration in <filename><replaceable>JBOSS_HOME</replaceable>/server/<replaceable>&lt;VERSION&gt;</replaceable>/deploy/gatein.ear/02portal.war/WEB-INF/conf/jcr/repository-configuration.xml</filename>: </para> <programlisting language="XML" role="XML"><xi:include href="../../../extras/Advanced_Development_JCR_search-configuration/default69.xml" parse="text" xmlns:xi="http://www.w3.org/2001/XInclude" /></programlisting> Modified: epp/docs/branches/EPP_5_1_Branch/Reference_Guide/en-US/modules/AuthenticationAndIdentity/AuthenticationTokenConfiguration.xml =================================================================== --- epp/docs/branches/EPP_5_1_Branch/Reference_Guide/en-US/modules/AuthenticationAndIdentity/AuthenticationTokenConfiguration.xml 2010-11-29 05:09:51 UTC (rev 5328) +++ epp/docs/branches/EPP_5_1_Branch/Reference_Guide/en-US/modules/AuthenticationAndIdentity/AuthenticationTokenConfiguration.xml 2010-11-29 05:53:36 UTC (rev 5329) @@ -37,7 +37,7 @@ <section id="sect-Reference_Guide-Authentication_Token_Configuration-Configuring_Token_Services"> <title>Configuring Token Services</title> <para> - Token services configuration includes specifying the token validity period. The token service is configured as a portal component using the <filename><replaceable>JBOSS_AS</replaceable>server/<replaceable>PROFILE</replaceable>/deploy/gatein.ear/02portal.war/WEB-INF/conf/common/autologin-configuration.xml</filename> file. + Token services configuration includes specifying the token validity period. The token service is configured as a portal component using the <filename><replaceable>JBOSS_HOME</replaceable>/server/<replaceable>PROFILE</replaceable>/deploy/gatein.ear/02portal.war/WEB-INF/conf/common/autologin-configuration.xml</filename> file. </para> <para> In the XML example below, <emphasis>CookieTokenService</emphasis> is a subclass of <emphasis role="bold">AbstractTokenService</emphasis> so it has a property which specifies the validity period of the token. 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-29 05:09:51 UTC (rev 5328) +++ epp/docs/branches/EPP_5_1_Branch/Reference_Guide/en-US/modules/AuthenticationAndIdentity/BackendConfiguration.xml 2010-11-29 05:53:36 UTC (rev 5329) @@ -71,6 +71,9 @@ <varlistentry> <term>hibernate.annotations</term> <listitem> + <para> + <parameter>values-param</parameter> + </para> <para> A list of annotated classes that will be added to Hibernate configuration. </para> @@ -79,6 +82,9 @@ <varlistentry> <term>hibernate.mappings</term> <listitem> + <para> + <parameter>values-param</parameter> + </para> <para> A list of xml files that will be added to hibernate configuration as mapping files. </para> @@ -110,6 +116,9 @@ <term>apiCacheConfig</term> <term>storeCacheConfig</term> <listitem> + <para> + <parameter>value-param</parameter> + </para> <para> These options reference the JBoss cache configuration used for Picketlink. </para> Modified: epp/docs/branches/EPP_5_1_Branch/Reference_Guide/en-US/modules/AuthenticationAndIdentity/PredefinedUserConfiguration.xml =================================================================== --- epp/docs/branches/EPP_5_1_Branch/Reference_Guide/en-US/modules/AuthenticationAndIdentity/PredefinedUserConfiguration.xml 2010-11-29 05:09:51 UTC (rev 5328) +++ epp/docs/branches/EPP_5_1_Branch/Reference_Guide/en-US/modules/AuthenticationAndIdentity/PredefinedUserConfiguration.xml 2010-11-29 05:53:36 UTC (rev 5329) @@ -5,6 +5,7 @@ ]> <section id="sect-Reference_Guide-Predefined_User_Configuration"> <title>Predefined User Configuration</title> + <section id="sect-Reference_Guide-Predefined_User_Configuration-Overview"> <title>Overview</title> <para> @@ -22,7 +23,7 @@ The <emphasis role="bold">checkDatabaseAlgorithm</emphasis> initialization parameter determines how the database update is performed. </para> <para> - If its value is set to <emphasis role="bold">entry</emphasis> it means that each user, group and membership listed in the configuration is checked each time &PRODUCT; is started. If the entry doesn&#39;t yet exist in the database, it is created. + If its value is set to <emphasis role="bold">entry</emphasis> it means that each user, group and membership listed in the configuration is checked each time &PRODUCT; is started. If the entry does not yet exist in the database, it is created. </para> <para> If <emphasis role="bold">checkDatabaseAlgorithm</emphasis> parameter value is set to <emphasis role="bold">empty</emphasis>, the configuration data will be updated to the database only if the database is empty. @@ -50,6 +51,11 @@ <para> The predefined groups are specified in the <emphasis role="bold">group</emphasis> field of the <emphasis role="bold">OrganizationConfig</emphasis> plugin parameter. </para> + <note> + <para> + See <literal>02portal.war:/WEB-INF/conf/organization/organization-configuration.xml</literal> for the full content. + </para> + </note> <programlisting language="XML" role="XML"><xi:include href="../../extras/Authentication_Identity_PredefinedUserConfiguration/default99.xml" parse="text" xmlns:xi="http://www.w3.org/2001/XInclude" /></programlisting> </section> @@ -57,18 +63,29 @@ <section id="sect-Reference_Guide-Predefined_User_Configuration-Users"> <title>Users</title> + <para> - The predefined users are specified in the <emphasis role="bold">membershipType</emphasis> field of the <emphasis role="bold">OrganizationConfig</emphasis> plugin parameter. + The predefined users are specified in the <emphasis role="bold">user</emphasis> field of the <emphasis role="bold">OrganizationConfig</emphasis> plugin parameter. </para> - + <note> + <para> + See <literal>02portal.war:/WEB-INF/conf/organization/organization-configuration.xml</literal> for the full content. + </para> + </note> <programlisting language="XML" role="XML"><xi:include href="../../extras/Authentication_Identity_PredefinedUserConfiguration/default100.xml" parse="text" xmlns:xi="http://www.w3.org/2001/XInclude" /></programlisting> </section> <section id="sect-Reference_Guide-Predefined_User_Configuration-Plugin_for_monitoring_user_creation"> - <title>Plugin for monitoring user creation</title> + <title>Plugin for managing user creation</title> + <note> + <title>DOC REVIEW:</title> + <para> + This section has been updated based on QE feedback. Please review for technical accuracy. + </para> +</note> <para> - The plugin type <literal>org.exoplatform.services.organization.impl.NewUserEventListener</literal> specifies which groups all the newly created users should become members of. + The plugin type <literal>org.exoplatform.services.organization.impl.NewUserEventListener</literal> specifies which groups all newly created users should become members of. </para> <para> It specifies the group memberships and the membership types to use (while a <emphasis>group</emphasis> is just a set of users, a membership <emphasis>type</emphasis> represents a user&#39;s role within a group). It also specifies a list of users that should not be processed (such as administrative users like &#39;<literal>root</literal>&#39;). Modified: epp/docs/branches/EPP_5_1_Branch/Reference_Guide/en-US/modules/PortalDevelopment/DefaultPortalConfiguration.xml =================================================================== --- epp/docs/branches/EPP_5_1_Branch/Reference_Guide/en-US/modules/PortalDevelopment/DefaultPortalConfiguration.xml 2010-11-29 05:09:51 UTC (rev 5328) +++ epp/docs/branches/EPP_5_1_Branch/Reference_Guide/en-US/modules/PortalDevelopment/DefaultPortalConfiguration.xml 2010-11-29 05:53:36 UTC (rev 5329) @@ -11,7 +11,7 @@ &PRODUCT;&#39;s default home page URL is <literal>http://{hostname}:{port}/portal/</literal>. There may be multiple independent portals deployed in parallel at any given time, each of which has its root context (<literal>http://{hostname}:{port}/sample-portal/</literal>, for example). </para> <para> - Each portal is internally composed of one or more &#39;portals&#39;. This is because there needs to be at least one such portal available. The default portal is called &#39;<emphasis>Classic</emphasis>&#39;. When accessing &PRODUCT;&#39;s default URL, you are automatically directed to the &#39;<emphasis>Classic</emphasis>&#39; portal. + Each portal container is internally composed of one or more &#39;portals&#39;. This is because there needs to be at least one such portal available. The default portal is called &#39;<emphasis>Classic</emphasis>&#39;. When accessing &PRODUCT;&#39;s default URL, you are automatically directed to the &#39;<emphasis>Classic</emphasis>&#39; portal. </para> <para> The default portal performs another important task. When starting up &PRODUCT; for the first time, its JCR database (where portal runtime-configurable settings are stored) will be empty . The default portal detects this and triggers automatic data initialization. @@ -26,26 +26,7 @@ </para> <programlisting language="XML" role="XML"><xi:include href="../../extras/PortalDevelopment_DefaultPortalConfiguration/default143.xml" parse="text" xmlns:xi="http://www.w3.org/2001/XInclude" /></programlisting> - <!-- <programlisting language="XML" role="XML"><![CDATA[<component> -<key>org.exoplatform.portal.config.UserPortalConfigService</key> -<type>org.exoplatform.portal.config.UserPortalConfigService</type> -<component-plugins> -<component-plugin> -<name>new.portal.config.user.listener</name> -<set-method>initListener</set-method> -<type>org.exoplatform.portal.config.NewPortalConfigListener</type> -<description>this listener init the portal configuration</description> -<init-params> -<value-param> -<name>default.portal</name> -<description>The default portal for checking db is empty or not</description> -<value>classic</value> -</value-param> -... -</init-params> -</component-plugin> -</component-plugins> -</component>]]></programlisting> --> + <para> In this example the <emphasis>Classic</emphasis> portal has been set as the default. </para> @@ -53,8 +34,9 @@ Notice that the <literal>NewPortalConfigListener</literal> <parameter>component-plugin</parameter> is used to add configuration to <literal>UserPortalConfigService</literal>, which is designed in this way to allow other components to add configuration to it. </para> <para> - <emphasis>Components</emphasis>, <emphasis>component-plugins</emphasis>, and <emphasis>init-params</emphasis> are explained in a later chapter of this document. + <emphasis>Components</emphasis>, <emphasis>component-plugins</emphasis>, and <emphasis>init-params</emphasis> are explained in a later chapter of this document (<xref linkend="chap-Reference_Guide-Foundations"/>). </para> +<!-- DOC NOTE: Rather than linking 11 chapters forward here (which contravenes the RH Style Guide, can this information be relocated to here?--> </section> </chapter> Modified: epp/docs/branches/EPP_5_1_Branch/Reference_Guide/en-US/modules/PortalDevelopment/DefaultPortalNavigationConfiguration.xml =================================================================== --- epp/docs/branches/EPP_5_1_Branch/Reference_Guide/en-US/modules/PortalDevelopment/DefaultPortalNavigationConfiguration.xml 2010-11-29 05:09:51 UTC (rev 5328) +++ epp/docs/branches/EPP_5_1_Branch/Reference_Guide/en-US/modules/PortalDevelopment/DefaultPortalNavigationConfiguration.xml 2010-11-29 05:53:36 UTC (rev 5329) @@ -98,10 +98,10 @@ </listitem> </varlistentry> <varlistentry> - <term>Subpages</term> + <term>Subnodes</term> <listitem> <para> - Subpages can also be created using the following XML structure + Subnodes can also be created using the following XML structure </para> <programlistingco> <areaspec> @@ -112,7 +112,7 @@ <calloutlist> <callout arearefs="area-Reference_Guide-Portal_Navigation_Configuration-Portal_Navigation-subpage"> <para> - This element defines the parent/child relationship between a page and a subpage. + This element defines the parent/child relationship between a page and a subnode. </para> </callout> </calloutlist> @@ -122,10 +122,20 @@ <varlistentry> <term>pages.xml</term> <listitem> + <note> + <title>DOC REVIEW:</title> + <para> + The paragraph below has been updated based on QE feedback. Please review for technical accuracy + </para> + </note> <para> - This configuration file structure is very similar to <filename>portal.xml</filename> and it can also contain container tags. Each application can decide whether to render the portlet border, the window state, the icons or portlet&#39;s mode. + This configuration file structure is very similar to <filename>portal.xml</filename> and it can also contain container tags (some usage examples of container tags can be found in <filename>02portal.war/WEB-INF/conf/portal/portal/sharedlayout.xml</filename>). + </para> + <para> + Each application can decide whether to render the portlet border, the window state, the icons or portlet&#39;s mode. </para> - +<!-- DOC NOTE: look into including some actual examples of 'container tags' from sharedlayout.xml in place here. --> + <programlisting language="XML" role="XML"><xi:include href="../../extras/PortalDevelopment_DefaultPortalNavigationConfiguration/pages.xml" parse="text" xmlns:xi="http://www.w3.org/2001/XInclude" /></programlisting> </listitem> Modified: epp/docs/branches/EPP_5_1_Branch/Reference_Guide/en-US/modules/PortalDevelopment/DefaultPortalPermissionConfiguration.xml =================================================================== --- epp/docs/branches/EPP_5_1_Branch/Reference_Guide/en-US/modules/PortalDevelopment/DefaultPortalPermissionConfiguration.xml 2010-11-29 05:09:51 UTC (rev 5328) +++ epp/docs/branches/EPP_5_1_Branch/Reference_Guide/en-US/modules/PortalDevelopment/DefaultPortalPermissionConfiguration.xml 2010-11-29 05:53:36 UTC (rev 5329) @@ -81,37 +81,7 @@ </variablelist> <programlisting language="XML" role="XML"><xi:include href="../../extras/PortalDevelopment_DefaultPortalPermissionConfiguration/default145.xml" parse="text" xmlns:xi="http://www.w3.org/2001/XInclude" /></programlisting> - <!-- <programlisting language="XML" role="XML"><![CDATA[<component> -<key>org.exoplatform.portal.config.UserACL</key> -<type>org.exoplatform.portal.config.UserACL</type> -<init-params> -<value-param> -<name>super.user</name> -<description>administrator</description> -<value>root</value> -</value-param> -<value-param> -<name>portal.creator.groups</name> -<description>groups with membership type have permission to manage portal</description> -<value>*:/platform/administrators,*:/organization/management/executive-board</value> -</value-param> -<value-param> -<name>navigation.creator.membership.type</name> -<description>specific membership type have full permission with group navigation</description> -<value>manager</value> -</value-param> -<value-param> -<name>guests.group</name> -<description>guests group</description> -<value>/platform/guests</value> -</value-param> -<value-param> -<name>access.control.workspace</name> -<description>groups with memberships that have the right to access the User Control Workspace</description> -<value>*:/platform/administrators,*:/organization/management/executive-board</value> -</value-param> -</init-params> -</component>]]></programlisting> --> + </section> @@ -122,27 +92,7 @@ </para> <programlisting language="XML" role="XML"><xi:include href="../../extras/PortalDevelopment_DefaultPortalPermissionConfiguration/default146.xml" parse="text" xmlns:xi="http://www.w3.org/2001/XInclude" /></programlisting> - <!-- <programlisting language="XML" role="XML"><![CDATA[<external-component-plugins> -<target-component>org.exoplatform.portal.config.UserACL</target-component> -<component-plugin> -<name>addPortalACLPlugin</name> -<set-method>addPortalACLPlugin</set-method> -<type>org.exoplatform.portal.config.PortalACLPlugin</type> -<description>setting some permission for portal</description> -<init-params> -<values-param> -<name>access.control.workspace.roles</name> -<value>*:/platform/administrators</value> -<value>*:/organization/management/executive-board</value> -</values-param> -<values-param> -<name>portal.creation.roles</name> -<value>*:/platform/administrators</value> -<value>*:/organization/management/executive-board</value> -</values-param> -</init-params> -</component-plugin> -</external-component-plugins>]]></programlisting> --> + </section> </chapter> Modified: epp/docs/branches/EPP_5_1_Branch/Reference_Guide/en-US/modules/PortalDevelopment/InternationalizationConfiguration.xml =================================================================== --- epp/docs/branches/EPP_5_1_Branch/Reference_Guide/en-US/modules/PortalDevelopment/InternationalizationConfiguration.xml 2010-11-29 05:09:51 UTC (rev 5328) +++ epp/docs/branches/EPP_5_1_Branch/Reference_Guide/en-US/modules/PortalDevelopment/InternationalizationConfiguration.xml 2010-11-29 05:53:36 UTC (rev 5329) @@ -211,7 +211,7 @@ </section> - <!-- Commented out as not fully enterpise ready: https://jira.jboss.org/browse/GTNPORTAL-1482 + <!-- Commented out as not fully enterprise ready: https://jira.jboss.org/browse/GTNPORTAL-1482 Will reinstate when issues resolved <section id="sect-Reference_Guide-_Portlets_-Debugging_Resource_Bundle_Usage"> <title>Debugging Resource Bundle Usage - PLEASE REVIEW</title> Modified: epp/docs/branches/EPP_5_1_Branch/Reference_Guide/en-US/modules/PortalDevelopment/RTLFramework.xml =================================================================== --- epp/docs/branches/EPP_5_1_Branch/Reference_Guide/en-US/modules/PortalDevelopment/RTLFramework.xml 2010-11-29 05:09:51 UTC (rev 5328) +++ epp/docs/branches/EPP_5_1_Branch/Reference_Guide/en-US/modules/PortalDevelopment/RTLFramework.xml 2010-11-29 05:53:36 UTC (rev 5329) @@ -5,13 +5,20 @@ ]> <chapter id="chap-Reference_Guide-Right_To_Left_RTL_Framework"> <title>Right To Left (RTL) Framework</title> + <note> + <title>DOC REVIEW:</title> + <para> + Some information has been removed from this section based on QE feedback. Please review to ensure there is no impact to technical accuracy. + </para> +</note> <para> The text orientation depends on the current locale setting. The orientation is a Java 5 enum that provides a set of functionalities: </para> <programlisting language="Java" role="Java"><xi:include href="../../extras/PortalDevelopment_RTLFramework/default172.java" parse="text" xmlns:xi="http://www.w3.org/2001/XInclude" /></programlisting> - <para> + <!-- DOC NOTE: Commented based on feedback from Marek Posolda that section seemed to have been included without previous explanatory context. + <para> The object defining the orientation for the current request is the <literal>UIPortalApplication</literal>. However it should be accessed at runtime using the <literal>RequestContext</literal> that delegates to the <literal>UIPortalApplication</literal>. </para> <para> @@ -19,11 +26,11 @@ </para> <para> In the case of a different context, it delegates to the parent context given the fact that the root <literal>RequestContext</literal> is always a <literal>PortalRequestContext</literal>. - </para> + </para>--> <section id="sect-Reference_Guide-Right_To_Left_RTL_Framework-Groovy_templates"> <title>Groovy templates</title> <para> - Orientation is defined by implicit variables in the groovy binding context: + Orientation is defined by implicit variables passed into the groovy binding context: </para> <variablelist> <varlistentry> @@ -71,7 +78,7 @@ It works by appending -lt or -rt to the stylesheet name. </para> <para> - For instance: <filename>/web/skin/portal/webui/component/UIFooterPortlet/DefaultStylesheet-rt.css</filename> will return the same stylesheet as <filename>/web/skin/portal/webui/component/UIFooterPortlet/DefaultStylesheet.css</filename> but processed for the RT orientation. The <parameter>-lt</parameter> suffix is optional. + For instance: <filename><replaceable>JBOSS_HOME</replaceable>/server/<replaceable>&lt;PROFILE&gt;</replaceable>/deploy/gatein.ear/web.war/skin/portal/webui/component/UIFooterPortlet/DefaultStylesheet-rt.css</filename> will return the same stylesheet as <filename><replaceable>JBOSS_HOME</replaceable>/server/<replaceable>&lt;PROFILE&gt;</replaceable>/deploy/gatein.ear/web.war/skin/portal/webui/component/UIFooterPortlet/DefaultStylesheet.css</filename> but processed for the RT orientation. The <parameter>-lt</parameter> suffix is optional. </para> <para> Stylesheet authors can annotate their stylesheet to create content that depends on the orientation. @@ -127,7 +134,8 @@ The web resource filter uses the same naming pattern as the skin service. When an image ends with the -rt suffix the portal will attempt to locate the original image and create a mirror of it. </para> <para> - For instance: requesting the image <filename>/GateInResources/skin/DefaultSkin/webui/component/UITabSystem/UITabs/background/NormalTabStyle-rt.gif</filename> returns a mirror of the image <filename>/GateInResources/skin/DefaultSkin/webui/component/UITabSystem/UITabs/background/NormalTabStyle.gif</filename>. + For instance: requesting the image <filename><replaceable>JBOSS_HOME</replaceable>/server/<replaceable>&lt;PROFILE&gt;</replaceable>/deploy/gatein.ear/01eXoResources.war/skin/DefaultSkin/webui/component/UITabSystem/UITabs/background/NormalTabStyle-rt.gif</filename> + returns a mirror of the image <filename><replaceable>JBOSS_HOME</replaceable>/server/<replaceable>&lt;PROFILE&gt;</replaceable>/deploy/gatein.ear/01eXoResources.war/skin/DefaultSkin/webui/component/UITabSystem/UITabs/background/NormalTabStyle.gif</filename>. </para> <note> <para> @@ -139,13 +147,7 @@ </para> <programlisting language="Java" role="Java"><xi:include href="../../extras/PortalDevelopment_RTLFramework/default179.java" parse="text" xmlns:xi="http://www.w3.org/2001/XInclude" /></programlisting> - <!-- <programlisting> -line-height: 24px; -background: url('background/NavigationTab.gif') no-repeat right top; /* orientation=lt */ -background: url('background/NavigationTab-rt.gif') no-repeat left top; /* orientation=rt */ -padding-right: 2px; /* orientation=lt */ -padding-left: 2px; /* orientation=rt */ -</programlisting> --> + </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-29 05:09:51 UTC (rev 5328) +++ epp/docs/branches/EPP_5_1_Branch/Reference_Guide/en-US/modules/WSRP.xml 2010-11-29 05:53:36 UTC (rev 5329) @@ -277,8 +277,27 @@ &PRODUCT;'s Producer is automatically set up when a portal instance is deployed with the WSRP service. </para> <para> - The WSDL file can be accessed at <filename>http://<replaceable>{hostname}</replaceable>:<replaceable>{port}</replaceable>/wsrp-producer/<replaceable>&lt;VERSION&gt;</replaceable>/MarkupService?wsdl</filename> (replace &lt;VERSION&gt; with either <emphasis>v1</emphasis> or <emphasis>v2</emphasis>, depending on which version of WSRP you are using). + The WSDL file can be accessed at: </para> + <variablelist> + <title></title> + <varlistentry> + <term>&PRODUCT; 5.0 and WSRP 1.0:</term> + <listitem> + <para> + <filename>http://<replaceable>{hostname}</replaceable>:<replaceable>{port}</replaceable>/wsrp-producer/v1/MarkupService?wsdl</filename>. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>&PRODUCT; 5.1 and WSRP 2.0:</term> + <listitem> + <para> + <filename>http://<replaceable>{hostname}</replaceable>:<replaceable>{port}</replaceable>/wsrp-producer/v2/MarkupService?wsdl</filename>. + </para> + </listitem> + </varlistentry> + </variablelist> <para> The default hostname is <literal>localhost</literal> and the default port is <literal>8080</literal>. </para>