From portal-commits at lists.jboss.org Wed Aug 29 06:18:40 2007
Content-Type: multipart/mixed; boundary="===============5361686419463904488=="
MIME-Version: 1.0
From: portal-commits at lists.jboss.org
To: portal-commits at lists.jboss.org
Subject: [portal-commits] JBoss Portal SVN: r8092 - in
 docs/trunk/referenceGuide/en: modules and 1 other directory.
Date: Wed, 29 Aug 2007 06:18:40 -0400
Message-ID: <E1IQKdE-000398-J9@committer01.frg.pub.inap.atl.jboss.com>

--===============5361686419463904488==
Content-Type: text/plain; charset="utf-8"
MIME-Version: 1.0
Content-Transfer-Encoding: quoted-printable

Author: thomas.heute(a)jboss.com
Date: 2007-08-29 06:18:40 -0400 (Wed, 29 Aug 2007)
New Revision: 8092

Removed:
   docs/trunk/referenceGuide/en/images/tutorials/jsf_portlet/package.gif
Modified:
   docs/trunk/referenceGuide/en/modules/tutorials.xml
Log:
Updated reference documentation about JSF tutorials

Deleted: docs/trunk/referenceGuide/en/images/tutorials/jsf_portlet/package.=
gif
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D
(Binary files differ)

Modified: docs/trunk/referenceGuide/en/modules/tutorials.xml
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D
--- docs/trunk/referenceGuide/en/modules/tutorials.xml	2007-08-29 08:41:42 =
UTC (rev 8091)
+++ docs/trunk/referenceGuide/en/modules/tutorials.xml	2007-08-29 10:18:40 =
UTC (rev 8092)
@@ -10,6 +10,11 @@
          <surname>Laprun</surname>
          <email>chris.laprun(a)jboss.com</email>
       </author>
+      <author>
+         <firstname>Thomas</firstname>
+         <surname>Heute</surname>
+         <email>thomas.heute(a)jboss.com</email>
+      </author>
    </chapterinfo>
    <title>Portlet Primer</title>
    <sect1 id=3D"portlet_primer">
@@ -706,14 +711,193 @@
             </para>
          </sect3>         =

       </sect2>
+      <sect2 id=3D"sunri_42x">
+         <title>A simple Sun's JSF Reference Implementation (RI) portlet o=
n JBoss AS 4.2.x</title>
+         <sect3>
+            <title>Introduction</title>
+            <para>This section will introduce the reader to deploying a si=
mple JSF portlet in JBoss Portal, using
+               Apache's MyFaces JSF implementation on JBoss AS 4.2.x. It r=
equires you download the HelloWorldJSFSunRIPortlet
+               from PortletSwap.com, using this link:
+               <ulink url=3D"http://anonsvn.jboss.org/repos/portletswap/po=
rtlets/2_6/bundles/HelloWorldJSFSunRIPortlet.zip">http://anonsvn.jboss.org/=
repos/portletswap/portlets/2_6/bundles/HelloWorldJSFSunRIPortlet.zip</ulink=
>.
+            </para>
+         </sect3>         =

