[jbosstools-commits] JBoss Tools SVN: r20778 - in branches/jbosstools-3.1.x/portlet/docs/reference: en-US and 5 other directories.

Author: irooskov(a)redhat.com Date: 2010-03-11 19:23:23 -0500 (Thu, 11 Mar 2010) New Revision: 20778 Added: branches/jbosstools-3.1.x/portlet/docs/reference/en-US/ branches/jbosstools-3.1.x/portlet/docs/reference/en-US/Author_Group.xml branches/jbosstools-3.1.x/portlet/docs/reference/en-US/Book_Info.xml branches/jbosstools-3.1.x/portlet/docs/reference/en-US/JBoss_Portlet_Tools_User_Guide.ent branches/jbosstools-3.1.x/portlet/docs/reference/en-US/JBoss_Portlet_Tools_User_Guide.xml branches/jbosstools-3.1.x/portlet/docs/reference/en-US/Preface.xml branches/jbosstools-3.1.x/portlet/docs/reference/en-US/Revision_History.xml branches/jbosstools-3.1.x/portlet/docs/reference/en-US/images/ branches/jbosstools-3.1.x/portlet/docs/reference/en-US/images/favicon.ico branches/jbosstools-3.1.x/portlet/docs/reference/en-US/images/jbosstools_logo.png branches/jbosstools-3.1.x/portlet/docs/reference/en-US/images/jsf_portlet/ branches/jbosstools-3.1.x/portlet/docs/reference/en-US/images/jsf_portlet/jsf_portlet1.png branches/jbosstools-3.1.x/portlet/docs/reference/en-US/images/jsf_portlet/jsf_portlet2.png branches/jbosstools-3.1.x/portlet/docs/reference/en-US/images/jsf_portlet/jsf_portlet2a.png branches/jbosstools-3.1.x/portlet/docs/reference/en-US/images/jsf_portlet/jsf_portlet3.png branches/jbosstools-3.1.x/portlet/docs/reference/en-US/images/jsf_portlet/jsf_portlet4.png branches/jbosstools-3.1.x/portlet/docs/reference/en-US/images/jsf_portlet/jsf_portlet5.png branches/jbosstools-3.1.x/portlet/docs/reference/en-US/images/jsf_portlet/jsf_portlet7.png branches/jbosstools-3.1.x/portlet/docs/reference/en-US/images/jsf_portlet/jsf_portlet8.png branches/jbosstools-3.1.x/portlet/docs/reference/en-US/images/jsf_portlet/jsf_portlet9.png branches/jbosstools-3.1.x/portlet/docs/reference/en-US/images/reference/ branches/jbosstools-3.1.x/portlet/docs/reference/en-US/images/reference/javaPortlet2.png branches/jbosstools-3.1.x/portlet/docs/reference/en-US/images/reference/javaPortlet3.png branches/jbosstools-3.1.x/portlet/docs/reference/en-US/images/reference/javaPortlet4.png branches/jbosstools-3.1.x/portlet/docs/reference/en-US/images/reference/jsf_seam_portlet1.png branches/jbosstools-3.1.x/portlet/docs/reference/en-US/images/reference/jsf_seam_portlet2.png branches/jbosstools-3.1.x/portlet/docs/reference/en-US/images/reference/jsf_seam_portlet3.png branches/jbosstools-3.1.x/portlet/docs/reference/en-US/images/reference/portlet_preferences.png branches/jbosstools-3.1.x/portlet/docs/reference/en-US/images/seam_portlet/ branches/jbosstools-3.1.x/portlet/docs/reference/en-US/images/seam_portlet/seam_portlet1.png branches/jbosstools-3.1.x/portlet/docs/reference/en-US/images/seam_portlet/seam_portlet2.png branches/jbosstools-3.1.x/portlet/docs/reference/en-US/images/seam_portlet/seam_portlet3.png branches/jbosstools-3.1.x/portlet/docs/reference/en-US/images/seam_portlet/seam_portlet4.png branches/jbosstools-3.1.x/portlet/docs/reference/en-US/images/seam_portlet/seam_portlet5.png branches/jbosstools-3.1.x/portlet/docs/reference/en-US/images/seam_portlet/seam_portlet6.png branches/jbosstools-3.1.x/portlet/docs/reference/en-US/images/seam_portlet/seam_portlet7.png branches/jbosstools-3.1.x/portlet/docs/reference/en-US/images/starting_project/ branches/jbosstools-3.1.x/portlet/docs/reference/en-US/images/starting_project/portlet_capabilities6.png branches/jbosstools-3.1.x/portlet/docs/reference/en-US/images/starting_project/runOnServer.png branches/jbosstools-3.1.x/portlet/docs/reference/en-US/images/starting_project/server_runtime_environment.png branches/jbosstools-3.1.x/portlet/docs/reference/en-US/images/starting_project/starting_project_1.png branches/jbosstools-3.1.x/portlet/docs/reference/en-US/images/starting_project/starting_project_12.png branches/jbosstools-3.1.x/portlet/docs/reference/en-US/images/starting_project/starting_project_13.png branches/jbosstools-3.1.x/portlet/docs/reference/en-US/images/starting_project/starting_project_14.png branches/jbosstools-3.1.x/portlet/docs/reference/en-US/images/starting_project/starting_project_2.png branches/jbosstools-3.1.x/portlet/docs/reference/en-US/images/starting_project/starting_project_3.png branches/jbosstools-3.1.x/portlet/docs/reference/en-US/images/starting_project/starting_project_4.png branches/jbosstools-3.1.x/portlet/docs/reference/en-US/images/starting_project/starting_project_4_a.png branches/jbosstools-3.1.x/portlet/docs/reference/en-US/images/starting_project/starting_project_6.png branches/jbosstools-3.1.x/portlet/docs/reference/en-US/images/starting_project/starting_project_7.png branches/jbosstools-3.1.x/portlet/docs/reference/en-US/images/starting_project/starting_project_8.png branches/jbosstools-3.1.x/portlet/docs/reference/en-US/intro.xml branches/jbosstools-3.1.x/portlet/docs/reference/en-US/jsf_portlet.xml branches/jbosstools-3.1.x/portlet/docs/reference/en-US/master.xml branches/jbosstools-3.1.x/portlet/docs/reference/en-US/master_output.xml branches/jbosstools-3.1.x/portlet/docs/reference/en-US/portlet_tools_tasks.xml branches/jbosstools-3.1.x/portlet/docs/reference/en-US/reference.xml branches/jbosstools-3.1.x/portlet/docs/reference/en-US/seam_portlet.xml branches/jbosstools-3.1.x/portlet/docs/reference/en-US/starting_project.xml branches/jbosstools-3.1.x/portlet/docs/reference/en-US/summary.xml branches/jbosstools-3.1.x/portlet/docs/reference/publican.cfg Removed: branches/jbosstools-3.1.x/portlet/docs/reference/en/ Modified: branches/jbosstools-3.1.x/portlet/docs/reference/pom.xml Log: updated to build with publican Added: branches/jbosstools-3.1.x/portlet/docs/reference/en-US/Author_Group.xml =================================================================== --- branches/jbosstools-3.1.x/portlet/docs/reference/en-US/Author_Group.xml (rev 0) +++ branches/jbosstools-3.1.x/portlet/docs/reference/en-US/Author_Group.xml 2010-03-12 00:23:23 UTC (rev 20778) @@ -0,0 +1,26 @@ +<?xml version='1.0' encoding='utf-8' ?> +<!DOCTYPE Book PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [ +]> +<authorgroup><author> + <firstname>Anatoly</firstname> + <surname>Fedosik</surname> + </author> + <author> + <firstname>Koen</firstname> + <surname>Aers</surname> + <email&gt;koen.aers(a)jboss.com&lt;/email&gt; + </author> + <author> + <firstname>Olga</firstname> + <surname>Chikvina</surname> + </author> + <author> + <firstname>Svetlana</firstname> + <surname>Mukhina</surname> + <email&gt;smukhina(a)exadel.com&lt;/email&gt; + </author> + <author> + <firstname>Tom</firstname> + <surname>Baeyens</surname> + <email&gt;tom.baeyens(a)jboss.com&lt;/email&gt; + </author></authorgroup> Added: branches/jbosstools-3.1.x/portlet/docs/reference/en-US/Book_Info.xml =================================================================== --- branches/jbosstools-3.1.x/portlet/docs/reference/en-US/Book_Info.xml (rev 0) +++ branches/jbosstools-3.1.x/portlet/docs/reference/en-US/Book_Info.xml 2010-03-12 00:23:23 UTC (rev 20778) @@ -0,0 +1,4 @@ +<?xml version='1.0' encoding='utf-8' ?> +<!DOCTYPE Book PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [ +]> +<bookinfo><title>JBoss Portlet Tools User Guide</title><subtitle>Provides information relating to the JBoss Portlet Tools set.</subtitle><productname>JBoss Developer Studio</productname><productnumber>3.0</productnumber><edition>1.0</edition><pubsnumber>0</pubsnumber><abstract><para>The JBoss Portlet Tools User Guide explains how to begin with and manage JBoss Portlet Tools.</para></abstract><corpauthor><inlinemediaobject><imageobject><imagedata fileref="Common_Content/images/title_logo.svg" format="SVG"></imagedata></imageobject></inlinemediaobject></corpauthor><xi:include href="Common_Content/Legal_Notice.xml" xmlns:xi="http://www.w3.org/2001/XInclude"></xi:include&g... href="Author_Group.xml" xmlns:xi="http://www.w3.org/2001/XInclude"></xi:include&g... Added: branches/jbosstools-3.1.x/portlet/docs/reference/en-US/JBoss_Portlet_Tools_User_Guide.ent =================================================================== --- branches/jbosstools-3.1.x/portlet/docs/reference/en-US/JBoss_Portlet_Tools_User_Guide.ent (rev 0) +++ branches/jbosstools-3.1.x/portlet/docs/reference/en-US/JBoss_Portlet_Tools_User_Guide.ent 2010-03-12 00:23:23 UTC (rev 20778) @@ -0,0 +1,4 @@ +<!ENTITY PRODUCT "JBoss"> +<!ENTITY BOOKID "JBoss_Portlet_Tools_Reference_Guide"> +<!ENTITY YEAR "2010"> +<!ENTITY HOLDER "Red Hat"> Added: branches/jbosstools-3.1.x/portlet/docs/reference/en-US/JBoss_Portlet_Tools_User_Guide.xml =================================================================== --- branches/jbosstools-3.1.x/portlet/docs/reference/en-US/JBoss_Portlet_Tools_User_Guide.xml (rev 0) +++ branches/jbosstools-3.1.x/portlet/docs/reference/en-US/JBoss_Portlet_Tools_User_Guide.xml 2010-03-12 00:23:23 UTC (rev 20778) @@ -0,0 +1,12 @@ +<?xml version='1.0' encoding='utf-8' ?> +<!DOCTYPE Book PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [ +]> +<book> +<xi:include href="Book_Info.xml" xmlns:xi="http://www.w3.org/2001/XInclude"></xi:include> +<xi:include href="Preface.xml" xmlns:xi="http://www.w3.org/2001/XInclude"></xi:include> +<xi:include href="intro.xml" xmlns:xi="http://www.w3.org/2001/XInclude"></xi:include> +<xi:include href="portlet_tools_tasks.xml" xmlns:xi="http://www.w3.org/2001/XInclude"></xi:include> +<xi:include href="reference.xml" xmlns:xi="http://www.w3.org/2001/XInclude"></xi:include> +<xi:include href="summary.xml" xmlns:xi="http://www.w3.org/2001/XInclude"></xi:include> +<xi:include href="Revision_History.xml" xmlns:xi="http://www.w3.org/2001/XInclude"></xi:include> +</book> Added: branches/jbosstools-3.1.x/portlet/docs/reference/en-US/Preface.xml =================================================================== --- branches/jbosstools-3.1.x/portlet/docs/reference/en-US/Preface.xml (rev 0) +++ branches/jbosstools-3.1.x/portlet/docs/reference/en-US/Preface.xml 2010-03-12 00:23:23 UTC (rev 20778) @@ -0,0 +1,4 @@ +<?xml version='1.0' encoding='utf-8' ?> +<!DOCTYPE Book PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [ +]> +<preface><title>Preface</title><xi:include href="Common_Content/Conventions.xml" xmlns:xi="http://www.w3.org/2001/XInclude"></xi:include&g... href="Feedback.xml" xmlns:xi="http://www.w3.org/2001/XInclude"><xi:fallback xmlns:xi="http://www.w3.org/2001/XInclude"><xi:include href="Common_Content/Feedback.xml" xmlns:xi="http://www.w3.org/2001/XInclude"></xi:include&g... Added: branches/jbosstools-3.1.x/portlet/docs/reference/en-US/Revision_History.xml =================================================================== --- branches/jbosstools-3.1.x/portlet/docs/reference/en-US/Revision_History.xml (rev 0) +++ branches/jbosstools-3.1.x/portlet/docs/reference/en-US/Revision_History.xml 2010-03-12 00:23:23 UTC (rev 20778) @@ -0,0 +1,4 @@ +<?xml version='1.0' encoding='utf-8' ?> +<!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>0</revnumber><date>Fri Nov 20 2009</date><author><firstname>Isaac</firstname><surname>Rooskov</surname><email>irooskov@redhat.com</email></author><revdescription><simplelist><member>Initial creation of book by publican</member></simplelist></revdescription></revision></revhistory></simpara></appendix> Added: branches/jbosstools-3.1.x/portlet/docs/reference/en-US/images/favicon.ico =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/portlet/docs/reference/en-US/images/favicon.ico ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/portlet/docs/reference/en-US/images/jbosstools_logo.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/portlet/docs/reference/en-US/images/jbosstools_logo.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/portlet/docs/reference/en-US/images/jsf_portlet/jsf_portlet1.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/portlet/docs/reference/en-US/images/jsf_portlet/jsf_portlet1.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/portlet/docs/reference/en-US/images/jsf_portlet/jsf_portlet2.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/portlet/docs/reference/en-US/images/jsf_portlet/jsf_portlet2.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/portlet/docs/reference/en-US/images/jsf_portlet/jsf_portlet2a.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/portlet/docs/reference/en-US/images/jsf_portlet/jsf_portlet2a.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/portlet/docs/reference/en-US/images/jsf_portlet/jsf_portlet3.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/portlet/docs/reference/en-US/images/jsf_portlet/jsf_portlet3.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/portlet/docs/reference/en-US/images/jsf_portlet/jsf_portlet4.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/portlet/docs/reference/en-US/images/jsf_portlet/jsf_portlet4.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/portlet/docs/reference/en-US/images/jsf_portlet/jsf_portlet5.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/portlet/docs/reference/en-US/images/jsf_portlet/jsf_portlet5.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/portlet/docs/reference/en-US/images/jsf_portlet/jsf_portlet7.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/portlet/docs/reference/en-US/images/jsf_portlet/jsf_portlet7.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/portlet/docs/reference/en-US/images/jsf_portlet/jsf_portlet8.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/portlet/docs/reference/en-US/images/jsf_portlet/jsf_portlet8.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/portlet/docs/reference/en-US/images/jsf_portlet/jsf_portlet9.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/portlet/docs/reference/en-US/images/jsf_portlet/jsf_portlet9.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/portlet/docs/reference/en-US/images/reference/javaPortlet2.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/portlet/docs/reference/en-US/images/reference/javaPortlet2.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/portlet/docs/reference/en-US/images/reference/javaPortlet3.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/portlet/docs/reference/en-US/images/reference/javaPortlet3.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/portlet/docs/reference/en-US/images/reference/javaPortlet4.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/portlet/docs/reference/en-US/images/reference/javaPortlet4.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/portlet/docs/reference/en-US/images/reference/jsf_seam_portlet1.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/portlet/docs/reference/en-US/images/reference/jsf_seam_portlet1.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/portlet/docs/reference/en-US/images/reference/jsf_seam_portlet2.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/portlet/docs/reference/en-US/images/reference/jsf_seam_portlet2.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/portlet/docs/reference/en-US/images/reference/jsf_seam_portlet3.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/portlet/docs/reference/en-US/images/reference/jsf_seam_portlet3.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/portlet/docs/reference/en-US/images/reference/portlet_preferences.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/portlet/docs/reference/en-US/images/reference/portlet_preferences.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/portlet/docs/reference/en-US/images/seam_portlet/seam_portlet1.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/portlet/docs/reference/en-US/images/seam_portlet/seam_portlet1.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/portlet/docs/reference/en-US/images/seam_portlet/seam_portlet2.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/portlet/docs/reference/en-US/images/seam_portlet/seam_portlet2.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/portlet/docs/reference/en-US/images/seam_portlet/seam_portlet3.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/portlet/docs/reference/en-US/images/seam_portlet/seam_portlet3.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/portlet/docs/reference/en-US/images/seam_portlet/seam_portlet4.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/portlet/docs/reference/en-US/images/seam_portlet/seam_portlet4.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/portlet/docs/reference/en-US/images/seam_portlet/seam_portlet5.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/portlet/docs/reference/en-US/images/seam_portlet/seam_portlet5.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/portlet/docs/reference/en-US/images/seam_portlet/seam_portlet6.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/portlet/docs/reference/en-US/images/seam_portlet/seam_portlet6.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/portlet/docs/reference/en-US/images/seam_portlet/seam_portlet7.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/portlet/docs/reference/en-US/images/seam_portlet/seam_portlet7.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/portlet/docs/reference/en-US/images/starting_project/portlet_capabilities6.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/portlet/docs/reference/en-US/images/starting_project/portlet_capabilities6.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/portlet/docs/reference/en-US/images/starting_project/runOnServer.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/portlet/docs/reference/en-US/images/starting_project/runOnServer.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/portlet/docs/reference/en-US/images/starting_project/server_runtime_environment.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/portlet/docs/reference/en-US/images/starting_project/server_runtime_environment.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/portlet/docs/reference/en-US/images/starting_project/starting_project_1.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/portlet/docs/reference/en-US/images/starting_project/starting_project_1.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/portlet/docs/reference/en-US/images/starting_project/starting_project_12.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/portlet/docs/reference/en-US/images/starting_project/starting_project_12.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/portlet/docs/reference/en-US/images/starting_project/starting_project_13.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/portlet/docs/reference/en-US/images/starting_project/starting_project_13.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/portlet/docs/reference/en-US/images/starting_project/starting_project_14.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/portlet/docs/reference/en-US/images/starting_project/starting_project_14.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/portlet/docs/reference/en-US/images/starting_project/starting_project_2.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/portlet/docs/reference/en-US/images/starting_project/starting_project_2.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/portlet/docs/reference/en-US/images/starting_project/starting_project_3.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/portlet/docs/reference/en-US/images/starting_project/starting_project_3.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/portlet/docs/reference/en-US/images/starting_project/starting_project_4.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/portlet/docs/reference/en-US/images/starting_project/starting_project_4.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/portlet/docs/reference/en-US/images/starting_project/starting_project_4_a.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/portlet/docs/reference/en-US/images/starting_project/starting_project_4_a.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/portlet/docs/reference/en-US/images/starting_project/starting_project_6.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/portlet/docs/reference/en-US/images/starting_project/starting_project_6.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/portlet/docs/reference/en-US/images/starting_project/starting_project_7.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/portlet/docs/reference/en-US/images/starting_project/starting_project_7.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/portlet/docs/reference/en-US/images/starting_project/starting_project_8.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/portlet/docs/reference/en-US/images/starting_project/starting_project_8.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/portlet/docs/reference/en-US/intro.xml =================================================================== --- branches/jbosstools-3.1.x/portlet/docs/reference/en-US/intro.xml (rev 0) +++ branches/jbosstools-3.1.x/portlet/docs/reference/en-US/intro.xml 2010-03-12 00:23:23 UTC (rev 20778) @@ -0,0 +1,124 @@ +<?xml version="1.0" encoding="UTF-8"?> +<chapter id="intro" xreflabel="intro"> + <?dbhtml filename="intro.html"?> + <title>Introduction</title> + + <para>Starting from 3.0.0.Alpha1 version, JBoss set of plugins includes tools for supporting <property>JBoss Portal</property> and JSR-186/JSR-286 portlets. + Thus, this guide is intended to explain you how to get started and manage <property>JBoss Portlet Tools</property>.</para> + + <section id="preface"> + <title>What is JBoss Portal and Portlet Tools?</title> + <para><property>JBoss Portal</property> provides an open source platform for hosting and + serving a portal's Web interface, publishing and managing its content, and customizing + its experience. It supports a wide range of features, including standard portlets, + single sign-on, clustering, and internationalization. More about <property>JBoss Portal</property> you can find visiting + its home page at: <ulink url="http://www.jboss.org/jbossportal/">http://www.jboss.org... + + <para>With <property>JBoss Portlet Tools</property> you can easily create a Java, JSF and Seam portlet and deploy it to <property>JBoss Portal</property>.</para> + </section> + + <section id="key_features"> + <title>Key Features of JBoss Portlet Tools</title> + <para><property>JBoss Portlet Tools</property> supports the <ulink url="http://www.jcp.org/en/jsr/detail?id=168">JSR-168 Portlet Specification (Portlet 1.0)</ulink> and + <ulink url="http://www.jcp.org/en/jsr/detail?id=286">JSR-286 Portlet Specification (Portlet 2.0)</ulink> and works with + <ulink url="http://www.jboss.org/portletbridge/">JBoss Portlet Bridge</ulink> for supporting Portlets + in JSF/Seam applications. To enable these features, you need to add the JBoss Portlet facet to a new or an existing web project + (see <link linkend="portlet_tools_tasks">JBoss Portlet Tools Tasks</link>). The project could be a non-WTP project, but you should know that + if it does not have the proper portlet API jar's the generated classes will have compile errors.</para> + + <para>The next table lists key features supplied by <property>JBoss Portlet Tools</property>.</para> + + <table> + <title>Key Features of JBoss Portlet Tools</title> + <tgroup cols="3"> + + <colspec colnum="1" align="left" colwidth="1*"/> + <colspec colnum="2" colwidth="5*"/> + <colspec colnum="3" align="left" colwidth="1*"/> + + <thead> + <row> + <entry>Feature</entry> + <entry>Benefit</entry> + <entry>Chapter</entry> + </row> + </thead> + + <tbody> + + <row> + <entry> + <para>JBoss Portlet facets</para> + </entry> + <entry> + <para><property>JBoss Portlet Tools</property> provides the Java, JSF and Seam Portlet facets that could be enabled for a Web project.</para> + </entry> + <entry> + <link linkend="portlet_tools_tasks">JBoss Portlet Tools Tasks</link> + </entry> + </row> + + <row> + <entry> + <para>Java Portlet wizard</para> + </entry> + + <entry> + <para>The wizard helps create a JSR-186/JSR-286 compliant + portlets</para> + </entry> + <entry> + <link linkend="java_portlet_wizard">Java Portlet Wizard</link> + </entry> + </row> + + <row> + <entry> + <para>JSF/Seam Portlet wizard</para> + </entry> + <entry> + <para>This wizard helps create JSF/Seam portlets</para> + </entry> + <entry> + <link linkend="jsf_seam_portlet_wizard">JSF/Seam Portlet Wizard</link> + </entry> + </row> + </tbody> + </tgroup> + </table> + </section> + + <section id="requirements_installation"> + <title>Requirements and Installation</title> + <para><property>JBoss + Portlet Tools</property> needs the following minimal requirements:</para> + + <itemizedlist> + <listitem> + <para>Eclipse 3.4.2/Ganymede</para> + </listitem> + <listitem> + <para>JBoss Tools 3.0.0.Alpha1 (for higher versions of JBoss Tools make sure you use the + <ulink url="http://www.jboss.org/community/wiki/Matrixofsupportedplatformsr... version of Eclipse</ulink>)</para> + </listitem> + <listitem><para>JDK 5 or higher</para></listitem> + <listitem> + <para>JBoss Portal + JBoss AS bundle from: <ulink + url="http://www.jboss.org/jbossportal/download/index.html">h... + <note> + <title>Note:</title> + <para>JBoss Portlet Tools has been tested using 2.6.5 and 2.7.0.ALPHA + versions of <property>JBoss Portal</property>. Remember, if you want to use Portlet + version 2.0 (JSR-268), you have to choose JBoss Portal 2.7.</para> + </note> + </listitem> + <listitem> + <para>JBoss Portlet Bridge (optionally) from: <ulink url="http://www.jboss.org/portletbridge/downloads.html">http... + </listitem> + </itemizedlist> + + <para><property>JBoss Portlet Tools</property> is included as part of <property>JBoss Tools</property> project. + Refer to <ulink url="http://www.jboss.org/tools/download/installation.html">... + for installation methods of <property>JBoss Tools</property>.</para> + </section> +</chapter> Added: branches/jbosstools-3.1.x/portlet/docs/reference/en-US/jsf_portlet.xml =================================================================== --- branches/jbosstools-3.1.x/portlet/docs/reference/en-US/jsf_portlet.xml (rev 0) +++ branches/jbosstools-3.1.x/portlet/docs/reference/en-US/jsf_portlet.xml 2010-03-12 00:23:23 UTC (rev 20778) @@ -0,0 +1,257 @@ +<?xml version="1.0" encoding="UTF-8"?> +<section id="jsf_portlet"> + <title>Creating and Deploying a JSF Portlet</title> + + <para>This chapter will explain how you can configure a JSF portlet within a JSF project with JBoss Portlet capabilities + and then deploy it to <property>JBoss Portal</property>.</para> + + <section id="jsf_portlet1"> + <title>Creating a JSF Project with JBoss Portlet Capabilities</title> + + <para>You can create a JSF project with JBoss Portlet capabilities in two ways:</para> + + <orderedlist> + <listitem> + <para>Create a dynamic Web project with the <emphasis><property>JavaServer Faces</property></emphasis> + and <emphasis><property>JBoss JSF Portlet</property></emphasis> facets enabled ( + <link linkend="create_dyn_web_proj_jsf">the steps to proceed</link>)</para> + </listitem> + <listitem><para>Or create a JSF project using the wizard JBoss JSF Tools provides, then enable + JSF and JBoss Portlet facets and add JBoss Portlet capabilities ( + <link linkend="create_jsf_proj">the steps to proceed</link>)</para></listitem> + </orderedlist> + + <para>Refer to the further sections for the procedures on how to do this.</para> + + <section id="create_dyn_web_proj_jsf"> + <title>Creating a Dynamic Web Project with the JBoss Portlet Capabilities</title> + + <para>The basic steps to create a dynamic Web project with the JBoss Portlet capabilities are as follows:</para> + + <orderedlist> + <listitem> + <para>Start the <emphasis><property>Dynamic Web Project</property></emphasis> wizard navigating to + <emphasis><property>File &gt; New &gt; Other &gt; Web &gt; Dynamic Web Project</property>.</emphasis></para> + + <tip> + <title>Tip:</title> + <para>You can also select the <property>Java EE</property> perspective and then go to + <emphasis><property>File &gt; New &gt; Dynamic Web Project</property>.</emphasis></para> + </tip> + + <figure> + <title>Setting the JSF Configuration</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/jsf_portlet/jsf_portlet1.png"/> + </imageobject> + </mediaobject> + </figure> + </listitem> + + <listitem> + <para>Specify the project name and set the target runtime to <property>JBoss Portal</property> by following the points 3, 4 and 5 in the + <link linkend="jboss_core_portlet">&quot;Creating a Web Project with JBoss Portlet Capabilities&quot;</link> procedure.</para> + </listitem> + + <listitem> + <para>In the <emphasis><property>Configuration</property></emphasis> + area, click <emphasis><property>Modify</property></emphasis> and enable <emphasis><property>JavaServer Faces</property>,</emphasis> + <emphasis><property>JBoss Core Portlet</property></emphasis> and <emphasis><property>JBoss JSF Portlet</property></emphasis> facets. + Hit <emphasis><property>OK</property>.</emphasis></para> + + <figure> + <title>Enabling the Portlet Facets</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/jsf_portlet/jsf_portlet2.png"/> + </imageobject> + </mediaobject> + </figure> + </listitem> + + <listitem> + <para>You may leave the next two wizard pages with defaults, just press <emphasis><property>Next</property></emphasis> to proceed.</para> + </listitem> + + <listitem> + <para>On the <property>JBoss Portlet Capabilities</property> page, select <emphasis> + <property>Portlet Target Runtime Provider</property></emphasis> and click <emphasis><property>Next</property>.</emphasis></para> + + <figure> + <title>JBoss Portlet Capabilities</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/jsf_portlet/jsf_portlet2a.png"/> + </imageobject> + </mediaobject> + </figure> + + <tip> + <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"... + </tip> + </listitem> + + <listitem> + <para>Next wizard page is for configuring JSF capabilities. You can leave everything as it + is here.</para> + + <figure> + <title>JSF Capabilities</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/jsf_portlet/jsf_portlet3.png"/> + </imageobject> + </mediaobject> + </figure> + </listitem> + + <listitem> + <para>On the <property>JBoss JSF Portlet Capabilities</property> page, select + <emphasis><property>JSF Portlet Target Runtime Provider</property></emphasis> as the JSF portlet implementation library. It will + copy Portlet Bridge libraries from the server runtime to the project classpath.</para> + + <figure> + <title>JBoss JSF PortletCapabilities</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/jsf_portlet/jsf_portlet4.png"/> + </imageobject> + </mediaobject> + </figure> + + <tip> + <title>Tip:</title> + <para>On this page, it is also possible to add the RichFaces libraries from the RichFaces distribution by checking + <emphasis><property>Add/Change Richfaces Libraries</property>.</emphasis></para> + </tip> + + <note> + <title>Note:</title> + <para>You can select the <emphasis><property>JSF Portletbridge Runtime Provider</property></emphasis> type. Then it + is necessary to set the home of the Portlet Bridge distribution.</para> + <para>For information about all the JSF Portlet facet library providers, refer to the wiki article at: + <ulink url="http://community.jboss.org/wiki/PortletFacetLibraries">... + </note> + </listitem> + + <listitem> + <para>Click <emphasis><property>Finish</property>.</emphasis> The project will be created in the workbench.</para> + </listitem> + </orderedlist> + </section> + + <section id="create_jsf_proj"> + <title>Creating a JSF Project and adding the JBoss Portlet Capabilities</title> + + <para>How to organize a JSF project you can find out in the JSF Tools User Guide. Just + remember to point the target runtime to <property>JBoss Portal</property> directory location (see + how it is done for a dynamic Web project: steps 3, 4 and 5 in the + <link linkend="jboss_core_portlet">&quot;Creating a Web Project with JBoss Portlet Capabilities&quot;</link> procedure).</para> + + <figure> + <title>Creating New JSF Project</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/jsf_portlet/jsf_portlet8.png"/> + </imageobject> + </mediaobject> + </figure> + + <para>To add the JBoss Portlet capabilities to the created JSF project you should complete the next steps:</para> + + <orderedlist> + <listitem> + <para>Right-click the project and click <emphasis> + <property>Properties</property> + </emphasis> to open the project <property>Properties</property> sheet. Select <property>Project Facets</property> + on the left and enable the <emphasis><property>JavaServer Faces</property>,</emphasis> + <emphasis><property>JBoss Core Portlet</property></emphasis> and <emphasis><property>JBoss JSF Portlet</property></emphasis> facets.</para> + + <figure> + <title>Project Facets</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/jsf_portlet/jsf_portlet9.png"/> + </imageobject> + </mediaobject> + </figure> + </listitem> + + <listitem> + <para>Notice, <emphasis> + <property>&quot;Further configuration available...&quot;</property> + </emphasis> warning appears at the bottom of the screen. It means that next you should configure the JSF Portlet capabilities in the project. + Click the link. The <property>Modify Faceted Project</property> wizard appears.</para> + </listitem> + + <listitem> + <para>Complete all wizard pages the same way as described in the steps 5, 6, 7 of the + <link linkend="jboss_core_portlet">&quot;Creating a Dynamic Web Project with the JBoss Portlet Capabilities&quot;</link> procedure. + Hit <emphasis><property>OK</property>.</emphasis></para> + </listitem> + + <listitem> + <para>To apply the changes click <emphasis><property>Apply</property></emphasis> and then + <emphasis><property>OK</property></emphasis> to close the project <property>Properties</property> sheet.</para> + </listitem> + </orderedlist> + </section> + </section> + + <section id="jsf_portlet_to_JSF_project"> + <title>Adding a JSF Portlet to the Project and Deploying It to JBoss Portal</title> + + <para>The previous section has shown how to create a JSF project with JBoss Portlet and JSF Portlet capabilities enabled. Use + the following procedure to add a JSF portlet to the created project and deploy it to <property>JBoss Portal</property>.</para> + + <orderedlist> + <listitem> + <para>Call the + <property>Create Portlet</property> wizard by navigating to <emphasis> + <property>New > Other > JBoss Tools Web > Portlet > JSF/Seam + Portlet</property></emphasis> on the context menu of the project (for information about the wizard options, see + <link linkend="jsf_seam_portlet_wizard">&quot;JSF/Seam Portlet Wizard&quot;</link> in the guide reference).</para> + + <figure> + <title>Calling New Portlet Wizard</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/jsf_portlet/jsf_portlet5.png"/> + </imageobject> + </mediaobject> + </figure> + + <tip> + <title>Tip:</title> + <para>As you see, the JSF and Seam Portlet wizards are merged into one. We have set the JSF + configuration for the project, so the default values in this wizard will be set as for a JSF + portlet.</para> + </tip> + </listitem> + + <listitem> + <para>Leave all the wizard pages with default values by clicking the <emphasis><property>Next</property></emphasis> button, + on the last one click <emphasis><property>Finish</property></emphasis> to complete the JSF portlet creation.</para> + </listitem> + + <listitem> + <para>Complete the steps described in the <link linkend="deploying_to_portal">&quot;Deploying a Portlet to JBoss Portal&quot;</link> procedure to + deploy a JSF portlet to <property>JBoss Portal</property>. Just use the other URL to see it in the browser: + <emphasis>http://localhost:8080/portal/portal/default/JSFPortlet</emphasis>.</para> + + <figure> + <title>JSF Portlet in the Browser</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/jsf_portlet/jsf_portlet7.png"/> + </imageobject> + </mediaobject> + </figure> + </listitem> + </orderedlist> + + </section> +</section> Added: branches/jbosstools-3.1.x/portlet/docs/reference/en-US/master.xml =================================================================== --- branches/jbosstools-3.1.x/portlet/docs/reference/en-US/master.xml (rev 0) +++ branches/jbosstools-3.1.x/portlet/docs/reference/en-US/master.xml 2010-03-12 00:23:23 UTC (rev 20778) @@ -0,0 +1,72 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN" +"http://www.docbook.org/xml/4.3/docbookx.dtd" + +[<!ENTITY intro SYSTEM "intro.xml"> +<!ENTITY installation SYSTEM "installation.xml"> +<!ENTITY portlet_tools_tasks SYSTEM "portlet_tools_tasks.xml"> +<!ENTITY starting_project SYSTEM "starting_project.xml"> +<!ENTITY jsf_portlet SYSTEM "jsf_portlet.xml"> +<!ENTITY seam_portlet SYSTEM "seam_portlet.xml"> +<!ENTITY reference SYSTEM "reference.xml"> +<!ENTITY summary SYSTEM "summary.xml"> + +<!ENTITY seamlink "../../seam/html_single/index.html"> +<!ENTITY aslink "../../as/html_single/index.html"> +<!ENTITY esblink "../../esb_ref_guide/html_single/index.html"> +<!ENTITY gsglink "../../GettingStartedGuide/html_single/index.html"> +<!ENTITY hibernatelink "../../hibernatetools/html_single/index.html"> +<!ENTITY jbpmlink "../../jbpm/html_single/index.html"> +<!ENTITY jsflink "../../jsf/html_single/index.html"> +<!ENTITY jsfreflink "../../jsf_tools_ref_guide/html_single/index.html"> +<!ENTITY jsftutoriallink "../../jsf_tools_tutorial/html_single/index.html"> +<!ENTITY strutsreflink "../../struts_tools_ref_guide/html_single/index.html"> +<!ENTITY strutstutoriallink "../../struts_tools_tutorial/html_single/index.html"> +]> + +<book> + + <bookinfo> + <title>JBoss Portlet Tools User Guide</title> + <corpauthor> + <inlinemediaobject> + <imageobject role="fo"> + <imagedata format="PNG" fileref="images/jbosstools_logo.png" /> + </imageobject> + <imageobject role="html"> + <imagedata/> + </imageobject> + </inlinemediaobject> + </corpauthor> + <author><firstname>Olga</firstname><surname>Chikvina</surname></author> + <author&gt;&lt;firstname&gt;Snjezana&lt;/firstname&gt;&lt;surname&gt;Peco&lt;/surname&gt;&lt;email&gt;snjezana.peco(a)redhat.com&lt;/email&gt;&lt;/author&gt; + <author&gt;&lt;firstname&gt;Svetlana&lt;/firstname&gt;&lt;surname&gt;Mukhina&lt;/surname&gt;&lt;email&gt;smukhina(a)exadel.com&lt;/email&gt;&lt;/author&gt; + <author&gt;&lt;firstname&gt;Thomas&lt;/firstname&gt;&lt;surname&gt;Heute&lt;/surname&gt;&lt;email&gt;theute(a)jboss.org&lt;/email&gt;&lt;/author&gt; + + <copyright> + <year>2008</year> + <year>2009</year> + <year>2010</year> + <holder>JBoss by Red Hat</holder> + </copyright> + <releaseinfo> + Version: 1.1.0.GA + </releaseinfo> + +<abstract> + <title/> + <para> + <ulink url="http://download.jboss.org/jbosstools/nightly-docs/en/jboss_port... version</ulink> + </para> +</abstract> + + + </bookinfo> + <toc/> + + + &intro; + &portlet_tools_tasks; + &reference; + &summary; +</book> Added: branches/jbosstools-3.1.x/portlet/docs/reference/en-US/master_output.xml =================================================================== --- branches/jbosstools-3.1.x/portlet/docs/reference/en-US/master_output.xml (rev 0) +++ branches/jbosstools-3.1.x/portlet/docs/reference/en-US/master_output.xml 2010-03-12 00:23:23 UTC (rev 20778) @@ -0,0 +1,1698 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN" +"http://www.docbook.org/xml/4.3/docbookx.dtd" + +[<!ENTITY intro SYSTEM "modules/intro.xml"> +<!ENTITY installation SYSTEM "modules/installation.xml"> +<!ENTITY portlet_tools_tasks SYSTEM "modules/portlet_tools_tasks.xml"> +<!ENTITY starting_project SYSTEM "modules/starting_project.xml"> +<!ENTITY jsf_portlet SYSTEM "modules/jsf_portlet.xml"> +<!ENTITY seam_portlet SYSTEM "modules/seam_portlet.xml"> +<!ENTITY reference SYSTEM "modules/reference.xml"> +<!ENTITY summary SYSTEM "modules/summary.xml"> + +<!ENTITY seamlink "../../seam/html_single/index.html"> +<!ENTITY aslink "../../as/html_single/index.html"> +<!ENTITY esblink "../../esb_ref_guide/html_single/index.html"> +<!ENTITY gsglink "../../GettingStartedGuide/html_single/index.html"> +<!ENTITY hibernatelink "../../hibernatetools/html_single/index.html"> +<!ENTITY jbpmlink "../../jbpm/html_single/index.html"> +<!ENTITY jsflink "../../jsf/html_single/index.html"> +<!ENTITY jsfreflink "../../jsf_tools_ref_guide/html_single/index.html"> +<!ENTITY jsftutoriallink "../../jsf_tools_tutorial/html_single/index.html"> +<!ENTITY strutsreflink "../../struts_tools_ref_guide/html_single/index.html"> +<!ENTITY strutstutoriallink "../../struts_tools_tutorial/html_single/index.html"> +]><book xmlns:diffmk="http://diffmk.sf.net/ns/diff"> + + <bookinfo> + <title>JBoss Portlet Tools User Guide</title> + <corpauthor> + <inlinemediaobject> + <imageobject role="fo"> + <imagedata fileref="images/jbosstools_logo.png" format="PNG"></imagedata> + </imageobject> + <imageobject role="html"> + <imagedata></imagedata> + </imageobject> + </inlinemediaobject> + </corpauthor> + <author><firstname>Olga</firstname><surname>Chikvina</surname></author> + <author&gt;&lt;firstname&gt;Snjezana&lt;/firstname&gt;&lt;surname&gt;Peco&lt;/surname&gt;&lt;email&gt;snjezana.peco(a)redhat.com&lt;/email&gt;&lt;/author&gt; + <author&gt;&lt;firstname&gt;Svetlana&lt;/firstname&gt;&lt;surname&gt;Mukhina&lt;/surname&gt;&lt;email&gt;smukhina(a)exadel.com&lt;/email&gt;&lt;/author&gt; + <author&gt;&lt;firstname&gt;Thomas&lt;/firstname&gt;&lt;surname&gt;Heute&lt;/surname&gt;&lt;email&gt;theute(a)jboss.org&lt;/email&gt;&lt;/author&gt; + + <copyright> + <year>2008</year> + <year>2009</year> + <year>2010</year> + <holder>JBoss by Red Hat</holder> + </copyright> + <releaseinfo><diffmk:wrapper diffmk:change="changed"> + Version: 1.1.0.GA + </diffmk:wrapper></releaseinfo> + +<abstract> + <title></title> + <para> + <ulink url="http://download.jboss.org/jbosstools/nightly-docs/en/jboss_port... version</ulink> + </para> +</abstract> + + + </bookinfo> + <toc></toc> + + + +<chapter id="intro" xml:base="file:///home/vchukhutsina/repos/ochik_jboss/portlet/docs/reference/en/modules/intro.xml" xreflabel="intro"> + <?dbhtml filename="intro.html"?> + <title>Introduction</title> + + <para>Starting from 3.0.0.Alpha1 version, JBoss set of plugins includes tools for supporting <property moreinfo="none">JBoss Portal</property> and JSR-186/JSR-286 portlets. + Thus, this guide is intended to explain you how to get started and manage <property moreinfo="none">JBoss Portlet Tools</property>.</para> + + <section id="preface"> + <title>What is JBoss Portal and Portlet Tools?</title> + <para><property moreinfo="none">JBoss Portal</property> provides an open source platform for hosting and + serving a portal's Web interface, publishing and managing its content, and customizing + its experience. It supports a wide range of features, including standard portlets, + single sign-on, clustering, and internationalization. More about <property moreinfo="none">JBoss Portal</property> you can find visiting + its home page at: <ulink url="http://www.jboss.org/jbossportal/">http://www.jboss.org... + + <para>With <property moreinfo="none">JBoss Portlet Tools</property> you can easily create a Java, JSF and Seam portlet and deploy it to <property moreinfo="none">JBoss Portal</property>.</para> + </section> + + <section id="key_features"> + <title>Key Features of JBoss Portlet Tools</title> + <para><property moreinfo="none">JBoss Portlet Tools</property> supports the <ulink url="http://www.jcp.org/en/jsr/detail?id=168">JSR-168 Portlet Specification (Portlet 1.0)</ulink> and + <ulink url="http://www.jcp.org/en/jsr/detail?id=286">JSR-286 Portlet Specification (Portlet 2.0)</ulink> and works with + <ulink url="http://www.jboss.org/portletbridge/">JBoss Portlet Bridge</ulink> for supporting Portlets + in JSF/Seam applications. To enable these features, you need to add the JBoss Portlet facet to a new or an existing web project + (see <link linkend="portlet_tools_tasks">JBoss Portlet Tools Tasks</link>). The project could be a non-WTP project, but you should know that + if it does not have the proper portlet API jar's the generated classes will have compile errors.</para> + + <para>The next table lists key features supplied by <property moreinfo="none">JBoss Portlet Tools</property>.</para> + + <table> + <title>Key Features of JBoss Portlet Tools</title> + <tgroup cols="3"> + + <colspec align="left" colnum="1" colwidth="1*"></colspec> + <colspec colnum="2" colwidth="5*"></colspec> + <colspec align="left" colnum="3" colwidth="1*"></colspec> + + <thead> + <row> + <entry>Feature</entry> + <entry>Benefit</entry> + <entry>Chapter</entry> + </row> + </thead> + + <tbody> + + <row> + <entry> + <para>JBoss Portlet facets</para> + </entry> + <entry> + <para><property moreinfo="none">JBoss Portlet Tools</property> provides the Java, JSF and Seam Portlet facets that could be enabled for a Web project.</para> + </entry> + <entry> + <link linkend="portlet_tools_tasks">JBoss Portlet Tools Tasks</link> + </entry> + </row> + + <row> + <entry> + <para>Java Portlet wizard</para> + </entry> + + <entry> + <para>The wizard helps create a JSR-186/JSR-286 compliant + portlets</para> + </entry> + <entry> + <link linkend="java_portlet_wizard">Java Portlet Wizard</link> + </entry> + </row> + + <row> + <entry> + <para>JSF/Seam Portlet wizard</para> + </entry> + <entry> + <para>This wizard helps create JSF/Seam portlets</para> + </entry> + <entry> + <link linkend="jsf_seam_portlet_wizard">JSF/Seam Portlet Wizard</link> + </entry> + </row> + </tbody> + </tgroup> + </table> + </section> + + <section id="requirements_installation"> + <title>Requirements and Installation</title> + <para><property moreinfo="none">JBoss + Portlet Tools</property> needs the following minimal requirements:</para> + + <itemizedlist> + <listitem> + <para>Eclipse 3.4.2/Ganymede</para> + </listitem> + <listitem> + <para>JBoss Tools 3.0.0.Alpha1 (for higher versions of JBoss Tools make sure you use the + <ulink url="http://www.jboss.org/community/wiki/Matrixofsupportedplatformsr... version of Eclipse</ulink>)</para> + </listitem> + <listitem><para>JDK 5 or higher</para></listitem> + <listitem> + <para>JBoss Portal + JBoss AS bundle from: <ulink url="http://www.jboss.org/jbossportal/download/index.html">h... + <note> + <title>Note:</title> + <para>JBoss Portlet Tools has been tested using 2.6.5 and 2.7.0.ALPHA + versions of <property moreinfo="none">JBoss Portal</property>. Remember, if you want to use Portlet + version 2.0 (JSR-268), you have to choose JBoss Portal 2.7.</para> + </note> + </listitem> + <listitem> + <para>JBoss Portlet Bridge (optionally) from: <ulink url="http://www.jboss.org/portletbridge/downloads.html">http... + </listitem> + </itemizedlist> + + <para><property moreinfo="none">JBoss Portlet Tools</property> is included as part of <property moreinfo="none">JBoss Tools</property> project. + Refer to <ulink url="http://www.jboss.org/tools/download/installation.html">... + for installation methods of <property moreinfo="none">JBoss Tools</property>.</para> + </section> +</chapter> + + +<chapter id="portlet_tools_tasks" xml:base="file:///home/vchukhutsina/repos/ochik_jboss/portlet/docs/reference/en/modules/portlet_tools_tasks.xml" xreflabel="portlet_tools_tasks"> + <?dbhtml filename="portlet_tools_tasks.html"?> + <title>JBoss Portlet Tools Tasks</title> + + +<section id="starting_project" xml:base="file:///home/vchukhutsina/repos/ochik_jboss/portlet/docs/reference/en/modules/starting_project.xml"> + <title>Creating and Deploying a Java Portlet</title> + + <para>This chapter shows how to create a Dynamic Web Project, add a Java + Portlet to it and deploy it to the <property moreinfo="none">JBoss Portal</property>.</para> + + <section id="jboss_core_portlet"> + <title>Creating a Web Project with JBoss Portlet Capabilities</title> + <para>Fallow the next procedure to create a Web project with JBoss Portlet capabilities pointed to the JBoss Portal runtime.</para> + + <orderedlist continuation="restarts" inheritnum="ignore"> + <listitem> + <para>Go to <emphasis> + <property moreinfo="none">File &gt; New &gt; Dynamic Web Project</property> + </emphasis> if you are in the <property moreinfo="none">Web</property> perspective or <emphasis><property moreinfo="none">File &gt; + New &gt; Other &gt; Web &gt; Dynamic Web Project</property></emphasis> in any other perspective. + The <property moreinfo="none">New Dynamic Web Project</property> wizard appears.</para> + + <figure float="0"> + <title>New Dynamic Web Project</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/starting_project/starting_project_1.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + </listitem> + + <listitem><para>Specify the name of the project.</para></listitem> + + <listitem> + <para>Click <emphasis> + <property moreinfo="none">New</property> + </emphasis> in the <emphasis> + <property moreinfo="none">Target Runtime</property> + </emphasis> area to create a JBoss Portal runtime. Choose <emphasis> + <property moreinfo="none">JBoss Community &gt; JBoss 4.2 Runtime</property> + </emphasis> and select the <emphasis> + <property moreinfo="none">Create a new local server</property> + </emphasis> check box below. Click <emphasis> + <property moreinfo="none">Next</property>.</emphasis></para> + + <figure float="0"> + <title>New Server Runtime</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/starting_project/starting_project_2.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + </listitem> + + <listitem> + <para>The <property moreinfo="none">New Server Runtime Environment</property> wizard appears. In the <emphasis> + <property moreinfo="none">Name</property></emphasis> field, type <emphasis> + <property moreinfo="none">JBoss Portal 2.7 Runtime</property>, + </emphasis> and then use the <emphasis> + <property moreinfo="none">Browse</property></emphasis> button to point to the location of JBoss Portal + JBoss AS extracted. Click <emphasis> + <property moreinfo="none">Next</property></emphasis> to proceed.</para> + + <figure float="0"> + <title>New Server Runtime Environment</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/starting_project/server_runtime_environment.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + </listitem> + + <listitem> + <para>At this point a new JBoss Server instance will be created. On the next page you can verify the + runtime information defined. If something is incorrect, press <emphasis> + <property moreinfo="none">Back</property> + </emphasis> to return to the previous wizard page. Click <emphasis> + <property moreinfo="none">Finish</property>.</emphasis></para> + + <figure float="0"> + <title>Target Server</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/starting_project/starting_project_3.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + </listitem> + + <listitem> + <para>Click <emphasis> + <property moreinfo="none">Modify</property> + </emphasis> in the <emphasis><property moreinfo="none">Configuration</property></emphasis> area to enable + a portlet facet for the project.</para> + + <figure float="0"> + <title>Setting the Project Configuration</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/starting_project/starting_project_4.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + </listitem> + + <listitem> + <para>In the <property moreinfo="none">Project Facets</property> dialog, check <emphasis> + <property moreinfo="none">JBoss Core Portlet</property> + </emphasis> and press <emphasis> + <property moreinfo="none">OK</property> + </emphasis>.</para> + + <figure float="0"> + <title>Enabling the JBoss Core Portlet Facet</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/starting_project/starting_project_4_a.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <note> + <title>Note:</title> + <para>If the portlet libraries aren't available in the runtime you targeted, + <emphasis> + <property moreinfo="none">JBoss Portlets</property></emphasis> facets will be hidden on this page.</para> + <para>To make them always visible no matter what the runtime is set, you should enable the appropriate option in + <link linkend="preferences">JBoss Portlet Preferences</link>.</para> + </note> + </listitem> + + <listitem> + <para>The <property moreinfo="none">Java</property> and <property moreinfo="none">Web Module</property> pages are for configuring Java and Web modules in the project. + Here all values are set, so leave everything as it is.</para> + </listitem> + + <listitem> + <para>The last wizard page will ask you to add JBoss Portlet capabilities to the + project. Select <emphasis> + <property moreinfo="none">Portlet Target Runtime Provider</property></emphasis> and click <emphasis> + <property moreinfo="none">Finish</property></emphasis> to complete the project creation.</para> + + <figure float="0"> + <title>Including the Portlet Libraries Provided by Target Runtime</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/starting_project/portlet_capabilities6.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <note> + <title>Note:</title> + <para>All types available under <emphasis> + <property moreinfo="none">Portlet Implementation Library</property></emphasis> are fully described in the Wiki article at: + <ulink url="http://www.jboss.org/community/wiki/PortletFacetLibraries"... + </note> + </listitem> + </orderedlist> + + <para>As the result, <property moreinfo="none">JBoss Portlet Tools</property> adds <emphasis> + <property moreinfo="none">JBoss Core Portlet</property></emphasis> facet to the project, + creates an empty <literal moreinfo="none">portlet.xml</literal> file and adds the JBoss Portlet library to the project classpath.</para> + + <figure float="0"> + <title>Portlet Project Structure Overview</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/starting_project/starting_project_6.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + </section> + + <section id="adding_java_portlet"> + <title>Adding a Java Portlet to a Web Project</title> + + <para>At the previous section you have created a web project with JBoss Portlet capabilities. + The next steps will show you how to add a new Java portlet to the project.</para> + + <orderedlist continuation="restarts" inheritnum="ignore"> + <listitem> + <para>Right-click the project and follow to <emphasis> + <property moreinfo="none">New &gt; Other &gt; JBoss Tools Web &gt; Portlet &gt; Java + Portlet</property>.</emphasis></para> + + <figure float="0"> + <title>New Java Portlet</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/starting_project/starting_project_7.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + </listitem> + + <listitem> + <para>The <property moreinfo="none">Create Portlet</property> wizard starts (for information about the wizard options, see + <link linkend="java_portlet_wizard">"Java Portlet Wizard"</link> in the guide reference). + The wizard fills in the <emphasis><property moreinfo="none">Project</property></emphasis> and <emphasis> + <property moreinfo="none">Source Folder</property></emphasis> fields for you. You should specify a Java package and a class name + (for instance, <emphasis> + <property moreinfo="none">org.example</property></emphasis> and <emphasis> + <property moreinfo="none">TestPortlet</property></emphasis>). Then click <emphasis> + <property moreinfo="none">Next</property> + </emphasis>.</para> + + <figure float="0"> + <title>Specifying Class File Destination</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/starting_project/starting_project_8.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + </listitem> + + <listitem><para>You may leave the next three pages with default values, on the last one hit <emphasis> + <property moreinfo="none">Finish</property>.</emphasis></para> + </listitem> + </orderedlist> + + <para>Once a Java portlet is created, new resources are added to the project structure: a Java portlet class (<literal moreinfo="none">TestPortlet.java</literal>), + <literal moreinfo="none">default-object.xml</literal> and <literal moreinfo="none">portlet-instances.xml</literal> files and the <literal moreinfo="none">portlet.xml</literal> descriptor is updated as well.</para> + + <figure float="0"> + <title>Structure of the Project with a Java Portlet</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/starting_project/starting_project_12.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>Thus, now the project is ready to be built and deployed.</para> + </section> + + <section id="deploying_to_portal"> + <title>Deploying a Portlet to JBoss Portal</title> + + <para>You can deploy a portlet project in the way you deploy any other web application.</para> + + <orderedlist continuation="restarts" inheritnum="ignore"> + <listitem> + <para>Right-click the project and do <emphasis> + <property moreinfo="none">Run As &gt; Run On Server</property>. + </emphasis> The <property moreinfo="none">Run On Server</property> wizard starts.</para> + + <figure float="0"> + <title>Running the Java Portlet on Server</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/starting_project/runOnServer.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + </listitem> + + <listitem> + <para>Select <emphasis><property moreinfo="none">JBoss Portal 2.7 Server</property></emphasis> created before and click <emphasis><property moreinfo="none">Next</property>.</emphasis></para> + </listitem> + + <listitem> + <para>On the <emphasis> + <property moreinfo="none">Add and Remove</property> + </emphasis> page move the created project to the right and click <emphasis> + <property moreinfo="none">Finish</property>.</emphasis></para> + + <figure float="0"> + <title>Deploying the Portlet Application</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/starting_project/starting_project_13.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>It will deploy the portlet application and start <property moreinfo="none">JBoss + AS</property>.</para> + </listitem> + + <listitem> + <para>Use the <emphasis>http://localhost:8080/portal/portal/default/default</emphasis> URL to see your + portlet in the browser.</para> + + <figure float="0"> + <title>Java Portlet in the Browser Window</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/starting_project/starting_project_14.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + </listitem> + </orderedlist> + </section> + +</section> + + +<section id="jsf_portlet" xml:base="file:///home/vchukhutsina/repos/ochik_jboss/portlet/docs/reference/en/modules/jsf_portlet.xml"> + <title>Creating and Deploying a JSF Portlet</title> + + <para>This chapter will explain how you can configure a JSF portlet within a JSF project with JBoss Portlet capabilities + and then deploy it to <property moreinfo="none">JBoss Portal</property>.</para> + + <section id="jsf_portlet1"> + <title>Creating a JSF Project with JBoss Portlet Capabilities</title> + + <para>You can create a JSF project with JBoss Portlet capabilities in two ways:</para> + + <orderedlist continuation="restarts" inheritnum="ignore"> + <listitem> + <para>Create a dynamic Web project with the <emphasis><property moreinfo="none">JavaServer Faces</property></emphasis> + and <emphasis><property moreinfo="none">JBoss JSF Portlet</property></emphasis> facets enabled ( + <link linkend="create_dyn_web_proj_jsf">the steps to proceed</link>)</para> + </listitem> + <listitem><para>Or create a JSF project using the wizard JBoss JSF Tools provides, then enable + JSF and JBoss Portlet facets and add JBoss Portlet capabilities ( + <link linkend="create_jsf_proj">the steps to proceed</link>)</para></listitem> + </orderedlist> + + <para>Refer to the further sections for the procedures on how to do this.</para> + + <section id="create_dyn_web_proj_jsf"> + <title>Creating a Dynamic Web Project with the JBoss Portlet Capabilities</title> + + <para>The basic steps to create a dynamic Web project with the JBoss Portlet capabilities are as follows:</para> + + <orderedlist continuation="restarts" inheritnum="ignore"> + <listitem> + <para>Start the <emphasis><property moreinfo="none">Dynamic Web Project</property></emphasis> wizard navigating to + <emphasis><property moreinfo="none">File &gt; New &gt; Other &gt; Web &gt; Dynamic Web Project</property>.</emphasis></para> + + <tip> + <title>Tip:</title> + <para>You can also select the <property moreinfo="none">Java EE</property> perspective and then go to + <emphasis><property moreinfo="none">File &gt; New &gt; Dynamic Web Project</property>.</emphasis></para> + </tip> + + <figure float="0"> + <title>Setting the JSF Configuration</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/jsf_portlet/jsf_portlet1.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + </listitem> + + <listitem> + <para>Specify the project name and set the target runtime to <property moreinfo="none">JBoss Portal</property> by following the points 3, 4 and 5 in the + <link linkend="jboss_core_portlet">"Creating a Web Project with JBoss Portlet Capabilities"</link> procedure.</para> + </listitem> + + <listitem> + <para>In the <emphasis><property moreinfo="none">Configuration</property></emphasis> + area, click <emphasis><property moreinfo="none">Modify</property></emphasis> and enable <emphasis><property moreinfo="none">JavaServer Faces</property>,</emphasis> + <emphasis><property moreinfo="none">JBoss Core Portlet</property></emphasis> and <emphasis><property moreinfo="none">JBoss JSF Portlet</property></emphasis> facets. + Hit <emphasis><property moreinfo="none">OK</property>.</emphasis></para> + + <figure float="0"> + <title>Enabling the Portlet Facets</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/jsf_portlet/jsf_portlet2.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + </listitem> + + <listitem> + <para>You may leave the next two wizard pages with defaults, just press <emphasis><property moreinfo="none">Next</property></emphasis> to proceed.</para> + </listitem> + + <listitem> + <para>On the <property moreinfo="none">JBoss Portlet Capabilities</property> page, select <emphasis> + <property moreinfo="none">Portlet Target Runtime Provider</property></emphasis> and click <emphasis><property moreinfo="none">Next</property>.</emphasis></para> + + <figure float="0"> + <title>JBoss Portlet Capabilities</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/jsf_portlet/jsf_portlet2a.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <tip> + <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"... + </tip> + </listitem> + + <listitem> + <para>Next wizard page is for configuring JSF capabilities. You can leave everything as it + is here.</para> + + <figure float="0"> + <title>JSF Capabilities</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/jsf_portlet/jsf_portlet3.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + </listitem> + + <listitem> + <para>On the <property moreinfo="none">JBoss JSF Portlet Capabilities</property> page, select + <emphasis><property moreinfo="none">JSF Portlet Target Runtime Provider</property></emphasis> as the JSF portlet implementation library. It will + copy Portlet Bridge libraries from the server runtime to the project classpath.</para> + + <figure float="0"> + <title>JBoss JSF PortletCapabilities</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/jsf_portlet/jsf_portlet4.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <tip> + <title>Tip:</title> + <para>On this page, it is also possible to add the RichFaces libraries from the RichFaces distribution by checking + <emphasis><property moreinfo="none">Add/Change Richfaces Libraries</property>.</emphasis></para> + </tip> + + <note> + <title>Note:</title> + <para>You can select the <emphasis><property moreinfo="none">JSF Portletbridge Runtime Provider</property></emphasis> type. Then it + is necessary to set the home of the Portlet Bridge distribution.</para> + <para>For information about all the JSF Portlet facet library providers, refer to the wiki article at: + <ulink url="http://community.jboss.org/wiki/PortletFacetLibraries">... + </note> + </listitem> + + <listitem> + <para>Click <emphasis><property moreinfo="none">Finish</property>.</emphasis> The project will be created in the workbench.</para> + </listitem> + </orderedlist> + </section> + + <section id="create_jsf_proj"> + <title>Creating a JSF Project and adding the JBoss Portlet Capabilities</title> + + <para>How to organize a JSF project you can find out in the <ulink url="../../jsf_tools_ref_guide/html_single/index.html#new_jsf_project">JSF Tools User Guide</ulink>. Just + remember to point the target runtime to <property moreinfo="none">JBoss Portal</property> directory location (see + how it is done for a dynamic Web project: steps 3, 4 and 5 in the + <link linkend="jboss_core_portlet">"Creating a Web Project with JBoss Portlet Capabilities"</link> procedure).</para> + + <figure float="0"> + <title>Creating New JSF Project</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/jsf_portlet/jsf_portlet8.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>To add the JBoss Portlet capabilities to the created JSF project you should complete the next steps:</para> + + <orderedlist continuation="restarts" inheritnum="ignore"> + <listitem> + <para>Right-click the project and click <emphasis> + <property moreinfo="none">Properties</property> + </emphasis> to open the project <property moreinfo="none">Properties</property> sheet. Select <property moreinfo="none">Project Facets</property> + on the left and enable the <emphasis><property moreinfo="none">JavaServer Faces</property>,</emphasis> + <emphasis><property moreinfo="none">JBoss Core Portlet</property></emphasis> and <emphasis><property moreinfo="none">JBoss JSF Portlet</property></emphasis> facets.</para> + + <figure float="0"> + <title>Project Facets</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/jsf_portlet/jsf_portlet9.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + </listitem> + + <listitem> + <para>Notice, <emphasis> + <property moreinfo="none">"Further configuration available..."</property> + </emphasis> warning appears at the bottom of the screen. It means that next you should configure the JSF Portlet capabilities in the project. + Click the link. The <property moreinfo="none">Modify Faceted Project</property> wizard appears.</para> + </listitem> + + <listitem> + <para>Complete all wizard pages the same way as described in the steps 5, 6, 7 of the + <link linkend="jboss_core_portlet">"Creating a Dynamic Web Project with the JBoss Portlet Capabilities"</link> procedure. + Hit <emphasis><property moreinfo="none">OK</property>.</emphasis></para> + </listitem> + + <listitem> + <para>To apply the changes click <emphasis><property moreinfo="none">Apply</property></emphasis> and then + <emphasis><property moreinfo="none">OK</property></emphasis> to close the project <property moreinfo="none">Properties</property> sheet.</para> + </listitem> + </orderedlist> + </section> + </section> + + <section id="jsf_portlet_to_JSF_project"> + <title>Adding a JSF Portlet to the Project and Deploying It to JBoss Portal</title> + + <para>The previous section has shown how to create a JSF project with JBoss Portlet and JSF Portlet capabilities enabled. Use + the following procedure to add a JSF portlet to the created project and deploy it to <property moreinfo="none">JBoss Portal</property>.</para> + + <orderedlist continuation="restarts" inheritnum="ignore"> + <listitem> + <para>Call the + <property moreinfo="none">Create Portlet</property> wizard by navigating to <emphasis> + <property moreinfo="none">New &gt; Other &gt; JBoss Tools Web &gt; Portlet &gt; JSF/Seam + Portlet</property></emphasis> on the context menu of the project (for information about the wizard options, see + <link linkend="jsf_seam_portlet_wizard">"JSF/Seam Portlet Wizard"</link> in the guide reference).</para> + + <figure float="0"> + <title>Calling New Portlet Wizard</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/jsf_portlet/jsf_portlet5.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <tip> + <title>Tip:</title> + <para>As you see, the JSF and Seam Portlet wizards are merged into one. We have set the JSF + configuration for the project, so the default values in this wizard will be set as for a JSF + portlet.</para> + </tip> + </listitem> + + <listitem> + <para>Leave all the wizard pages with default values by clicking the <emphasis><property moreinfo="none">Next</property></emphasis> button, + on the last one click <emphasis><property moreinfo="none">Finish</property></emphasis> to complete the JSF portlet creation.</para> + </listitem> + + <listitem> + <para>Complete the steps described in the <link linkend="deploying_to_portal">"Deploying a Portlet to JBoss Portal"</link> procedure to + deploy a JSF portlet to <property moreinfo="none">JBoss Portal</property>. Just use the other URL to see it in the browser: + <emphasis>http://localhost:8080/portal/portal/default/JSFPortlet</emphasis>.</para> + + <figure float="0"> + <title>JSF Portlet in the Browser</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/jsf_portlet/jsf_portlet7.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + </listitem> + </orderedlist> + + </section> +</section> + + +<section id="seam_portlet" xml:base="file:///home/vchukhutsina/repos/ochik_jboss/portlet/docs/reference/en/modules/seam_portlet.xml"> + <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 moreinfo="none">JBoss Portlet Tools</property> features.</para> + + <section id="seam_portlet1"> + <title>Creating a Seam Project with JBoss Portlet Capabilities</title> + + <para>Follow one of two ways of creating a Seam project with JBoss Portlet capabilities enabled:</para> + <orderedlist continuation="restarts" inheritnum="ignore"> + <listitem> + <para>Create a dynamic Web project with the <emphasis><property moreinfo="none">Seam</property></emphasis> + and <emphasis><property moreinfo="none">JBoss Portlets</property></emphasis> facets enabled (<link linkend="create_dyn_web_proj_seam">the steps to proceed</link>)</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 (<link linkend="create_seam_proj">the steps to proceed</link>)</para></listitem> + </orderedlist> + + <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> + + <orderedlist continuation="restarts" inheritnum="ignore"> + <listitem> + <para>In the <emphasis><property moreinfo="none">File</property></emphasis> menu, go to + <emphasis><property moreinfo="none">New &gt; Other &gt; Web &gt; Dynamic Web Project</property>.</emphasis> The <property moreinfo="none">New Dynamic Web Project</property> + wizard starts.</para> + + <figure float="0"> + <title>Creating a New Dynamic Web Project</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/seam_portlet/seam_portlet1.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + </listitem> + + <listitem> + <para>Give the project a name and follow the steps 3, 4, 5 of the + <link linkend="jboss_core_portlet">"Creating a Web Project with JBoss Portlet Capabilities"</link> procedure to set the target runtime.</para> + </listitem> + + <listitem> + <para>In the <emphasis><property moreinfo="none">Configuration</property></emphasis> area of the first wizard page, + select <emphasis> + <property moreinfo="none">JBoss Seam Portlet Project v2.0</property>.</emphasis> It will add needed facets to the project.</para> + + <tip> + <title>Tip:</title> + <para>If you now click the <emphasis><property moreinfo="none">Modify</property></emphasis> button, you should see the + <emphasis><property moreinfo="none">JavaServer Faces</property>,</emphasis> <emphasis><property moreinfo="none">Jboss Portlets</property></emphasis> + and <emphasis><property moreinfo="none">Seam</property></emphasis> facets enabled.</para> + </tip> + + <figure float="0"> + <title>Project Facets</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/seam_portlet/seam_portlet2.png"></imagedata> + </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 moreinfo="none">Next</property>.</emphasis></para> + </listitem> + + <listitem> + <para>On the <property moreinfo="none">Jboss Portlet Capabilities</property> page, select + <emphasis><property moreinfo="none">Portlet Target Runtime Provider</property></emphasis> as the portlet implementation library.</para> + + <tip> + <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"... + </tip> + </listitem> + + <listitem> + <para>The next page is for configuring JSF capabilities. As it contains the default values, just click + <emphasis><property moreinfo="none">Next</property></emphasis> to proceed.</para> + </listitem> + + <listitem> + <para>On the <property moreinfo="none">Seam Facet</property> page, set a Seam runtime and + a connection profile.</para> + + <tip> + <title>Tip:</title> + <para>For details about how to set a Seam runtime and a connection profile, see + <ulink url="../../seam/html_single/index.html#seamFacet">"Configure Seam Facet Settings"</ulink> in the Chapter 2, + <ulink url="../../seam/html_single/index.html">"Seam Dev Tools Reference Guide"</ulink>.</para> + </tip> + + <figure float="0"> + <title>Seam Facet Settings</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/seam_portlet/seam_portlet3.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + </listitem> + + <listitem> + <para>On the <property moreinfo="none">JBoss JSF Portlet Capabilities</property> page, select the + <emphasis><property moreinfo="none">JSF Portlet Target Runtime Provider</property></emphasis> type of the implementation library.</para> + + <tip> + <title>Tip:</title> + <para>If you have <property moreinfo="none">JBoss Portlet Bridge</property> downloaded, + alternatively you can select <emphasis><property moreinfo="none">JSF Portletbridge Runtime Provider</property></emphasis> and then provide a path to + the <property moreinfo="none">JBoss Portlet Bridge</property> distribution.</para> + </tip> + + <figure float="0"> + <title>Setting Portlet Bridge Provider</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/jsf_portlet/jsf_portlet4.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>It will add <property moreinfo="none">JBoss Portlet Bridge</property> libraries to the project classpath.</para> + </listitem> + + <listitem> + <para>Hit <emphasis><property moreinfo="none">Finish</property></emphasis> to complete the project creation.</para> + </listitem> + </orderedlist> + </section> + + <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> + + <orderedlist continuation="restarts" inheritnum="ignore"> + <listitem> + <para>In the <emphasis><property moreinfo="none">File</property></emphasis> menu, go to <emphasis> + <property moreinfo="none">New &gt; Other &gt; Seam &gt; Seam Web Project</property>.</emphasis> The <property moreinfo="none">New Seam Project</property> + wizard appears.</para> + </listitem> + + <listitem> + <para>Next steps are the same as in the <link linkend="create_dyn_web_proj_seam">"Creating a Dynamic Web Project with Seam and JBoss Portlet Capabilities"</link> + 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 moreinfo="none">JBoss Portal</property> by following the next procedure:</para> + + <orderedlist continuation="restarts" inheritnum="ignore"> + <listitem> + <para>In the <emphasis><property moreinfo="none">File</property></emphasis> or context menu of the project go to + <emphasis><property moreinfo="none">New &gt; Other &gt; JBoss Tools Web &gt; Portlet &gt; JSF/Seam + Portlet</property>.</emphasis></para> + + <figure float="0"> + <title>Calling the Create Portlet Wizard</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/seam_portlet/seam_portlet5.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + </listitem> + + <listitem> + <para>The <property moreinfo="none">Create Portlet</property> wizard starts (for more information about wizard options, see + <link linkend="jsf_seam_portlet_wizard">"JSF/Seam Portlet Wizard"</link> in the guide reference). + As the Seam configuration is set for the project, the wizard puts the values as for Seam portlet.</para> + + <figure float="0"> + <title>Creating Seam Portlet</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/seam_portlet/seam_portlet6.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + </listitem> + + <listitem> + <para>Next two pages are filled out with default values, just press <emphasis><property moreinfo="none">Next</property></emphasis> to + proceed. On the last one click <emphasis><property moreinfo="none">Finish</property></emphasis> to complete.</para> + </listitem> + + <listitem> + <para>To deploy and run the portlet on <property moreinfo="none">JBoss Portal</property> complete the steps described in the + <link linkend="deploying_to_portal">"Deploying a Portlet to JBoss Portal"</link> procedure. Just use the following URL to see it in the browser: + <emphasis>http://localhost:8080/portal/portal/default/SeamPortlet</emphasis>.</para> + + <figure float="0"> + <title>Seam Portlet in the Browser Window</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/seam_portlet/seam_portlet7.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + </listitem> + </orderedlist> + </section> +</section> + +</chapter> + +<chapter id="reference" xml:base="file:///home/vchukhutsina/repos/ochik_jboss/portlet/docs/reference/en/modules/reference.xml" xreflabel="reference"> + <?dbhtml filename="reference.html"?> + <title>Reference</title> + + <para>This chapter includes detailed reference information about <property moreinfo="none">JBoss Portlet Tools</property>.</para> + <section id="project_overview"> + <title>JBoss Portlet Descriptors</title> + + <para>In order to a web project with portlets could be deployed to <property moreinfo="none">JBoss Portal</property>, it should include certain descriptors. + The next table lists and describes these configuration files.</para> + + <table> + <title>JBoss Portlet Descriptors</title> + <tgroup cols="2"> + <thead> + <row> + <entry>Name</entry> + + <entry>Description</entry> + </row> + </thead> + <tbody> + <row> + <entry>portlet.xml</entry> + <entry>The mandatory portlet descriptor defined by the <ulink url="http://www.jcp.org/en/jsr/detail?id=168">JSR-168 Portlet Specification</ulink>. + It is used during deployment.</entry> + </row> + + <row> + <entry>portlet-instances.xml</entry> + <entry>The optional <property moreinfo="none">JBoss Portal</property> specific descriptor. It allows to create a portlet instance from a portlet class definition.</entry> + </row> + + <row> + <entry>*-object.xml</entry> + <entry>The optional <property moreinfo="none">JBoss Portal</property> specific descriptor. It helps define the layout of the portal.</entry> + </row> + + <row> + <entry>jboss-portlet.xml</entry> + <entry>The optional <property moreinfo="none">JBoss Portal</property> specific descriptor. It allows to use JBoss + specific functionality within a portlet application.</entry> + </row> + </tbody> + </tgroup> + </table> + + <para>For more detail information about each descriptor, see + <ulink url="http://docs.jboss.org/jbportal/v2.7.1/referenceGuide/html_singl... Descriptors"</ulink> in Chapter 6, + <ulink url="http://docs.jboss.org/jbportal/v2.7.1/referenceGuide/html_singl... Portal Reference Guide"</ulink>.</para> + </section> + + <section id="wizards"> + <title>Wizards</title> + <para>This section describes the <property moreinfo="none">JBoss Portlet Tools</property> wizards:</para> + <itemizedlist> + <listitem><para><link linkend="java_portlet_wizard">Java Portlet wizard</link></para></listitem> + <listitem><para><link linkend="jsf_seam_portlet_wizard">JSF/Seam Portlet wizard</link></para></listitem> + </itemizedlist> + + <section id="java_portlet_wizard"> + <title>Java Portlet Wizard</title> + + <para>The <property moreinfo="none">Java Portlet</property> wizard helps you create a new Java portlet (1.0 or 2.0). It is based on the WTP's Create Servlet wizard, + but adapted to JBoss Portlet. You can call it from the <emphasis><property moreinfo="none">File</property></emphasis> or context menu of your project by following to + <emphasis><property moreinfo="none">New &gt; Other &gt; JBoss Tools Web &gt; Portlet &gt; Java Portlet</property>.</emphasis></para> + + <para>The wizard consists of the four pages:</para> + + <orderedlist continuation="restarts" inheritnum="ignore"> + <listitem> + <para>The first one includes the next options to adjust:</para> + + <table> + <title>Java Portlet Wizard. First Page Options.</title> + <tgroup cols="3"> + <colspec align="left" colnum="1" colwidth="1*"></colspec> + <colspec colnum="2" colwidth="3*"></colspec> + <colspec align="left" colnum="3" colwidth="1*"></colspec> + + <thead> + <row> + <entry>Option</entry> + <entry>Description</entry> + <entry>Default</entry> + </row> + </thead> + <tbody> + <row> + <entry>Project</entry> + <entry>Select the project to add a new Java portlet</entry> + <entry>The project selected when the wizard has been started</entry> + </row> + + <row> + <entry>Source folder</entry> + <entry>The path to the source folder relative to the selected project</entry> + <entry>The source folder of the project selected in the <emphasis><property moreinfo="none">Project</property></emphasis> field</entry> + </row> + + <row> + <entry>Java package</entry> + <entry>Enter a package to contain a new portlet. Either type a valid package name or click + <emphasis><property moreinfo="none">Browse</property></emphasis> to select a package via the dialog box.</entry> + <entry>&lt;blank&gt;</entry> + </row> + + <row> + <entry>Class name</entry> + <entry>Type a name for a new Java portlet class</entry> + <entry>&lt;blank&gt;</entry> + </row> + + <row> + <entry>Superclass</entry> + <entry>Type or click <emphasis><property moreinfo="none">Browse</property></emphasis> to select a superclass for a Java portlet class</entry> + <entry>javax.portlet.GenericPortlet</entry> + </row> + + <row> + <entry>Use an existing Portlet class</entry> + <entry>Select this check box if you want to use an existing Java portlet class. In the appeared + <emphasis><property moreinfo="none">Class name</property></emphasis> field type or + click <emphasis><property moreinfo="none">Browse</property></emphasis> to select an existing portlet class.</entry> + <entry>Cleared</entry> + </row> + </tbody> + </tgroup> + </table> + </listitem> + + <listitem> + <para>The second wizard page is for specifying modifiers, interfaces to implement and method stubs to generate.</para> + + <figure float="0"> + <title>Second Page of the Java Portlet Wizard</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/reference/javaPortlet2.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>The descriptions of the options listed on this page are in the following table.</para> + + <table> + <title>Java Portlet Wizard. Second Page Options.</title> + <tgroup cols="3"> + <colspec align="left" colnum="1" colwidth="1*"></colspec> + <colspec align="left" colnum="2" colwidth="3*"></colspec> + <colspec align="left" colnum="3" colwidth="1*"></colspec> + + <thead> + <row> + <entry>Option</entry> + <entry>Description</entry> + <entry>Default</entry> + </row> + </thead> + <tbody> + <row> + <entry>Modifiers</entry> + <entry>Select one or more access modifiers for a new Java portlet class: + <itemizedlist> + <listitem><para>Public</para></listitem> + <listitem><para>Abstract</para></listitem> + <listitem><para>Final</para></listitem> + </itemizedlist> + </entry> + <entry>Public</entry> + </row> + + <row> + <entry>Interfaces</entry> + <entry>Click <emphasis><property moreinfo="none">Add</property></emphasis> to choose interfaces that a new class implements</entry> + <entry>&lt;blank&gt;</entry> + </row> + + <row> + <entry>Which method stubs would you like to create?</entry> + <entry>Choose which methods from superclass to override in the Java portlet class: + <itemizedlist> + <listitem><para>Constructors from superclass</para></listitem> + <listitem><para>Inherited abstract methods</para></listitem> + <listitem><para>init</para></listitem> + <listitem><para>doView</para></listitem> + <listitem><para>doDispatch</para></listitem> + <listitem><para>destroy</para></listitem> + <listitem><para>doEdit</para></listitem> + <listitem><para>processAction</para></listitem> + <listitem><para>getPortletConfig</para></listitem> + <listitem><para>doHelp</para></listitem> + <listitem><para>render</para></listitem> + </itemizedlist> + </entry> + <entry>Inherited abstract methods, doView</entry> + </row> + </tbody> + </tgroup> + </table> + </listitem> + + <listitem> + <para>The third page is for adjusting the portlet deployment descriptor settings.</para> + + <figure float="0"> + <title>Third Page of the Java Portlet Wizard</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/reference/javaPortlet3.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <table> + <title>Java Portlet Wizard. Third Page Options.</title> + <tgroup cols="3"> + <colspec align="left" colnum="1" colwidth="1*"></colspec> + <colspec align="left" colnum="2" colwidth="3*"></colspec> + <colspec align="left" colnum="3" colwidth="1*"></colspec> + + <thead> + <row> + <entry>Option</entry> + <entry>Description</entry> + <entry>Default</entry> + </row> + </thead> + <tbody> + <row> + <entry>Name</entry> + <entry>Enter the portlet name. It does not have to be the portlet class name.</entry> + <entry>The name of the portlet class</entry> + </row> + + <row> + <entry>Display name</entry> + <entry>Enter the display name of the Java portlet</entry> + <entry>The name of the portlet class</entry> + </row> + + <row> + <entry>Title</entry> + <entry>Enter the title of the portlet</entry> + <entry>The name of the portlet class</entry> + </row> + + <row> + <entry>Description</entry> + <entry>Enter the description of the portlet's function</entry> + <entry>&lt;blank&gt;</entry> + </row> + + <row> + <entry>Portlet Modes</entry> + <entry>Select one or more of three modes defined by the JSR-286 specification: + <itemizedlist> + <listitem><para><emphasis>View</emphasis> - generates markup reflecting the current state of the portlet;</para></listitem> + <listitem><para><emphasis>Edit</emphasis> - allows customizing the behavior of the portlet;</para></listitem> + <listitem><para><emphasis>Help</emphasis> - provides an information on how to use the portlet.</para></listitem> + </itemizedlist> + </entry> + <entry>View</entry> + </row> + + <row> + <entry>Initialization Parameters</entry> + <entry>Specify initialization parameters to create an initial state inside your portlet class. Click + <emphasis><property moreinfo="none">Add</property></emphasis> and fill in the + <emphasis><property moreinfo="none">Name</property>,</emphasis> <emphasis><property moreinfo="none">Value</property></emphasis> and + <emphasis><property moreinfo="none">Description</property></emphasis> (optional) fields to set a parameter.</entry> + <entry>&lt;blank&gt;</entry> + </row> + </tbody> + </tgroup> + </table> + + </listitem> + + <listitem> + <para>The last wizard page helps configure the JBoss Portlet specific descriptors.</para> + + <figure float="0"> + <title>Last Page of the Java Portlet Wizard</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/reference/javaPortlet4.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <table> + <title>Java Portlet Wizard. Last Page Options.</title> + <tgroup cols="3"> + <colspec align="left" colnum="1" colwidth="1*"></colspec> + <colspec align="left" colnum="2" colwidth="3*"></colspec> + <colspec align="left" colnum="3" colwidth="1*"></colspec> + + <thead> + <row> + <entry>Option</entry> + <entry>Description</entry> + <entry>Default</entry> + </row> + </thead> + <tbody> + <row> + <entry>Create Portlet Instance</entry> + <entry>Clear the <emphasis><property moreinfo="none">Create Portlet Instance</property></emphasis> check box, + if you don't wont the wizard to create the deployment elements + in the <literal moreinfo="none">default-object.xml</literal> and <literal moreinfo="none"> + portlet-instances.xml</literal> files</entry> + <entry>Selected</entry> + </row> + + <row> + <entry>If Exists</entry> + <entry>Select one of two options: + <itemizedlist> + <listitem><para><emphasis>overwrite</emphasis> - destroys the existing object and creates a new one based on the content of the deployment</para></listitem> + <listitem><para><emphasis>keep</emphasis> - maintains the existing object deployment or creates a new one if it does not exist</para></listitem> + </itemizedlist> + </entry> + <entry>overwrite</entry> + </row> + + <row> + <entry>Instance Name</entry> + <entry>Enter a name of the portlet instance that the portlet window represents</entry> + <entry>[Portlet class name]Instance</entry> + </row> + + <row> + <entry>Page Name</entry> + <entry>If set, the portlet page is created with the name defined</entry> + <entry>&lt;blank&gt;</entry> + </row> + + <row> + <entry>Window Name</entry> + <entry>Enter a name of the portlet window</entry> + <entry>[Portlet class name]Window</entry> + </row> + + <row> + <entry>Parent Reference</entry> + <entry> + <para>Define a reference to the parent object. The syntax for this element is <literal moreinfo="none">[portal-instance].[portal-page]</literal>.</para> + <para>For example, <literal moreinfo="none">default.default</literal> means that the window appears on the default page, in the default portal.</para> + </entry> + <entry>default.default</entry> + </row> + + <row> + <entry>Region</entry> + <entry>Specify the region where the window should appear on the page</entry> + <entry>center</entry> + </row> + + <row> + <entry>Height</entry> + <entry>Define the height of the window</entry> + <entry>1</entry> + </row> + + <row> + <entry>Initial Window State</entry> + <entry>Set the window state indicator by selecting one of three states defined by the JSR-168 specification: + <itemizedlist> + <listitem><para><emphasis>normal</emphasis> - a portlet shares this page with other portlets</para></listitem> + <listitem><para><emphasis>minimized</emphasis> - a portlet may show very little information or none at all</para></listitem> + <listitem><para><emphasis>maximized</emphasis> - a portlet may be the only portlet displayed on this page</para></listitem> + </itemizedlist> + </entry> + <entry>maximized</entry> + </row> + </tbody> + </tgroup> + </table> + </listitem> + </orderedlist> + </section> + + <section id="jsf_seam_portlet_wizard"> + <title>JSF/Seam Portlet Wizard</title> + + <para>The <property moreinfo="none">JSF/Seam Portlet</property> wizard, that is merged into one JSF and Seam Portlet wizards, helps you create a + JSF/Seam portlet that uses the <property moreinfo="none">JBoss Portlet Bridge</property> libraries. The default values in this wizard + depend on the configuration set for the project. For instance, if you set the JSF configuration, the default values in this wizard will be + as for a JSF portlet.</para> + + <para>The <property moreinfo="none">JSF/Seam Portlet</property> wizard could be started from the <emphasis><property moreinfo="none">File</property></emphasis> or + context menu of your project by following to + <emphasis><property moreinfo="none">New &gt; Other &gt; JBoss Tools Web &gt; Portlet &gt; JSF/Seam Portlet</property>.</emphasis></para> + + <para>The wizard includes three pages to adjust JSF/Seam portlet setting:</para> + + <orderedlist continuation="restarts" inheritnum="ignore"> + <listitem> + <para>The first wizard page asks to select a project to add JSF/Seam portlet and set a class file destination.</para> + + <figure float="0"> + <title>First Page of the JSF Portlet Wizard</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/reference/jsf_seam_portlet1.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <table> + <title>JSF/Seam Portlet Wizard. First Page Options.</title> + <tgroup cols="3"> + <colspec align="left" colnum="1" colwidth="1*"></colspec> + <colspec align="left" colnum="2" colwidth="3*"></colspec> + <colspec align="left" colnum="3" colwidth="1*"></colspec> + + <thead> + <row> + <entry>Option</entry> + <entry>Description</entry> + <entry>Default</entry> + </row> + </thead> + <tbody> + <row> + <entry>Project</entry> + <entry>Select the project to add a new JSF/Seam portlet</entry> + <entry>The project selected when the wizard has been started</entry> + </row> + + <row> + <entry>Class name</entry> + <entry>Type or click <emphasis><property moreinfo="none">Browse</property></emphasis> to select a class for a JSF/Seam portlet</entry> + <entry>javax.portlet.faces.GenericFacesPortlet</entry> + </row> + </tbody> + </tgroup> + </table> + </listitem> + + <listitem> + <para>The second page allows to configure a portlet deployment descriptors.</para> + + <figure float="0"> + <title>Second Page of the JSF Portlet Wizard</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/reference/jsf_seam_portlet2.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <table> + <title>JSF/Seam Portlet Wizard. Second Page Options.</title> + <tgroup cols="3"> + <colspec align="left" colnum="1" colwidth="1*"></colspec> + <colspec align="left" colnum="2" colwidth="3*"></colspec> + <colspec align="left" colnum="3" colwidth="1*"></colspec> + + <thead> + <row> + <entry>Option</entry> + <entry>Description</entry> + <entry>Default (JSF / Seam)</entry> + </row> + </thead> + <tbody> + <row> + <entry>Name</entry> + <entry>Enter the portlet name. It does not have to be the portlet class name.</entry> + <entry>riPortlet / seamPortlet</entry> + </row> + + <row> + <entry>Display name</entry> + <entry>Enter the display name of the Java portlet</entry> + <entry>JBoss JSF Portlet / JBoss Seam Portlet</entry> + </row> + + <row> + <entry>Title</entry> + <entry>Enter the title of the portlet</entry> + <entry>JBoss JSF Portlet / JBoss Seam Portlet</entry> + </row> + + <row> + <entry>Description</entry> + <entry>Enter the description of the portlet's function</entry> + <entry>&lt;blank&gt;</entry> + </row> + + <row> + <entry>Portlet Modes</entry> + <entry>Select one or more of three modes defined by the JSR-286 specification: + <itemizedlist> + <listitem><para><emphasis>View</emphasis> - generates markup reflecting the current state of the portlet</para></listitem> + <listitem><para><emphasis>Edit</emphasis> - allows customizing the behavior of the portlet</para></listitem> + <listitem><para><emphasis>Help</emphasis> - provides an information on how to use the portlet</para></listitem> + </itemizedlist> + </entry> + <entry>View, Edit, Help / View</entry> + </row> + + <row> + <entry>Initialization Parameters</entry> + <entry>Specify initialization parameters to create an initial state inside your portlet class. Click + <emphasis><property moreinfo="none">Add</property></emphasis> and fill in the + <emphasis><property moreinfo="none">Name</property>,</emphasis> <emphasis><property moreinfo="none">Value</property></emphasis> and + <emphasis><property moreinfo="none">Description</property></emphasis> (optional) fields to set a parameter.</entry> + <entry>javax.portlet.faces.defaultViewId.view, javax.portlet.faces.defaultViewId.edit, + javax.portlet.faces.defaultViewId.help / javax.portlet.faces.defaultViewId.view</entry> + </row> + </tbody> + </tgroup> + </table> + </listitem> + + <listitem> + <para>The last wizard page helps you configure the JBoss Portlet specific information.</para> + + <figure float="0"> + <title>Third Page of the JSF Portlet Wizard</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/reference/jsf_seam_portlet3.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <table> + <title>JSF/Seam Portlet Wizard. Third Page Options.</title> + <tgroup cols="3"> + <colspec align="left" colnum="1" colwidth="1*"></colspec> + <colspec align="left" colnum="2" colwidth="3*"></colspec> + <colspec align="left" colnum="3" colwidth="1*"></colspec> + + <thead> + <row> + <entry>Option</entry> + <entry>Description</entry> + <entry>Default (JSF / Seam)</entry> + </row> + </thead> + <tbody> + <row> + <entry>Create Portlet Instance</entry> + <entry>Clear the <emphasis><property moreinfo="none">Create Portlet Instance</property></emphasis> check box, + if you don't wont the wizard to create the deployment elements + in the <literal moreinfo="none">default-object.xml</literal> and <literal moreinfo="none"> + portlet-instances.xml</literal> files</entry> + <entry>Selected</entry> + </row> + + <row> + <entry>If Exists</entry> + <entry>Select one of two options: + <itemizedlist> + <listitem><para><emphasis>overwrite</emphasis> - destroys the existing object and creates a new one based on the content of the deployment</para></listitem> + <listitem><para><emphasis>keep</emphasis> - maintains the existing object deployment or creates a new one if it does not exist</para></listitem> + </itemizedlist> + </entry> + <entry>overwrite</entry> + </row> + + <row> + <entry>Instance Name</entry> + <entry>Enter a name of the portlet instance that the portlet window represents</entry> + <entry>JSFPortletInstance / SeamPortletInstance</entry> + </row> + + <row> + <entry>Page Name</entry> + <entry>If set, the portlet page is created with the name defined</entry> + <entry>JSFPortlet / SeamPortlet</entry> + </row> + + <row> + <entry>Window Name</entry> + <entry>Enter a name of the portlet window</entry> + <entry>JSFPortletWindow / SeamPortletWindow</entry> + </row> + + <row> + <entry>Parent Reference</entry> + <entry> + <para>Define a reference to the parent object.</para> + <para>For example, <literal moreinfo="none">default</literal> means that the page appears in the default portal.</para> + </entry> + <entry>default</entry> + </row> + + <row> + <entry>Region</entry> + <entry>Specify the region where the window should appear on the page</entry> + <entry>center</entry> + </row> + + <row> + <entry>Height</entry> + <entry>Define the height of the window</entry> + <entry>1</entry> + </row> + + <row> + <entry>Initial Window State</entry> + <entry>Set the window state indicator by selecting one of three states defined by the JSR-168 specification: + <itemizedlist> + <listitem><para><emphasis>normal</emphasis> - a portlet shares this page with other portlets</para></listitem> + <listitem><para><emphasis>minimized</emphasis> - a portlet may show very little information or none at all</para></listitem> + <listitem><para><emphasis>maximized</emphasis> - a portlet may be the only portlet displayed on this page</para></listitem> + </itemizedlist> + </entry> + <entry>maximized</entry> + </row> + + <row> + <entry>Create JBoss Application</entry> + <entry> + <para>Select to add the <literal moreinfo="none">jboss-app.xml</literal> descriptor.</para> + <para><emphasis>riPortletApp / seamPortletApp</emphasis> - the default name of the JBoss application. You can change it by + typing a new one in the <emphasis><property moreinfo="none">JBoss Application Name</property></emphasis> field.</para> + </entry> + <entry>Selected</entry> + </row> + + <row> + <entry>Add the jboss-portlet.xml file</entry> + <entry>Select to create the <literal moreinfo="none">jboss-portlet.xml</literal> file</entry> + <entry>Selected</entry> + </row> + + <row> + <entry>Copy JSF Templates</entry> + <entry>Select to add the folder with JSF templates (<literal moreinfo="none">edit.jsp</literal>, <literal moreinfo="none">help.jsp</literal>, + <literal moreinfo="none">view.jsp</literal>) to the project</entry> + <entry>Cleared</entry> + </row> + </tbody> + </tgroup> + </table> + </listitem> + </orderedlist> + </section> + </section> + + <section id="preferences"> + <title>JBoss Portlet Preferences</title> + + <para>To open <property moreinfo="none">JBoss Portlet Preferences</property> property sheet, go to <emphasis> + <property moreinfo="none">Window &gt; Preferences</property> + </emphasis> and then <emphasis> + <property moreinfo="none">JBoss Tools &gt; JBoss Portlet</property>. + </emphasis></para> + + <figure float="0"> + <title>JBoss Runtime Preferences</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/reference/portlet_preferences.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>The <emphasis> + <property moreinfo="none">Check runtimes for Portlet Components</property> + </emphasis> option makes the JBoss Portlet functionality always visible no matter what the runtime is set. By default the option is checked.</para> + </section> +</chapter> + +<chapter id="summary" xml:base="file:///home/vchukhutsina/repos/ochik_jboss/portlet/docs/reference/en/modules/summary.xml" xreflabel="summary"> + <?dbhtml filename="summary.html"?> + <title>Summary</title> + + <para>In conclusion, with this document you could easily get started with <property moreinfo="none">JBoss + Portlet Tools</property>. + The above chapters walked you through the steps on how to organize a web project with + JBoss Portlet capabilities enabled, create a Java portlet, JSF or Seam portlet and deploy them to <property moreinfo="none">JBoss + Portal</property>. The document also includes the reference of <property moreinfo="none">JBoss Portlet Tools</property> features.</para> + + <para>If you have questions or suggestions concerned both the documentation and tools behavior, you are welcome + to <ulink url="http://www.jboss.com/index.html?module=bb&amp;op=viewforum&... Tools Users forum</ulink>.</para> + + <para>Please, use <ulink url="https://jira.jboss.org/jira/browse/JBDS">Jira</ulink... to report bugs and requests on documentation.</para> + + <section id="rel_resources"> + <title>Other Relevant Resources on the Topic</title> + + <itemizedlist> + <listitem> + <para> + JBoss Portal home page: <ulink url="http://www.jboss.org/jbossportal/">http://www.jboss.org... + </para> + </listitem> + + <listitem> + <para> + JBoss Portal Wiki at: <ulink url="http://wiki.jboss.org/wiki/JBossPortal">http://wiki.jbo... + </para> + </listitem> + + <listitem> + <para>JBoss Portal documentation set at: <ulink url="http://docs.jboss.org/jbportal/">http://docs.jboss.org/... + </listitem> + + <listitem> + <para> + JBoss Tools home page at: <ulink url="http://www.jboss.org/tools/">http://www.jboss.org/tools... + </para> + </listitem> + + <listitem> + <para> + The latest JBossTools/JBDS documentation builds at: <ulink url="http://download.jboss.org/jbosstools/nightly-docs/">htt... + </para> + </listitem> + + <listitem> + <para>JBoss Developer Studio/JBoss Tools release documentation you can + find at <ulink url="http://docs.jboss.org/tools/">http://docs.jboss.org/too... in the corresponding release directory.</para> + </listitem> + </itemizedlist> + + </section> +</chapter> +</book> Added: branches/jbosstools-3.1.x/portlet/docs/reference/en-US/portlet_tools_tasks.xml =================================================================== --- branches/jbosstools-3.1.x/portlet/docs/reference/en-US/portlet_tools_tasks.xml (rev 0) +++ branches/jbosstools-3.1.x/portlet/docs/reference/en-US/portlet_tools_tasks.xml 2010-03-12 00:23:23 UTC (rev 20778) @@ -0,0 +1,10 @@ +<?xml version="1.0" encoding="UTF-8"?> +<chapter id="portlet_tools_tasks" xreflabel="portlet_tools_tasks"> + <?dbhtml filename="portlet_tools_tasks.html"?> + <title>JBoss Portlet Tools Tasks</title> + + <xi:include href="starting_project.xml" xmlns:xi="http://www.w3.org/2001/XInclude"></xi:include> + <xi:include href="jsf_portlet.xml" xmlns:xi="http://www.w3.org/2001/XInclude"></xi:include> + <xi:include href="seam_portlet.xml" xmlns:xi="http://www.w3.org/2001/XInclude"></xi:include> + +</chapter> \ No newline at end of file Added: branches/jbosstools-3.1.x/portlet/docs/reference/en-US/reference.xml =================================================================== --- branches/jbosstools-3.1.x/portlet/docs/reference/en-US/reference.xml (rev 0) +++ branches/jbosstools-3.1.x/portlet/docs/reference/en-US/reference.xml 2010-03-12 00:23:23 UTC (rev 20778) @@ -0,0 +1,670 @@ +<?xml version="1.0" encoding="UTF-8"?> +<chapter id="reference" xreflabel="reference"> + <?dbhtml filename="reference.html"?> + <title>Reference</title> + + <para>This chapter includes detailed reference information about <property>JBoss Portlet Tools</property>.</para> + <section id="project_overview"> + <title>JBoss Portlet Descriptors</title> + + <para>In order to a web project with portlets could be deployed to <property>JBoss Portal</property>, it should include certain descriptors. + The next table lists and describes these configuration files.</para> + + <table> + <title>JBoss Portlet Descriptors</title> + <tgroup cols="2"> + <thead> + <row> + <entry>Name</entry> + + <entry>Description</entry> + </row> + </thead> + <tbody> + <row> + <entry>portlet.xml</entry> + <entry>The mandatory portlet descriptor defined by the <ulink url="http://www.jcp.org/en/jsr/detail?id=168">JSR-168 Portlet Specification</ulink>. + It is used during deployment.</entry> + </row> + + <row> + <entry>portlet-instances.xml</entry> + <entry>The optional <property>JBoss Portal</property> specific descriptor. It allows to create a portlet instance from a portlet class definition.</entry> + </row> + + <row> + <entry>*-object.xml</entry> + <entry>The optional <property>JBoss Portal</property> specific descriptor. It helps define the layout of the portal.</entry> + </row> + + <row> + <entry>jboss-portlet.xml</entry> + <entry>The optional <property>JBoss Portal</property> specific descriptor. It allows to use JBoss + specific functionality within a portlet application.</entry> + </row> + </tbody> + </tgroup> + </table> + + <para>For more detail information about each descriptor, see + <ulink url="http://docs.jboss.org/jbportal/v2.7.1/referenceGuide/html_singl... Descriptors&quot;</ulink> in Chapter 6, + <ulink url="http://docs.jboss.org/jbportal/v2.7.1/referenceGuide/html_singl... Portal Reference Guide&quot;</ulink>.</para> + </section> + + <section id="wizards"> + <title>Wizards</title> + <para>This section describes the <property>JBoss Portlet Tools</property> wizards:</para> + <itemizedlist> + <listitem><para><link linkend="java_portlet_wizard">Java Portlet wizard</link></para></listitem> + <listitem><para><link linkend="jsf_seam_portlet_wizard">JSF/Seam Portlet wizard</link></para></listitem> + </itemizedlist> + + <section id="java_portlet_wizard"> + <title>Java Portlet Wizard</title> + + <para>The <property>Java Portlet</property> wizard helps you create a new Java portlet (1.0 or 2.0). It is based on the WTP's Create Servlet wizard, + but adapted to JBoss Portlet. You can call it from the <emphasis><property>File</property></emphasis> or context menu of your project by following to + <emphasis><property>New &gt; Other &gt; JBoss Tools Web &gt; Portlet &gt; Java Portlet</property>.</emphasis></para> + + <para>The wizard consists of the four pages:</para> + + <orderedlist> + <listitem> + <para>The first one includes the next options to adjust:</para> + + <table> + <title>Java Portlet Wizard. First Page Options.</title> + <tgroup cols="3"> + <colspec colnum="1" align="left" colwidth="1*"/> + <colspec colnum="2" colwidth="3*"/> + <colspec colnum="3" align="left" colwidth="1*"/> + + <thead> + <row> + <entry>Option</entry> + <entry>Description</entry> + <entry>Default</entry> + </row> + </thead> + <tbody> + <row> + <entry>Project</entry> + <entry>Select the project to add a new Java portlet</entry> + <entry>The project selected when the wizard has been started</entry> + </row> + + <row> + <entry>Source folder</entry> + <entry>The path to the source folder relative to the selected project</entry> + <entry>The source folder of the project selected in the <emphasis><property>Project</property></emphasis> field</entry> + </row> + + <row> + <entry>Java package</entry> + <entry>Enter a package to contain a new portlet. Either type a valid package name or click + <emphasis><property>Browse</property></emphasis> to select a package via the dialog box.</entry> + <entry>&lt;blank&gt;</entry> + </row> + + <row> + <entry>Class name</entry> + <entry>Type a name for a new Java portlet class</entry> + <entry>&lt;blank&gt;</entry> + </row> + + <row> + <entry>Superclass</entry> + <entry>Type or click <emphasis><property>Browse</property></emphasis> to select a superclass for a Java portlet class</entry> + <entry>javax.portlet.GenericPortlet</entry> + </row> + + <row> + <entry>Use an existing Portlet class</entry> + <entry>Select this check box if you want to use an existing Java portlet class. In the appeared + <emphasis><property>Class name</property></emphasis> field type or + click <emphasis><property>Browse</property></emphasis> to select an existing portlet class.</entry> + <entry>Cleared</entry> + </row> + </tbody> + </tgroup> + </table> + </listitem> + + <listitem> + <para>The second wizard page is for specifying modifiers, interfaces to implement and method stubs to generate.</para> + + <figure> + <title>Second Page of the Java Portlet Wizard</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/reference/javaPortlet2.png"/> + </imageobject> + </mediaobject> + </figure> + + <para>The descriptions of the options listed on this page are in the following table.</para> + + <table> + <title>Java Portlet Wizard. Second Page Options.</title> + <tgroup cols="3"> + <colspec colnum="1" align="left" colwidth="1*"/> + <colspec colnum="2" align="left" colwidth="3*"/> + <colspec colnum="3" align="left" colwidth="1*"/> + + <thead> + <row> + <entry>Option</entry> + <entry>Description</entry> + <entry>Default</entry> + </row> + </thead> + <tbody> + <row> + <entry>Modifiers</entry> + <entry>Select one or more access modifiers for a new Java portlet class: + <itemizedlist> + <listitem><para>Public</para></listitem> + <listitem><para>Abstract</para></listitem> + <listitem><para>Final</para></listitem> + </itemizedlist> + </entry> + <entry>Public</entry> + </row> + + <row> + <entry>Interfaces</entry> + <entry>Click <emphasis><property>Add</property></emphasis> to choose interfaces that a new class implements</entry> + <entry>&lt;blank&gt;</entry> + </row> + + <row> + <entry>Which method stubs would you like to create?</entry> + <entry>Choose which methods from superclass to override in the Java portlet class: + <itemizedlist> + <listitem><para>Constructors from superclass</para></listitem> + <listitem><para>Inherited abstract methods</para></listitem> + <listitem><para>init</para></listitem> + <listitem><para>doView</para></listitem> + <listitem><para>doDispatch</para></listitem> + <listitem><para>destroy</para></listitem> + <listitem><para>doEdit</para></listitem> + <listitem><para>processAction</para></listitem> + <listitem><para>getPortletConfig</para></listitem> + <listitem><para>doHelp</para></listitem> + <listitem><para>render</para></listitem> + </itemizedlist> + </entry> + <entry>Inherited abstract methods, doView</entry> + </row> + </tbody> + </tgroup> + </table> + </listitem> + + <listitem> + <para>The third page is for adjusting the portlet deployment descriptor settings.</para> + + <figure> + <title>Third Page of the Java Portlet Wizard</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/reference/javaPortlet3.png"/> + </imageobject> + </mediaobject> + </figure> + + <table> + <title>Java Portlet Wizard. Third Page Options.</title> + <tgroup cols="3"> + <colspec colnum="1" align="left" colwidth="1*"/> + <colspec colnum="2" align="left" colwidth="3*"/> + <colspec colnum="3" align="left" colwidth="1*"/> + + <thead> + <row> + <entry>Option</entry> + <entry>Description</entry> + <entry>Default</entry> + </row> + </thead> + <tbody> + <row> + <entry>Name</entry> + <entry>Enter the portlet name. It does not have to be the portlet class name.</entry> + <entry>The name of the portlet class</entry> + </row> + + <row> + <entry>Display name</entry> + <entry>Enter the display name of the Java portlet</entry> + <entry>The name of the portlet class</entry> + </row> + + <row> + <entry>Title</entry> + <entry>Enter the title of the portlet</entry> + <entry>The name of the portlet class</entry> + </row> + + <row> + <entry>Description</entry> + <entry>Enter the description of the portlet&apos;s function</entry> + <entry>&lt;blank&gt;</entry> + </row> + + <row> + <entry>Portlet Modes</entry> + <entry>Select one or more of three modes defined by the JSR-286 specification: + <itemizedlist> + <listitem><para><emphasis>View</emphasis> - generates markup reflecting the current state of the portlet;</para></listitem> + <listitem><para><emphasis>Edit</emphasis> - allows customizing the behavior of the portlet;</para></listitem> + <listitem><para><emphasis>Help</emphasis> - provides an information on how to use the portlet.</para></listitem> + </itemizedlist> + </entry> + <entry>View</entry> + </row> + + <row> + <entry>Initialization Parameters</entry> + <entry>Specify initialization parameters to create an initial state inside your portlet class. Click + <emphasis><property>Add</property></emphasis> and fill in the + <emphasis><property>Name</property>,</emphasis> <emphasis><property>Value</property></emphasis> and + <emphasis><property>Description</property></emphasis> (optional) fields to set a parameter.</entry> + <entry>&lt;blank&gt;</entry> + </row> + </tbody> + </tgroup> + </table> + + </listitem> + + <listitem> + <para>The last wizard page helps configure the JBoss Portlet specific descriptors.</para> + + <figure> + <title>Last Page of the Java Portlet Wizard</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/reference/javaPortlet4.png"/> + </imageobject> + </mediaobject> + </figure> + + <table> + <title>Java Portlet Wizard. Last Page Options.</title> + <tgroup cols="3"> + <colspec colnum="1" align="left" colwidth="1*"/> + <colspec colnum="2" align="left" colwidth="3*"/> + <colspec colnum="3" align="left" colwidth="1*"/> + + <thead> + <row> + <entry>Option</entry> + <entry>Description</entry> + <entry>Default</entry> + </row> + </thead> + <tbody> + <row> + <entry>Create Portlet Instance</entry> + <entry>Clear the <emphasis><property>Create Portlet Instance</property></emphasis> check box, + if you don&apos;t wont the wizard to create the deployment elements + in the <literal>default-object.xml</literal> and <literal> + portlet-instances.xml</literal> files</entry> + <entry>Selected</entry> + </row> + + <row> + <entry>If Exists</entry> + <entry>Select one of two options: + <itemizedlist> + <listitem><para><emphasis>overwrite</emphasis> - destroys the existing object and creates a new one based on the content of the deployment</para></listitem> + <listitem><para><emphasis>keep</emphasis> - maintains the existing object deployment or creates a new one if it does not exist</para></listitem> + </itemizedlist> + </entry> + <entry>overwrite</entry> + </row> + + <row> + <entry>Instance Name</entry> + <entry>Enter a name of the portlet instance that the portlet window represents</entry> + <entry>[Portlet class name]Instance</entry> + </row> + + <row> + <entry>Page Name</entry> + <entry>If set, the portlet page is created with the name defined</entry> + <entry>&lt;blank&gt;</entry> + </row> + + <row> + <entry>Window Name</entry> + <entry>Enter a name of the portlet window</entry> + <entry>[Portlet class name]Window</entry> + </row> + + <row> + <entry>Parent Reference</entry> + <entry> + <para>Define a reference to the parent object. The syntax for this element is <literal>[portal-instance].[portal-page]</literal>.</para> + <para>For example, <literal>default.default</literal> means that the window appears on the default page, in the default portal.</para> + </entry> + <entry>default.default</entry> + </row> + + <row> + <entry>Region</entry> + <entry>Specify the region where the window should appear on the page</entry> + <entry>center</entry> + </row> + + <row> + <entry>Height</entry> + <entry>Define the height of the window</entry> + <entry>1</entry> + </row> + + <row> + <entry>Initial Window State</entry> + <entry>Set the window state indicator by selecting one of three states defined by the JSR-168 specification: + <itemizedlist> + <listitem><para><emphasis>normal</emphasis> - a portlet shares this page with other portlets</para></listitem> + <listitem><para><emphasis>minimized</emphasis> - a portlet may show very little information or none at all</para></listitem> + <listitem><para><emphasis>maximized</emphasis> - a portlet may be the only portlet displayed on this page</para></listitem> + </itemizedlist> + </entry> + <entry>maximized</entry> + </row> + </tbody> + </tgroup> + </table> + </listitem> + </orderedlist> + </section> + + <section id="jsf_seam_portlet_wizard"> + <title>JSF/Seam Portlet Wizard</title> + + <para>The <property>JSF/Seam Portlet</property> wizard, that is merged into one JSF and Seam Portlet wizards, helps you create a + JSF/Seam portlet that uses the <property>JBoss Portlet Bridge</property> libraries. The default values in this wizard + depend on the configuration set for the project. For instance, if you set the JSF configuration, the default values in this wizard will be + as for a JSF portlet.</para> + + <para>The <property>JSF/Seam Portlet</property> wizard could be started from the <emphasis><property>File</property></emphasis> or + context menu of your project by following to + <emphasis><property>New &gt; Other &gt; JBoss Tools Web &gt; Portlet &gt; JSF/Seam Portlet</property>.</emphasis></para> + + <para>The wizard includes three pages to adjust JSF/Seam portlet setting:</para> + + <orderedlist> + <listitem> + <para>The first wizard page asks to select a project to add JSF/Seam portlet and set a class file destination.</para> + + <figure> + <title>First Page of the JSF Portlet Wizard</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/reference/jsf_seam_portlet1.png"/> + </imageobject> + </mediaobject> + </figure> + + <table> + <title>JSF/Seam Portlet Wizard. First Page Options.</title> + <tgroup cols="3"> + <colspec colnum="1" align="left" colwidth="1*"/> + <colspec colnum="2" align="left" colwidth="3*"/> + <colspec colnum="3" align="left" colwidth="1*"/> + + <thead> + <row> + <entry>Option</entry> + <entry>Description</entry> + <entry>Default</entry> + </row> + </thead> + <tbody> + <row> + <entry>Project</entry> + <entry>Select the project to add a new JSF/Seam portlet</entry> + <entry>The project selected when the wizard has been started</entry> + </row> + + <row> + <entry>Class name</entry> + <entry>Type or click <emphasis><property>Browse</property></emphasis> to select a class for a JSF/Seam portlet</entry> + <entry>javax.portlet.faces.GenericFacesPortlet</entry> + </row> + </tbody> + </tgroup> + </table> + </listitem> + + <listitem> + <para>The second page allows to configure a portlet deployment descriptors.</para> + + <figure> + <title>Second Page of the JSF Portlet Wizard</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/reference/jsf_seam_portlet2.png"/> + </imageobject> + </mediaobject> + </figure> + + <table> + <title>JSF/Seam Portlet Wizard. Second Page Options.</title> + <tgroup cols="3"> + <colspec colnum="1" align="left" colwidth="1*"/> + <colspec colnum="2" align="left" colwidth="3*"/> + <colspec colnum="3" align="left" colwidth="1*"/> + + <thead> + <row> + <entry>Option</entry> + <entry>Description</entry> + <entry>Default (JSF / Seam)</entry> + </row> + </thead> + <tbody> + <row> + <entry>Name</entry> + <entry>Enter the portlet name. It does not have to be the portlet class name.</entry> + <entry>riPortlet / seamPortlet</entry> + </row> + + <row> + <entry>Display name</entry> + <entry>Enter the display name of the Java portlet</entry> + <entry>JBoss JSF Portlet / JBoss Seam Portlet</entry> + </row> + + <row> + <entry>Title</entry> + <entry>Enter the title of the portlet</entry> + <entry>JBoss JSF Portlet / JBoss Seam Portlet</entry> + </row> + + <row> + <entry>Description</entry> + <entry>Enter the description of the portlet&apos;s function</entry> + <entry>&lt;blank&gt;</entry> + </row> + + <row> + <entry>Portlet Modes</entry> + <entry>Select one or more of three modes defined by the JSR-286 specification: + <itemizedlist> + <listitem><para><emphasis>View</emphasis> - generates markup reflecting the current state of the portlet</para></listitem> + <listitem><para><emphasis>Edit</emphasis> - allows customizing the behavior of the portlet</para></listitem> + <listitem><para><emphasis>Help</emphasis> - provides an information on how to use the portlet</para></listitem> + </itemizedlist> + </entry> + <entry>View, Edit, Help / View</entry> + </row> + + <row> + <entry>Initialization Parameters</entry> + <entry>Specify initialization parameters to create an initial state inside your portlet class. Click + <emphasis><property>Add</property></emphasis> and fill in the + <emphasis><property>Name</property>,</emphasis> <emphasis><property>Value</property></emphasis> and + <emphasis><property>Description</property></emphasis> (optional) fields to set a parameter.</entry> + <entry>javax.portlet.faces.defaultViewId.view, javax.portlet.faces.defaultViewId.edit, + javax.portlet.faces.defaultViewId.help / javax.portlet.faces.defaultViewId.view</entry> + </row> + </tbody> + </tgroup> + </table> + </listitem> + + <listitem> + <para>The last wizard page helps you configure the JBoss Portlet specific information.</para> + + <figure> + <title>Third Page of the JSF Portlet Wizard</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/reference/jsf_seam_portlet3.png"/> + </imageobject> + </mediaobject> + </figure> + + <table> + <title>JSF/Seam Portlet Wizard. Third Page Options.</title> + <tgroup cols="3"> + <colspec colnum="1" align="left" colwidth="1*"/> + <colspec colnum="2" align="left" colwidth="3*"/> + <colspec colnum="3" align="left" colwidth="1*"/> + + <thead> + <row> + <entry>Option</entry> + <entry>Description</entry> + <entry>Default (JSF / Seam)</entry> + </row> + </thead> + <tbody> + <row> + <entry>Create Portlet Instance</entry> + <entry>Clear the <emphasis><property>Create Portlet Instance</property></emphasis> check box, + if you don&apos;t wont the wizard to create the deployment elements + in the <literal>default-object.xml</literal> and <literal> + portlet-instances.xml</literal> files</entry> + <entry>Selected</entry> + </row> + + <row> + <entry>If Exists</entry> + <entry>Select one of two options: + <itemizedlist> + <listitem><para><emphasis>overwrite</emphasis> - destroys the existing object and creates a new one based on the content of the deployment</para></listitem> + <listitem><para><emphasis>keep</emphasis> - maintains the existing object deployment or creates a new one if it does not exist</para></listitem> + </itemizedlist> + </entry> + <entry>overwrite</entry> + </row> + + <row> + <entry>Instance Name</entry> + <entry>Enter a name of the portlet instance that the portlet window represents</entry> + <entry>JSFPortletInstance / SeamPortletInstance</entry> + </row> + + <row> + <entry>Page Name</entry> + <entry>If set, the portlet page is created with the name defined</entry> + <entry>JSFPortlet / SeamPortlet</entry> + </row> + + <row> + <entry>Window Name</entry> + <entry>Enter a name of the portlet window</entry> + <entry>JSFPortletWindow / SeamPortletWindow</entry> + </row> + + <row> + <entry>Parent Reference</entry> + <entry> + <para>Define a reference to the parent object.</para> + <para>For example, <literal>default</literal> means that the page appears in the default portal.</para> + </entry> + <entry>default</entry> + </row> + + <row> + <entry>Region</entry> + <entry>Specify the region where the window should appear on the page</entry> + <entry>center</entry> + </row> + + <row> + <entry>Height</entry> + <entry>Define the height of the window</entry> + <entry>1</entry> + </row> + + <row> + <entry>Initial Window State</entry> + <entry>Set the window state indicator by selecting one of three states defined by the JSR-168 specification: + <itemizedlist> + <listitem><para><emphasis>normal</emphasis> - a portlet shares this page with other portlets</para></listitem> + <listitem><para><emphasis>minimized</emphasis> - a portlet may show very little information or none at all</para></listitem> + <listitem><para><emphasis>maximized</emphasis> - a portlet may be the only portlet displayed on this page</para></listitem> + </itemizedlist> + </entry> + <entry>maximized</entry> + </row> + + <row> + <entry>Create JBoss Application</entry> + <entry> + <para>Select to add the <literal>jboss-app.xml</literal> descriptor.</para> + <para><emphasis>riPortletApp / seamPortletApp</emphasis> - the default name of the JBoss application. You can change it by + typing a new one in the <emphasis><property>JBoss Application Name</property></emphasis> field.</para> + </entry> + <entry>Selected</entry> + </row> + + <row> + <entry>Add the jboss-portlet.xml file</entry> + <entry>Select to create the <literal>jboss-portlet.xml</literal> file</entry> + <entry>Selected</entry> + </row> + + <row> + <entry>Copy JSF Templates</entry> + <entry>Select to add the folder with JSF templates (<literal>edit.jsp</literal>, <literal>help.jsp</literal>, + <literal>view.jsp</literal>) to the project</entry> + <entry>Cleared</entry> + </row> + </tbody> + </tgroup> + </table> + </listitem> + </orderedlist> + </section> + </section> + + <section id="preferences"> + <title>JBoss Portlet Preferences</title> + + <para>To open <property>JBoss Portlet Preferences</property> property sheet, go to <emphasis> + <property>Window &gt; Preferences</property> + </emphasis> and then <emphasis> + <property>JBoss Tools &gt; JBoss Portlet</property>. + </emphasis></para> + + <figure> + <title>JBoss Runtime Preferences</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/reference/portlet_preferences.png"/> + </imageobject> + </mediaobject> + </figure> + + <para>The <emphasis> + <property>Check runtimes for Portlet Components</property> + </emphasis> option makes the JBoss Portlet functionality always visible no matter what the runtime is set. By default the option is checked.</para> + </section> +</chapter> \ No newline at end of file Added: branches/jbosstools-3.1.x/portlet/docs/reference/en-US/seam_portlet.xml =================================================================== --- branches/jbosstools-3.1.x/portlet/docs/reference/en-US/seam_portlet.xml (rev 0) +++ branches/jbosstools-3.1.x/portlet/docs/reference/en-US/seam_portlet.xml 2010-03-12 00:23:23 UTC (rev 20778) @@ -0,0 +1,220 @@ +<?xml version="1.0" encoding="UTF-8"?> +<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>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 (<link linkend="create_dyn_web_proj_seam">the steps to proceed</link>)</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 (<link linkend="create_seam_proj">the steps to proceed</link>)</para></listitem> + </orderedlist> + + <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> + + <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> + + <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 + <link linkend="jboss_core_portlet">&quot;Creating a Web Project with JBoss Portlet Capabilities&quot;</link> 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> + + <tip> + <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> + </tip> + + <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>On the <property>Jboss Portlet Capabilities</property> page, select + <emphasis><property>Portlet Target Runtime Provider</property></emphasis> as the portlet implementation library.</para> + + <tip> + <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"... + </tip> + </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>On the <property>Seam Facet</property> page, set a Seam runtime and + a connection profile.</para> + + <tip> + <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, + Seam Dev Tools Reference Guide.</para> + </tip> + + <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> + + <tip> + <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> + </tip> + + <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> + + <listitem> + <para>Hit <emphasis><property>Finish</property></emphasis> to complete the project creation.</para> + </listitem> + </orderedlist> + </section> + + <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> + + <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> + + <listitem> + <para>Next steps are the same as in the <link + linkend="create_dyn_web_proj_seam">&quot;Creating a Dynamic Web Project with Seam and JBoss Portlet Capabilities&quot;</link> + 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> + + <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 + <link linkend="jsf_seam_portlet_wizard">&quot;JSF/Seam Portlet Wizard&quot;</link> in the guide reference). + As the Seam configuration is set for the project, the wizard puts the values as for Seam portlet.</para> + + <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>To deploy and run the portlet on <property>JBoss Portal</property> complete the steps described in the + <link linkend="deploying_to_portal">&quot;Deploying a Portlet to JBoss Portal&quot;</link> 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> +</section> Added: branches/jbosstools-3.1.x/portlet/docs/reference/en-US/starting_project.xml =================================================================== --- branches/jbosstools-3.1.x/portlet/docs/reference/en-US/starting_project.xml (rev 0) +++ branches/jbosstools-3.1.x/portlet/docs/reference/en-US/starting_project.xml 2010-03-12 00:23:23 UTC (rev 20778) @@ -0,0 +1,297 @@ +<?xml version="1.0" encoding="UTF-8"?> +<section id="starting_project"> + <title>Creating and Deploying a Java Portlet</title> + + <para>This chapter shows how to create a Dynamic Web Project, add a Java + Portlet to it and deploy it to the <property>JBoss Portal</property>.</para> + + <section id="jboss_core_portlet"> + <title>Creating a Web Project with JBoss Portlet Capabilities</title> + <para>Fallow the next procedure to create a Web project with JBoss Portlet capabilities pointed to the JBoss Portal runtime.</para> + + <orderedlist> + <listitem> + <para>Go to <emphasis> + <property>File > New > Dynamic Web Project</property> + </emphasis> if you are in the <property>Web</property> perspective or <emphasis><property>File > + New > Other > Web > Dynamic Web Project</property></emphasis> in any other perspective. + The <property>New Dynamic Web Project</property> wizard appears.</para> + + <figure> + <title>New Dynamic Web Project</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/starting_project/starting_project_1.png"/> + </imageobject> + </mediaobject> + </figure> + </listitem> + + <listitem><para>Specify the name of the project.</para></listitem> + + <listitem> + <para>Click <emphasis> + <property>New</property> + </emphasis> in the <emphasis> + <property>Target Runtime</property> + </emphasis> area to create a JBoss Portal runtime. Choose <emphasis> + <property>JBoss Community &gt; JBoss 4.2 Runtime</property> + </emphasis> and select the <emphasis> + <property>Create a new local server</property> + </emphasis> check box below. Click <emphasis> + <property>Next</property>.</emphasis></para> + + <figure> + <title>New Server Runtime</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/starting_project/starting_project_2.png"/> + </imageobject> + </mediaobject> + </figure> + </listitem> + + <listitem> + <para>The <property>New Server Runtime Environment</property> wizard appears. In the <emphasis> + <property>Name</property></emphasis> field, type <emphasis> + <property>JBoss Portal 2.7 Runtime</property>, + </emphasis> and then use the <emphasis> + <property>Browse</property></emphasis> button to point to the location of JBoss Portal + JBoss AS extracted. Click <emphasis> + <property>Next</property></emphasis> to proceed.</para> + + <figure> + <title>New Server Runtime Environment</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/starting_project/server_runtime_environment.png"/> + </imageobject> + </mediaobject> + </figure> + </listitem> + + <listitem> + <para>At this point a new JBoss Server instance will be created. On the next page you can verify the + runtime information defined. If something is incorrect, press <emphasis> + <property>Back</property> + </emphasis> to return to the previous wizard page. Click <emphasis> + <property>Finish</property>.</emphasis></para> + + <figure> + <title>Target Server</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/starting_project/starting_project_3.png"/> + </imageobject> + </mediaobject> + </figure> + </listitem> + + <listitem> + <para>Click <emphasis> + <property>Modify</property> + </emphasis> in the <emphasis><property>Configuration</property></emphasis> area to enable + a portlet facet for the project.</para> + + <figure> + <title>Setting the Project Configuration</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/starting_project/starting_project_4.png"/> + </imageobject> + </mediaobject> + </figure> + </listitem> + + <listitem> + <para>In the <property>Project Facets</property> dialog, check <emphasis> + <property>JBoss Core Portlet</property> + </emphasis> and press <emphasis> + <property>OK</property> + </emphasis>.</para> + + <figure> + <title>Enabling the JBoss Core Portlet Facet</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/starting_project/starting_project_4_a.png"/> + </imageobject> + </mediaobject> + </figure> + + <note> + <title>Note:</title> + <para>If the portlet libraries aren&apos;t available in the runtime you targeted, + <emphasis> + <property>JBoss Portlets</property></emphasis> facets will be hidden on this page.</para> + <para>To make them always visible no matter what the runtime is set, you should enable the appropriate option in + <link linkend="preferences">JBoss Portlet Preferences</link>.</para> + </note> + </listitem> + + <listitem> + <para>The <property>Java</property> and <property>Web Module</property> pages are for configuring Java and Web modules in the project. + Here all values are set, so leave everything as it is.</para> + </listitem> + + <listitem> + <para>The last wizard page will ask you to add JBoss Portlet capabilities to the + project. Select <emphasis> + <property>Portlet Target Runtime Provider</property></emphasis> and click <emphasis> + <property>Finish</property></emphasis> to complete the project creation.</para> + + <figure> + <title>Including the Portlet Libraries Provided by Target Runtime</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/starting_project/portlet_capabilities6.png"/> + </imageobject> + </mediaobject> + </figure> + + <note> + <title>Note:</title> + <para>All types available under <emphasis> + <property>Portlet Implementation Library</property></emphasis> are fully described in the Wiki article at: + <ulink url="http://www.jboss.org/community/wiki/PortletFacetLibraries"... + </note> + </listitem> + </orderedlist> + + <para>As the result, <property>JBoss Portlet Tools</property> adds <emphasis> + <property>JBoss Core Portlet</property></emphasis> facet to the project, + creates an empty <literal>portlet.xml</literal> file and adds the JBoss Portlet library to the project classpath.</para> + + <figure> + <title>Portlet Project Structure Overview</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/starting_project/starting_project_6.png"/> + </imageobject> + </mediaobject> + </figure> + </section> + + <section id="adding_java_portlet"> + <title>Adding a Java Portlet to a Web Project</title> + + <para>At the previous section you have created a web project with JBoss Portlet capabilities. + The next steps will show you how to add a new Java portlet to the project.</para> + + <orderedlist> + <listitem> + <para>Right-click the project and follow to <emphasis> + <property>New &gt; Other &gt; JBoss Tools Web &gt; Portlet &gt; Java + Portlet</property>.</emphasis></para> + + <figure> + <title>New Java Portlet</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/starting_project/starting_project_7.png"/> + </imageobject> + </mediaobject> + </figure> + </listitem> + + <listitem> + <para>The <property>Create Portlet</property> wizard starts (for information about the wizard options, see + <link linkend="java_portlet_wizard">&quot;Java Portlet Wizard&quot;</link> in the guide reference). + The wizard fills in the <emphasis><property>Project</property></emphasis> and <emphasis> + <property>Source Folder</property></emphasis> fields for you. You should specify a Java package and a class name + (for instance, <emphasis> + <property>org.example</property></emphasis> and <emphasis> + <property>TestPortlet</property></emphasis>). Then click <emphasis> + <property>Next</property> + </emphasis>.</para> + + <figure> + <title>Specifying Class File Destination</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/starting_project/starting_project_8.png"/> + </imageobject> + </mediaobject> + </figure> + </listitem> + + <listitem><para>You may leave the next three pages with default values, on the last one hit <emphasis> + <property>Finish</property>.</emphasis></para> + </listitem> + </orderedlist> + + <para>Once a Java portlet is created, new resources are added to the project structure: a Java portlet class (<literal>TestPortlet.java</literal>), + <literal>default-object.xml</literal> and <literal>portlet-instances.xml</literal> files and the <literal>portlet.xml</literal> descriptor is updated as well.</para> + + <figure> + <title>Structure of the Project with a Java Portlet</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/starting_project/starting_project_12.png"/> + </imageobject> + </mediaobject> + </figure> + + <para>Thus, now the project is ready to be built and deployed.</para> + </section> + + <section id="deploying_to_portal"> + <title>Deploying a Portlet to JBoss Portal</title> + + <para>You can deploy a portlet project in the way you deploy any other web application.</para> + + <orderedlist> + <listitem> + <para>Right-click the project and do <emphasis> + <property>Run As &gt; Run On Server</property>. + </emphasis> The <property>Run On Server</property> wizard starts.</para> + + <figure> + <title>Running the Java Portlet on Server</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/starting_project/runOnServer.png"/> + </imageobject> + </mediaobject> + </figure> + </listitem> + + <listitem> + <para>Select <emphasis><property>JBoss Portal 2.7 Server</property></emphasis> created before and click <emphasis><property>Next</property>.</emphasis></para> + </listitem> + + <listitem> + <para>On the <emphasis> + <property>Add and Remove</property> + </emphasis> page move the created project to the right and click <emphasis> + <property>Finish</property>.</emphasis></para> + + <figure> + <title>Deploying the Portlet Application</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/starting_project/starting_project_13.png"/> + </imageobject> + </mediaobject> + </figure> + + <para>It will deploy the portlet application and start <property>JBoss + AS</property>.</para> + </listitem> + + <listitem> + <para>Use the <emphasis>http://localhost:8080/portal/portal/default/default</emphasis> URL to see your + portlet in the browser.</para> + + <figure> + <title>Java Portlet in the Browser Window</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/starting_project/starting_project_14.png"/> + </imageobject> + </mediaobject> + </figure> + </listitem> + </orderedlist> + </section> + +</section> Added: branches/jbosstools-3.1.x/portlet/docs/reference/en-US/summary.xml =================================================================== --- branches/jbosstools-3.1.x/portlet/docs/reference/en-US/summary.xml (rev 0) +++ branches/jbosstools-3.1.x/portlet/docs/reference/en-US/summary.xml 2010-03-12 00:23:23 UTC (rev 20778) @@ -0,0 +1,56 @@ +<?xml version="1.0" encoding="UTF-8"?> +<chapter id="summary" xreflabel="summary"> + <?dbhtml filename="summary.html"?> + <title>Summary</title> + + <para>In conclusion, with this document you could easily get started with <property>JBoss + Portlet Tools</property>. + The above chapters walked you through the steps on how to organize a web project with + JBoss Portlet capabilities enabled, create a Java portlet, JSF or Seam portlet and deploy them to <property>JBoss + Portal</property>. The document also includes the reference of <property>JBoss Portlet Tools</property> features.</para> + + <para>If you have questions or suggestions concerned both the documentation and tools behavior, you are welcome + to <ulink url="http://www.jboss.com/index.html?module=bb&amp;op=viewforum&... Tools Users forum</ulink>.</para> + + <para>Please, use <ulink url="https://jira.jboss.org/jira/browse/JBDS">Jira</ulink... to report bugs and requests on documentation.</para> + + <section id="rel_resources"> + <title>Other Relevant Resources on the Topic</title> + + <itemizedlist> + <listitem> + <para> + JBoss Portal home page: <ulink url="http://www.jboss.org/jbossportal/">http://www.jboss.org... + </para> + </listitem> + + <listitem> + <para> + JBoss Portal Wiki at: <ulink url="http://wiki.jboss.org/wiki/JBossPortal">http://wiki.jbo... + </para> + </listitem> + + <listitem> + <para>JBoss Portal documentation set at: <ulink url="http://docs.jboss.org/jbportal/">http://docs.jboss.org/... + </listitem> + + <listitem> + <para> + JBoss Tools home page at: <ulink url="http://www.jboss.org/tools/">http://www.jboss.org/tools... + </para> + </listitem> + + <listitem> + <para> + The latest JBossTools/JBDS documentation builds at: <ulink url="http://download.jboss.org/jbosstools/nightly-docs/">htt... + </para> + </listitem> + + <listitem> + <para>JBoss Developer Studio/JBoss Tools release documentation you can + find at <ulink url="http://docs.jboss.org/tools/">http://docs.jboss.org/too... in the corresponding release directory.</para> + </listitem> + </itemizedlist> + + </section> +</chapter> \ No newline at end of file Modified: branches/jbosstools-3.1.x/portlet/docs/reference/pom.xml =================================================================== --- branches/jbosstools-3.1.x/portlet/docs/reference/pom.xml 2010-03-12 00:20:34 UTC (rev 20777) +++ branches/jbosstools-3.1.x/portlet/docs/reference/pom.xml 2010-03-12 00:23:23 UTC (rev 20778) @@ -32,7 +32,7 @@ <profile> <id>releaseJBDS</id> <properties> - <master>master.xml</master> + <master>master_output.xml</master> <xsl-single>classpath:/xslt/com/jboss/tools/xhtml-single-release.xsl</xsl-single> <xsl-chunked>classpath:/xslt/com/jboss/tools/xhtml-release.xsl</xsl-chunked> <xsl-pdf>classpath:/xslt/com/jboss/tools/pdf.xsl</xsl-pdf> @@ -99,9 +99,9 @@ <configuration> <sourceDocumentName>${master}</sourceDocumentName> - <sourceDirectory>${pom.basedir}/en</sourceDirectory> + <sourceDirectory>${pom.basedir}/en-US</sourceDirectory> <imageResource> - <directory>${pom.basedir}/en</directory> + <directory>${pom.basedir}/en-US</directory> <includes> <include>images/**/*</include> </includes> Added: branches/jbosstools-3.1.x/portlet/docs/reference/publican.cfg =================================================================== --- branches/jbosstools-3.1.x/portlet/docs/reference/publican.cfg (rev 0) +++ branches/jbosstools-3.1.x/portlet/docs/reference/publican.cfg 2010-03-12 00:23:23 UTC (rev 20778) @@ -0,0 +1,7 @@ +# Config::Simple 4.59 +# Fri Nov 20 13:19:45 2009 + +xml_lang: en-US +type: Book +brand: JBoss +