[gatein-commits] gatein SVN: r7047 - in epp/docs/branches/5.1/Reference_Guide/en-US/modules: Advanced/JCR and 2 other directories.

Author: smumford Date: 2011-08-11 01:53:52 -0400 (Thu, 11 Aug 2011) New Revision: 7047 Modified: epp/docs/branches/5.1/Reference_Guide/en-US/modules/Advanced/JCR/as_managed_datasources.xml epp/docs/branches/5.1/Reference_Guide/en-US/modules/AuthenticationAndIdentity.xml epp/docs/branches/5.1/Reference_Guide/en-US/modules/AuthenticationAndIdentity/LDAP.xml epp/docs/branches/5.1/Reference_Guide/en-US/modules/AuthenticationAndIdentity/SSO.xml epp/docs/branches/5.1/Reference_Guide/en-US/modules/PortalDevelopment/DefaultPortalNavigationConfiguration.xml epp/docs/branches/5.1/Reference_Guide/en-US/modules/WSRP.xml Log: Prep for 5.1.1 release. Modified: epp/docs/branches/5.1/Reference_Guide/en-US/modules/Advanced/JCR/as_managed_datasources.xml =================================================================== --- epp/docs/branches/5.1/Reference_Guide/en-US/modules/Advanced/JCR/as_managed_datasources.xml 2011-08-11 05:12:13 UTC (rev 7046) +++ epp/docs/branches/5.1/Reference_Guide/en-US/modules/Advanced/JCR/as_managed_datasources.xml 2011-08-11 05:53:52 UTC (rev 7047) @@ -24,7 +24,7 @@ --> <section> - <title><remark>Using AS Managed Datasources</remark></title> + <title>Using AS Managed Datasources</title> <important> <title>Supported Datasources</title> <para> Modified: epp/docs/branches/5.1/Reference_Guide/en-US/modules/AuthenticationAndIdentity/LDAP.xml =================================================================== --- epp/docs/branches/5.1/Reference_Guide/en-US/modules/AuthenticationAndIdentity/LDAP.xml 2011-08-11 05:12:13 UTC (rev 7046) +++ epp/docs/branches/5.1/Reference_Guide/en-US/modules/AuthenticationAndIdentity/LDAP.xml 2011-08-11 05:53:52 UTC (rev 7047) @@ -5,7 +5,7 @@ ]> <section id="sect-Reference_Guide-LDAP_Integration"> - <title><remark>LDAP Integration</remark></title> + <title>LDAP Integration</title> <note> <title>Notational Device</title> <para> Modified: epp/docs/branches/5.1/Reference_Guide/en-US/modules/AuthenticationAndIdentity/SSO.xml =================================================================== --- epp/docs/branches/5.1/Reference_Guide/en-US/modules/AuthenticationAndIdentity/SSO.xml 2011-08-11 05:12:13 UTC (rev 7046) +++ epp/docs/branches/5.1/Reference_Guide/en-US/modules/AuthenticationAndIdentity/SSO.xml 2011-08-11 05:53:52 UTC (rev 7047) @@ -61,7 +61,7 @@ </section> <section> - <title><remark>Enabling SSO using JBoss SSO Valve</remark></title> + <title>Enabling SSO using JBoss SSO Valve</title> <!-- Source Metadata URL: https://issues.jboss.org/browse/JBQA-4530 Author [w/email]: Marek Posolda (mposolda(a)redhat.com) Modified: epp/docs/branches/5.1/Reference_Guide/en-US/modules/AuthenticationAndIdentity.xml =================================================================== --- epp/docs/branches/5.1/Reference_Guide/en-US/modules/AuthenticationAndIdentity.xml 2011-08-11 05:12:13 UTC (rev 7046) +++ epp/docs/branches/5.1/Reference_Guide/en-US/modules/AuthenticationAndIdentity.xml 2011-08-11 05:53:52 UTC (rev 7047) @@ -6,7 +6,7 @@ <chapter id="chap-Reference_Guide-Authentication_and_Identity"> <title>Authentication and Identity</title> <section id="sect-Reference_Guide-Authentication_and_Identity-Password_Encryption" > - <title><remark>Password Encryption</remark></title> + <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> Modified: epp/docs/branches/5.1/Reference_Guide/en-US/modules/PortalDevelopment/DefaultPortalNavigationConfiguration.xml =================================================================== --- epp/docs/branches/5.1/Reference_Guide/en-US/modules/PortalDevelopment/DefaultPortalNavigationConfiguration.xml 2011-08-11 05:12:13 UTC (rev 7046) +++ epp/docs/branches/5.1/Reference_Guide/en-US/modules/PortalDevelopment/DefaultPortalNavigationConfiguration.xml 2011-08-11 05:53:52 UTC (rev 7047) @@ -4,7 +4,7 @@ %BOOK_ENTITIES; ]> <chapter id="chap-Reference_Guide-Portal_Navigation_Configuration"> - <title><remark>Portal Navigation Configuration</remark></title> + <title>Portal Navigation Configuration</title> <section id="sect-Reference_Guide-Portal_Navigation_Configuration-Overview"> <title>Overview</title> <para> @@ -28,19 +28,19 @@ </listitem> </itemizedlist> <para> - These navigations are configured using the standard XML syntax in the file; &#34;<filename>02portal.war:/WEB-INF/conf/portal/portal-configuration.xml</filename>&#34;. + These navigations are configured using the standard XML syntax in the file; <filename>02portal.war:/WEB-INF/conf/portal/portal-configuration.xml</filename>. </para> <programlisting language="XML" role="XML"><xi:include href="../../extras/PortalDevelopment_DefaultPortalNavigationConfiguration/default144.xml" parse="text" xmlns:xi="http://www.w3.org/2001/XInclude" /></programlisting> <para> - This XML configuration defines where in the portal's <literal>WAR</literal> to look for configuration settings, and which portals, groups, and user specific views to include in portal/group/user navigation. + This XML configuration defines where in the portal's <literal>WAR</literal> to look for configuration settings, and which portals, groups, and user specific views to include in <emphasis>portal/group/user</emphasis> navigation. </para> <para> The first time the portal is launched those files will be used to create an initial navigation. That information will then be stored in the JCR content repository and can be modified and managed from the portal UI. </para> - <remark>Added based on Gatein revision 6987:</remark> + <!--DOC NOTE: Added based on Gatein revision 6987--> <para> -Each portal, groups and users navigation is indicated by a configuration paragraph, for example: + Each portal, groups and users navigation is indicated by a configuration paragraph, for example: </para> <programlistingco> <areaspec> @@ -75,42 +75,42 @@ <calloutlist> <callout arearefs="area-Reference_Guide.Portalconf.predifinedOwner"> <para> - <emphasis>predefinedOwner</emphasis> define the navigation owner, portal will look for the configuration files in folder with this name, if there is no suitable folder, a default portal will be created with name is this value. + <parameter>predefinedOwner</parameter> defines the navigation owner, portal will look for the configuration files in folder with this name, if there is no suitable folder, a default portal will be created with name is this value. </para> </callout> <callout arearefs="area-Reference_Guide.Portalconf.ownerType"> <para> - <emphasis> ownerType</emphasis> define the type of portal navigation. It may be a portal, group or user + <parameter>ownerType</parameter> define the type of portal navigation. It may be a portal, group or user </para> </callout> <callout arearefs="area-Reference_Guide.Portalconf.templateLocation"> <para> - <emphasis> templateLocation</emphasis> the classpath where contains all portal configuration files + <parameter>templateLocation</parameter> the classpath where contains all portal configuration files </para> </callout> <callout arearefs="area-Reference_Guide.Portalconf.importMode"> <para> - <emphasis> importMode</emphasis> The mode for navigation import. There are 4 types of import mode: + <parameter>importMode</parameter> The mode for navigation import. There are 4 types of import mode: </para> <itemizedlist> <listitem> <para> - <emphasis>conserve</emphasis>: Import data when it does not exist, otherwise do nothing. + <parameter>conserve</parameter>: Import data when it does not exist, otherwise do nothing. </para> </listitem> <listitem> <para> - <emphasis>insert</emphasis>: Import data when it does not exist, otherwise performs a strategy that adds new data only. + <parameter>insert</parameter>: Import data when it does not exist, otherwise performs a strategy that adds new data only. </para> </listitem> <listitem> <para> - <emphasis>merge</emphasis>: Import data when it does not exist, update data when it exists. + <parameter>merge</parameter>: Import data when it does not exist, update data when it exists. </para> </listitem> <listitem> <para> - <emphasis>rewrite</emphasis>: Overwrite data whatsoever. + <parameter>rewrite</parameter>: Overwrite data whatsoever. </para> </listitem> </itemizedlist> @@ -118,13 +118,18 @@ </calloutlist> <para> -Base on these parameters, portal will look for the configuration files and create a relevant portal navigation, pages and data import strategy. The portal configuration files will be stored in folders with path look like <literal>{templateLocation}/{ownerType}/{predefinedOwner}</literal>, all navigations are defined in the <literal>navigation.xml</literal> file, pages are defined in pages.xml and portal configuration is defined in <literal>{ownerType}.xml</literal>. -For example, with the above configuration, portal will look for all configuration files from <literal>war:/conf/portal/portal/classic path.</literal> + Based on these parameters, the portal will look for the configuration files and create a relevant portal navigation, pages and data import strategy. </para> + <para> + The portal configuration files will be stored in folders with path look like <filename>{templateLocation}/{ownerType}/{predefinedOwner}</filename>, all navigations are defined in the <filename>navigation.xml</filename> file, pages are defined in <filename>pages.xml</filename> and portal configuration is defined in <filename>{ownerType}.xml</filename>. + </para> + <para> + For example, with the above configuration, portal will look for all configuration files from <filename>war:/conf/portal/portal/classic path.</filename> + </para> </section> <section id="sect-Reference_Guide-Portal_Navigation_Configuration-Portal_Navigation"> - <title><remark>Portal Navigation</remark></title> + <title>Portal Navigation</title> <!-- Updated based on Gatein revision 6987 --> <para> The portal navigation incorporates the pages that can be accessed even when a user is not logged in (assuming the applicable permissions allow public access). For example; several portal navigations could be used when a company has multiple trademarks, and websites are set up for each of them. @@ -144,7 +149,7 @@ <para> It is also possible to apply a nested container that can also contain portlets. Row, column or tab containers are then responsible for the layout of their child portlets. </para> - <remark>Updated based on Gatein revision 6987:</remark> + <!--Updated based on Gatein revision 6987--> <para> Each application references a portlet using the id <literal>portal#{portalName}:/{portletWarName}/{portletName}/{uniqueId}</literal>. </para> @@ -162,7 +167,7 @@ <para> This file defines all the navigation nodes the portal will have. The syntax is simple and uses nested node tags. Each node references a page defined in <filename>pages.xml</filename> file. </para> - <remark>Updated based on Gatein revision 6987:</remark> + <!--Updated based on Gatein revision 6987--> <para> If the administrator wants to create node labels for each language, they will have to use <literal>xml:lang</literal> attribute in the label tag with value of <literal>xml:lang</literal> is the relevant locale. </para> @@ -179,7 +184,7 @@ For top nodes, the <emphasis role="bold">uri</emphasis> and the <emphasis role="bold">name</emphasis> of your navigation nodes must have the <emphasis>same</emphasis> value. For other nodes the <emphasis role="bold">uri</emphasis> is a relative path. </para> <para> - For example; <emphasis><uri>contentmanagement/fileexplorer</uri></emphasis> where '<literal>contentmanagement</literal> ' is the name of the parent node and '<literal>fileexplorer</literal>' is the name of the node ( <emphasis>&#60;name&#62;fileexplorer&#60;/name&#62; </emphasis> ). + For example; <emphasis><uri>contentmanagement/fileexplorer</uri></emphasis> where '<literal>contentmanagement</literal> ' is the name of the parent node and '<literal>fileexplorer</literal>' is the name of the node (<emphasis>&#60;name&#62;fileexplorer&#60;/name&#62; </emphasis>). </para> </warning> </listitem> @@ -240,19 +245,20 @@ <section id="sect-Reference_Guide-Portal_Navigation_Configuration-User_Navigation"> - <title><remark>User Navigation</remark></title> + <title>User Navigation</title> <para> User navigation is the set of nodes and pages that are owned by a user. They are part of the user's dashboard. </para> - <remark>This Paragraph:</remark> + <!-- DOC NOTE: Get an answer on the below!--> + <!--<remark>This Paragraph:</remark>--> <para> Two files configure the user navigation (<filename>navigation.xml</filename> and <filename>pages.xml</filename>). They are located in the directory &#34;<filename>02portal.war/WEB-INF/conf/portal/users/{userName}</filename>&#34;. </para> - <remark>Became this paragraph in GateIn r6987</remark> + <!--<remark>Became this paragraph in GateIn r6987</remark> <para> Three files configure the user navigation (<filename>navigation.xml</filename>, <filename>pages.xml</filename> and <filename>portlet-preferences.xml</filename>). They are located in the <filename>{templateLocation}/{ownerType}/{predefinedOwner}</filename> directory with <literal>ownerType</literal> is <literal>user</literal> and <literal>predefinedOwner</literal> is username that want to create the navigation. For example, if administrator want to create navigation for user <literal>root</literal>, he has to locate the configuration files in <filename>portal.war/WEB-INF/conf/portal/user/root </filename> </para> - <remark>Which is appropriate for EPP 5.1.1?</remark> + <remark>Which is appropriate for EPP 5.1.1?</remark>--> <para> The file <filename>eXoGadgets.war/WEB-INF/gadget.xml</filename> defines the gadgets that will be available on a user dashboard. </para> Modified: epp/docs/branches/5.1/Reference_Guide/en-US/modules/WSRP.xml =================================================================== --- epp/docs/branches/5.1/Reference_Guide/en-US/modules/WSRP.xml 2011-08-11 05:12:13 UTC (rev 7046) +++ epp/docs/branches/5.1/Reference_Guide/en-US/modules/WSRP.xml 2011-08-11 05:53:52 UTC (rev 7047) @@ -1311,7 +1311,7 @@ </section> <section id="sect-Reference_Guide-Web_Services_for_Remote_Portlets_WSRP-Removing_WSRP"> - <title><remark>Removing WSRP</remark></title> + <title>Removing WSRP</title> <para> If you are not going to use WSRP in your JBoss Enterprise Portal Platform instance, the WSRP configuration files may be left in place. They will not adversely affect your installation. </para>