8:35 p.m.
Author: jaredmorgs
Date: 2013-01-30 21:35:40 -0500 (Wed, 30 Jan 2013)
New Revision: 9102
Modified:
epp/docs/branches/6.0/Developer_Guide/en-US/chapter-4-GDG_Portal_Development.xml
Log:
Changes incorporated for
https://docs.jboss.org/author/display/GTNPORTAL35/Custom+Internationaliza...
Modified:
epp/docs/branches/6.0/Developer_Guide/en-US/chapter-4-GDG_Portal_Development.xml
===================================================================
---
epp/docs/branches/6.0/Developer_Guide/en-US/chapter-4-GDG_Portal_Development.xml 2013-01-31
01:43:20 UTC (rev 9101)
+++
epp/docs/branches/6.0/Developer_Guide/en-US/chapter-4-GDG_Portal_Development.xml 2013-01-31
02:35:40 UTC (rev 9102)
@@ -223,7 +223,7 @@
<title>Custom Skin for a Portlet</title>
<remark>Source:
https://docs.jboss.org/author/display/GTNPORTAL35/Custom+Skin+for+a+Portl...
<para>
- This section mentions code from the Portal Extension Examples available for
download from <ulink url="https://access.redhat.com/"/>;. as part of your
JBoss Portal Platform subscription.
+ This section mentions code from the Portal Extension Examples available for
download from <ulink url="https://access.redhat.com/"/> as part of your
JBoss Portal Platform subscription.
</para>
<para>The same guidelines that apply when creating a new portlet skin also
apply when creating a custom skin for a built-in portlet distributed with JBoss Portal
Platform. </para>
<para>Declare the skin first in the
@@ -302,7 +302,7 @@
<section id="Custom_Navigation_And_Pages">
<title>Custom Navigation and Pages</title>
<para>
- This section mentions code from the Portal Extension Examples available for
download from <ulink url="https://access.redhat.com/"/>;. as part of your
JBoss Portal Platform subscription.
+ This section mentions code from the Portal Extension Examples available for
download from <ulink url="https://access.redhat.com/"/> as part of your
JBoss Portal Platform subscription.
</para>
<para>In Portal Extension quickstart, we have added a couple of navigation
nodes and pages to the ones available in the default GateIn Portal
installation.</para>
<section id="portal-configuration-xml">
@@ -622,111 +622,101 @@
</section>
<section id="Custom_Internationalization_Resource_Bundles">
<title>Custom Internationalization Resource Bundles</title>
+ <remark>Source:
https://docs.jboss.org/author/display/GTNPORTAL35/Custom+Internationaliza...
<para>
- This section mentions code from the Portal Extension Examples available for
download from <ulink url="https://access.redhat.com/"/>;. as part of your
JBoss Portal Platform subscription.
+ This section mentions code from the Portal Extension Examples available for
download from <ulink url="https://access.redhat.com/"/> as part of your
JBoss Portal Platform subscription.
</para>
<para>There are two resource bundle customization scenarios possible with a
Portal Extension:</para>
<itemizedlist>
<listitem>
- <para>to add new resource bundle items to the ones available in default
GateIn Portal installation and</para>
+ <para>to add new resource bundle items to the ones available in the
default JBoss Portal Platform installation.</para>
</listitem>
<listitem>
- <para>to assign new values to resource bundle items available in
default GateIn Portal installation</para>
+ <para>to assign new values to resource bundle items available in
default JBoss Portal Platform installation.</para>
</listitem>
</itemizedlist>
<para>
- Both scenarios can be demonstrated on
+ Both scenarios can be demonstrated using the
<code>locale.portal.extension</code>
- resource bundle. To use this bundle we need to include it in both
+ resource bundle. To use this bundle, include both
<code>init.resources</code>
and
<code>portal.resource.names</code>
- parameters of
+ parameters for the
<code>BaseResourceBundlePlugin</code>
- in
+<type> directive in
<code>war/src/main/webapp/WEB-INF/conf/sample-ext/common/common-configuration.xml</code>
:
</para>
<example>
<title>common-configuration.xml containing declarations of navigation
resource bundles</title>
- <programlisting>
-19. <configuration
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
-20. xsi:schemaLocation="http://www.exoplaform.org/xml/ns/kernel_1_2.xsd
http://www.exoplaform.org/xml/ns/kernel_1_2.xsd"
xmlns="http://www.exoplaform.org/xml/ns/kernel_1_2.xsd"...
-21. <external-component-plugins>
-22. <!-- The full qualified name of the ResourceBundleService -->
-23.
<target-component>org.exoplatform.services.resources.ResourceBundleService</target-component>
-24. <component-plugin>
-25. <!-- The name of the plugin -->
-26. <name>Sample ResourceBundle Plugin</name>
-27. <!-- The name of the method to call on the ResourceBundleService
in order to register the ResourceBundles -->
-28. <set-method>addResourceBundle</set-method>
-29. <!-- The full qualified name of the BaseResourceBundlePlugin
-->
-30.
<type>org.exoplatform.services.resources.impl.BaseResourceBundlePlugin</type>
-31. <init-params>
-32. <values-param>
-33. <name>init.resources</name>
-34. <description>Initiate the following resources
during the first launch.</description>
-35.
<value>locale.portal.extension</value>
-36.
<value>locale.navigation.user.root</value>
-37. <!--
-38. Note that we actually do not need to name
locale.navigation.portal.classic and
-39. locale.navigation.group.platform.administrators here as they
are in init.resources
-40. of the default GateIn installation. But it makes no harm to
include them once again here.
-41. -->
-42.
<value>locale.navigation.portal.classic</value>
-43.
<value>locale.navigation.group.platform.administrators</value>
-44. </values-param>
-45. <values-param>
-46. <name>portal.resource.names</name>
-47. <description>These resources are merged to a single
resource bundle which is accessible from anywhere
-48. in GateIn. All these keys are located in the same bundle,
which is separated from the navigation
-49. resource bundles.</description>
-50.
<value>locale.portal.extension</value>
-51. </values-param>
-52. </init-params>
-53. </component-plugin>
-54. </external-component-plugins>
-55. </configuration>
-</programlisting>
+ <programlisting language="XML"><configuration
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+ xsi:schemaLocation="http://www.exoplatform.org/xml/ns/kernel_1_2...
http://www.exoplatform.org/xml/ns/kernel_1_2.xsd"
xmlns="http://www.exoplatform.org/xml/ns/kernel_1_2.xsd"...
+ <external-component-plugins>
+ <!-- The full qualified name of the ResourceBundleService -->
+
<target-component>org.exoplatform.services.resources.ResourceBundleService</target-component>
+ <component-plugin>
+ <!-- The name of the plugin -->
+ <name>Sample ResourceBundle Plugin</name>
+ <!-- The name of the method to call on the ResourceBundleService in
order to register the ResourceBundles -->
+ <set-method>addResourceBundle</set-method>
+ <!-- The full qualified name of the BaseResourceBundlePlugin
-->
+
<type>org.exoplatform.services.resources.impl.BaseResourceBundlePlugin</type>
+ <init-params>
+ <values-param>
+ <name>init.resources</name>
+ <description>Initiate the following resources during
the first launch.</description>
+ <value>locale.portal.extension</value>
+
<value>locale.navigation.user.root</value>
+ <!--
+ Note that we actually do not need to name
locale.navigation.portal.classic and
+ locale.navigation.group.platform.administrators here as they are
in init.resources
+ of the default GateIn installation. But it makes no harm to
include them once again here.
+ -->
+
<value>locale.navigation.portal.classic</value>
+
<value>locale.navigation.group.platform.administrators</value>
+ </values-param>
+ <values-param>
+ <name>portal.resource.names</name>
+ <description>These resources are merged to a single
resource bundle which is accessible from anywhere
+ in GateIn. All these keys are located in the same bundle, which
is separated from the navigation
+ resource bundles.</description>
+ <value>locale.portal.extension</value>
+ </values-param>
+ </init-params>
+ </component-plugin>
+ </external-component-plugins>
+</configuration></programlisting>
</example>
<para>
The English version of
- <code>locale.portal.extension</code>
- can be found under
-
<code>war/src/main/webapp/WEB-INF/classes/locale/portal/extension_en.properties</code>
- :
- </para>
+ <code>locale.portal.extension</code> is located in
+
<filename>war/src/main/webapp/WEB-INF/classes/locale/portal/extension_en.properties</filename>.
</para>
<example>
<title>English version of locale.portal.extension</title>
- <programlisting>
-17. UIHomePagePortlet.Label.Slogan=Congratulations!
-18. UIHomePagePortlet.Label.SubSlogan=You have just installed the GateIn Portal
Extension
-19. UIHomePagePortlet.Label.Title=Sign in as:
-</programlisting>
+ <programlisting>UIHomePagePortlet.Label.Slogan=Congratulations!
+UIHomePagePortlet.Label.SubSlogan=You have just installed the GateIn Portal Extension
+UIHomePagePortlet.Label.Title=Sign in as:</programlisting>
</example>
<para>
<code>UIHomePagePortlet.Label.SubSlogan</code>
- is a new key which is not available in default GateIn Portal installation.
- </para>
- <para>
+ is a new key which is not normally available in the default JBoss Portal
Platform installation.
+
However,
<code>UIHomePagePortlet.Label.Slogan</code>
is redefined in
<code>extension_en.properties</code>
- shown above. In
-
<code>gatein.ear/web.war/WEB-INF/classes/locale/portlet/web/GroovyPortlet_en.properties</code>
- it is already defined as
- </para>
+ shown above. </para>
+ <para>In
+
<filename>JPP_HOME/gatein/gatein.ear/web.war/WEB-INF/classes/locale/portlet/web/GroovyPortlet_en.properties</filename>
+ it is already defined as: </para>
<programlisting>UIHomePagePortlet.Label.Slogan=The Best of eXo and JBoss
Portal<div>GateIn
#{gatein.version}</div></programlisting>
- <para>
- and here, within the Portal Extension we assign a new value
+ <para>Within the Portal Extension, the new value
<code>Congratulations!</code>
- to it.
+is appended to it.
</para>
- <para>
- Please refer to the
- <link
linkend="Adding_Navigation_Node_Group_Navigation">previous
section</link>
- for more details on internationalization of navigation nodes.
+ <para>Refer to the <xref
linkend="Adding_Navigation_Node_Group_Navigation"/>
+ for more details on internationalization of navigation nodes.
</para>
</section>
<section id="Custom_Sign_In_Page">