Author: julien(a)jboss.com
Date: 2007-04-26 08:38:38 -0400 (Thu, 26 Apr 2007)
New Revision: 7069
Added:
docs/trunk/referenceGuide/en/modules/ajax.xml
Modified:
docs/trunk/referenceGuide/en/master.xml
docs/trunk/referenceGuide/en/modules/clustering.xml
Log:
started ajax chapter
Modified: docs/trunk/referenceGuide/en/master.xml
===================================================================
--- docs/trunk/referenceGuide/en/master.xml 2007-04-26 12:27:02 UTC (rev 7068)
+++ docs/trunk/referenceGuide/en/master.xml 2007-04-26 12:38:38 UTC (rev 7069)
@@ -16,6 +16,7 @@
<!ENTITY CMS SYSTEM "modules/cmsPortlet.xml">
<!ENTITY navtabs SYSTEM "modules/navtabs.xml">
<!ENTITY themeandlayouts SYSTEM "modules/themeandlayouts.xml">
+ <!ENTITY ajax SYSTEM "modules/ajax.xml">
<!ENTITY identity SYSTEM "modules/identity.xml">
<!ENTITY authentication SYSTEM "modules/authentication.xml">
<!ENTITY ldap SYSTEM "modules/ldap.xml">
@@ -77,6 +78,7 @@
<!-- CMS --> &CMS;
<!-- NavTabs --> &navtabs;
<!-- theme/layout api --> &themeandlayouts;
+ <!-- ajax --> &ajax;
<!-- troubleshooting FAQ--> &troubleshooting;
</book>
Added: docs/trunk/referenceGuide/en/modules/ajax.xml
===================================================================
--- docs/trunk/referenceGuide/en/modules/ajax.xml (rev 0)
+++ docs/trunk/referenceGuide/en/modules/ajax.xml 2007-04-26 12:38:38 UTC (rev 7069)
@@ -0,0 +1,111 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<chapter id="clustering">
+ <chapterinfo>
+ <author>
+ <firstname>Julien</firstname>
+ <surname>Viet</surname>
+ <email>julien.viet(a)jboss.com</email>
+ </author>
+ </chapterinfo>
+ <title>Ajax</title>
+ <para>This section covers the ajax features provided by the
portal.</para>
+ <sect1>
+ <title>Introduction</title>
+ <para>Todo</para>
+ </sect1>
+ <sect1>
+ <title>Ajaxified markup</title>
+ <sect2>
+ <title>Ajaxified layouts</title>
+ <para>Part of the Ajax capabilities are implemented in the layout
framework which provide the structure for
+ generating portal pages. The good news is that the existing layout only requires
a few modifications in
+ order to be ajaxified.</para>
+ <para>We will use as example an simplified version of the layout JSP
provided in JBoss Portal 2.6 and outline
+ what are the required changes that makes it an ajaxified layout:
+ <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>
+ <meta http-equiv="Content-Type" content="text/html;"/>
+ <!-- inject the theme, default to the Renaissance theme if nothing is selected for
the portal or the page -->
+ <p:theme themeName="renaissance"/>
+ <!-- insert header content that was possibly set by portlets on the page -->
+ <p:headerContent/>
+</head>
+
+<body id="body">
+<p:region regionName='AJAXScripts' regionID='AJAXScripts'/>
+<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">
+
+ <!-- Utility controls -->
+ <p:region regionName='dashboardnav'
regionID='dashboardnav'/>
+
+ <!-- navigation tabs and such -->
+ <p:region regionName='navigation'
regionID='navigation'/>
+ <div id="spacer"></div>
+ </td>
+ </tr>
+ </table>
+ <div id="content-container">
+ <!-- insert the content of the 'left' region of the page, and
assign the css selector id 'regionA' -->
+ <p:region regionName='left' regionID='regionA'/>
+ <!-- insert the content of the 'center' region of the page, and
assign the css selector id 'regionB' -->
+ <p:region regionName='center' regionID='regionB'/>
+ <hr class="cleaner"/>
+ </div>
+ </div>
+ </div>
+</div>
+
+<p:region regionName='AJAXFooter' regionID='AJAXFooter'/>
+
+</body>
+</html>
+]]></programlisting>
+ <itemizedlist>
+ <listitem><![CDATA[<p:theme
themeName="renaissance"/>]]> should be already present as it exists since
2.4 but is even more
+ necessary as it will inject in the page the reference to the ajax
stylesheet.</listitem>
+ <listitem><![CDATA[<p:region regionName='AJAXScripts'
regionID='AJAXScripts'/>]]> should be added before any other region
+ in the markup of the layout.</listitem>
+ <listitem><![CDATA[<p:region regionName='AJAXFooter'
regionID='AJAXFooter'/>]]> should be added after any other region
+ in the markup of the layout.</listitem>
+ </itemizedlist>
+ </para>
+ </sect2>
+ <sect2>
+ <title>Ajaxified renderers</title>
+ <para>At runtime the portal combines the layout and the renderers in order
create the markup returned to the
+ web browser. The most used render set is the divRenderer. Renderers only need a
modification in the deployment
+ descriptor to indicate that they support ajax. Here is the declaration of the
default divRenderer now in 2.6:</para>
+ <programlisting><![CDATA[
+<renderSet name="divRenderer">
+ <set content-type="text/html">
+ <ajax-enabled>true</ajax-enabled>
+
<region-renderer>org.jboss.portal.theme.impl.render.div.DivRegionRenderer</region-renderer>
+
<window-renderer>org.jboss.portal.theme.impl.render.div.DivWindowRenderer</window-renderer>
+
<portlet-renderer>org.jboss.portal.theme.impl.render.div.DivPortletRenderer</portlet-renderer>
+
<decoration-renderer>org.jboss.portal.theme.impl.render.div.DivDecorationRenderer</decoration-renderer>
+ </set>
+</renderSet>
+]]></programlisting>
+ <para>You should notice the
<![CDATA[<ajax-enabled>true</ajax-enabled>]]> which indicates that the
render set
+ supports ajaxification.</para>
+ </sect2>
+ </sect1>
+ <sect1>
+ <title>Ajaxified pages</title>
+ <para>todo</para>
+ </sect1>
+ <sect1>
+ <title>Ajaxified portlets</title>
+ <para>todo</para>
+ </sect1>
+</chapter>
\ No newline at end of file
Modified: docs/trunk/referenceGuide/en/modules/clustering.xml
===================================================================
--- docs/trunk/referenceGuide/en/modules/clustering.xml 2007-04-26 12:27:02 UTC (rev
7068)
+++ docs/trunk/referenceGuide/en/modules/clustering.xml 2007-04-26 12:38:38 UTC (rev
7069)
@@ -2,15 +2,15 @@
<chapter id="clustering">
<chapterinfo>
<author>
+ <firstname>Julien</firstname>
+ <surname>Viet</surname>
+ <email>julien.viet(a)jboss.com</email>
+ </author>
+ <author>
<firstname>Roy</firstname>
<surname>Russo</surname>
<email>roy(a)jboss.org</email>
</author>
- <author>
- <firstname>Julien</firstname>
- <surname>Viet</surname>
- <email>julien.viet(a)jboss.com</email>
- </author>
</chapterinfo>
<title>Clustering Configuration</title>
<para>This section covers configuring JBoss Portal to function in a clustered
environment.</para>