Author: mmcallis
Date: 2008-02-11 22:35:38 -0500 (Mon, 11 Feb 2008)
New Revision: 9938
Modified:
docs/branches/JBoss_Portal_Branch_2_6/referenceGuide/en/modules/tutorials.xml
Log:
revising 5.2.1.5. Building your Portlet
adding orderedlist/procedure for building/exploding helloworldportlet
example
Modified: docs/branches/JBoss_Portal_Branch_2_6/referenceGuide/en/modules/tutorials.xml
===================================================================
---
docs/branches/JBoss_Portal_Branch_2_6/referenceGuide/en/modules/tutorials.xml 2008-02-12
01:08:04 UTC (rev 9937)
+++
docs/branches/JBoss_Portal_Branch_2_6/referenceGuide/en/modules/tutorials.xml 2008-02-12
03:35:38 UTC (rev 9938)
@@ -519,41 +519,67 @@
</para>
</sect3>
<sect3 id="first_portlet_build">
- <title>Building your portlet</title>
- <para>If you have downloaded the sample, you can execute the build.xml
with ant or inside your IDE.
- Executing the <literal>deploy</literal> target will compile
all the source files and produce a
- <literal>helloworldportlet.war</literal> file under
- <literal>HelloWorldPortlet\helloworldportlet.war.</literal>
- </para>
+ <title>Building your Portlet</title>
<para>
- <mediaobject>
- <imageobject>
- <imagedata align="center"
fileref="images/tutorials/first_portlet/building.gif"
valign="middle"/>
- </imageobject>
- </mediaobject>
- </para>
+ A pre-compiled
<filename>HelloWorldPortlet/helloworldportlet.war</filename> file is created
after extracting the <ulink
url="http://anonsvn.jboss.org/repos/portletswap/portlets/2_6/bundles...
file. To manually build the <filename>helloworldportlet.war</filename> file:
+ </para>
+ <para>
+ <orderedlist>
+ <listitem>
+ <para>
+ Change into the <filename>HelloWorldPortlet/</filename> directory,
and remove the existing <filename>helloworldportlet.war</filename> file.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ Run the <command>ant deploy</command> command:
+ </para>
+ <para>
+ <mediaobject>
+ <imageobject>
+ <imagedata align="center"
fileref="images/tutorials/first_portlet/building.gif"
valign="middle"/>
+ </imageobject>
+ </mediaobject>
+ </para>
+ </listitem>
+ </orderedlist>
+ </para>
<para>
- If you want to create an expanded WAR directory, after executing the above
deploy target, you should
- execute the <literal>explode</literal> target.
+ Expanding the <filename>helloworldportlet.war</filename> allows you to
deploy the portlet as an expanded directory, which makes development easier. This gives
you access to the XML descriptors, resource files, JSF, and JSP pages. To expand the
<filename>helloworldportlet.war</filename> file:
+ </para>
+ <para>
+ <orderedlist>
+ <listitem>
+ <para>
+ If you do not have the
<filename>HelloWorldPortlet/helloworldportlet.war</filename> file, change into
the run the <filename>HelloWorldPortlet/</filename> directory and run the
<command>ant deploy</command> command to create it.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ Change into the <filename>HelloWorldPortlet/</filename> directory
and run the <command>ant explode</command> command:
+ </para>
+ <para>
+ <mediaobject>
+ <imageobject>
+ <imagedata align="center"
fileref="images/tutorials/first_portlet/buildexplode.gif"
valign="middle"/>
+ </imageobject>
+ </mediaobject>
+ </para>
+ </listitem>
+ </orderedlist>
+ </para>
+ <para>
+ The <command>ant explode</command> command creates a directory
structure such as the following:
+ </para>
+ <para>
<mediaobject>
<imageobject>
- <imagedata align="center"
fileref="images/tutorials/first_portlet/buildexplode.gif"
- valign="middle"/>
- </imageobject>
- </mediaobject>
- </para>
- <para>
- The above target will produce the following:
- <mediaobject>
- <imageobject>
<imagedata align="center"
fileref="images/tutorials/first_portlet/exploded.gif"
valign="middle"/>
</imageobject>
</mediaobject>
- This will deflate <literal>helloworldportlet.war</literal>,
and allow you to deploy it as an
- expanded directory. It will work just the same but is easier to work with
during development as you can
- easily modify the XML descriptors, resources files, JSF/JSP pages. A
simple <literal>touch</literal>
- operation (or equivalent) on the <literal>web.xml</literal>
file will let any live JBoss Application
- Server instance know that it needs to hot-redeploy your web application.
+ </para>
+ <para>
+ The expanded directory and the XML descriptors are located in the
<filename>HelloWorldPortlet/output/lib/exploded/helloworldportlet.war/</filename>
directory. Touching the <filename>web.xml</filename> file will let any live
JBoss AS instance know that it needs to hot re-deploy the web application.
</para>
</sect3>
<sect3>