Author: mcaspers Date: 2011-01-18 00:51:43 -0500 (Tue, 18 Jan 2011) New Revision: 28342 Modified: trunk/portlet/docs/reference/en-US/Revision_History.xml trunk/portlet/docs/reference/en-US/jsf_portlet.xml trunk/portlet/docs/reference/en-US/seam_portlet.xml Log: General Updates Modified: trunk/portlet/docs/reference/en-US/Revision_History.xml =================================================================== --- trunk/portlet/docs/reference/en-US/Revision_History.xml 2011-01-18 05:29:40 UTC (rev 28341) +++ trunk/portlet/docs/reference/en-US/Revision_History.xml 2011-01-18 05:51:43 UTC (rev 28342) @@ -2,31 +2,51 @@ <!DOCTYPE Book PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [ ]> <appendix> - <title>Revision History</title> - <simpara> - <revhistory> - <revision> - <revnumber>1</revnumber><date>Wed Jun 09 2010</date> - <author> - <firstname>JBoss Tools</firstname><surname>Documentation Team&lt;/surname&gt;&lt;email&gt;irooskov(a)redhat.com&lt;/email&gt; - </author> - <revdescription> - <simplelist> - <member>General updates</member> - </simplelist> - </revdescription> - </revision> - <revision> - <revnumber>0</revnumber><date>Fri Nov 20 2009</date> - <author> - <firstname&gt;Isaac&lt;/firstname&gt;&lt;surname&gt;Rooskov&lt;/surname&gt;&lt;email&gt;irooskov(a)redhat.com&lt;/email&gt; - </author> - <revdescription> - <simplelist> - <member>Initial creation of book by publican</member> - </simplelist> - </revdescription> - </revision> - </revhistory> - </simpara> + <title>Revision History</title> + <simpara> + <revhistory> + <revision> + <revnumber>2</revnumber> + <date>Tue Jan 18 2011</date> + <author> + <firstname>JBoss Tools</firstname> + <surname>Documentation Team</surname> + <email&gt;mcaspers(a)redhat.com&lt;/email&gt; + </author> + <revdescription> + <simplelist> + <member>General updates</member> + </simplelist> + </revdescription> + </revision> + <revision> + <revnumber>1</revnumber> + <date>Wed Jun 09 2010</date> + <author> + <firstname>JBoss Tools</firstname> + <surname>Documentation Team</surname> + <email&gt;irooskov(a)redhat.com&lt;/email&gt; + </author> + <revdescription> + <simplelist> + <member>General updates</member> + </simplelist> + </revdescription> + </revision> + <revision> + <revnumber>0</revnumber> + <date>Fri Nov 20 2009</date> + <author> + <firstname>Isaac</firstname> + <surname>Rooskov</surname> + <email&gt;irooskov(a)redhat.com&lt;/email&gt; + </author> + <revdescription> + <simplelist> + <member>Initial creation of book by publican</member> + </simplelist> + </revdescription> + </revision> + </revhistory> + </simpara> </appendix> Modified: trunk/portlet/docs/reference/en-US/jsf_portlet.xml =================================================================== --- trunk/portlet/docs/reference/en-US/jsf_portlet.xml 2011-01-18 05:29:40 UTC (rev 28341) +++ trunk/portlet/docs/reference/en-US/jsf_portlet.xml 2011-01-18 05:51:43 UTC (rev 28342) @@ -78,7 +78,7 @@ </listitem> <listitem> - <para>On the <property>JBoss Portlet Capabilities</property> page, select <emphasis><property>Portlet Target Runtime Provider</property></emphasis> and click the <guibutton>Next</guibutton> button.</emphasis> + <para>On the <property>JBoss Portlet Capabilities</property> page, select <emphasis><property>Portlet Target Runtime Provider</property></emphasis> and click the <guibutton>Next</guibutton> button. </para> <figure> Modified: trunk/portlet/docs/reference/en-US/seam_portlet.xml =================================================================== --- trunk/portlet/docs/reference/en-US/seam_portlet.xml 2011-01-18 05:29:40 UTC (rev 28341) +++ trunk/portlet/docs/reference/en-US/seam_portlet.xml 2011-01-18 05:51:43 UTC (rev 28342) @@ -2,219 +2,218 @@ <section id="seam_portlet"> <title>Creating and Deploying a Seam Portlet</title> - <para>This chapter covers the steps on how to configure a Seam portlet within a Seam - project with the help of the <property>JBoss Portlet Tools</property> features.</para> - - <section id="seam_portlet1"> - <title>Creating a Seam Project with JBoss Portlet Capabilities</title> + <para> + This chapter covers the steps required to configure a Seam portlet within a Seam project with the help of the <property>JBoss Portlet Tools</property> features. + </para> - <para>Follow one of two ways of creating a Seam project with JBoss Portlet capabilities enabled:</para> - <orderedlist> - <listitem> - <para>Create a dynamic Web project with the <emphasis><property>Seam</property></emphasis> - and <emphasis><property>JBoss Portlets</property></emphasis> facets enabled (see <xref linkend="create_dyn_web_proj_seam"/>)</para> - </listitem> - <listitem><para>Or create a Seam project with the JBoss Seam portlet configuration using the wizard JBoss Seam Tools provides - and follow all the wizard steps to enable JBoss Portlet capabilities (see <xref linkend="create_seam_proj"/>)</para></listitem> - </orderedlist> + <section id="seam_portlet1"> + <title>Creating a Seam Project with JBoss Portlet Capabilities</title> + + <para>One of the following two procedures can be used to create a Seam project with JBoss Portlet capabilities enabled:</para> + <orderedlist> + <listitem> + <para> + Create a dynamic Web project with the <emphasis><property>Seam</property></emphasis> and <emphasis><property>JBoss Portlets</property></emphasis> facets enabled (see <xref linkend="create_dyn_web_proj_seam"/>) + </para> + </listitem> + <listitem> + <para> + Create a Seam project with the JBoss Seam portlet configuration using the wizard JBoss Seam Tools provides and follow all the wizard steps to enable JBoss Portlet capabilities (see <xref linkend="create_seam_proj"/>) + </para> + </listitem> + </orderedlist> - <section id="create_dyn_web_proj_seam"> - <title>Creating a Dynamic Web Project with Seam and JBoss Portlet Capabilities</title> + <section id="create_dyn_web_proj_seam"> + <title>Creating a Dynamic Web Project with Seam and JBoss Portlet Capabilities</title> - <para>To create a dynamic Web project with Seam and JBoss Portlet capabilities you should take the following steps:</para> + <para>To create a dynamic Web project with Seam and JBoss Portlet capabilities you should complete the following steps:</para> - <orderedlist> - <listitem> - <para>In the <emphasis><property>File</property></emphasis> menu, go to - <emphasis><property>New &gt; Other &gt; Web &gt; Dynamic Web Project</property>.</emphasis> The <property>New Dynamic Web Project</property> - wizard starts.</para> + <orderedlist> + <listitem> + <para> Select. <menuchoice><guimenuitem>File</guimenuitem><guimenuitem>New</guimenuitem><guimenuitem>Other</guimenuitem><guimenuitem>Web</guimenuitem><guimenuitem>Dynamic Web Project</guimenuitem></menuchoice>. The <property>New Dynamic Web Project</property> wizard will then be displayed.</para> - <figure> - <title>Creating a New Dynamic Web Project</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/seam_portlet/seam_portlet1.png"/> - </imageobject> - </mediaobject> - </figure> - </listitem> + <figure> + <title>Creating a New Dynamic Web Project</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/seam_portlet/seam_portlet1.png"/> + </imageobject> + </mediaobject> + </figure> + </listitem> - <listitem> - <para>Give the project a name and follow the steps 3, 4, 5 of the - <xref linkend="jboss_core_portlet"/> procedure to set the target runtime.</para> - </listitem> + <listitem> + <para>Give the project a name and follow the steps 3, 4, 5 of the <xref linkend="jboss_core_portlet"/> procedure to set the target runtime.</para> + </listitem> - <listitem> - <para>In the <emphasis><property>Configuration</property></emphasis> area of the first wizard page, - select <emphasis> - <property>JBoss Seam Portlet Project v2.0</property>.</emphasis> It will add needed facets to the project.</para> + <listitem> + <para> + In the <emphasis><property>Configuration</property></emphasis> area of the first wizard page, select <emphasis><property>JBoss Seam Portlet Project v2.0</property>.</emphasis> It will add needed facets to the project. + </para> - <note> - <title>Tip:</title> - <para>If you now click the <emphasis><property>Modify</property></emphasis> button, you should see the - <emphasis><property>JavaServer Faces</property>,</emphasis> <emphasis><property>Jboss Portlets</property></emphasis> - and <emphasis><property>Seam</property></emphasis> facets enabled.</para> - </note> + <note> + <title>Tip:</title> + <para>If you now click the <guibutton>Modify</guibutton> button, you should see the<emphasis><property>JavaServer Faces</property>,</emphasis><emphasis><property>Jboss Portlets</property></emphasis> and <emphasis><property>Seam</property></emphasis> facets enabled.</para> + </note> - <figure> - <title>Project Facets</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/seam_portlet/seam_portlet2.png"/> - </imageobject> - </mediaobject> - </figure> - </listitem> + <figure> + <title>Project Facets</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/seam_portlet/seam_portlet2.png"/> + </imageobject> + </mediaobject> + </figure> + </listitem> - <listitem> - <para>The next two pages are for adjusting the project Java and Web modules. - They include the default values, so you can skip them by pressing <emphasis> - <property>Next</property>.</emphasis></para> - </listitem> + <listitem> + <para> + The next two pages are for adjusting the project Java and Web modules. They include the default values, so you can skip them by clicking the <guibutton>Next</guibutton> button. + </para> + </listitem> - <listitem> - <para>On the <property>Jboss Portlet Capabilities</property> page, select - <emphasis><property>Portlet Target Runtime Provider</property></emphasis> as the portlet implementation library.</para> + <listitem> + <para> + On the <property>Jboss Portlet Capabilities</property> page, select <emphasis><property>Portlet Target Runtime Provider</property></emphasis> as the portlet implementation library. + </para> - <note> - <title>Tip:</title> - <para>All types of the portlet implementation library are described more closely in the wiki article at: - <ulink url="http://www.jboss.org/community/wiki/PortletFacetLibraries"... - </note> - </listitem> + <note> + <title>Tip:</title> + <para> + All types of the portlet implementation library are described more closely in the wiki article at: <ulink url="http://www.jboss.org/community/wiki/PortletFacetLibraries"...;. + </para> + </note> + </listitem> - <listitem> - <para>The next page is for configuring JSF capabilities. As it contains the default values, just click - <emphasis><property>Next</property></emphasis> to proceed.</para> - </listitem> + <listitem> + <para> + The next page is for configuring JSF capabilities. As it contains the default values, just click the <guibutton>Next</guibutton> button to proceed. + </para> + </listitem> - <listitem> - <para>On the <property>Seam Facet</property> page, set a Seam runtime and - a connection profile.</para> + <listitem> + <para>On the <property>Seam Facet</property> page, set a Seam runtime and a connection profile.</para> - <note> - <title>Tip:</title> - <para>For details about how to set a Seam runtime and a connection profile, see - Configure Seam Facet Settings in the Chapter 2 of the - Seam Dev Tools Reference Guide.</para> - </note> + <note> + <title>Tip:</title> + <para> + For details about how to set a Seam runtime and a connection profile, see Configure Seam Facet Settings in the Chapter 2 of the Seam Dev Tools Reference Guide. + </para> + </note> - <figure> - <title>Seam Facet Settings</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/seam_portlet/seam_portlet3.png"/> - </imageobject> - </mediaobject> - </figure> - </listitem> + <figure> + <title>Seam Facet Settings</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/seam_portlet/seam_portlet3.png"/> + </imageobject> + </mediaobject> + </figure> + </listitem> - <listitem> - <para>On the <property>JBoss JSF Portlet Capabilities</property> page, select the - <emphasis><property>JSF Portlet Target Runtime Provider</property></emphasis> type of the implementation library.</para> + <listitem> + <para> + On the <property>JBoss JSF Portlet Capabilities</property> page, select the <emphasis><property>JSF Portlet Target Runtime Provider</property></emphasis> type of the implementation library. + </para> - <note> - <title>Tip:</title> - <para>If you have <property>JBoss Portlet Bridge</property> downloaded, - alternatively you can select <emphasis><property>JSF Portletbridge Runtime Provider</property></emphasis> and then provide a path to - the <property>JBoss Portlet Bridge</property> distribution.</para> - </note> + <note> + <title>Tip:</title> + <para> + If you have <property>JBoss Portlet Bridge</property> downloaded, alternatively you can select <emphasis><property>JSF Portletbridge Runtime Provider</property></emphasis> and then provide a path to the <property>JBoss Portlet Bridge</property> distribution. + </para> + </note> - <figure> - <title>Setting Portlet Bridge Provider</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/jsf_portlet/jsf_portlet4.png"/> - </imageobject> - </mediaobject> - </figure> + <figure> + <title>Setting Portlet Bridge Provider</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/jsf_portlet/jsf_portlet4.png"/> + </imageobject> + </mediaobject> + </figure> + + <para>It will add <property>JBoss Portlet Bridge</property> libraries to the project classpath.</para> + </listitem> - <para>It will add <property>JBoss Portlet Bridge</property> libraries to the project classpath.</para> - </listitem> - - <listitem> - <para>Hit <emphasis><property>Finish</property></emphasis> to complete the project creation.</para> - </listitem> - </orderedlist> - </section> + <listitem> + <para>Click the <guibutton>Finish</guibutton> button to complete the project creation.</para> + </listitem> + </orderedlist> + </section> - <section id="create_seam_proj"> - <title>Creating a Seam Project with JBoss Portlet Capabilities</title> + <section id="create_seam_proj"> + <title>Creating a Seam Project with JBoss Portlet Capabilities</title> - <para>The steps to create a Seam project with JBoss Portlet capabilities are as follows:</para> + <para>The steps to create a Seam project with JBoss Portlet capabilities are as follows:</para> - <orderedlist> - <listitem> - <para>In the <emphasis><property>File</property></emphasis> menu, go to <emphasis> - <property>New &gt; Other &gt; Seam &gt; Seam Web Project</property>.</emphasis> The <property>New Seam Project</property> - wizard appears.</para> - </listitem> + <orderedlist> + <listitem> + <para> Select <menuchoice><guimenuitem>File</guimenuitem><guimenuitem>New</guimenuitem><guimenuitem>Other</guimenuitem><guimenuitem>Seam</guimenuitem><guimenuitem>Seam Web Project</guimenuitem></menuchoice>. The <property>New Seam Project</property> wizard will be displayed.</para> + </listitem> - <listitem> - <para>Next steps are the same as in the <xref - linkend="create_dyn_web_proj_seam"/> - procedure starting from the step 2.</para> - </listitem> - </orderedlist> - </section> - </section> - - <section id="seam_portlet_to_seam_project"> - <title>Adding a Seam Portlet to the Project and Deploying It to JBoss Portal</title> + <listitem> + <para>Next steps are the same as in the <xref linkend="create_dyn_web_proj_seam"/> procedure starting from the step 2.</para> + </listitem> + </orderedlist> + </section> + </section> + + <section id="seam_portlet_to_seam_project"> + <title>Adding a Seam Portlet to the Project and Deploying It to JBoss Portal</title> - <para>The previous section has shown you how to create a Web project with Seam and JBoss Portlet capabilities. Now you can create a Seam portlet - and deploy it to <property>JBoss Portal</property> by following the next procedure:</para> - - <orderedlist> - <listitem> - <para>In the <emphasis><property>File</property></emphasis> or context menu of the project go to - <emphasis><property>New > Other > JBoss Tools Web > Portlet > JSF/Seam - Portlet</property>.</emphasis></para> + <para> + The previous section has demonstrated how to create a Web project with Seam and JBoss Portlet capabilities. Now you can create a Seam portlet and deploy it to <property>JBoss Portal</property> by following the next procedure: + </para> + + <orderedlist> + <listitem> + <para> + Select <menuchoice><guimenuitem>File</guimenuitem><guimenuitem>New</guimenuitem><guimenuitem>Other</guimenuitem><guimenuitem>JBoss Tools Web</guimenuitem><guimenuitem>Portlet</guimenuitem><guimenuitem>JSF/Seam Portlet</guimenuitem></menuchoice>. + </para> - <figure> - <title>Calling the Create Portlet Wizard</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/seam_portlet/seam_portlet5.png"/> - </imageobject> - </mediaobject> - </figure> - </listitem> + <figure> + <title>Calling the Create Portlet Wizard</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/seam_portlet/seam_portlet5.png"/> + </imageobject> + </mediaobject> + </figure> + </listitem> - <listitem> - <para>The <property>Create Portlet</property> wizard starts (for more information about wizard options, see - <xref linkend="jsf_seam_portlet_wizard"/> in the guide reference). - As the Seam configuration is set for the project, the wizard puts the values as for Seam portlet.</para> + <listitem> + <para> + The <property>Create Portlet</property> wizard is displayed (for more information about wizard options, see <xref linkend="jsf_seam_portlet_wizard"/> in the guide reference). As the Seam configuration is set for the project, the wizard enters the values for the for Seam portlet. + </para> - <figure> - <title>Creating Seam Portlet</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/seam_portlet/seam_portlet6.png"/> - </imageobject> - </mediaobject> - </figure> - </listitem> + <figure> + <title>Creating Seam Portlet</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/seam_portlet/seam_portlet6.png"/> + </imageobject> + </mediaobject> + </figure> + </listitem> - <listitem> - <para>Next two pages are filled out with default values, just press <emphasis><property>Next</property></emphasis> to - proceed. On the last one click <emphasis><property>Finish</property></emphasis> to complete.</para> - </listitem> + <listitem> + <para>Next two pages are filled out with default values, just click the <guibutton>Next</guibutton> button to proceed. On the last one click the <guibutton>Finish</guibutton> button to complete the procedure.</para> + </listitem> - <listitem> - <para>To deploy and run the portlet on <property>JBoss Portal</property> complete the steps described in the - <xref linkend="deploying_to_portal"/> procedure. Just use the following URL to see it in the browser: - <emphasis>http://localhost:8080/portal/portal/default/SeamPortlet</emphasis>.</para> + <listitem> + <para> + To deploy and run the portlet on <property>JBoss Portal</property> complete the steps described in the <xref linkend="deploying_to_portal"/> procedure. Just use the following URL to see it in the browser: <emphasis>http://localhost:8080/portal/portal/default/SeamPortlet</emphasis>. + </para> - <figure> - <title>Seam Portlet in the Browser Window</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/seam_portlet/seam_portlet7.png"/> - </imageobject> - </mediaobject> - </figure> - </listitem> - </orderedlist> - </section> + <figure> + <title>Seam Portlet in the Browser Window</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/seam_portlet/seam_portlet7.png"/> + </imageobject> + </mediaobject> + </figure> + </listitem> + </orderedlist> + </section> </section>