+         <sect3>
+            <title>Package Content</title>
+            <para>
+               <mediaobject>
+                  <imageobject>
+                     <imagedata align=3D"center" fileref=3D"images/tutoria=
ls/jsf_portlet/package_sunri.png" valign=3D"middle"/>
+                  </imageobject>
+               </mediaobject>
+               Like a typical JSF application, we also package our faces-c=
onfig.xml that defines our
+               managed-beans, converters, validators, navigation rules, et=
c...
+               <note>JBoss Application Server version 4.2.x bundles Sun's =
JSF Reference Implementation (RI) in
+                  <literal>JBOSS_HOME/server/default/deploy/jboss-web.depl=
oyer/jsf-libs/</literal>. As a result,
+                  you do not need to package Sun RI's libraries with your =
portlet application.
+               </note>
+            </para>
+            <para>For the sake of brevity, we only discuss the <literal>po=
rtlet.xml</literal> and
+               <literal>faces-config.xml</literal> descriptors here. For d=
iscussion on the other descriptors, please
+               view <xref linkend=3D"first_portlet_descriptors"/> or the c=
hapter on descriptors:
+               <xref linkend=3D"descriptors_portlet"/>.
+               <mediaobject>
+                  <imageobject>
+                     <imagedata align=3D"center" fileref=3D"images/tutoria=
ls/jsf_portlet/package_sunri.png" valign=3D"middle"/>
+                  </imageobject>
+               </mediaobject>
+               <itemizedlist>
+                  <listitem>
+                     <para><literal>portlet.xml</literal>
+<programlisting><![CDATA[<?xml version=3D"1.0" encoding=3D"UTF-8"?>
+<portlet-app xmlns=3D"http://java.sun.com/xml/ns/portlet/portlet-app_1_0.x=
sd"
+             xmlns:xsi=3D"http://www.w3.org/2001/XMLSchema-instance"
+             xsi:schemaLocation=3D"http://java.sun.com/xml/ns/portlet/port=
let-app_1_0.xsd
+                                 http://java.sun.com/xml/ns/portlet/portle=
t-app_1_0.xsd"
+             version=3D"1.0">
+   <portlet>
+      <portlet-name>HelloWorldJSFPortlet</portlet-name>
+      <portlet-class>com.sun.faces.portlet.FacesPortlet</portlet-class>
+      <init-param>
+         <name>com.sun.faces.portlet.INIT_VIEW</name>
+         <value>/WEB-INF/jsp/index.jsp</value>
+      </init-param>
+      <supports>
+         <mime-type>text/html</mime-type>
+         <portlet-mode>VIEW</portlet-mode>
+      </supports>
+      <portlet-info>
+         <title>HelloWorld JSF Portlet</title>
+      </portlet-info>
+   </portlet>
+</portlet-app>]]></programlisting>
+                        This file must adhere to its definition in the Por=
tlet Specification. You may define more than
+                        one portlet application in this file. Now let's lo=
ok at the portions that deal with our use of
+                        JSF:
+                        <itemizedlist>
+                           <listitem>
+                              <para>
+                                 <programlisting><![CDATA[<portlet-class>c=
om.sun.faces.portlet.FacesPortlet</portlet-class>]]></programlisting>
+                                 Here we specify that com.sun.faces.portle=
t.FacesPortlet will handle all requests/responses from our
+                                 users. This class is part of jsf-portlet.=
jar as explained later.
+                              </para>
+                           </listitem>
+                           <listitem>
+                              <para>
+                                 We need to initialize the portlet with a =
default view page for it to render, much like
+                                 a welcome page:
+                                 <programlisting><![CDATA[<init-param>
+   <name>com.sun.faces.portlet.INIT_VIEW</name>
+   <value>/WEB-INF/jsp/index.jsp</value>
+</init-param>]]></programlisting>
+                              </para>
+                           </listitem>
+                        </itemizedlist>
+                     </para>
+                  </listitem>
+                  <listitem>
+                     <para><literal>faces-config.xml</literal>
+<programlisting><![CDATA[<?xml version=3D"1.0"?>
+<!DOCTYPE faces-config PUBLIC
+   "-//Sun Microsystems, Inc.//DTD JavaServer Faces Config 1.0//EN"
+   "http://java.sun.com/dtd/web-facesconfig_1_0.dtd">
+<faces-config>
+   <managed-bean>
+      <description>Basic UserBean</description>
+      <managed-bean-name>user</managed-bean-name>
+      <managed-bean-class>org.jboss.portlet.hello.bean.User</managed-bean-=
class>
+      <managed-bean-scope>session</managed-bean-scope>
+   </managed-bean>
+   <navigation-rule>
+      <navigation-case>
+         <from-outcome>done</from-outcome>
+         <to-view-id>/WEB-INF/jsp/result.jsp</to-view-id>
+      </navigation-case>
+   </navigation-rule>
+</faces-config>]]></programlisting>
+                        There is nothing special about the <literal>faces-=
config.xml</literal> file included here. This
+                        application would work just as well outside of a p=
ortlet as it would inside a portlet container.
+                        In the above lines, we define a basic <literal>Use=
r</literal> Bean and a navigation rule to
+                        handle the submittal of the original form on <lite=
ral>index.jsp</literal>.
+                     </para>
+                  </listitem>
+                  <listitem>
+                     <para><literal>web.xml</literal>
+<programlisting><![CDATA[<?xml version=3D"1.0"?>
+<!DOCTYPE web-app PUBLIC
+   "-//Sun Microsystems, Inc.//DTD Web Application 2.3//EN"
+   "http://java.sun.com/dtd/web-app_2_3.dtd">
+<web-app>
+
+    <!-- Faces Servlet -->
+    <servlet>
+        <servlet-name>Faces Servlet</servlet-name>
+        <servlet-class>javax.faces.webapp.FacesServlet</servlet-class>
+        <load-on-startup>1</load-on-startup>
+    </servlet>
+
+
+    <!-- Faces Servlet Mapping -->
+    <servlet-mapping>
+        <servlet-name>Faces Servlet</servlet-name>
+        <url-pattern>*.jsf</url-pattern>
+    </servlet-mapping>
+
+</web-app>]]></programlisting>
+                        For the Sun RI, this definition is mandatory to as=
sociate jsf extension with the faces servlet.
+                     </para>
+                  </listitem>
+                  <listitem>
+                     <para><literal>jsf-portlet.jar</literal> This library=
 that can be downloaded here: <ulink url=3D"https://jsfportletbridge.dev.ja=
