From portal-commits at lists.jboss.org Thu Feb 14 23:44:18 2008
Content-Type: multipart/mixed; boundary="===============3529102017090512265=="
MIME-Version: 1.0
From: portal-commits at lists.jboss.org
To: portal-commits at lists.jboss.org
Subject: [portal-commits] JBoss Portal SVN: r9985 -
 docs/branches/JBoss_Portal_Branch_2_6/referenceGuide/en/modules.
Date: Thu, 14 Feb 2008 23:44:18 -0500
Message-ID: <E1JPsQs-0005Si-Kq@committer01.frg.pub.inap.atl.jboss.com>

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

Author: mmcallis
Date: 2008-02-14 23:44:18 -0500 (Thu, 14 Feb 2008)
New Revision: 9985

Modified:
   docs/branches/JBoss_Portal_Branch_2_6/referenceGuide/en/modules/tutorial=
s.xml
Log:
5.2.2.5. Building and deploying your portlet
revising with more content so that it is consistent with =

5.2.1. Deploying your First Portlet
*** this will break the book***, but I wanted a backup :)


Modified: docs/branches/JBoss_Portal_Branch_2_6/referenceGuide/en/modules/t=
utorials.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/branches/JBoss_Portal_Branch_2_6/referenceGuide/en/modules/tutoria=
ls.xml	2008-02-15 02:42:15 UTC (rev 9984)
+++ docs/branches/JBoss_Portal_Branch_2_6/referenceGuide/en/modules/tutoria=
ls.xml	2008-02-15 04:44:18 UTC (rev 9985)
@@ -137,7 +137,7 @@
       </sect2>-->
 =

       <sect2>
-         <title>Deploying your First Portlet</title>
+         <title>Deploying your first Portlet</title>
          <sect3>
             <title>Introduction</title>
             <para>
@@ -518,7 +518,7 @@
          <sect3 id=3D"first_portlet_build">
             <title>Building your Portlet</title>
             <para>
-		    A pre-compiled <filename>HelloWorldPortlet/helloworldportlet.war</fi=
lename> file is created after extracting the <filename>HelloWorldPortlet.zi=
p</filename> file. To manually build the <filename>helloworldportlet.war</f=
ilename> file:
+		    The <filename>HelloWorldPortlet.zip</filename> file contains a pre-c=
ompiled <filename>helloworldportlet.war</filename> file; however, to manual=
ly build the <filename>helloworldportlet.war</filename> file:
 	    </para>
 	    <para>
 		    <orderedlist>
@@ -534,7 +534,7 @@
 			    </listitem>
 			    <listitem>
 				    <para>
-					    Run the <command>ant deploy</command> command:
+					    Run the <command>ant deploy</command> command. On Microsoft Windo=
ws, the output will be similar to the following:
 				    </para>
 				    <para>
                				<mediaobject>
@@ -543,6 +543,9 @@
 						</imageobject>
 					</mediaobject>
 				    </para>
+				    <para>
+					    Note: the directory names will be different for your system.
+				 </para>
 			    </listitem>
 		    </orderedlist>
 	    </para>
@@ -553,12 +556,12 @@
 		    <orderedlist>
 			    <listitem>
 				    <para>
-					    If you do not have the <filename>HelloWorldPortlet/helloworldport=
let.war</filename> file, change into the <filename>HelloWorldPortlet/</file=
name> directory, and run the <command>ant deploy</command> command. This cr=
eates a <filename>helloworldportlet.war</filename> file.
+					    If you do not have the <filename>HelloWorldPortlet/helloworldport=
let.war</filename> file, change into the <filename>HelloWorldPortlet/</file=
name> directory, and run the <command>ant deploy</command> command. This cr=
eates the <filename>helloworldportlet.war</filename> file.
 				    </para>
 			    </listitem>
 			    <listitem>
 				    <para>
-					    To expand the war file, change into the <filename>HelloWorldPortl=
et/</filename> directory, and run the <command>ant explode</command> comman=
d:
+					    To expand the war file, change into the <filename>HelloWorldPortl=
et/</filename> directory, and run the <command>ant explode</command> comman=
d. On Microsoft Windows, the output will be similar to the following:
 				    </para>
 				    <para>
 					    <mediaobject>
@@ -567,6 +570,9 @@
 						    </imageobject>
               				 </mediaobject>
 				 </para>
+				 <para>
+					 Note: the directory names will be different for your system.
+				 </para>
 			    </listitem>
 		    </orderedlist>
 	    </para>
@@ -863,7 +869,95 @@
 </para>
          </sect3>
          <sect3>
