[jboss-svn-commits] JBoss Portal SVN: r5594 - in docs/trunk: referenceGuide/en referenceGuide/en/images referenceGuide/en/images/navtabs referenceGuide/en/modules userGuide/en/images/intro userGuide/en/modules
jboss-svn-commits at lists.jboss.org
jboss-svn-commits at lists.jboss.org
Tue Nov 7 14:36:21 EST 2006
Author: roy.russo at jboss.com
Date: 2006-11-07 14:36:16 -0500 (Tue, 07 Nov 2006)
New Revision: 5594
Added:
docs/trunk/referenceGuide/en/images/navtabs/
docs/trunk/referenceGuide/en/images/navtabs/navtabs_ss.gif
docs/trunk/referenceGuide/en/modules/navtabs.xml
docs/trunk/userGuide/en/images/intro/nav_sub.gif
Modified:
docs/trunk/referenceGuide/en/master.xml
docs/trunk/userGuide/en/modules/intro.xml
Log:
JBPORTAL-1032 - documented tab changes in user/ref guides.
Added: docs/trunk/referenceGuide/en/images/navtabs/navtabs_ss.gif
===================================================================
(Binary files differ)
Property changes on: docs/trunk/referenceGuide/en/images/navtabs/navtabs_ss.gif
___________________________________________________________________
Name: svn:mime-type
+ application/octet-stream
Modified: docs/trunk/referenceGuide/en/master.xml
===================================================================
--- docs/trunk/referenceGuide/en/master.xml 2006-11-07 17:04:54 UTC (rev 5593)
+++ docs/trunk/referenceGuide/en/master.xml 2006-11-07 19:36:16 UTC (rev 5594)
@@ -14,6 +14,7 @@
<!ENTITY urls SYSTEM "modules/urls.xml">
<!ENTITY ipc SYSTEM "modules/ipc.xml">
<!ENTITY CMS SYSTEM "modules/cmsPortlet.xml">
+ <!ENTITY navtabs SYSTEM "modules/navtabs.xml">
<!ENTITY themeandlayouts SYSTEM "modules/themeandlayouts.xml">
<!ENTITY clustering SYSTEM "modules/clustering.xml">
<!ENTITY wsrp SYSTEM "modules/wsrp.xml">
@@ -61,6 +62,7 @@
<!-- WSRP --> &wsrp;
<!-- security administration --> &security;
<!-- CMS --> &CMS;
+ <!-- NavTabs --> &navtabs;
<!-- theme/layout api --> &themeandlayouts;
<!-- troubleshooting FAQ--> &troubleshooting;
Added: docs/trunk/referenceGuide/en/modules/navtabs.xml
===================================================================
--- docs/trunk/referenceGuide/en/modules/navtabs.xml 2006-11-07 17:04:54 UTC (rev 5593)
+++ docs/trunk/referenceGuide/en/modules/navtabs.xml 2006-11-07 19:36:16 UTC (rev 5594)
@@ -0,0 +1,67 @@
+<chapter id="navtabs">
+ <chapterinfo>
+ <author>
+ <firstname>Roy</firstname>
+ <surname>Russo</surname>
+ <email>roy at jboss dot org</email>
+ </author>
+ </chapterinfo>
+ <title>Navigation Tabs</title>
+ <para>The navigation tabs allow users to navigate the portal pages. This section describes some of the functionality
+ available in configuring them.
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/navtabs/navtabs_ss.gif" format="gif" align="center" valign="middle"/>
+ </imageobject>
+ </mediaobject>
+ </para>
+ <sect1>
+ <title>Explicit ordering of tabs</title>
+ <para>Explicit ordering of the tab display, is accomplished via page properties that are defined in your
+ <emphasis>*-object.xml</emphasis>
+ (
+ <xref linkend="desc_objectxml"/>
+ ). Ordering is accomplished using the
+ <emphasis>order</emphasis>
+ tag at the page level as a page property.
+ <programlisting>
+ <![CDATA[
+<page>
+ <page-name>default</page-name>
+ <properties>
+ <property>
+ <name>order</name>
+ <value>1</value>
+ </property>
+ </properties>
+ ...
+</page>
+ ]]>
+ </programlisting>
+ </para>
+ </sect1>
+ <sect1>
+ <title>Internationalizing tab labels</title>
+ <para>JBoss Portal uses Resource bundles to localize the tab naming for international users. The resource files
+ can be found in
+ <emphasis>jboss-portal.sar/conf/bundles</emphasis>
+ and have the names
+ <emphasis>Resource_*.properties</emphasis>
+ </para>
+ <para>The resource files provide a mapping between the name of the page, as defined in the *-object.xml, and a
+ localized value to display in the tab. For example, our standard bundled pages: Home, Admin, Test, News, are
+ mapped as such in the
+ <emphasis>Resource_fr.properties</emphasis>
+ file, for French users:
+ <programlisting><![CDATA[
+PAGENAME_default=Accueil
+PAGENAME_Admin=Admin
+PAGENAME_Test=Test
+PAGENAME_News=Actualités
+ ]]>
+ </programlisting>
+ So the mapping pattern is
+ <emphasis>PAGE_NAME_[Name in *-object.xml]=[translated value]</emphasis>
+ </para>
+ </sect1>
+</chapter>
\ No newline at end of file
Added: docs/trunk/userGuide/en/images/intro/nav_sub.gif
===================================================================
(Binary files differ)
Property changes on: docs/trunk/userGuide/en/images/intro/nav_sub.gif
___________________________________________________________________
Name: svn:mime-type
+ application/octet-stream
Modified: docs/trunk/userGuide/en/modules/intro.xml
===================================================================
--- docs/trunk/userGuide/en/modules/intro.xml 2006-11-07 17:04:54 UTC (rev 5593)
+++ docs/trunk/userGuide/en/modules/intro.xml 2006-11-07 19:36:16 UTC (rev 5594)
@@ -186,6 +186,14 @@
</imageobject>
</mediaobject>
</para>
+ <para>Take note, also, that the navigation tabs support sub-page navigation as well. By hovering over a tab
+ with childPages, it will display a flyout menu for those subpages
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/intro/nav_sub.gif" format="gif" align="center" valign="middle"/>
+ </imageobject>
+ </mediaobject>
+ </para>
<para>Altervatively, once logged in, you are able to navigate to your Dashboard or the Admin Portal by using
the navigation elements, located in the top-right of the main portal page.
<mediaobject>
@@ -240,9 +248,6 @@
<listitem>
<xref linkend="intro_cms_portlet"/>
</listitem>
- <listitem>
- <xref linkend="intro_nav_portlet"/>
- </listitem>
</itemizedlist>
</para>
<sect3 id="intro_greetings_portlet">
@@ -357,16 +362,6 @@
, for managing the data in the CMS.
</note>
</sect3>
- <sect3 id="intro_nav_portlet">
- <title>Navigation Portlet</title>
- <para>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/intro/tabs.gif" format="gif" align="center" valign="middle"/>
- </imageobject>
- </mediaobject>
- </para>
- </sect3>
</sect2>
<sect2>
<title>News Page</title>
More information about the jboss-svn-commits
mailing list