va.net/servlets/ProjectDocumentList">https://jsfportletbridge.dev.java.net/=
servlets/ProjectDocumentList</ulink> =

+                     contains the classes for the JSF-Portlet bridge. Sinc=
e they are not included with the JSF
+                     implementation (unlike myfaces) neither in JBoss AS, =
it is required to have this library available
+                     in the package.</para>
+                  </listitem>
+               </itemizedlist>
+            </para>
+         </sect3>
+         <!-- =

+         <sect3>
+            <title>JSP files</title>
+            <para>TODO!!</para>
+         </sect3>
+          -->
+         <sect3>
+            <title>Building and deploying your portlet</title>
+            <para>If you have downloaded the sample, you can execute the b=
uild.xml with ant or inside your IDE.
+               Executing <literal>ant</literal> will compile all source fi=
les and produce a
+               <literal>helloworldjspportlet.war</literal> file in a way s=
imilar to what we saw in
+               <xref linkend=3D"first_portlet_build"/>.
+            </para>
+            <!-- =

+            <para>
+               The <literal>explode</literal> target will produce the foll=
owing:
+               <mediaobject>
+                  <imageobject>
+                     <imagedata align=3D"center" fileref=3D"images/tutoria=
ls/jsf_portlet/exploded.gif" valign=3D"middle"/>
+                  </imageobject>
+               </mediaobject>
+            </para>
+             -->
+            <para>
+               Deploying the portlet is as easy as copying/moving the <lit=
eral>helloworldjspportlet.war</literal> file
+               to the server <literal>deploy</literal> directory. We can t=
hen see our portlet on the Portal default
+               page (<ulink url=3D"http://localhost:8080/portal/">http://l=
ocalhost:8080/portal/</ulink>):
+               <mediaobject>
+                  <imageobject>
+                     <imagedata align=3D"center" fileref=3D"images/tutoria=
ls/jsf_portlet/output.png" valign=3D"middle"/>
+                  </imageobject>
+               </mediaobject>
+            </para>
+         </sect3>                  =

+      </sect2>
       <sect2 id=3D"myfaces_40x">
