Author: jaredmorgs Date: 2013-02-03 23:36:06 -0500 (Sun, 03 Feb 2013) New Revision: 9111 Modified: epp/docs/branches/6.0/Developer_Guide/en-US/Revision_History.xml epp/docs/branches/6.0/Developer_Guide/en-US/chapter-4-GDG_Portal_Development.xml epp/docs/branches/6.0/Developer_Guide/en-US/images/Kinds+of+Navigation.png Log: Changes incorporated for https://docs.jboss.org/author/display/GTNPORTAL35/Custom+Navigation+and+P... in Section 4.1.1.4, ?\226?\128?\156Custom Navigation and Pages?\226?\128?\157. Heavy nesting in this section caused me to restructure some of the deeply nested sections into examples. Also updated a very outdated screenshot using shutter to annotate. Modified: epp/docs/branches/6.0/Developer_Guide/en-US/Revision_History.xml =================================================================== --- epp/docs/branches/6.0/Developer_Guide/en-US/Revision_History.xml 2013-02-01 15:13:00 UTC (rev 9110) +++ epp/docs/branches/6.0/Developer_Guide/en-US/Revision_History.xml 2013-02-04 04:36:06 UTC (rev 9111) @@ -5,6 +5,20 @@ <simpara> <revhistory> <revision> + <revnumber>6.0.0-11</revnumber> + <date>Mon Feb 4 2013</date> + <author> + <firstname>Jared</firstname> + <surname>Morgan</surname> + <email/> + </author> + <revdescription> + <simplelist> + <member>Changes incorporated for https://docs.jboss.org/author/display/GTNPORTAL35/Custom+Navigation+and+P... in <xref linkend="Custom_Navigation_And_Pages"/>. Heavy nesting in this section caused me to restructure some of the deeply nested sections into examples.</member> + </simplelist> + </revdescription> + </revision> + <revision> <revnumber>6.0.0-10</revnumber> <date>Fri Feb 1 2013</date> <author> 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-02-01 15:13:00 UTC (rev 9110) +++ epp/docs/branches/6.0/Developer_Guide/en-US/chapter-4-GDG_Portal_Development.xml 2013-02-04 04:36:06 UTC (rev 9111) @@ -285,14 +285,12 @@ </para> <example id="exam-DefaultStylesheetCss"> <title>DefaultStylesheet.css</title> - <programlisting> -051. .UIHomePagePortlet .TRContainer .DotLine { -052. background: url(&quot;DefaultSkin/background/Line.gif&quot;) no-repeat -2px top; -053. height: 1px; -054. width: 182px; -055. margin: 7px auto; -056. } -</programlisting> + <programlisting>.UIHomePagePortlet .TRContainer .DotLine { + background: url(&quot;DefaultSkin/background/Line.gif&quot;) no-repeat -2px top; + height: 1px; + width: 182px; + margin: 7px auto; +}</programlisting> </example> <note> <para>For further information about creating portlets skins, refer to<citetitle> Skinning the Portal</citetitle> in the JBoss Portal Platform <citetitle>Reference Guide</citetitle>.</para> @@ -301,117 +299,125 @@ </section> <section id="Custom_Navigation_And_Pages"> <title>Custom Navigation and Pages</title> + <remark>Source: https://docs.jboss.org/author/display/GTNPORTAL35/Custom+Navigation+and+P... <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. </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"> <title>portal-configuration.xml</title> - <para> - In Portal Extension quickstart, this configuration file is located in - <code>war/src/main/webapp/WEB-INF/conf/sample-ext/portal</code> - directory. It is the starting point of the navigation customization. We will not say more about this file here as there is usually no need to change it. Please refer to - <ulink url="https://docs.jboss.org/author/pages/viewpage.action?pageId=5426... Navigation Configuration</ulink> - section of GateIn Portal Reference Guide for more information. + <para>This configuration file is located in + <filename>war/src/main/webapp/WEB-INF/conf/sample-ext/portal</filename> + directory of the Portal Extension quickstart. It is the starting point for navigation customization. Generally, there is no need to change any configuration in this file, although it is useful to know of it&apos;s location.</para> + <para>For more information about <filename>portal-configuration.xml</filename>, refer to the &quot;Portal Navigation Configuration&quot; section in the JBoss Portal Platform <citetitle>Reference Guide</citetitle>. </para> </section> - <section id="Three_Kinds_Of_Navigation"> - <title>Three kinds of Navigation</title> - <para>Rather than using too many words to explain what and why, let us look at the following image:</para> - <figure> - <title>TODO InformalFigure image title empty</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/Kinds+of+Navigation.png"/> - </imageobject> - </mediaobject> - </figure> - </section> - <section id="Adding_Navigation_Node_Site_Navigation"> + </section> + <section id="Three_Kinds_Of_Navigation"> + <title>Navigation Node Types</title> + <para>There are three types of navigation nodes, as described in <xref linkend="fig-Types_of_Navigation_Nodes"/> :</para> + <figure id="fig-Types_of_Navigation_Nodes"> + <title>Types of Navigation Nodes</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/Kinds+of+Navigation.png"/> + </imageobject> + <textobject> + <para>The JBoss Portal Platform home screen, with the Home tab, Group menu, and Dashboard menu called-out.</para> + </textobject> + </mediaobject> + </figure> + <variablelist> + <varlistentry> + <term>1 (Site)</term> + <listitem> + <para>Navigation nodes of the current site.</para> + </listitem> + </varlistentry> + <varlistentry> + <term>2 (User Group)</term> + <listitem> + <para>Navigation nodes of <emphasis>user groups</emphasis> which the current user is a member.</para> + </listitem> + </varlistentry> + <varlistentry> + <term>3 (User)</term> + <listitem> + <para>Navigation nodes of the current user.</para> + </listitem> + </varlistentry> + </variablelist> + <example id="exam-Adding_Navigation_Node_Site"> <title>Adding a Navigation Node to a Site Navigation</title> - <para> - Let us have a look at + <para>The file <code>war/src/main/webapp/WEB-INF/conf/sample-ext/portal/portal/classic/navigation.xml</code> - . Note that in this path, - <emphasis role="italics">classic</emphasis> - is the name of the site the navigation of which we are which we want to define. +contains the + <emphasis role="italics">classic</emphasis> site navigation which can be modified. </para> - <example> - <title>Site-wide navigation.xml</title> - <programlisting> -19. &lt;node-navigation xmlns:xsi=&quot;http://www.w3.org/2001/XMLSchema-instance&quot; -20. xsi:schemaLocation=&quot;http://www.gatein.org/xml/ns/gatein_objects_1_3 http://www.gatein.org/xml/ns/gatein_objects_1_3&quot; xmlns=&quot;http://www.gatein.org/xml/ns/gatein_objects_1_3&quot;... -21. &lt;!-- Priority has no significance in site navigations. But it is required. See GTNPORTAL-2751 --&gt; -22. &lt;priority&gt;1&lt;/priority&gt; -23. -24. &lt;!-- -25. In this file, we are adding a navigation node to the navigation of the site called &quot;classic&quot;. -26. The site-wide navigation is used e.g. in NavigationPortlet. -27. Visibility of navigation nodes depends on &lt;access-permissions&gt; set in the sibling pages.xml file. -28. See also portal.configuration section of the file ../../portal-configuration.xml. -29. --&gt; -30. &lt;page-nodes&gt; -31. &lt;node&gt; -32. &lt;name&gt;page-just-added&lt;/name&gt; -33. &lt;!-- -34. #{portal.extension.justAddedPage} is place holder for an internationalized string. -35. See WEB-INF/classes/locale/navigation/portal/classic_en.properties -36. --&gt; -37. &lt;label&gt;#{portal.extension.justAddedPage}&lt;/label&gt; -</programlisting> - </example> - <para> - In this file, we have added + <programlisting language="XML">&lt;node-navigation xmlns:xsi=&quot;http://www.w3.org/2001/XMLSchema-instance&quot; + xsi:schemaLocation=&quot;http://www.gatein.org/xml/ns/gatein_objects_1_3 http://www.gatein.org/xml/ns/gatein_objects_1_3&quot; xmlns=&quot;http://www.gatein.org/xml/ns/gatein_objects_1_3&quot;... + &lt;!-- Priority has no significance in site navigations. But it is required. See GTNPORTAL-2751 --&gt; + &lt;priority&gt;1&lt;/priority&gt; + + &lt;!-- + In this file, we are adding a navigation node to the navigation of the site called &quot;classic&quot;. + The site-wide navigation is used e.g. in NavigationPortlet. + Visibility of navigation nodes depends on &lt;access-permissions&gt; set in the sibling pages.xml file. + See also portal.configuration section of the file ../../portal-configuration.xml. + --&gt; + &lt;page-nodes&gt; + &lt;node&gt; + &lt;name&gt;page-just-added&lt;/name&gt; + &lt;!-- + #{portal.extension.justAddedPage} is place holder for an internationalized string. + See WEB-INF/classes/locale/navigation/portal/classic_en.properties + --&gt; + &lt;label&gt;#{portal.extension.justAddedPage}&lt;/label&gt; + &lt;/node&gt; + &lt;/page-nodes&gt; +&lt;/node-navigation&gt;</programlisting> + <para>By appending the <code>page-just-added</code> - navigation node into the portal navigation. It can be seen in the navigation bar. + navigation node into the portal navigation, the new site navigation node is now visible in the navigation bar. </para> + <mediaobject> + <imageobject> + <imagedata fileref="images/navigation-bar.png"/> + </imageobject> + <textobject> + <para>Navigation menu, with Page Just Added now visible as a site navigation option.</para> + </textobject> + </mediaobject> <para> - <figure> - <title>TODO InformalFigure image title empty</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/navigation-bar.png"/> - </imageobject> - </mediaobject> - </figure> - </para> - <para> The <code>page-just-added</code> navigation node refers to <code>portal::classic::justAddedPage</code> - which we define in + which is defined the <code>pages.xml</code> - file located in the same directory as the above - <code>navigation.xml</code> - . + file located in the same directory as the + <code>navigation.xml</code> file. </para> - <example> - <title>Site-wide pages.xml</title> - <programlisting> -19. &lt;page-set xmlns:xsi=&quot;http://www.w3.org/2001/XMLSchema-instance&quot; xsi:schemaLocation=&quot;http://www.gatein.org/xml/ns/gatein_objects_1_3 http://www.gatein.org/xml/ns/gatein_objects_1_3&quot; -20. xmlns=&quot;http://www.gatein.org/xml/ns/gatein_objects_1_3&quot;... -21. &lt;page&gt; -22. &lt;name&gt;justAddedPage&lt;/name&gt; -23. &lt;title&gt;Page Just Added&lt;/title&gt; -24. &lt;!-- This page and any navigation nodes refering to it will be visible to all visitors (signed in or anonymous). --&gt; -25. &lt;access-permissions&gt;Everyone&lt;/access-permissions&gt; -26. &lt;edit-permission&gt;*:/platform/administrators&lt;/edit-permission&gt; -27. &lt;portlet-application&gt; -28. &lt;portlet&gt; -29. &lt;application-ref&gt;gatein-portal-extension&lt;/application-ref&gt; -30. &lt;portlet-ref&gt;JustAddedPortlet&lt;/portlet-ref&gt; -31. &lt;/portlet&gt; -32. &lt;title&gt;Just Added Portlet&lt;/title&gt; -33. &lt;access-permissions&gt;Everyone&lt;/access-permissions&gt; -34. &lt;show-info-bar&gt;false&lt;/show-info-bar&gt; -35. &lt;show-application-state&gt;false&lt;/show-application-state&gt; -36. &lt;show-application-mode&gt;false&lt;/show-application-mode&gt; -37. &lt;/portlet-application&gt; -38. &lt;/page&gt; -39. &lt;/page-set&gt; -</programlisting> - </example> + <programlisting language="XML">&lt;page-set xmlns:xsi=&quot;http://www.w3.org/2001/XMLSchema-instance&quot; xsi:schemaLocation=&quot;http://www.gatein.org/xml/ns/gatein_objects_1_3 http://www.gatein.org/xml/ns/gatein_objects_1_3&quot; + xmlns=&quot;http://www.gatein.org/xml/ns/gatein_objects_1_3&quot;... + &lt;page&gt; + &lt;name&gt;justAddedPage&lt;/name&gt; + &lt;title&gt;Page Just Added&lt;/title&gt; + &lt;!-- This page and any navigation nodes refering to it will be visible to all visitors (signed in or anonymous). --&gt; + &lt;access-permissions&gt;Everyone&lt;/access-permissions&gt; + &lt;edit-permission&gt;*:/platform/administrators&lt;/edit-permission&gt; + &lt;portlet-application&gt; + &lt;portlet&gt; + &lt;application-ref&gt;gatein-portal-extension&lt;/application-ref&gt; + &lt;portlet-ref&gt;JustAddedPortlet&lt;/portlet-ref&gt; + &lt;/portlet&gt; + &lt;title&gt;Just Added Portlet&lt;/title&gt; + &lt;access-permissions&gt;Everyone&lt;/access-permissions&gt; + &lt;show-info-bar&gt;false&lt;/show-info-bar&gt; + &lt;show-application-state&gt;false&lt;/show-application-state&gt; + &lt;show-application-mode&gt;false&lt;/show-application-mode&gt; + &lt;/portlet-application&gt; + &lt;/page&gt; +&lt;/page-set&gt;</programlisting> <para> Note that <code>page-just-added</code> @@ -421,42 +427,35 @@ <code>Everyone</code> in the above file. </para> - </section> - <section id="Adding_Navigation_Node_Group_Navigation"> + </example> + <example id="exam-Adding_Navigation_Node_Group"> <title>Adding a Navigation Node to a Group Navigation</title> <para> To add a new navigation node visible to the members of <code>/platform/administrators</code> - group we need to create a - <code>navigation.xml</code> + group, create a <code>navigation.xml</code> file located in <code>war/src/main/webapp/WEB-INF/conf/sample-ext/portal/group/platform/administrators/navigation.xml</code> - . Note that the name of the user group - <code>/platform/administrators</code> - is a part of the path. + . The name of the user group + <code>/platform/administrators</code> forms part of the path. </para> - <example> - <title>navigation.xml of /platform/administrators group</title> - <programlisting> -19. &lt;node-navigation xmlns:xsi=&quot;http://www.w3.org/2001/XMLSchema-instance&quot; -20. xsi:schemaLocation=&quot;http://www.gatein.org/xml/ns/gatein_objects_1_3 http://www.gatein.org/xml/ns/gatein_objects_1_3&quot; xmlns=&quot;http://www.gatein.org/xml/ns/gatein_objects_1_3&quot;... -21. &lt;!-- Priority is currently ignored for importMode merge. But it is required. See GTNPORTAL-2751 --&gt; -22. &lt;priority&gt;1&lt;/priority&gt; -23. -24. &lt;page-nodes&gt; -25. &lt;node&gt; -26. &lt;name&gt;admins-sitemap&lt;/name&gt; -27. &lt;!-- -28. #{platform.administrators.adminsSitemap} is place holder for an internationalized string. -29. See WEB-INF/classes/locale/navigation/group/platform/administrators_en.properties -30. --&gt; -31. &lt;label&gt;#{platform.administrators.adminsSitemap}&lt;/label&gt; -32. &lt;page-reference&gt;group::/platform/administrators::adminsSitemap&lt;/page-reference&gt; -33. &lt;/node&gt; -34. &lt;/page-nodes&gt; -35. &lt;/node-navigation&gt; -</programlisting> - </example> + <programlisting>&lt;node-navigation xmlns:xsi=&quot;http://www.w3.org/2001/XMLSchema-instance&quot; + xsi:schemaLocation=&quot;http://www.gatein.org/xml/ns/gatein_objects_1_3 http://www.gatein.org/xml/ns/gatein_objects_1_3&quot; xmlns=&quot;http://www.gatein.org/xml/ns/gatein_objects_1_3&quot;... + &lt;!-- Priority is currently ignored for importMode merge. But it is required. See GTNPORTAL-2751 --&gt; + &lt;priority&gt;1&lt;/priority&gt; + + &lt;page-nodes&gt; + &lt;node&gt; + &lt;name&gt;admins-sitemap&lt;/name&gt; + &lt;!-- + #{platform.administrators.adminsSitemap} is place holder for an internationalized string. + See WEB-INF/classes/locale/navigation/group/platform/administrators_en.properties + --&gt; + &lt;label&gt;#{platform.administrators.adminsSitemap}&lt;/label&gt; + &lt;page-reference&gt;group::/platform/administrators::adminsSitemap&lt;/page-reference&gt; + &lt;/node&gt; + &lt;/page-nodes&gt; +&lt;/node-navigation&gt;</programlisting> <para> The navigation node <code>admins-sitemap</code> @@ -466,35 +465,30 @@ <code>pages.xml</code> file: </para> - <example> - <title>pages.xml of /platform/administrators group</title> - <programlisting> -19. xmlns=&quot;http://www.gatein.org/xml/ns/gatein_objects_1_3&quot;... -20. &lt;!-- -21. adminsSitemap page contains just SiteMapPortlet. There is nothing special about it. -22. It is here just to demonstrate the adding of nodes to group navigation in the sibling -23. navigation.xml file. -24. --&gt; -25. &lt;page&gt; -26. &lt;name&gt;adminsSitemap&lt;/name&gt; -27. &lt;title&gt;Admins&apos; Sitemap&lt;/title&gt; -28. &lt;access-permissions&gt;*:/platform/administrators&lt;/access-permissions&gt; -29. &lt;edit-permission&gt;*:/platform/administrators&lt;/edit-permission&gt; -30. &lt;portlet-application&gt; -31. &lt;portlet&gt; -32. &lt;application-ref&gt;web&lt;/application-ref&gt; -33. &lt;portlet-ref&gt;SiteMapPortlet&lt;/portlet-ref&gt; -34. &lt;/portlet&gt; -35. &lt;title&gt;Sitemap&lt;/title&gt; -36. &lt;access-permissions&gt;*:/platform/administrators&lt;/access-permissions&gt; -37. &lt;show-info-bar&gt;false&lt;/show-info-bar&gt; -38. &lt;/portlet-application&gt; -39. &lt;/page&gt; -40. &lt;/page-set&gt; -</programlisting> - </example> - </section> - <section id="Adding_Navigation_Node_User_Navigation"> + <programlisting> xmlns=&quot;http://www.gatein.org/xml/ns/gatein_objects_1_3&quot;... + &lt;!-- + adminsSitemap page contains just SiteMapPortlet. There is nothing special about it. + It is here just to demonstrate the adding of nodes to group navigation in the sibling + navigation.xml file. + --&gt; + &lt;page&gt; + &lt;name&gt;adminsSitemap&lt;/name&gt; + &lt;title&gt;Admins&apos; Sitemap&lt;/title&gt; + &lt;access-permissions&gt;*:/platform/administrators&lt;/access-permissions&gt; + &lt;edit-permission&gt;*:/platform/administrators&lt;/edit-permission&gt; + &lt;portlet-application&gt; + &lt;portlet&gt; + &lt;application-ref&gt;web&lt;/application-ref&gt; + &lt;portlet-ref&gt;SiteMapPortlet&lt;/portlet-ref&gt; + &lt;/portlet&gt; + &lt;title&gt;Sitemap&lt;/title&gt; + &lt;access-permissions&gt;*:/platform/administrators&lt;/access-permissions&gt; + &lt;show-info-bar&gt;false&lt;/show-info-bar&gt; + &lt;/portlet-application&gt; + &lt;/page&gt; +&lt;/page-set&gt;</programlisting> + </example> + <example id="exam-Adding_Navigation_Node_User"> <title>Adding a Navigation Node to a User Navigation</title> <para> To add a new navigation node visible to a particular user, say @@ -507,24 +501,19 @@ <code>root</code> is a part of the path. </para> - <example> - <title>navigation.xml of user root</title> - <programlisting> -19. &lt;node-navigation xmlns:xsi=&quot;http://www.w3.org/2001/XMLSchema-instance&quot; -20. xsi:schemaLocation=&quot;http://www.gatein.org/xml/ns/gatein_objects_1_3 http://www.gatein.org/xml/ns/gatein_objects_1_3&quot; xmlns=&quot;http://www.gatein.org/xml/ns/gatein_objects_1_3&quot;... -21. &lt;!-- Priority has no significance in user navigations. But it is required. See GTNPORTAL-2751 --&gt; -22. &lt;priority&gt;1&lt;/priority&gt; -23. -24. &lt;page-nodes&gt; -25. &lt;node&gt; -26. &lt;name&gt;roots-extra-dashboard&lt;/name&gt; -27. &lt;label&gt;#{user.root.RootsExtraDashboard}&lt;/label&gt; -28. &lt;page-reference&gt;user::root::roots-dashboard&lt;/page-reference&gt; -29. &lt;/node&gt; -30. &lt;/page-nodes&gt; -31. &lt;/node-navigation&gt; -</programlisting> - </example> + <programlisting>&lt;node-navigation xmlns:xsi=&quot;http://www.w3.org/2001/XMLSchema-instance&quot; + xsi:schemaLocation=&quot;http://www.gatein.org/xml/ns/gatein_objects_1_3 http://www.gatein.org/xml/ns/gatein_objects_1_3&quot; xmlns=&quot;http://www.gatein.org/xml/ns/gatein_objects_1_3&quot;... + &lt;!-- Priority has no significance in user navigations. But it is required. See GTNPORTAL-2751 --&gt; + &lt;priority&gt;1&lt;/priority&gt; + + &lt;page-nodes&gt; + &lt;node&gt; + &lt;name&gt;roots-extra-dashboard&lt;/name&gt; + &lt;label&gt;#{user.root.RootsExtraDashboard}&lt;/label&gt; + &lt;page-reference&gt;user::root::roots-dashboard&lt;/page-reference&gt; + &lt;/node&gt; + &lt;/page-nodes&gt; +&lt;/node-navigation&gt;</programlisting> <para> The navigation node <code>roots-extra-dashboard</code> @@ -534,39 +523,34 @@ <code>pages.xml</code> file: </para> - <example> - <title>pages.xml of user root</title> - <programlisting> -19. &lt;page-set xmlns:xsi=&quot;http://www.w3.org/2001/XMLSchema-instance&quot; xsi:schemaLocation=&quot;http://www.gatein.org/xml/ns/gatein_objects_1_3 http://www.gatein.org/xml/ns/gatein_objects_1_3&quot; -20. xmlns=&quot;http://www.gatein.org/xml/ns/gatein_objects_1_3&quot;... -21. &lt;!-- -22. roots-dashboard page contains just DashboardPortlet. There is nothing special about it. -23. It is here just to demonstrate the adding of nodes to user navigation in the sibling -24. navigation.xml file. -25. --&gt; -26. &lt;page&gt; -27. &lt;name&gt;roots-dashboard&lt;/name&gt; -28. &lt;title&gt;Root&apos;s Extra Dashboard&lt;/title&gt; -29. &lt;access-permissions&gt;*:/platform/users&lt;/access-permissions&gt; -30. &lt;edit-permission&gt;*:/platform/administrators&lt;/edit-permission&gt; -31. &lt;portlet-application&gt; -32. &lt;portlet&gt; -33. &lt;application-ref&gt;dashboard&lt;/application-ref&gt; -34. &lt;portlet-ref&gt;DashboardPortlet&lt;/portlet-ref&gt; -35. &lt;/portlet&gt; -36. &lt;title&gt;Root&apos;s Extra Dashboard&lt;/title&gt; -37. &lt;access-permissions&gt;*:/platform/users&lt;/access-permissions&gt; -38. &lt;show-info-bar&gt;false&lt;/show-info-bar&gt; -39. &lt;/portlet-application&gt; -40. &lt;/page&gt; -41. &lt;/page-set&gt; -42. -</programlisting> - </example> - </section> - <section id="Internationalization_Navigation_Nodes"> - <title>Internationalization of Navigation Nodes</title> - <para> + <programlisting>&lt;page-set xmlns:xsi=&quot;http://www.w3.org/2001/XMLSchema-instance&quot; xsi:schemaLocation=&quot;http://www.gatein.org/xml/ns/gatein_objects_1_3 http://www.gatein.org/xml/ns/gatein_objects_1_3&quot; + xmlns=&quot;http://www.gatein.org/xml/ns/gatein_objects_1_3&quot;... + &lt;!-- + roots-dashboard page contains just DashboardPortlet. There is nothing special about it. + It is here just to demonstrate the adding of nodes to user navigation in the sibling + navigation.xml file. + --&gt; + &lt;page&gt; + &lt;name&gt;roots-dashboard&lt;/name&gt; + &lt;title&gt;Root&apos;s Extra Dashboard&lt;/title&gt; + &lt;access-permissions&gt;*:/platform/users&lt;/access-permissions&gt; + &lt;edit-permission&gt;*:/platform/administrators&lt;/edit-permission&gt; + &lt;portlet-application&gt; + &lt;portlet&gt; + &lt;application-ref&gt;dashboard&lt;/application-ref&gt; + &lt;portlet-ref&gt;DashboardPortlet&lt;/portlet-ref&gt; + &lt;/portlet&gt; + &lt;title&gt;Root&apos;s Extra Dashboard&lt;/title&gt; + &lt;access-permissions&gt;*:/platform/users&lt;/access-permissions&gt; + &lt;show-info-bar&gt;false&lt;/show-info-bar&gt; + &lt;/portlet-application&gt; + &lt;/page&gt; +&lt;/page-set&gt;</programlisting> + </example> + </section> + <section id="Internationalization_Navigation_Nodes"> + <title>Internationalization of Navigation Nodes</title> + <para> As you can see in the above <code>navigation.xml</code> files the labels of navigation nodes can be internationalized. The files containing translation resources live under @@ -577,7 +561,7 @@ <code>pages.xml</code> files: </para> - <para> + <para> Note that the navigation resource bundles also need to be named in <code>init.resources</code> parameter of @@ -586,39 +570,37 @@ <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. &lt;configuration xmlns:xsi=&quot;http://www.w3.org/2001/XMLSchema-instance&quot; -20. xsi:schemaLocation=&quot;http://www.exoplaform.org/xml/ns/kernel_1_2.xsd http://www.exoplaform.org/xml/ns/kernel_1_2.xsd&quot; xmlns=&quot;http://www.exoplaform.org/xml/ns/kernel_1_2.xsd&quot;... -21. &lt;external-component-plugins&gt; -22. &lt;!-- The full qualified name of the ResourceBundleService --&gt; -23. &lt;target-component&gt;org.exoplatform.services.resources.ResourceBundleService&lt;/target-component&gt; -24. &lt;component-plugin&gt; -25. &lt;!-- The name of the plugin --&gt; -26. &lt;name&gt;Sample ResourceBundle Plugin&lt;/name&gt; -27. &lt;!-- The name of the method to call on the ResourceBundleService in order to register the ResourceBundles --&gt; -28. &lt;set-method&gt;addResourceBundle&lt;/set-method&gt; -29. &lt;!-- The full qualified name of the BaseResourceBundlePlugin --&gt; -30. &lt;type&gt;org.exoplatform.services.resources.impl.BaseResourceBundlePlugin&lt;/type&gt; -31. &lt;init-params&gt; -32. &lt;values-param&gt; -33. &lt;name&gt;init.resources&lt;/name&gt; -34. &lt;description&gt;Initiate the following resources during the first launch.&lt;/description&gt; -35. &lt;value&gt;locale.portal.extension&lt;/value&gt; -36. &lt;value&gt;locale.navigation.user.root&lt;/value&gt; -37. &lt;!-- -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. --&gt; -42. &lt;value&gt;locale.navigation.portal.classic&lt;/value&gt; -43. &lt;value&gt;locale.navigation.group.platform.administrators&lt;/value&gt; -44. &lt;/values-param&gt; -45. &lt;values-param&gt; -</programlisting> - </example> - </section> + <example> + <title>common-configuration.xml containing declarations of navigation resource bundles</title> + <programlisting>&lt;configuration xmlns:xsi=&quot;http://www.w3.org/2001/XMLSchema-instance&quot; + xsi:schemaLocation=&quot;http://www.exoplaform.org/xml/ns/kernel_1_2.xsd http://www.exoplaform.org/xml/ns/kernel_1_2.xsd&quot; xmlns=&quot;http://www.exoplaform.org/xml/ns/kernel_1_2.xsd&quot;... + &lt;external-component-plugins&gt; + &lt;!-- The full qualified name of the ResourceBundleService --&gt; + &lt;target-component&gt;org.exoplatform.services.resources.ResourceBundleService&lt;/target-component&gt; + &lt;component-plugin&gt; + &lt;!-- The name of the plugin --&gt; + &lt;name&gt;Sample ResourceBundle Plugin&lt;/name&gt; + &lt;!-- The name of the method to call on the ResourceBundleService in order to register the ResourceBundles --&gt; + &lt;set-method&gt;addResourceBundle&lt;/set-method&gt; + &lt;!-- The full qualified name of the BaseResourceBundlePlugin --&gt; + &lt;type&gt;org.exoplatform.services.resources.impl.BaseResourceBundlePlugin&lt;/type&gt; + &lt;init-params&gt; + &lt;values-param&gt; + &lt;name&gt;init.resources&lt;/name&gt; + &lt;description&gt;Initiate the following resources during the first launch.&lt;/description&gt; + &lt;value&gt;locale.portal.extension&lt;/value&gt; + &lt;value&gt;locale.navigation.user.root&lt;/value&gt; + &lt;!-- + 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. + --&gt; + &lt;value&gt;locale.navigation.portal.classic&lt;/value&gt; + &lt;value&gt;locale.navigation.group.platform.administrators&lt;/value&gt; + &lt;/values-param&gt; + &lt;/init-params&gt; + &lt;/component-plugin&gt;</programlisting> + </example> </section> <section id="Custom_Internationalization_Resource_Bundles"> <title>Custom Internationalization Resource Bundles</title> @@ -715,7 +697,7 @@ <code>Congratulations!</code> is appended to it. </para> - <para>Refer to the <xref linkend="Adding_Navigation_Node_Group_Navigation"/> + <para>Refer to the <xref linkend="exam-Adding_Navigation_Node_Group"/> for more details on internationalization of navigation nodes. </para> </section> Modified: epp/docs/branches/6.0/Developer_Guide/en-US/images/Kinds+of+Navigation.png =================================================================== (Binary files differ)