Author: jaredmorgs Date: 2013-02-24 23:10:23 -0500 (Sun, 24 Feb 2013) New Revision: 9179 Modified: epp/docs/branches/6.0/Reference_Guide/en-US/modules/PortalDevelopment/DataImportStrategy.xml epp/docs/branches/6.0/Reference_Guide/en-US/modules/PortalDevelopment/DefaultPortalNavigationConfiguration.xml epp/docs/branches/6.0/Reference_Guide/en-US/modules/PortalDevelopment/RTLFramework.xml epp/docs/branches/6.0/Reference_Guide/en-US/modules/PortalDevelopment/Skinning.xml Log: Incorporated eXo Platform feedback to the Ref Guide from Patrice's email. Very minor rework Modified: epp/docs/branches/6.0/Reference_Guide/en-US/modules/PortalDevelopment/DataImportStrategy.xml =================================================================== --- epp/docs/branches/6.0/Reference_Guide/en-US/modules/PortalDevelopment/DataImportStrategy.xml 2013-02-25 03:58:43 UTC (rev 9178) +++ epp/docs/branches/6.0/Reference_Guide/en-US/modules/PortalDevelopment/DataImportStrategy.xml 2013-02-25 04:10:23 UTC (rev 9179) @@ -31,6 +31,52 @@ </itemizedlist> <para>Each type of object data has some differences in the import strategy. </para> + <para>The modes for the import strategy include the following: + </para> + <itemizedlist> + <listitem> + <para> + <literal>CONSERVE</literal> + </para> + </listitem> + <listitem> + <para> + <literal>MERGE</literal> + </para> + </listitem> + <listitem> + <para> + <literal>INSERT</literal> + </para> + </listitem> + <listitem> + <para> + <literal>OVERWRITE</literal> + </para> + </listitem> + </itemizedlist> + <para> + Each mode indicates how the portal data is 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. The default value is configurable as a UserPortalConfigService initial parameter. For example, the configuration below means that the default value is <literal>MERGE</literal>. + </para> + <programlisting language="XML"> +&lt;component&gt; + &lt;key&gt;org.exoplatform.portal.config.UserPortalConfigService&lt;/key&gt; + &lt;type&gt;org.exoplatform.portal.config.UserPortalConfigService&lt;/type&gt; + &lt;component-plugins&gt; + ............ + &lt;/component-plugins&gt; + &lt;init-params&gt; + &lt;value-param&gt; + &lt;name&gt;default.import.mode&lt;/name&gt; + &lt;value&gt;merge&lt;/value&gt; + &lt;/value-param&gt; + &lt;/init-params&gt; +&lt;/component&gt; + +</programlisting> + <para> + The way the import strategy works with the import mode will be clearly demonstrated in next sections for each type of data. + </para> <section id="sect-Reference_Guide-Data_Import_Strategy-Portal_Config"> <title>Portal Configuration</title> <para> @@ -116,7 +162,7 @@ </step> </procedure> <para> - Let&apos;s see the example with two navigation nodes in each import mode. In this case, there are 2 navigation definitions: + Let&apos;s see the example with two navigation nodes in each import mode. In this case, there are two navigation definitions: </para> <programlisting language="XML" role="XML">&lt;node-navigation&gt; &lt;page-nodes&gt; @@ -134,14 +180,14 @@ &lt;/node&gt; &lt;/page-nodes&gt; &lt;/node-navigation&gt;</programlisting> -<figure> - <title id="DataImportStrategy-navigation1">Data Import Strategy Navigation1</title> - <mediaobject> - <imageobject> - <imagedata width="444" align="center" fileref="images/DataImportStrategy/navigation1.png" format="PNG"/> - </imageobject> - </mediaobject> -</figure> + <figure> + <title id="DataImportStrategy-navigation1">Data Import Strategy Navigation1</title> + <mediaobject> + <imageobject> + <imagedata width="444" align="center" fileref="images/DataImportStrategy/navigation1.png" format="PNG"/> + </imageobject> + </mediaobject> + </figure> <programlisting language="XML" role="XML">&lt;node-navigation&gt; &lt;page-nodes&gt; &lt;node&gt; @@ -154,14 +200,14 @@ &lt;/node&gt; &lt;/page-nodes&gt; &lt;/node-navigation&gt;</programlisting> -<figure> - <title id="DataImportStrategy-navigation2">Data Import Strategy Navigation2</title> -<mediaobject> - <imageobject> - <imagedata width="444" align="center" fileref="images/DataImportStrategy/navigation2.png" format="PNG"/> - </imageobject> - </mediaobject> -</figure> + <figure> + <title id="DataImportStrategy-navigation2">Data Import Strategy Navigation2</title> + <mediaobject> + <imageobject> + <imagedata width="444" align="center" fileref="images/DataImportStrategy/navigation2.png" format="PNG"/> + </imageobject> + </mediaobject> + </figure> <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> @@ -173,17 +219,17 @@ <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> -<figure> -<title id="DataImportStrategy-navigation_1">Data Import Strategy Navigation1</title> - <mediaobject> - <imageobject role="html"> - <imagedata align="center" fileref="images/DataImportStrategy/navigation1.png" format="PNG"/> - </imageobject> - <imageobject role="fo"> - <imagedata width="100mm" align="center" fileref="images/DataImportStrategy/navigation1.png" format="PNG"/> - </imageobject> - </mediaobject> -</figure> + <figure> + <title id="DataImportStrategy-navigation_1">Data Import Strategy Navigation1</title> + <mediaobject> + <imageobject role="html"> + <imagedata align="center" fileref="images/DataImportStrategy/navigation1.png" format="PNG"/> + </imageobject> + <imageobject role="fo"> + <imagedata width="100mm" align="center" fileref="images/DataImportStrategy/navigation1.png" format="PNG"/> + </imageobject> + </mediaobject> + </figure> </listitem> </varlistentry> <varlistentry> @@ -192,14 +238,14 @@ <para> If a node does not exist, the importer will add new nodes to the navigation tree. You will see the following result: </para> -<figure> -<title id="DataImportStrategy-navigationInsert">Data Import Strategy Navigation_Insert</title> - <mediaobject> - <imageobject> - <imagedata width="444" align="center" fileref="images/DataImportStrategy/navigation_insert.png" format="PNG"/> - </imageobject> - </mediaobject> -</figure> + <figure> + <title id="DataImportStrategy-navigationInsert">Data Import Strategy Navigation_Insert</title> + <mediaobject> + <imageobject> + <imagedata width="444" align="center" fileref="images/DataImportStrategy/navigation_insert.png" format="PNG"/> + </imageobject> + </mediaobject> + </figure> <para> Hereafter, the node &apos;bar&apos; is added to the navigation tree, because it does not exist in the initiated data. Other nodes are kept in the import process. </para> @@ -211,14 +257,14 @@ <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> -<figure> -<title id="DataImportStrategy-navigationmerge">Data Import Strategy Navigation_Merge</title> - <mediaobject> - <imageobject> - <imagedata width="444" align="center" fileref="images/DataImportStrategy/navigation_merge.png" format="PNG"/> - </imageobject> - </mediaobject> -</figure> + <figure> + <title id="DataImportStrategy-navigationmerge">Data Import Strategy Navigation_Merge</title> + <mediaobject> + <imageobject> + <imagedata width="444" align="center" fileref="images/DataImportStrategy/navigation_merge.png" format="PNG"/> + </imageobject> + </mediaobject> + </figure> </listitem> </varlistentry> <varlistentry> @@ -227,67 +273,17 @@ <para> Everything will be destroyed and replaced with new data if the <literal>OVERWRITE</literal> mode is used. </para> -<figure> -<title id="DataImportStrategy-navigation_2">Data Import Strategy Navigation_2</title> - <mediaobject> - <imageobject> - <imagedata width="444" align="center" fileref="images/DataImportStrategy/navigation2.png" format="PNG"/> - </imageobject> - </mediaobject> -</figure> + <figure> + <title id="DataImportStrategy-navigation_2">Data Import Strategy Navigation_2</title> + <mediaobject> + <imageobject> + <imagedata width="444" align="center" fileref="images/DataImportStrategy/navigation2.png" format="PNG"/> + </imageobject> + </mediaobject> + </figure> </listitem> </varlistentry> </variablelist> </section> </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>INSERT</literal> - </para> - </listitem> - <listitem> - <para> - <literal>OVERWRITE</literal> - </para> - </listitem> - </itemizedlist> - <para> - Each mode indicates how the portal data is 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; - &lt;type&gt;org.exoplatform.portal.config.UserPortalConfigService&lt;/type&gt; - &lt;component-plugins&gt; - ............ - &lt;/component-plugins&gt; - &lt;init-params&gt; - &lt;value-param&gt; - &lt;name&gt;default.import.mode&lt;/name&gt; - &lt;value&gt;merge&lt;/value&gt; - &lt;/value-param&gt; - &lt;/init-params&gt; -&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> - </section> </chapter> Modified: epp/docs/branches/6.0/Reference_Guide/en-US/modules/PortalDevelopment/DefaultPortalNavigationConfiguration.xml =================================================================== --- epp/docs/branches/6.0/Reference_Guide/en-US/modules/PortalDevelopment/DefaultPortalNavigationConfiguration.xml 2013-02-25 03:58:43 UTC (rev 9178) +++ epp/docs/branches/6.0/Reference_Guide/en-US/modules/PortalDevelopment/DefaultPortalNavigationConfiguration.xml 2013-02-25 04:10:23 UTC (rev 9179) @@ -5,7 +5,7 @@ ]> <chapter id="chap-Reference_Guide-Portal_Navigation_Configuration"> <title>Portal Navigation Configuration</title> -<remark>Source: https://docs.jboss.org/author/display/GTNPORTAL35/Portal+Navigation+Confi... + <remark>Source: https://docs.jboss.org/author/display/GTNPORTAL35/Portal+Navigation+Confi... <section id="sect-Reference_Guide-Portal_Navigation_Configuration-Overview"> <title>Overview</title> <para> @@ -198,12 +198,8 @@ User navigation is the set of nodes and pages that are owned by a user. They are part of the user&apos;s dashboard. </para> <!-- DOC NOTE: Get an answer on the below! --><!-- This Paragraph: --> <para> - Two files configure the user navigation (<filename>navigation.xml</filename> and <filename>pages.xml</filename>). They are located in the directory &quot;<filename>portal.war/WEB-INF/conf/portal/users/{userName}</filename>&quot;. - </para> + Two files configure the user navigation (<filename>navigation.xml</filename> and <filename>pages.xml</filename>). They are located in the directory<filename>JPP_HOME/gatein.ear/portal.war/WEB-INF/conf/portal/user/{userName}</filename>. </para> <para> - The file <filename>eXoGadgets.war/WEB-INF/gadget.xml</filename> defines the gadgets that will be available on a user dashboard. - </para> - <para> The example below shows a dashboard with all of the default gadgets included, as well as an extra currency converter gadget sourced from <ulink url="http://www.google.com/ig/directory?synd=open" type="http">Google Gadgets</ulink>. </para> <programlisting language="XML" role="XML"><xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="../../extras/PortalDevelopment_DefaultPortalNavigationConfiguration/gadgets.xml" parse="text"/></programlisting> Modified: epp/docs/branches/6.0/Reference_Guide/en-US/modules/PortalDevelopment/RTLFramework.xml =================================================================== --- epp/docs/branches/6.0/Reference_Guide/en-US/modules/PortalDevelopment/RTLFramework.xml 2013-02-25 03:58:43 UTC (rev 9178) +++ epp/docs/branches/6.0/Reference_Guide/en-US/modules/PortalDevelopment/RTLFramework.xml 2013-02-25 04:10:23 UTC (rev 9179) @@ -116,7 +116,7 @@ </para> <note> <para> - It is important to consider whether the image to be mirrored is symmetrical as this will impact it&apos;s final appearance. + It is important to consider whether the image to be mirrored is symmetrical as this will impact its final appearance. </para> </note> <para> Modified: epp/docs/branches/6.0/Reference_Guide/en-US/modules/PortalDevelopment/Skinning.xml =================================================================== --- epp/docs/branches/6.0/Reference_Guide/en-US/modules/PortalDevelopment/Skinning.xml 2013-02-25 03:58:43 UTC (rev 9178) +++ epp/docs/branches/6.0/Reference_Guide/en-US/modules/PortalDevelopment/Skinning.xml 2013-02-25 04:10:23 UTC (rev 9179) @@ -74,11 +74,9 @@ <title>Skin Selection</title> <section id="sect-Reference_Guide-Skin_Selection-Skin_Selection_Through_the_User_Interface"> <title>Skin Selection Through the User Interface</title> - <para> - A skin can be selected to be displayed to the user by multiple means. The easiest way to change the skin is to select it through the user interface. An administrator can change the default skin for the portal, or a logged in user can select which skin they would prefer to be displayed. + <para>The easiest way to change a skin is to select it through the user interface. An administrator can change the default skin for the portal, or a logged in user can select which skin they would prefer to be displayed. </para> - <para> - Please see the <ulink url="http://www.redhat.com/docs/en-US/JBoss_Enterprise_Portal_Platfo... type="http">User Guide</ulink> for information on how to change the skin using the user interface. + <para>For more information about changing skins, see the JBoss Portal Platform User Guide at <ulink url="https://access.redhat.com/knowledge/docs/en-US/JBoss_Portal_Pla... type="http"/>. </para> </section> <section id="sect-Reference_Guide-Skin_Selection-Setting_the_Default_Skin_within_the_Configuration_Files"> @@ -556,7 +554,7 @@ JBoss Portal Platform relies heavily on CSS to create the layout and effects for the UI. Some common techniques for customizing JBoss Portal Platform CSS are explained below. </para> <section id="sect-Reference_Guide-Some_CSS_Techniques-Border_Pattern"> - <title>Border Pattern</title> + <title>Decorator Pattern</title> <para> The decorator is a pattern to create a contour or a curve around an area. In order to achieve this effect you need to create nine cells. The <literal>BODY</literal> is the central area that you want to decorate. The other eight cells are distributed around the <literal>BODY</literal> cell. You can use the width, height and background image properties to achieve any decoration effect that you want. </para>