8:47 a.m.
Author: thomas.heute(a)jboss.com
Date: 2007-04-26 09:47:47 -0400 (Thu, 26 Apr 2007)
New Revision: 7077
Modified:
docs/trunk/referenceGuide/en/modules/themeandlayouts.xml
Log:
Added comment on region inclusion in the layout
Modified: docs/trunk/referenceGuide/en/modules/themeandlayouts.xml
===================================================================
--- docs/trunk/referenceGuide/en/modules/themeandlayouts.xml 2007-04-26 13:25:08 UTC (rev
7076)
+++ docs/trunk/referenceGuide/en/modules/themeandlayouts.xml 2007-04-26 13:47:47 UTC (rev
7077)
@@ -11,6 +11,11 @@
<surname>Fernandes</surname>
<email>mfernandes(a)novell.com</email>
</author>
+ <author>
+ <firstname>Thomas</firstname>
+ <surname>Heute</surname>
+ <email>theute(a)jboss.org</email>
+ </author>
</chapterinfo>
<title>Layouts and Themes</title>
<sect1>
@@ -102,7 +107,12 @@
<sect2>
<title>Overview</title>
<para>The default header is divided into two parts, links to pages
displayed as tabs and links
- to navigate between portals and dahsboards as well as loggin in and out.
+ to navigate between portals and dahsboards as well as loggin in and out.
Those two parts are
+ included into the template thanks to the layout as defined in <xref
linkend="layouts"/>.
+ In fact, the region named, <literal>dashboardnav</literal> will
include the navigation links,
+ while the region named <literal>navigation</literal> will include
the navigation tabs.
+ It is then easy to hide one and/or the other by removing the corresponding
inclusion in the
+ layout.
</para>
<para>Screenshot:</para>
<para>
@@ -240,7 +250,7 @@
</sect3-->
</sect2>
</sect1>
- <sect1>
+ <sect1 id="layouts">
<title>Layouts</title>
<sect2>
<title>How to define a Layout</title>
@@ -283,29 +293,29 @@
the desired layout is made in the portal descriptor
(YourNameHere-object.xml). Here
is an example of such a portal descriptor:
<programlisting><![CDATA[
- <portal>
- <portal-name>default</portal-name>
- <properties>
- <!-- Set the layout for the default portal -->
- <!-- see also portal-layouts.xml -->
- <property>
- <name>layout.id</name>
- <value>phalanx</value>
- </property>
- </properties>
- <pages>
- <page>
- <page-name>theme test</page-name>
- <properties>
- <!-- set a difference layout for this page -->
- <property>
- <name>layout.id</name>
- <value>industrial</value>
- </property>
- </properties>
- </page>
- </pages>
- </portal>]]></programlisting>
+<portal>
+ <portal-name>default</portal-name>
+ <properties>
+ <!-- Set the layout for the default portal -->
+ <!-- see also portal-layouts.xml -->
+ <property>
+ <name>layout.id</name>
+ <value>phalanx</value>
+ </property>
+ </properties>
+ <pages>
+ <page>
+ <page-name>theme test</page-name>
+ <properties>
+ <!-- set a difference layout for this page -->
+ <property>
+ <name>layout.id</name>
+ <value>industrial</value>
+ </property>
+ </properties>
+ </page>
+ </pages>
+</portal>]]></programlisting>
The name specified for the layout to use has to
match one of the names defined in the portal-layouts.xml descriptor of one
of the
deployed applications.
@@ -381,42 +391,43 @@
<para>Here is an example layout JSP that uses tags from the latter:
<programlisting>
<![CDATA[
- <%@ taglib uri="/WEB-INF/theme/portal-layout.tld"
prefix="p" %>
- <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
- <html xmlns="http://www.w3.org/1999/xhtml">
- <head>
- <title>JBoss Portal: 2.2 early (Industrial)</title>
- <meta http-equiv="Content-Type" content="text/html;"
/>
- <p:theme themeName='phalanx' />
- <p:headerContent />
- </head>
- <body id="body">
- <div id="portal-container">
- <div id="sizer">
- <div id="expander">
- <div id="logoName"></div>
- <table border="0" cellpadding="0"
cellspacing="0" id="header-container">
- <tr>
- <td align="center" valign="top"
id="header"><div id="spacer"></div></td>
- </tr>
- </table>
- <div id="content-container">
- <p:region regionName='This-Is-The-Page-Region-To-Query-The-Page'
-
regionID='This-Is-The-Tag-ID-Attribute-To-Match-The-CSS-Selector'/>
- <p:region regionName='left' regionID='regionA'/>
- <p:region regionName='center' regionID='regionB'/>
- <hr class="cleaner" />
- <div id="footer-container"
class="portal-copyright">Powered by
- <a class="portal-copyright"
href="http://www.jboss.com/products/jbossportal">JBoss
Portal</a><br/>
- Theme by <a class="portal-copyright"
href="http://www.novell.com">Novell</a>
- </div>
- </div>
- </div>
- </div>
- </div>
- </body>
- </html>
- ]]></programlisting>
+<%@ taglib uri="/WEB-INF/theme/portal-layout.tld" prefix="p"
%>
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml">
+ <head>
+ <title>JBoss Portal</title>
+ <meta http-equiv="Content-Type" content="text/html;" />
+ <p:theme themeName='renaissance' />
+ <p:headerContent />
+ </head>
+ <body id="body">
+ <div id="portal-container">
+ <div id="sizer">
+ <div id="expander">
+ <div id="logoName"></div>
+ <table border="0" cellpadding="0"
cellspacing="0" id="header-container">
+ <tr>
+ <td align="center" valign="top"
id="header">
+ <div id="spacer"></div>
+ </td>
+ </tr>
+ </table>
+ <div id="content-container">
+ <p:region
regionName='This-Is-The-Page-Region-To-Query-The-Page'
+
regionID='This-Is-The-Tag-ID-Attribute-To-Match-The-CSS-Selector'/>
+ <p:region regionName='left' regionID='regionA'/>
+ <p:region regionName='center'
regionID='regionB'/>
+ <hr class="cleaner" />
+ <div id="footer-container"
class="portal-copyright">Powered by
+ <a class="portal-copyright"
href="http://www.jboss.com/products/jbossportal">JBoss Portal</a>
+ </div>
+ </div>
+ </div>
+ </div>
+ </div>
+ </body>
+</html>
+]]></programlisting>
</para>
<para>
<sect3>