-         <title>A Simple MyFaces JSF Portlet on JBoss AS 4.0.x</title>
+         <title>A simple MyFaces JSF Portlet on JBoss AS 4.0.5+</title>
          <sect3>
             <title>Introduction</title>
             <para>This section will introduce the reader to deploying a si=
mple JSF portlet in JBoss Portal, using
-               Apache's MyFaces JSF implementation on JBoss AS 4.0.x. It r=
equires you download the HelloWorldJSFPortlet
-               from PortletSwap.com, using this
-               <ulink url=3D"http://anonsvn.jboss.org/repos/portletswap/po=
rtlets/2_4/bundles/HelloWorldJSFPortlet.zip">link</ulink>.
+               Apache's MyFaces JSF implementation on JBoss AS 4.0.5+. It =
requires you download the HelloWorldJSFMyFacesPortlet
+               from PortletSwap.com, using this link:
+               <ulink url=3D"http://anonsvn.jboss.org/repos/portletswap/po=
rtlets/2_6/bundles/HelloWorldJSFMyFacesPortlet.zip">http://anonsvn.jboss.or=
g/repos/portletswap/portlets/2_6/bundles/HelloWorldJSFMyFacesPortlet.zip</u=
link>.
             </para>
          </sect3>         =

          <sect3>
@@ -721,7 +905,7 @@
             <para>
                <mediaobject>
                   <imageobject>
-                     <imagedata align=3D"center" fileref=3D"images/tutoria=
ls/jsf_portlet/package.gif" valign=3D"middle"/>
+                     <imagedata align=3D"center" fileref=3D"images/tutoria=
ls/jsf_portlet/package_myfaces.png" valign=3D"middle"/>
                   </imageobject>
                </mediaobject>
                Like a typical JSF application, we also package our faces-c=
onfig.xml that defines our
@@ -737,7 +921,7 @@
                <xref linkend=3D"descriptors_portlet"/>.
                <mediaobject>
                   <imageobject>
-                     <imagedata align=3D"center" fileref=3D"images/tutoria=
ls/jsf_portlet/package.gif" valign=3D"middle"/>
+                     <imagedata align=3D"center" fileref=3D"images/tutoria=
ls/jsf_portlet/package_myfaces.png" valign=3D"middle"/>
                   </imageobject>
                </mediaobject>
                <itemizedlist>
@@ -821,17 +1005,20 @@
                </itemizedlist>
             </para>
          </sect3>
+         <!-- =

          <sect3>
             <title>JSP files</title>
             <para>TODO!!</para>
          </sect3>
+          -->
          <sect3>
             <title>Building and deploying your portlet</title>
             <para>If you have downloaded the sample, you can execute the b=
uild.xml with ant or inside your IDE.
-               Executing the <literal>deploy</literal> target will compile=
 all source files and produce a
-               <literal>helloworldjspportlet.war</literal> file in a way s=
imilar to what we saw in
+               Executing <literal>ant</literal> will compile all source fi=
les and produce a
+               <literal>helloworldjsfportlet.war</literal> file in a way s=
imilar to what we saw in
                <xref linkend=3D"first_portlet_build"/>.
             </para>
+            <!-- =

             <para>
                The <literal>explode</literal> target will produce the foll=
owing:
                <mediaobject>
@@ -840,6 +1027,7 @@
                   </imageobject>
                </mediaobject>
             </para>
+             -->
             <para>
                Deploying the portlet is as easy as copying/moving the <lit=
eral>helloworldjspportlet.war</literal> file
                to the server <literal>deploy</literal> directory. We can t=
hen see our portlet on the Portal default
@@ -883,9 +1071,5 @@
             </mediaobject>
          </para>
       </sect2>
-      <sect2>
-         <title>JSF Portlet using Sun's JSF Reference Implementation (RI)<=
/title>
-         <para>TODO</para>
-      </sect2>
    </sect1>
 </chapter>
\ No newline at end of file


--===============5361686419463904488==--