-            <title>Building and deploying your portlet</title>
+            <title>Building your Portlet</title>
+	    <para>
+		    The <filename>HelloWorldJSPPortlet.zip</filename> file contains a pr=
e-compiled <filename>helloworldjspportlet.war</filename> file; however, to =
manually build the <filename>helloworldjspportlet.war</filename> file:
+	    </para>
+	    <para>
+		 <orderedlist>
+			    <listitem>
+				    <para>
+					    Change into the <filename>HelloWorldJSPPortlet/</filename> direct=
ory, and remove the existing <filename>helloworldjspportlet.war</filename> =
file.
+				    </para>
+			    </listitem>
+			    <listitem>
+				    <para>
+					    If required, edit the <filename>HelloWorldJSPPortlet/src/main/org=
/jboss/portlet/hello/HelloWorldJSPPortlet.java</filename> file, and the XML=
 descriptors in the <filename>HelloWorldJSPPortlet/src/resources/helloworld=
jspportlet-war/WEB-INF</filename> directory.
+				    </para>
+			    </listitem>
+			    <listitem>
+				    <para>
+					    Run the <command>ant deploy</command> command. On Linux, the outp=
ut will be similar to the following:
+				    </para>
+				    <para>
+					    <mediaobject>
+						    <imageobject>
+							    <imagedata align=3D"center" fileref=3D"images/tutorials/jsp_por=
tlet/jsp_ant_deploy.png" valign=3D"middle"/>
+						    </imageobject>
+					    </mediaobject>
+				    </para>
+			    </listitem>
+		    </orderedlist>
+	    </para>
+		<para>
+			Note: the directory names will be different for your system.
+		</para> =

+	    <para>
+		    Expanding the <filename>helloworldjspportlet.war</filename> file all=
ows you to deploy the portlet as an expanded directory, which makes develop=
ment easier. As well, it gives you access to the XML descriptors, resource =
files, JSF, and JSP pages. To expand the <filename>helloworldjspportlet.war=
</filename> file:
+	    </para>
+	    <para>
+		    <orderedlist>
+			    <listitem>
+				    <para>
+					    If you do not have the <filename>HelloWorldJSPPortlet/helloworldj=
spportlet.war</filename> file, change into the <filename>HelloWorldJSPPortl=
et/</filename> directory, and run the <command>ant deploy</command> command=
. This creates the <filename>helloworldjspportlet.war</filename> file.
+				    </para>
+			    </listitem>
+			    <listitem>
+				    <para>
+					    To expand the war file, change into the <filename>HelloWorldJSPPo=
rtlet/</filename> directory, and run the <command>ant explode</command> com=
mand. On Linux, the output will be similar to the following:
+				    </para>
+				    <para>
+					    <mediaobject>
+						    <imageobject>
+							    <imagedata align=3D"center" fileref=3D"images/tutorials/jsp_por=
tlet/jsp_ant_explode.png" valign=3D"middle"/>
+						    </imageobject>
+               				    </mediaobject>
+				    </para>
+			    </listitem>
+		    </orderedlist>
+	    </para>
+	    <para>
+		    Note: the directory names will be different for your system.
+	    </para>
+	    <para>
+		    The <command>ant explode</command> command creates a directory struc=
ture such as the following:
+	    </para>
+	    <para>
+		    <mediaobject>
+			    <imageobject>
+				    <imagedata align=3D"center" fileref=3D"images/tutorials/jsp_portle=
t/exploded.gif" valign=3D"middle"/>
+			    </imageobject>
+                    </mediaobject>
+	    </para>
+	    <para>
+		    The expanded war file and the XML descriptors are located in the <fi=
lename>HelloWorldPortlet/output/lib/exploded/helloworldportlet.war/</filena=
me> directory.
+	    </para>
+		    =

+		    =

+
+	    =

+	    =

+	    =

+	    =

+	    =

+	    =

+	    =

+	    =

+	    =

+	    =

+	    =

+	    =

+	    =

             <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
@@ -873,7 +967,7 @@
                The <literal>explode</literal> target will produce the foll=
owing:
                <mediaobject>
                   <imageobject>
-                     <imagedata align=3D"center" fileref=3D"images/tutoria=
ls/jsp_portlet/exploded.gif" valign=3D"middle"/>
+			  <imagedata align=3D"center" fileref=3D"images/tutorials/jsp_ant_explo=
de.png" valign=3D"middle"/>
                   </imageobject>
                </mediaobject>
             </para>


--===============3529102017090512265==--