Author: smumford Date: 2010-04-30 03:57:03 -0400 (Fri, 30 Apr 2010) New Revision: 2909 Modified: portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Reference_Guide/en-US/modules/Introduction.xml portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Reference_Guide/en-US/modules/PortalDevelopment/AjaxLoadingMaskLayerDeactivation.xml portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Reference_Guide/en-US/modules/PortalDevelopment/DefaultPortalConfiguration.xml portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Reference_Guide/en-US/modules/PortalDevelopment/DefaultPortalNavigationConfiguration.xml portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Reference_Guide/en-US/modules/PortalDevelopment/DefaultPortalPermissionConfiguration.xml portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Reference_Guide/en-US/modules/PortalDevelopment/InternationalizationConfiguration.xml portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Reference_Guide/en-US/modules/PortalDevelopment/JavascriptConfiguration.xml portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Reference_Guide/en-US/modules/PortalDevelopment/JavascriptInterApplicationCommunication.xml portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Reference_Guide/en-US/modules/PortalDevelopment/PortalLifecycle.xml portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Reference_Guide/en-US/modules/PortalDevelopment/RTLFramework.xml portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Reference_Guide/en-US/modules/PortalDevelopment/Skinning.xml portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Reference_Guide/en-US/modules/PortalDevelopment/UploadComponent.xml portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Reference_Guide/en-US/modules/PortalDevelopment/XMLResourceBundles.xml Log: JBEPP-276: First edits of Part 1 Modified: portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Reference_Guide/en-US/modules/Introduction.xml =================================================================== --- portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Reference_Guide/en-US/modules/Introduction.xml 2010-04-30 07:23:12 UTC (rev 2908) +++ portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Reference_Guide/en-US/modules/Introduction.xml 2010-04-30 07:57:03 UTC (rev 2909) @@ -10,10 +10,10 @@ </para> <mediaobject> <imageobject role="html"> - <imagedata align="center" fileref="images/Common/Frontpage.png" format="PNG" scale="110" width="444" /> + <imagedata align="center" fileref="images/Common/Frontpage.png" format="PNG" scale="100" /> </imageobject> <imageobject role="fo"> - <imagedata align="center" contentwidth="150mm" fileref="images/Common/Frontpage.png" format="PNG" width="444" /> + <imagedata align="center" contentwidth="150mm" fileref="images/Common/Frontpage.png" format="PNG"/> </imageobject> </mediaobject> <para> Modified: portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Reference_Guide/en-US/modules/PortalDevelopment/AjaxLoadingMaskLayerDeactivation.xml =================================================================== --- portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Reference_Guide/en-US/modules/PortalDevelopment/AjaxLoadingMaskLayerDeactivation.xml 2010-04-30 07:23:12 UTC (rev 2908) +++ portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Reference_Guide/en-US/modules/PortalDevelopment/AjaxLoadingMaskLayerDeactivation.xml 2010-04-30 07:57:03 UTC (rev 2909) @@ -36,8 +36,8 @@ <para> However, the mask layer may need to be deactivated in instances where the portal requires user instructions before previous instructions have been carried out. </para> - <procedure id="proc-Reference_Guide-Purpose-How_to_deactivate_the_ajax_loading_mask"> - <title>How to deactivate the ajax-loading mask</title> + <procedure id="proc-Reference_Guide-Purpose-How_to_Deactivate_the_Ajax_Loading_Mask"> + <title>How to Deactivate the Ajax-Loading Mask</title> <step> <para> Generate a script to make an asynchronous ajax-call. Use the <literal>uicomponent.doAsync()</literal> method rather than the <literal>uicomponent.event()</literal> method. @@ -57,15 +57,16 @@ This request is asynchronous and the ajax-loading mask will not deployed. </para> <note> + <title>Asynchronous Requests Using <literal>uicomponent.event()</literal></title> <para> - An asynchronous request can still be made using the <literal>uicomponent.event()</literal>. When using this method, however, the asyncparam must be added manually. + An asynchronous request can still be made using the <literal>uicomponent.event()</literal>. When using this method, however, the <literal>asyncparam</literal> must be added manually. </para> </note> </step> </procedure> <para> - The GUI will be blocked to ensure a user can only request one action at a time and while the request seems to be synchronous, all ajax requests are, in fact always asynchronous. For further information refer to <xref linkend="sect-Reference_Guide-Deactivation_of_the_Ajax_Loading_Mask_Layer_-Synchronous_issue" />. + The GUI will be blocked to ensure a user can only request one action at a time and while the request seems to be synchronous, all ajax requests are, in fact, always asynchronous. For further information refer to <xref linkend="sect-Reference_Guide-Deactivation_of_the_Ajax_Loading_Mask_Layer_-Synchronous_issue" />. </para> </section> Modified: portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Reference_Guide/en-US/modules/PortalDevelopment/DefaultPortalConfiguration.xml =================================================================== --- portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Reference_Guide/en-US/modules/PortalDevelopment/DefaultPortalConfiguration.xml 2010-04-30 07:23:12 UTC (rev 2908) +++ portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Reference_Guide/en-US/modules/PortalDevelopment/DefaultPortalConfiguration.xml 2010-04-30 07:57:03 UTC (rev 2909) @@ -8,8 +8,14 @@ <section id="sect-Reference_Guide-Default_Portal_Configuration-Overview"> <title>Overview</title> <para> - &PRODUCT; 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 (i.e.: <literal>http://{hostname}:{port}/sample-portal/</literal>). Each portal is internally composed of one or more, what we again call 'portals'. There needs to be at least one such portal - the default one is called 'classic'. When accessing &PRODUCT; default home page URL, you are automatically redirected to 'classic' portal. The default portal performs another important task. When starting up &PRODUCT; for the first time, its JCR database will be empty (that's where portals keep their runtime-configurable settings). It's the default portal that's used to detect this, and to trigger automatic data initialization. + &PRODUCT; 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 (i.e.: <literal>http://{hostname}:{port}/sample-portal/</literal>). </para> + <para> + Each portal is internally composed of one or more 'portals'. This is because there needs to be at least one such portal available. The default one is called 'classic'. When accessing &PRODUCT;'s default home page URL, you are automatically directed to the 'classic' 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. + </para> </section> <section id="sect-Reference_Guide-Default_Portal_Configuration-Configuration"> @@ -42,11 +48,12 @@ <para> In this example the <emphasis role="bold">classic</emphasis> portal has been set as the default. </para> - <note> - <para> - Components, component-plugins, and init-params are explained in Foundations chapter. For now just note how <literal>NewPortalConfigListener</literal> component-plugin 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> - </note> + <para> + Notice that the <literal>NewPortalConfigListener</literal> <emphasis>component-plugin</emphasis> 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. + </para> </section> </chapter> Modified: portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Reference_Guide/en-US/modules/PortalDevelopment/DefaultPortalNavigationConfiguration.xml =================================================================== --- portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Reference_Guide/en-US/modules/PortalDevelopment/DefaultPortalNavigationConfiguration.xml 2010-04-30 07:23:12 UTC (rev 2908) +++ portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Reference_Guide/en-US/modules/PortalDevelopment/DefaultPortalNavigationConfiguration.xml 2010-04-30 07:57:03 UTC (rev 2909) @@ -97,8 +97,11 @@ &lt;/component-plugins&gt; </programlisting> <para> - This XML configuration defines where in the portal's war to look for configuration, and what portals, groups, and user specific views to include in portal/group/user navigation. Those files will be used to create an initial navigation, the first time the portal is launched. That information will then be stored in JCR content repository, and can then be modified, and managed from the portal UI. + 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. </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> </section> <section id="sect-Reference_Guide-Portal_Navigation_Configuration-Portal_Navigation"> @@ -107,7 +110,7 @@ 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 are used when a company owns multiple trademarks, and sets up a web site for each of them. </para> <para> - The <emphasis role="bold">classic</emphasis> portal is configured by four XML files in <filename>02portal.war:/WEB-INF/conf/portal/portal/classic</filename> directory: + The <emphasis role="bold">classic</emphasis> portal is configured by four XML files in the <filename>02portal.war:/WEB-INF/conf/portal/portal/classic</filename> directory: </para> <variablelist> <varlistentry> @@ -170,10 +173,10 @@ <term>navigation.xml</term> <listitem> <para> - This file defines all the navigation nodes the portal will have. The syntax is simple, using nested node tags. Each node references a page defined in pages.xml file (explained next). + 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> <para> - When <literal>#{...}</literal> syntax is used, the enclosed property name serves as a key that is automatically passed to internationalization mechanism so the literal property name is replaced by a localized value taken from the associated properties file matching the current locale. + When the <literal>#{...}</literal> syntax is used, the enclosed property name serves as a key that is automatically passed to internationalization mechanism so the literal property name is replaced by a localized value taken from the associated properties file matching the current locale. </para> <programlisting role="XML">&lt;?xml version="1.0" encoding="UTF-8"?&gt; @@ -202,8 +205,11 @@ </para> <warning> <para> - 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. 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>&lt;name&gt;fileexplorer&lt;/name&gt; </emphasis> ). + 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>&lt;name&gt;fileexplorer&lt;/name&gt; </emphasis> ). + </para> </warning> </listitem> </varlistentry> @@ -255,7 +261,8 @@ <term>portlet-preferences.xml</term> <listitem> <para> - Porlet instances can be associated with <literal>portlet-preferences</literal> that override the ones defined in <filename>portlet.xml</filename> of the portlet application <literal>war</literal> (TODO: clarify which file in which war). + Porlet instances can be associated with <literal>portlet-preferences</literal> that override the ones defined in <filename>portlet.xml</filename> of the portlet application <literal>war</literal>. + (TODO: clarify which file in which war). </para> <programlisting role="XML">&lt;?xml version="1.0" encoding="ISO-8859-1"?&gt; @@ -503,7 +510,7 @@ <section id="sect-Reference_Guide-Portal_Navigation_Configuration-Group_Navigation"> <title>Group Navigation</title> <para> - Group navigations are dynamically added to the user navigation at login. This allows users to see in the menu all the pages assigned to any groups they belong to. + Group navigations are dynamically added to the user navigation at login. This allows users to see the pages assigned to any groups they belong to in the menu. </para> <para> The group navigation menu is configured by three XML files (<filename>navigation.xml</filename>, <filename>pages.xml</filename> and <filename>portlet-preferences.xml</filename>). The syntax used in these files is the same as those covered in <xref linkend="sect-Reference_Guide-Portal_Navigation_Configuration-Portal_Navigation" />. @@ -573,7 +580,7 @@ <section id="sect-Reference_Guide-Tips-Direct_External_Links"> <title>Direct External Links</title> <para> - If you wish to add a link to a URL outside the portal you first have to define a "page" that will only serve as a navigation placeholder for external redirect - it will not be used for any portlets. Then add the URL to the navigation. (TODO: check for correctness) + If you wish to add a link to a URL outside the portal you must first define a "page" that will only serve as a navigation placeholder for an external redirect. This page will not be used for any portlets. Then add the URL to the navigation. (TODO: check for correctness) </para> <variablelist> <varlistentry> Modified: portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Reference_Guide/en-US/modules/PortalDevelopment/DefaultPortalPermissionConfiguration.xml =================================================================== --- portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Reference_Guide/en-US/modules/PortalDevelopment/DefaultPortalPermissionConfiguration.xml 2010-04-30 07:23:12 UTC (rev 2908) +++ portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Reference_Guide/en-US/modules/PortalDevelopment/DefaultPortalPermissionConfiguration.xml 2010-04-30 07:57:03 UTC (rev 2909) @@ -8,7 +8,7 @@ <section id="sect-Reference_Guide-Portal_Default_Permission_Configuration-Overview"> <title>Overview</title> <para> - The default permission configuration for the portal is defined through <literal>org.exoplatform.portal.config.UserACL</literal> component configuration in the file <filename>02portal.war:/WEB-INF/conf/portal/portal-configuration.xml</filename>. + The default permission configuration for the portal is defined through the <literal>org.exoplatform.portal.config.UserACL</literal> component configuration in the file <filename>02portal.war:/WEB-INF/conf/portal/portal-configuration.xml</filename>. </para> <para> It defines 5 permissions types: @@ -50,7 +50,7 @@ <term>access.control.workspace</term> <listitem> <para> - Defines the users that have access to the control workspace. In the demo version the control workspace is accessible only to <emphasis>root</emphasis> and <emphasis>john</emphasis>. They can expand/collapse the workspace at the left hand side. The format is <literal>membership:/group/subgroup</literal> - an asterisk '*' gives permission to all memberships. + Defines the users that have access to the control workspace. In the demontration (demo) version the control workspace is accessible only to <emphasis>root</emphasis> and <emphasis>john</emphasis>. They can expand/collapse the workspace at the left hand side. The format is <literal>membership:/group/subgroup</literal>. An asterisk (*) gives permission to all memberships. </para> </listitem> </varlistentry> @@ -94,7 +94,7 @@ <section id="sect-Reference_Guide-Portal_Default_Permission_Configuration-Overwrite_Portal_Default_Permissions"> <title>Overwrite Portal Default Permissions</title> <para> - When creating custom portals and portal extensions it's possible to override the default configuration by using <literal>org.exoplatform.portal.config.PortalACLPlugin</literal>, configuring it as an external-plugin of <literal>org.exoplatform.portal.config.UserACL</literal> service: + When creating custom portals and portal extensions it is possible to override the default configuration by using <literal>org.exoplatform.portal.config.PortalACLPlugin</literal>, configuring it as an external-plugin of <literal>org.exoplatform.portal.config.UserACL</literal> service: </para> <programlisting role="XML">&lt;external-component-plugins&gt; Modified: portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Reference_Guide/en-US/modules/PortalDevelopment/InternationalizationConfiguration.xml =================================================================== --- portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Reference_Guide/en-US/modules/PortalDevelopment/InternationalizationConfiguration.xml 2010-04-30 07:23:12 UTC (rev 2908) +++ portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Reference_Guide/en-US/modules/PortalDevelopment/InternationalizationConfiguration.xml 2010-04-30 07:57:03 UTC (rev 2909) @@ -20,13 +20,13 @@ All &PRODUCT; applications contain property files for various languages. They are packaged with the portlets applications in a <filename>WEB-INF/classes/locale/</filename> directory. </para> <para> - These files are located in the <literal>classes</literal> folder of the WEB-INF directory, so as to be loaded by the ClassLoader. + These files are located in the <filename>classes</filename> folder of the <filename>WEB-INF</filename> directory, so as to be loaded by the <literal>ClassLoader</literal>. </para> <para> All resource files are in a subfolder named <literal>locale</literal>. </para> <para> - For instance; the translations for the <emphasis>NavigationPortlet</emphasis> are located in <literal>web.war/WEB-INF/classes/locale/portlet/portal</literal> + For instance; the translations for the <emphasis>NavigationPortlet</emphasis> are located in <filename>web.war/WEB-INF/classes/locale/portlet/portal</filename> </para> <programlisting>NavigationPortlet_de.properties @@ -39,7 +39,7 @@ NavigationPortlet_ar.xml </programlisting> <para> - Inside those file are typical <literal>key=value</literal> Java EE properties. For example the French one: + Inside those file are typical <literal>key=value</literal> Java EE properties. For example; in the <literal>French</literal> file: </para> <programlisting>javax.portlet.title=Portlet Navigation @@ -51,18 +51,21 @@ From a portlet you can then access translations from the portlet itself or shared at the portal level, both are aggregated when you need them. </para> <note> - <title>Translation in XML format</title> + <title>Translation in XML Format</title> <para> - It is also possible to use a proprietary XML format to define translations. This is a more convenient way to translate a document for some languages such as Japanese, Arabic or Russian. Property files have te be ASCII encoded, while the XML file can define its encoding. As a result it's easier for a human being to read (and fix) a translation in XML instead of having to decode and encode the property file. + It is also possible to use a proprietary XML format to define translations. This is a more convenient way to translate a document for some languages such as Japanese, Arabic or Russian. </para> <para> + Property files have te be ASCII encoded, while the XML file can define its encoding. As a result it's easier for a human being to read a translation in XML instead of having to decode and encode the property file. + </para> + <para> For more information refer to: <xref linkend="chap-Reference_Guide-XML_Resources_Bundles" /> </para> </note> </section> <section id="sect-Reference_Guide-Internationalization_Configuration-Locales_configuration"> - <title>Locales configuration</title> + <title>Locales Configuration</title> <para> Various languages are available in the portal package. The configuration below will define which languages are shown in the "Change Language" section and made available to users. </para> @@ -134,17 +137,17 @@ </callout> <callout arearefs="area-Reference_Guide-i18n.locales.configuration.input-encoding"> <para> - <emphasis>input-encoding</emphasis> In the java implementation, the encoding parameters will be used for the request response stream. The input-encoding parameter will be used for request setCharacterEncoding(..). + <emphasis>input-encoding</emphasis> In the java implementation, the encoding parameters will be used for the request response stream. The input-encoding parameter will be used for request <literal>setCharacterEncoding(..)</literal>. </para> </callout> <callout arearefs="area-Reference_Guide-i18n.locales.configuration.description"> <para> - <emphasis>description</emphasis> Description for the language + <emphasis>description</emphasis> A description of the language </para> </callout> <callout arearefs="area-Reference_Guide-i18n.locales.configuration.orientation"> <para> - <emphasis>orientation</emphasis> The default orientation of text and images is Left-To-Right. &PRODUCT; supports <emphasis role="bold">Right-To-Left</emphasis> orientation. Modifying text orientation is explained in <xref linkend="chap-Reference_Guide-RTL_Right_To_Left_Framework" />. + <emphasis>orientation</emphasis> Although the default orientation of text and images is Left-To-Right, &PRODUCT; supports <emphasis role="bold">Right-To-Left</emphasis> orientation. Modifying text orientation is explained in <xref linkend="chap-Reference_Guide-RTL_Right_To_Left_Framework" />. </para> </callout> </calloutlist> @@ -231,13 +234,13 @@ The previous example shows bundle definitions for the navigation of the classic portal and of four different groups. Each of these resource bundles occupies a different sphere, they are independent of each other and they are not included in the <parameter>portal.resource.names</parameter> parameter. </para> <para> - The properties for a group must be in the <filename>WEB-INF/classes/locale/navigation/group/</filename> folder. <literal>/WEB-INF/classes/locale/navigation/group/organization/management/executive-board_en.properties</literal>, for example. + The properties for a group must be in the <filename>WEB-INF/classes/locale/navigation/group/</filename> folder. For example; <literal>/WEB-INF/classes/locale/navigation/group/organization/management/executive-board_en.properties</literal>. </para> <para> - The folder and file names must correspond to the group hierarchy. The group name "<parameter>executive-board</parameter>" is followed by the iso 639 code. + The folder and file names must correspond to the group hierarchy. The group name "<parameter>executive-board</parameter>" is followed by the <emphasis role="bold">iso 639</emphasis> code. </para> <para> - For each language defined in <parameter>LocalesConfig</parameter> must have a resource file defined. If the name of a group is changed the name of the folder and/or files of the correspondent navigation resource bundles must also be changed. + Each language defined in <parameter>LocalesConfig</parameter> must have a resource file defined. If the name of a group is changed the name of the folder and/or files of the correspondent navigation resource bundles must also be changed. </para> <para> Content of <filename>executive-board_en.properties</filename>: @@ -252,7 +255,7 @@ </section> <section id="sect-Reference_Guide-Internationalization_Configuration-_Portlets_"> - <title> Portlets </title> + <title>Portlets</title> <para> Portlets are independent applications and deliver their own resource files. </para> @@ -273,7 +276,7 @@ </step> <step> <para> - In <filename>portlet.xml</filename>, add <parameter>Spanish</parameter> as a <emphasis role="bold">supported-locale</emphasis> ('es' is the 2 letters code for Spanish), the <emphasis role="bold">resource-bundle</emphasis> is already declared and is the same for all languages : + In <filename>portlet.xml</filename>, add <parameter>Spanish</parameter> as a <emphasis role="bold">supported-locale</emphasis> ('<emphasis role="bold">es</emphasis>' is the two letter code for Spanish). The <emphasis role="bold">resource-bundle</emphasis> is already declared and is the same for all languages : </para> <programlisting role="XML">&lt;supported-locale&gt;en&lt;/supported-locale&gt; @@ -286,10 +289,10 @@ <para> See the portlet specification for more details about portlet internationalization. </para> - <section id="sect-Reference_Guide-_Portlets_-Standard_portlet_resource_keys"> - <title>Standard portlet resource keys</title> + <section id="sect-Reference_Guide-_Portlets_-Standard_Portlet_Resource_Keys"> + <title>Standard Portlet Resource Keys</title> <para> - The portlet specifications defines three standard keys: Title, Short Title and Keywords. Keywords is formatted as a comma-separated list of tags. + The portlet specifications defines three standard keys: <emphasis>Title</emphasis>, <emphasis>Short Title</emphasis> and <emphasis>Keywords</emphasis>. Keywords is formatted as a comma-separated list of tags. </para> <programlisting> javax.portlet.title=Breadcrumbs Portlet @@ -298,8 +301,8 @@ </programlisting> </section> - <section id="sect-Reference_Guide-_Portlets_-Debugging_resource_bundle_usage"> - <title>Debugging resource bundle usage</title> + <section id="sect-Reference_Guide-_Portlets_-Debugging_Resource_Bundle_Usage"> + <title>Debugging Resource Bundle Usage</title> <para> When translating an application it can sometimes be difficult to find the right key for a given property. </para> Modified: portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Reference_Guide/en-US/modules/PortalDevelopment/JavascriptConfiguration.xml =================================================================== --- portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Reference_Guide/en-US/modules/PortalDevelopment/JavascriptConfiguration.xml 2010-04-30 07:23:12 UTC (rev 2908) +++ portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Reference_Guide/en-US/modules/PortalDevelopment/JavascriptConfiguration.xml 2010-04-30 07:57:03 UTC (rev 2909) @@ -9,13 +9,13 @@ Managing Javascript scripts in an application like &PRODUCT; is a critical part of the configuration work. Configuring the scripts correctly will result in a faster response time from the portal. </para> <para> - Every portlet can have its own javscript code but in many cases it is more convenient to reuse some existing shared libraries. For that reason, &PRODUCT; has a mechanism to easily register the libraries that will be loaded when the first page will be rendered. + Every portlet can have its own javscript code but in many cases it is more convenient to reuse some existing shared libraries. For that reason, &PRODUCT; has a mechanism to easily register the libraries that will be loaded when the first page is rendered. </para> <para> To do so, every WAR deployed in &PRODUCT; can register the <filename>.js</filename> files with the groovy script <filename>WEB-INF/conf/script/groovy/JavascriptScript.groovy</filename>. (TODO: this file doesn't seem to exist) </para> <para> - The example file below is found in the 01eXoResources.war + The example file below is found in the <literal>01eXoResources.war</literal> </para> <programlisting role="JAVA">JavascriptService.addJavascript("eXo", "/javascript/eXo.js", ServletContext); @@ -77,10 +77,10 @@ To see or use the merged file set this property to <literal>false</literal>. </para> <para> - The property can be passed as a JVM parameter with the <literal>-D</literal> option in your <literal>GateIn.sh</literal> or <literal>GateIn.bat</literal> startup script. + The property can be passed as a JVM parameter with the <literal>-D</literal> option in your <literal>run.sh</literal> or <literal>run.bat</literal> startup script. </para> <para> - Every javascript file is associated with a module name which acts as a namespace. The module name is passed as a first parameter to JavascriptService.addJavascript() function as in the following example: + Every javascript file is associated with a module name which acts as a namespace. The module name is passed as a first parameter to <literal>JavascriptService.addJavascript()</literal> function as in the following example: </para> <programlisting role="JAVA"> Modified: portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Reference_Guide/en-US/modules/PortalDevelopment/JavascriptInterApplicationCommunication.xml =================================================================== --- portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Reference_Guide/en-US/modules/PortalDevelopment/JavascriptInterApplicationCommunication.xml 2010-04-30 07:23:12 UTC (rev 2908) +++ portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Reference_Guide/en-US/modules/PortalDevelopment/JavascriptInterApplicationCommunication.xml 2010-04-30 07:57:03 UTC (rev 2909) @@ -186,7 +186,7 @@ <term>Publish</term> <listitem> <para> - The <literal>publish</literal> function is used to publish an event to the other subscribered applications through the given channels. Its parameters are: + The <literal>publish</literal> function is used to publish an event to the other subscribed applications through the given channels. Its parameters are: </para> <variablelist> <varlistentry> Modified: portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Reference_Guide/en-US/modules/PortalDevelopment/PortalLifecycle.xml =================================================================== --- portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Reference_Guide/en-US/modules/PortalDevelopment/PortalLifecycle.xml 2010-04-30 07:23:12 UTC (rev 2908) +++ portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Reference_Guide/en-US/modules/PortalDevelopment/PortalLifecycle.xml 2010-04-30 07:57:03 UTC (rev 2909) @@ -4,21 +4,21 @@ %BOOK_ENTITIES; ]> <chapter id="chap-Reference_Guide-Portal_Lifecycle"> - <title>Portal Lifecycle</title> + <title>Portal Life-cycle</title> <section id="sect-Reference_Guide-Portal_Lifecycle-Overview"> <title>Overview</title> <para> - This chapter describes the portal lifecycle from the application server start to its stop as well as how requests are handled. + This chapter describes the portal life-cycle from the application server start to its stop as well as how requests are handled. </para> </section> <section id="sect-Reference_Guide-Portal_Lifecycle-Application_Server_start_and_stop"> <title>Application Server start and stop</title> <para> - A portal instance is simply a web application deployed as a WAR in an application server. Portlets are also part of an enhanced WAR called a portlet application. + A portal instance is simply a web application deployed as a <literal>WAR</literal> in an application server. Portlets are also part of an enhanced WAR called a portlet application. </para> <para> - &PRODUCT; doesn't require any particular setup for your portlet in most common scenarios and the <filename>web.xml</filename> file can remain without any &PRODUCT; specific configuration. + &PRODUCT; does not require any particular setup for your portlet in most common scenarios and the <filename>web.xml</filename> file can remain without any &PRODUCT; specific configuration. </para> <para> During deployment, &PRODUCT; will automatically and transparently inject a servlet into the portlet application to be able to interact with it. This feature is dependent on the underlying servlet container but will work out of the box on the proposed bundles. @@ -91,12 +91,13 @@ <section id="sect-Reference_Guide-Portal_Lifecycle-The_Command_Servlet"> <title>The Command Servlet</title> <para> - The servlet is the main entry point for incoming requests, it also includes some init code when the portal is launched. This servlet (<literal>org.gatein.wci.command.CommandServlet</literal>) is automatically added during deployment and mapped to <literal>/tomcatgateinservlet</literal>. + The servlet is the main entry point for incoming requests, it also includes some <literal>init</literal> code when the portal is launched. This servlet (<literal>org.gatein.wci.command.CommandServlet</literal>) is automatically added during deployment and mapped to <literal>/tomcatgateinservlet</literal>. </para> <para> This is equivalent to adding the following into <filename>web.xml</filename>. </para> <note> + <title>Servlet Configuration</title> <para> As the servlet is already configured this example is for information only. </para> @@ -115,7 +116,7 @@ &lt;/servlet-mapping&gt; </programlisting> <para> - It is possible to filter on the CommandServlet by filtering the URL pattern used by the Servlet mapping. + It is possible to filter on the <literal>CommandServlet</literal> by filtering the URL pattern used by the servlet mapping. </para> <para> The example below would create a servlet filter that calculates the time of execution of a portlet request. @@ -157,8 +158,11 @@ } </programlisting> <para> - The Java EE web application configuration file (<filename>web.xml</filename>) of the portlet on which we want to know the time to serve a portlet request. As mentioned above nothing specific to &PRODUCT; needs to be included, only the URL pattern to set has to be known. + The Java EE web application configuration file (<filename>web.xml</filename>) of the portlet is the file on which we want to know the time to serve a portlet request. </para> + <para> + As mentioned above nothing specific to &PRODUCT; needs to be included, only the URL pattern to set has to be known. + </para> <programlisting role="XML"> &lt;?xml version="1.0"?&gt; @@ -183,7 +187,7 @@ <note> <title>INCLUDE dispatcher</title> <para> - It is important to set <literal>INCLUDE</literal> as dispatcher as the portal will always hit the CommandServlet through a request dispatcher. Without this, the filter will not be triggered, unless direct access to a resource (such as an image). + It is important to set <literal>INCLUDE</literal> as dispatcher as the portal will always hit the <literal>CommandServlet</literal> through a request dispatcher. Without this, the filter will not be triggered, unless direct access to a resource (such as an image). </para> </note> </para> Modified: portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Reference_Guide/en-US/modules/PortalDevelopment/RTLFramework.xml =================================================================== --- portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Reference_Guide/en-US/modules/PortalDevelopment/RTLFramework.xml 2010-04-30 07:23:12 UTC (rev 2908) +++ portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Reference_Guide/en-US/modules/PortalDevelopment/RTLFramework.xml 2010-04-30 07:57:03 UTC (rev 2909) @@ -4,7 +4,7 @@ %BOOK_ENTITIES; ]> <chapter id="chap-Reference_Guide-RTL_Right_To_Left_Framework"> - <title>RTL (Right To Left) Framework</title> + <title>Right To Left (RTL) Framework</title> <para> The text orientation depends on the current locale setting. The orientation is a Java 5 enum that provides a set of functionalities: </para> @@ -38,7 +38,7 @@ <term>Orientation</term> <listitem> <para> - The current orientation as an Orientation + The current orientation as an Orientation. </para> </listitem> </varlistentry> @@ -46,7 +46,7 @@ <term>isLT</term> <listitem> <para> - The value of orientation.isLT() + The value of <literal>orientation.isLT()</literal>. </para> </listitem> </varlistentry> @@ -54,7 +54,7 @@ <term>isRT</term> <listitem> <para> - The value of orientation.isRT() + The value of <literal>orientation.isRT()</literal>. </para> </listitem> </varlistentry> @@ -62,7 +62,7 @@ <term>dir</term> <listitem> <para> - The string 'ltr' if the orientation is LT or the string 'rtl' if the orientation is RT. + The string '<emphasis role="bold">ltr</emphasis>' if the orientation is LT or the string '<emphasis role="bold">rtl</emphasis>' if the orientation is RT. </para> </listitem> </varlistentry> @@ -162,8 +162,8 @@ </programlisting> </section> - <section id="sect-Reference_Guide-RTL_Right_To_Left_Framework-Client_side_JavaScript"> - <title>Client side JavaScript</title> + <section id="sect-Reference_Guide-RTL_Right_To_Left_Framework-Client_Side_JavaScript"> + <title>Client Side JavaScript</title> <para> The <literal>eXo.core.I18n</literal> object provides the following parameters for orientation: </para> Modified: portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Reference_Guide/en-US/modules/PortalDevelopment/Skinning.xml =================================================================== --- portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Reference_Guide/en-US/modules/PortalDevelopment/Skinning.xml 2010-04-30 07:23:12 UTC (rev 2908) +++ portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Reference_Guide/en-US/modules/PortalDevelopment/Skinning.xml 2010-04-30 07:57:03 UTC (rev 2909) @@ -4,7 +4,7 @@ %BOOK_ENTITIES; ]> <chapter id="chap-Reference_Guide-Skinning_the_portal"> - <title>Skinning the portal</title> + <title>Skinning the Portal</title> <section id="sect-Reference_Guide-Skinning_the_portal-Overview"> <title>Overview</title> <para> @@ -15,14 +15,14 @@ <section id="sect-Reference_Guide-Skinning_the_portal-Skin_Components"> <title>Skin Components</title> <para> - The complete skinning of a page can be decomposed into three main parts: + The complete skinning of a page is composed of three main parts: </para> <variablelist> <varlistentry> <term>Portal Skin</term> <listitem> <para> - The portal skin contains the css styles for the portal and its various UI components. This should include all the UI components except for the window decorators and portlet specific styles. + The portal skin contains the CSS styles for the portal and its various UI components. This should include all the UI components except for the window decorators and portlet specific styles. </para> </listitem> </varlistentry> @@ -45,7 +45,7 @@ <term>Portlet Specification CSS Classes</term> <listitem> <para> - The portlet specification defines a set of css classes that should be available to portlets. &PRODUCT; provides these classes as part of the portal skin. This allows each portal skin to define its own look and feel for these default values. + The portlet specification defines a set of CSS classes that should be available to portlets. &PRODUCT; provides these classes as part of the portal skin. This allows each portal skin to define its own look and feel for these default values. </para> </listitem> </varlistentry> @@ -53,7 +53,7 @@ <term>Portlet Skins</term> <listitem> <para> - &PRODUCT; provides a means for portlet css files to be loaded based on the current portal skin. This allows a portlet to provide different css styles to better match the current portal look and feel. Portlet skins provide a much more customizable css experience than just using the portlet specification css classes. + &PRODUCT; provides a means for portlet CSS files to be loaded based on the current portal skin. This allows a portlet to provide different CSS styles to better match the current portal look and feel. Portlet skins provide a much more customizable CSS experience than just using the portlet specification CSS classes. </para> </listitem> </varlistentry> @@ -64,10 +64,10 @@ <note> <title>CSS Classes</title> <para> - The window decorators and the default portlet specification css classes should be considered separate types of skinning components, but they need to be included as part of the overall portal skin. The portal skin must include these components' css classes or they will not be displayed correctly. + The window decorators and the default portlet specification CSS classes should be considered separate types of skinning components, but they need to be included as part of the overall portal skin. The portal skin must include these components' CSS classes or they will not be displayed correctly. </para> <para> - A portlet skin doesn't need to be included as part of the portal skin and can be included within the portlets web application. + A portlet skin does not need to be included as part of the portal skin and can be included within the portlets web application. </para> </note> </section> @@ -77,7 +77,7 @@ <section id="sect-Reference_Guide-Skin_Selection-Skin_Selection_Through_the_User_Interface"> <title>Skin Selection Through the User Interface</title> <para> - There are a few means in which a skin can be selected to be displayed to the user. The easiest way to change the skin is select it through the user interface. An admin can change the default skin for the portal, or a logged in user can select which skin they would prefer to be displayed. + There are a few means in which a skin can be selected to be displayed to the user. The easiest way to change the skin is 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 type="http" url="http://www.redhat.com/docs/en-US/JBoss_Enterprise_Portal_Platfo... Guide</ulink> for information on how to change the skin using the user interface. @@ -87,7 +87,7 @@ <section id="sect-Reference_Guide-Skin_Selection-Setting_the_Default_Skin_within_the_Configuration_Files"> <title>Setting the Default Skin within the Configuration Files</title> <para> - The default skin can also be configured through the portal configuration files if using the admin user interface is not desired. This will allow for the portal to have the new default skin ready when &PRODUCT; is first started. + The default skin can also be configured using the portal configuration files. This allows the portal to have the new default skin ready for use when &PRODUCT; is first started. </para> <para> The default skin of the portal is called <literal>Default</literal>. To change this value add a <literal>skin</literal> tag in the <literal>02portal.war/WEB-INF/conf/portal/portal/classic/portal.xml</literal> configuration file. @@ -111,17 +111,17 @@ <section id="sect-Reference_Guide-Skinning_the_portal-Skins_in_Page_Markups"> <title>Skins in Page Markups</title> <para> - A &PRODUCT; skin contains css styles for the portal's components but also shares components that may be reused in portlets. When &PRODUCT; generates a portal page markup, it inserts stylesheet links in the page's <literal>head</literal> tag. + A &PRODUCT; skin contains CSS styles for the portal's components but also shares components that may be reused in portlets. When &PRODUCT; generates a portal page markup, it inserts stylesheet links in the page's <literal>head</literal> tag. </para> <para> - There are two main types of css links that will appear in the <literal>head</literal> tag: a link to the portal skin css file and a link to the portlet skin css files. + There are two main types of CSS links that will appear in the <literal>head</literal> tag: a link to the portal skin CSS file and a link to the portlet skin CSS files. </para> <variablelist> <varlistentry> <term>Portal Skin</term> <listitem> <para> - The portal skin will appear as a single link to a css file. This link will contain contents from all the portal skin classes merged into one file. This allow for the portal skin to be transfered more quickly as a single file instead of many multiple smaller files. Included with every page render. + The portal skin will appear as a single link to a CSS file. This link will contain contents from all the portal skin classes merged into one file. This allows the portal skin to be transfered as a single file instead of multiple smaller files. Included with every page render <emphasis>&gt;-- Unsure what this is referring to.</emphasis> </para> </listitem> </varlistentry> @@ -129,7 +129,7 @@ <term>Portlet Skin</term> <listitem> <para> - Each portlet on a page may contribute its own style. The link to the portlet skin will only appear on the page if that portlet is loaded on the current page. A page may contain many portlet skin css links or none. + Each portlet on a page may contribute its own style. The link to the portlet skin will only appear on the page if that portlet is loaded on the current page. A page may contain many portlet skin CSS links or none. </para> </listitem> </varlistentry> @@ -141,18 +141,18 @@ <programlisting role="XML">&lt;head&gt; ... &lt;!-- The portal skin --&gt; -&lt;link id="CoreSkin" rel="stylesheet" type="text/css" href="/eXoResources/skin/Stylesheet.css" /&gt; +&lt;link id="CoreSkin" rel="stylesheet" type="text/CSS" href="/eXoResources/skin/Stylesheet.CSS" /&gt; &lt;!-- The portlet skins --&gt; -&lt;link id="web_FooterPortlet" rel="stylesheet" type="text/css" href= "/web/skin/portal/webui/component/UIFooterPortlet/DefaultStylesheet.css" /&gt; -&lt;link id="web_NavigationPortlet" rel="stylesheet" type="text/css" href= "/web/skin/portal/webui/component/UINavigationPortlet/DefaultStylesheet.css" /&gt; -&lt;link id="web_HomePagePortlet" rel="stylesheet" type="text/css" href= "/portal/templates/skin/webui/component/UIHomePagePortlet/DefaultStylesheet.css" /&gt; -&lt;link id="web_BannerPortlet" rel="stylesheet" type="text/css" href= "/web/skin/portal/webui/component/UIBannerPortlet/DefaultStylesheet.css" /&gt; +&lt;link id="web_FooterPortlet" rel="stylesheet" type="text/CSS" href= "/web/skin/portal/webui/component/UIFooterPortlet/DefaultStylesheet.CSS" /&gt; +&lt;link id="web_NavigationPortlet" rel="stylesheet" type="text/CSS" href= "/web/skin/portal/webui/component/UINavigationPortlet/DefaultStylesheet.CSS" /&gt; +&lt;link id="web_HomePagePortlet" rel="stylesheet" type="text/CSS" href= "/portal/templates/skin/webui/component/UIHomePagePortlet/DefaultStylesheet.CSS" /&gt; +&lt;link id="web_BannerPortlet" rel="stylesheet" type="text/CSS" href= "/web/skin/portal/webui/component/UIBannerPortlet/DefaultStylesheet.CSS" /&gt; ... &lt;/head&gt; </programlisting> <note> - <title>CSS classes</title> + <title>CSS Classes</title> <para> Window styles and the portlet specification CSS classes are included within the portal skin. </para> @@ -162,7 +162,7 @@ <section id="sect-Reference_Guide-Skinning_the_portal-The_Skin_Service"> <title>The Skin Service</title> <para> - The skin service is a &PRODUCT; service which manages the various types of skins. It is reponsible for discovering and deploying the skins into the portal. + The skin service is a service which manages the various types of skins. It is reponsible for discovering and deploying the skins into the portal. </para> <section id="sect-Reference_Guide-The_Skin_Service-Skin_configuration"> <title>Skin configuration</title> @@ -174,13 +174,13 @@ </para> <para> - Here is an example where we define a skin (MySkin) with its CSS location, and specify a few window decorator skins: + Here is an example where we define a skin (<literal>MySkin</literal>) with its CSS location, and specify a few window decorator skins: </para> <programlisting role="XML">&lt;gatein-resources&gt; &lt;portal-skin&gt; &lt;skin-name&gt;MySkin&lt;/skin-name&gt; - &lt;css-path&gt;/skin/myskin.css&lt;/css-path&gt; + &lt;CSS-path&gt;/skin/myskin.CSS&lt;/CSS-path&gt; &lt;overwrite&gt;false&lt;/overwrite&gt; &lt;/portal-skin&gt; &lt;/gatein-resources&gt; @@ -201,10 +201,10 @@ <section id="sect-Reference_Guide-The_Skin_Service-Resource_Request_Filter"> <title>Resource Request Filter</title> <para> - Because of the Right-To-Left support all CSS files need to be retrieved through a Servlet filter and the web application needs to be configured to activate this filter. This is already done for 01eXoResources.war web application which contains the default skin. + Because of &PRODUCT;'s Right-To-Left support, all CSS files need to be retrieved through a Servlet filter and the web application needs to be configured to activate this filter. This is already done for <literal>01eXoResources.war</literal> web application which contains the default skin. </para> <para> - Any new web applications containing skinning css files will need to have the following added to their <literal>web.xml</literal> : + Any new web applications containing skinning CSS files will need to have the following added to their <filename>web.xml</filename> : </para> <programlisting role="XML">&lt;filter&gt; @@ -214,12 +214,12 @@ &lt;filter-mapping&gt; &lt;filter-name&gt;ResourceRequestFilter&lt;/filter-name&gt; - &lt;url-pattern&gt;*.css&lt;/url-pattern&gt; + &lt;url-pattern&gt;*.CSS&lt;/url-pattern&gt; &lt;/filter-mapping&gt; </programlisting> <note> - <title><literal>display-name</literal></title> + <title>The <literal>display-name</literal> Element</title> <para> The <literal>display-name</literal> element will also need to be specified in the <literal>web.xml</literal> for the skinning service to work properly with the web application. </para> @@ -230,9 +230,9 @@ <section id="sect-Reference_Guide-Skinning_the_portal-The_Default_Skin"> <title>The Default Skin</title> <para> - The default skin for &PRODUCT; is located as part of the <literal>01eXoResource.war</literal>. The main files associated with the skin is show below: + The default skin for &PRODUCT; is located as part of the <literal>01eXoResource.war</literal>. The main files associated with the skin are: </para> - <programlistingco> +<!-- <programlistingco> <areaspec> <area coords="1" id="area-Reference_Guide-Skin_Configuration-Default_Skin-gatein-resources" /> <area coords="2" id="area-Reference_Guide-Skin_Configuration-Default_Skin-web" /> @@ -241,7 +241,7 @@ <programlisting>WEB-INF/gatein-resources.xml WEB-INF/web.xml -skin/Stylesheet.css +skin/Stylesheet.CSS </programlisting> <calloutlist> <callout arearefs="area-Reference_Guide-Skin_Configuration-Default_Skin-gatein-resources"> @@ -256,18 +256,34 @@ </callout> <callout arearefs="area-Reference_Guide-Skin_Configuration-Default_Skin-skin-Stylesheet"> <para> - Stylesheet.css: contains the CSS class definitions for this skin. + Stylesheet.CSS: contains the CSS class definitions for this skin. </para> </callout> </calloutlist> - </programlistingco> - + </programlistingco> --> + <itemizedlist> + <listitem> + <para> + <filename>WEB-INF/gatein-resources.xml</filename> + </para> + </listitem> + <listitem> + <para> + <filename>WEB-INF/web.xml</filename> + </para> + </listitem> + <listitem> + <para> + <filename>skin/Stylesheet.CSS</filename> + </para> + </listitem> + </itemizedlist> <variablelist> <varlistentry> <term>gatein-resources.xml</term> <listitem> <para> - For the default portal skin, this file contains definitions for the portal skin, the window decorations that this skin provides and well as defining some javascript resources which are not related to the skin. The default portal skin doesn't directly define portlet skins, these should be provided by the portlets themeselves. + For the default portal skin, this file contains definitions for the portal skin, the window decorations that this skin provides and well as defining some javascript resources which are not related to the skin. The default portal skin doesn't directly define portlet skins, these should be provided by the portlets themselves. </para> </listitem> </varlistentry> @@ -275,15 +291,15 @@ <term>web.xml</term> <listitem> <para> - For the default portal skin, the <filename>web.xml</filename> of the <literal>eXoResources.war</literal> will contains a lot of information which is mostly irrelevant to the portal skining. The areas of interest in this file is the resourcerequestfilter and the fact that the display-name is set. + For the default portal skin, the <filename>web.xml</filename> of the <literal>eXoResources.war</literal> will contains a lot of information which is mostly irrelevant to the portal skinning. The area of interest in this file is the <literal>resourcerequestfilter</literal> and the fact that the <parameter>display-name</parameter> is set. </para> </listitem> </varlistentry> <varlistentry> - <term>Stylesheet.css</term> + <term>Stylesheet.CSS</term> <listitem> <para> - The main portal skin stylesheet. The file is the main entry point to the css class definitions for the skin. Below is shown the contents of this file: + This file is the main portal skin stylesheet. It is the main entry point to the CSS class definitions for the skin. The main content points of this file are: </para> <programlistingco> <areaspec> @@ -293,15 +309,15 @@ <area coords="4" id="area-Reference_Guide-Skin_Configuration-Default_Skin-portlet" /> </areaspec> -<programlisting>@import url(DefaultSkin/portal/webui/component/UIPortalApplicationSkin.css); -@import url(DefaultSkin/webui/component/Stylesheet.css); -@import url(PortletThemes/Stylesheet.css); -@import url(Portlet/Stylesheet.css); +<programlisting>@import url(DefaultSkin/portal/webui/component/UIPortalApplicationSkin.CSS); +@import url(DefaultSkin/webui/component/Stylesheet.CSS); +@import url(PortletThemes/Stylesheet.CSS); +@import url(Portlet/Stylesheet.CSS); </programlisting> <calloutlist> <callout arearefs="area-Reference_Guide-Skin_Configuration-Default_Skin-uiportletapplication"> <para> - Skin for the main portal page. + The skin for the main portal page. </para> </callout> <callout arearefs="area-Reference_Guide-Skin_Configuration-Default_Skin-components"> @@ -316,25 +332,25 @@ </callout> <callout arearefs="area-Reference_Guide-Skin_Configuration-Default_Skin-portlet"> <para> - The portlet specificiation css classes. + The portlet specification CSS classes. </para> </callout> </calloutlist> </programlistingco> <para> - Instead of defining all the CSS classes in this one file we are instead importing other css stylesheet files, some of which may also import other CSS stylesheets. The css classes are split up between multiple files to make it easier for new skins to reuse parts of the default skin. + Instead of defining all the CSS classes in this one file, we are instead importing other CSS stylesheet files, some of which may also import other CSS stylesheets. Splitting the CSS classes between multiple files allows new skins to reuse parts of the default skin. </para> <para> - To reuse a CSS stylesheet from the default portal skin you would need to reference the default skin from eXoResources. For example, to include the window decorators from the default skin within a new portal skin you would need to use this import: + To reuse a CSS stylesheet from the default portal skin you would need to reference the default skin from <literal>eXoResources</literal>. For example; to include the window decorators from the default skin within a new portal skin you would need to use this import: </para> -<programlisting>@import url(/eXoResources/skin/Portlet/Stylesheet.css); +<programlisting>@import url(/eXoResources/skin/Portlet/Stylesheet.CSS); </programlisting> <note> <title>Stylesheet Merging</title> <para> - When the portal skin is added to the page, it merge all the css stylesheets into a single file. + When the portal skin is added to the page, it merge all the CSS stylesheets into a single file. </para> </note> </listitem> @@ -347,18 +363,18 @@ <section id="sect-Reference_Guide-Creating_New_Skins-Creating_a_New_Portal_Skin"> <title>Creating a New Portal Skin</title> <para> - A new portal will need to be added to the portal through the skin service. As such the web application which contains the skin will need to be properly configured for the skin service to discover them. This means properly configuring the ResourceRequestFilter and gatein-resources.xml. + A new portal skins will need to be added to the portal through the skin service. Therefore, the web application which contains the skins will need to be properly configured for the skin service to discover them. This means properly configuring the <literal>ResourceRequestFilter</literal> and <filename>gatein-resources.xml</filename>. </para> <section id="sect-Reference_Guide-Creating_a_New_Portal_Skin-Portal_Skin_Configuration"> <title>Portal Skin Configuration</title> <para> - The gatein-resources.xml will need to specify the new portal skin. This will include specifying the name of the new skin, where to locate its css stylesheet file and whether to overwrite an existing portal theme with the same name. + The <filename>gatein-resources.xml</filename> will need to specify the new portal skin. This will include the name of the new skin, where to locate its CSS stylesheet file and whether to overwrite an existing portal theme with the same name. </para> <programlisting role="XML">&lt;gatein-resources&gt; &lt;portal-skin&gt; &lt;skin-name&gt;MySkin&lt;/skin-name&gt; - &lt;css-path&gt;/skin/myskin.css&lt;/css-path&gt; + &lt;CSS-path&gt;/skin/myskin.CSS&lt;/CSS-path&gt; &lt;overwrite&gt;false&lt;/overwrite&gt; &lt;/portal-skin&gt; &lt;/gatein-resources&gt; @@ -369,7 +385,7 @@ <note> <title>CSS</title> <para> - The css for the portal skin needs to contain the css for all the window decorations and the portlet specification css classes. + The CSS for the portal skin needs to contain the CSS for all the window decorations and the portlet specification CSS classes. </para> </note> </section> @@ -377,8 +393,11 @@ <section id="sect-Reference_Guide-Creating_a_New_Portal_Skin-Portal_Skin_Preview_Icon"> <title>Portal Skin Preview Icon</title> <para> - When selecting a skin it is possible to see a preview of what the skin will look like. The current skin needs to know about the skin icons for all the available skins, otherwise it will not be able to show the previews. When creating a new portal it is recommended to include the preview icons of the other skins and to update the other skins with your new portal skin preview. + When selecting a skin it is possible to see a preview of what the skin will look like. The current skin needs to know about the skin icons for all the available skins, otherwise it will not be able to show the previews. </para> + <para> + It is recommended that preview icons of any other skins are included when creating a new portal skin and that the other skins are updated with your new portal skin preview. + </para> <mediaobject> <imageobject role="html"> <imagedata fileref="images/PortalDevelopment/Skinning/portal-change-skin.png" format="PNG" align="center" scale="100" /> @@ -400,7 +419,7 @@ In order for the default skin to know about the skin icon for a new portal skin, the preview screenshot needs to be place in: <filename>01eXoResources.war:/skin/DefaultSkin/portal/webui/component/customization/UIChangeSkinForm/background</filename>. </para> <para> - The CSS stylesheet for the default portal needs to have the following updated with the preview icon css class. For a skin named <emphasis role="bold">MySkin</emphasis> then the following needs to be updated: <filename>01eXoResources.war:/skin/DefaultSkin/portal/webui/component/customization/UIChangeSkinForm/Stylesheet.css</filename>. + The CSS stylesheet for the default portal needs to have the following updated with the preview icon CSS class. For a skin named <emphasis role="bold">MySkin</emphasis> then the following needs to be updated: <filename>01eXoResources.war:/skin/DefaultSkin/portal/webui/component/customization/UIChangeSkinForm/Stylesheet.CSS</filename>. </para> <programlisting>.UIChangeSkinForm .UIItemSelector .TemplateContainer .<emphasis role="bold">MySkinImage</emphasis> { margin: auto; @@ -416,9 +435,11 @@ <section id="sect-Reference_Guide-Creating_New_Skins-Creating_a_New_Window_Style"> <title>Creating a New Window Style</title> <para> - Window styles are the CSS applied to window decoration. When an administrator choose a new application to add on a page he can decide which style of decoration would go around the window if any. + Window styles are the CSS applied to window decorations. An administrator can decide which style of decoration should go around the window when he adds a new application to a page. </para> - <para>PortalDevelopment/Skinning/windowStyles + <para> + PortalDevelopment/Skinning/windowStyles + </para> <mediaobject> <imageobject role="html"> <imagedata fileref="images/PortalDevelopment/Skinning/windowStyles.png" format="PNG" align="center" scale="100" /> @@ -427,14 +448,14 @@ <imagedata fileref="images/PortalDevelopment/Skinning/windowStyles.png" format="PNG" align="center" contentwidth="150mm" /> </imageobject> </mediaobject> - </para> + <section id="sect-Reference_Guide-Creating_a_New_Window_Style-Window_Style_Configuration"> <title>Window Style Configuration</title> <para> - Window Styles are defined within a gatein-resources.xml file which is used by the skin service to deploy the window style into the portal. Window styles can belong in with a window style category, this category and the window styles will need to be specified in resources file. + Window Styles are defined within a <filename>gatein-resources.xml</filename> file which is used by the skin service to deploy the window style into the portal. Window styles can belong in with a window style category, this category and the window styles will need to be specified in resources file. </para> <para> - The following gatein-resource.xml fragment will add MyThemeBlue and MyThemeRed to the MyTheme category. + The following <filename>gatein-resource.xml</filename> fragment will add <literal>MyThemeBlue</literal> and <literal>MyThemeRed</literal> to the <literal>MyTheme</literal> category. </para> <programlisting role="XML">&lt;window-style&gt; @@ -453,7 +474,7 @@ <note> <title>Window Styles and Portal Skins</title> <para> - When a window style is defined in <filename>gatein-resources.xml</filename> file, it will be available to all portlets regardless if the current portal skin supports the window decorator or not. It is recommended that when a new window decorator is added that it is added to all portal skins or that portal skins share a common stylesheet for window decorators. + When a window style is defined in <filename>gatein-resources.xml</filename> file, it will be available to all portlets regardless of whether the current portal skin supports the window decorator or not. It is recommended that when a new window decorator is added that it be added to all portal skins or that all portal skins share a common stylesheet for window decorators. </para> </note> </section> @@ -461,10 +482,10 @@ <section id="sect-Reference_Guide-Creating_a_New_Window_Style-Window_Style_CSS"> <title>Window Style CSS</title> <para> - In order for the skin service to display the window decorators, it must have CSS classes with specific naming in relation to the window style name. The service will try and display css based on this naming. The css class must be included as part of the current portal skin for the window decorators to be displayed. + In order for the skin service to display the window decorators, it must have CSS classes specifically named in relation to the window style name. The service will try and display CSS based on this naming convention. The CSS class must be included as part of the current portal skin for the window decorators to be displayed. </para> <para> - The location of the window decorator css classes for the default portal theme is located at: <filename>01eXoResources.war/skin/PortletThemes/Stylesheet.css</filename>. + The location of the window decorator CSS classes for the default portal theme is located at: <filename>01eXoResources.war/skin/PortletThemes/Stylesheet.CSS</filename>. </para> <para> </para> @@ -605,12 +626,12 @@ <section id="sect-Reference_Guide-Creating_a_New_Window_Style-How_to_Set_the_Default_Window_Style"> <title>How to Set the Default Window Style</title> <para> - To set the default window style to be used for a portal, you will to specify the css classes for a theme called <literal>DefaultTheme</literal>. + To set the default window style to be used for a portal, you will to specify the CSS classes for a theme called <literal>DefaultTheme</literal>. </para> <note> <title>DefaultTheme</title> <para> - You do not need to specify the DefaultTheme in <filename>gatein-resources.xml</filename>. + You do not need to specify the <literal>DefaultTheme</literal> in <filename>gatein-resources.xml</filename>. </para> </note> </section> @@ -618,7 +639,7 @@ </section> <section id="sect-Reference_Guide-Creating_New_Skins-How_to_Create_New_Portlet_skins"> - <title>How to Create New Portlet skins</title> + <title>How to Create New Portlet Skins</title> <para> Portlets often require additional styles that may not be defined by the portal skin. &PRODUCT; allows portlets to define additional stylesheets for each portlet and will append the corresponding <literal>link</literal> tags to the <literal>head</literal>. </para> @@ -631,30 +652,30 @@ &lt;application-name&gt;portletAppName&lt;/application-name&gt; &lt;portlet-name&gt;PortletName&lt;/portlet-name&gt; &lt;skin-name&gt;Default&lt;/skin-name&gt; - &lt;css-path&gt;/skin/DefaultStylesheet.css&lt;/css-path&gt; + &lt;CSS-path&gt;/skin/DefaultStylesheet.CSS&lt;/CSS-path&gt; &lt;/portlet-skin&gt; &lt;portlet-skin&gt; &lt;application-name&gt;portletAppName&lt;/application-name&gt; &lt;portlet-name&gt;PortletName&lt;/portlet-name&gt; &lt;skin-name&gt;OtherSkin&lt;/skin-name&gt; - &lt;css-path&gt;/skin/OtherSkinStylesheet.css&lt;/css-path&gt; + &lt;CSS-path&gt;/skin/OtherSkinStylesheet.CSS&lt;/CSS-path&gt; &lt;/portlet-skin&gt; </programlisting> </para> <para> - This will load the DefaultStylesheet.css when the Default skin is used and the OtherSkinStylesheet.css when the OtherSkin is used. + This will load the <literal>DefaultStylesheet.css</literal> when the Default skin is used and the <literal>OtherSkinStylesheet.css</literal> when the <literal>OtherSkin</literal> is used. </para> <note> - <title>Updating portlet skins</title> + <title>Updating Portlet Skins</title> <para> - If the current portal skin is not defined as part of the supported skins, then the portlet css class will not be loaded. It is recommended to update portlet skins whenever a new portal skin is created. + If the current portal skin is not defined as part of the supported skins, then the portlet CSS class will not be loaded. It is recommended that portlet skins are updated whenever a new portal skin is created. </para> </note> <section id="sect-Reference_Guide-How_to_Create_New_Portlet_skins-Change_portlet_icons"> - <title>Change portlet icons</title> + <title>Change Portlet Icons</title> <para> - Each portlet can be represented by an unique icon that you can see in the portlet registry or page editor. This icon can be changed by adding an image to the directory of the portlet webapplication: + Each portlet can be represented by an unique icon in the portlet registry or page editor. This icon can be changed by adding an image to the directory of the portlet <literal>webapplication</literal>: </para> <itemizedlist> <listitem> @@ -667,7 +688,7 @@ To be used correctly the icon must be named after the portlet. </para> <para> - For example, the icon for an account portlet named AccountPortlet would be located at: + For example; the icon for an account portlet named <literal>AccountPortlet</literal> would be located at: </para> <itemizedlist> <listitem> @@ -677,7 +698,7 @@ </listitem> </itemizedlist> <note> - <title>Portlet icons directory</title> + <title>Portlet Icons Directory</title> <para> You must use <literal>skin/DefaultSkin/portletIcons/</literal> for the directory to store the portlet icon regardless of what skin is going to be used. </para> @@ -687,12 +708,12 @@ </section> <section id="sect-Reference_Guide-Creating_New_Skins-How_to_create_a_new_Portlet_Specification_CSS_Classes"> - <title>How to create a new Portlet Specification CSS Classes</title> + <title>Create New Portlet Specification CSS Classes</title> <para> - The portlet specification defines a set of default css classes that should be available for portlets. These classes are included as part of the portal skin. Please see the portlet specification for a list of the default classes that should be available. + The portlet specification defines a set of default CSS classes that should be available for portlets. These classes are included as part of the portal skin. Please see the portlet specification for a list of the default classes that should be available. </para> <para> - For the default portal skin, the portlet specification CSS classes are defined in: <filename>eXoResources.war/skin/Portlet/Stylesheet.css</filename>. + For the default portal skin, the portlet specification CSS classes are defined in: <filename>eXoResources.war/skin/Portlet/Stylesheet.CSS</filename>. </para> </section> @@ -701,34 +722,33 @@ <section id="sect-Reference_Guide-Skinning_the_portal-Tips_and_Tricks"> <title>Tips and Tricks</title> - <section id="sect-Reference_Guide-Tips_and_Tricks-Easier_css_debugging"> - <title>Easier css debugging</title> + <section id="sect-Reference_Guide-Tips_and_Tricks-Easier_CSS_debugging"> + <title>Easier CSS Debugging</title> <para> By default, CSS files are cached and their imports are merged into a single CSS file at the server side. This reduces the number of HTTP requests from the browser to the server. </para> <para> - The optimization code is quite simple as all the CSS files are parsed at the server startup time and all the @import and url(...) references are rewritten to support a single flat file. The result is stored in a cache directly used from the <literal>ResourceRequestFilter</literal>. + The optimization code is quite simple as all the CSS files are parsed at the server startup and all the <literal>@import</literal> and <literal>url(...)</literal> references are rewritten to support a single flat file. The result is stored in a cache directly used from the <literal>ResourceRequestFilter</literal>. </para> <para> - Although the optimization is useful for a production environments, it may be easier to deactivate this optimization while debugging stylesheets. To do so, set the java system property <literal>exo.product.developing</literal> to <literal>true</literal>. + Although the optimization is useful for a production environment, it may be easier to deactivate this optimization while debugging stylesheets. Set the java system property <literal>exo.product.developing</literal> to <literal>true</literal> to disable the optimization. </para> <para> - For example, the property can be passed as a JVM parameter with <literal>-D</literal> option when running GateIn. + For example, the property can be passed as a JVM parameter with <literal>-D</literal> option when running &PRODUCT;. </para> <programlisting>sh $JBOSS_HOME/bin/run.sh -Dexo.product.developing=true </programlisting> - <orderedlist numeration="arabic"> - <listitem> - <para> - warning("This option may cause display bugs with certain browsers like Internet Explorer") - </para> - </listitem> - </orderedlist> + + <warning> + <para> + This option may cause display bugs with certain browsers (Internet Explorer, for example). + </para> + </warning> </section> <section id="sect-Reference_Guide-Tips_and_Tricks-Some_CSS_techniques"> - <title>Some CSS techniques</title> + <title>Some CSS Techniques</title> <para> It is recommended that users have some experience with CSS before studying &PRODUCT; CSS. </para> @@ -736,9 +756,9 @@ &PRODUCT; relies heavily on CSS to create the layout and effects for the UI. Some common techniques for customizing &PRODUCT; CSS are explained below. </para> <section id="sect-Reference_Guide-Some_CSS_techniques-Decorator_pattern"> - <title>Decorator 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 9 cells. The BODY is the central area that you want to decorate. The other 8 cells are distributed around the BODY cell. You can use the width, height and background image properties to achieve any decoration effect that you want. + 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> <mediaobject> <imageobject> @@ -768,9 +788,9 @@ </section> <section id="sect-Reference_Guide-Some_CSS_techniques-Left_margin_left_pattern"> - <title>Left margin left pattern</title> + <title>Left Margin Left Pattern</title> <para> - Left margin left pattern is a technique to create 2 blocks side by side. The left block will have a fixed size and the right block will take the rest of the available space. When the user resizes the browser the added or removed space will be taken from the right block. + Left margin left pattern is a technique to create two blocks side by side. The left block will have a fixed size and the right block will take the rest of the available space. When the user resizes the browser the added or removed space will be taken from the right block. </para> <mediaobject> <imageobject> Modified: portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Reference_Guide/en-US/modules/PortalDevelopment/UploadComponent.xml =================================================================== --- portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Reference_Guide/en-US/modules/PortalDevelopment/UploadComponent.xml 2010-04-30 07:23:12 UTC (rev 2908) +++ portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Reference_Guide/en-US/modules/PortalDevelopment/UploadComponent.xml 2010-04-30 07:57:03 UTC (rev 2909) @@ -36,7 +36,7 @@ <section id="sect-Reference_Guide-Upload_Component-Upload_Service"> <title>Upload Service</title> <para> - The service is defined by the class: <literal>org.exoplatform.upload.UploadService</literal>; + This service is defined by the class: <literal>org.exoplatform.upload.UploadService</literal>; </para> <para> This can be configured with the following xml code: @@ -118,12 +118,12 @@ </step> <step> <para> - The upload service stores a temporary file on the filesystem during the upload process. When the upload is finished, the service must be cleaned in order to: + The upload service stores a temporary file on the file system during the upload process. When the upload is finished, the service must be cleaned in order to: </para> <orderedlist numeration="arabic"> <listitem> <para> - Delete the temporary file. + Delete the temporary file and... </para> </listitem> <listitem> @@ -133,7 +133,7 @@ </listitem> </orderedlist> <para> - Use the<literal>removeUpload()</literal> method defined in the upload service to purge the file: + Use the <literal>removeUpload()</literal> method defined in the upload service to purge the file: </para> <programlisting role="JAVA">UploadService uploadService = uiForm.getApplicationComponent(UploadService.class) ; Modified: portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Reference_Guide/en-US/modules/PortalDevelopment/XMLResourceBundles.xml =================================================================== --- portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Reference_Guide/en-US/modules/PortalDevelopment/XMLResourceBundles.xml 2010-04-30 07:23:12 UTC (rev 2908) +++ portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Reference_Guide/en-US/modules/PortalDevelopment/XMLResourceBundles.xml 2010-04-30 07:57:03 UTC (rev 2909) @@ -13,12 +13,12 @@ <itemizedlist> <listitem> <para> - The XML format declares the encoding of the file. This avoids use of the native2ascii program which can interfere with encoding. + The XML format declares the encoding of the file. This avoids use of the <literal>native2ascii</literal> program which can interfere with encoding. </para> </listitem> <listitem> <para> - Property files generally use ISO 8859-1 character encoding which does not cover the full unicode charset. As a result, languages such as Arabic would not be natively supported. + Property files generally use <literal>ISO 8859-1</literal> character encoding which does not cover the full unicode charset. As a result, languages such as Arabic would not be natively supported. </para> </listitem> <listitem> @@ -71,8 +71,8 @@ </programlisting> </section> - <section id="sect-Reference_Guide-XML_Resources_Bundles-Portal_support"> - <title>Portal support</title> + <section id="sect-Reference_Guide-XML_Resources_Bundles-Portal_Support"> + <title>Portal Support</title> <para> In order to be loaded by the portal at runtime (actually the resource bundle service), the name of the file must be the same as a property file and it must use the <emphasis role="bold">.xml</emphasis> suffix. </para>