[jbosstools-commits] JBoss Tools SVN: r12068 - trunk/portlet/docs/reference/en/modules.

Author: ochikvina Date: 2008-11-26 06:32:51 -0500 (Wed, 26 Nov 2008) New Revision: 12068 Added: trunk/portlet/docs/reference/en/modules/jsf_portlet.xml trunk/portlet/docs/reference/en/modules/portlets_to_nonWTP_projects.xml trunk/portlet/docs/reference/en/modules/seam_portlet.xml Log: https://jira.jboss.org/jira/browse/JBDS-479 - restructuring and adding new info; Added: trunk/portlet/docs/reference/en/modules/jsf_portlet.xml =================================================================== --- trunk/portlet/docs/reference/en/modules/jsf_portlet.xml (rev 0) +++ trunk/portlet/docs/reference/en/modules/jsf_portlet.xml 2008-11-26 11:32:51 UTC (rev 12068) @@ -0,0 +1,190 @@ +<?xml version="1.0" encoding="UTF-8"?> +<chapter id="jsf_portlet" xreflabel="jsf_portlet"> + <?dbhtml filename="jsf_portlet.html"?> + <title>Creating JSF Portlet</title> + + <para>This chapter will explain how you can configure JSF Portlet within Dynamic Web + Project and JSF Project by using the wizards <property>JBoss Tools</property> provides.</para> + + <section id="jsf_portlet1"> + <title>Adding JSF Portlet to Dynamic Web Project</title> + + <para>To add JSF Portlet to a Dynamic Web Project, you should set the Configuration to <emphasis> + <property>JavaServer Faces v1.1 Project</property> + </emphasis> or <emphasis> + <property>JavaServer Faces v1.2 Project</property> + </emphasis> and configure the JSF Portlet Facets in the <property>New Dynamic Web + Project wizard</property> by clicking the <emphasis> + <property>Modify</property> + </emphasis> button.</para> + + <figure> + <title>Setting the JSF Configuration</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/jsf_portlet/jsf_portlet1.png"/> + </imageobject> + </mediaobject> + </figure> + + <para>On the Project Facets dialog you should select <property>JBoss Core Portlet</property> + and <property>JBoss JSF Portlet</property> check boxes.</para> + + <figure> + <title>Enabling the Portlet Facets</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/jsf_portlet/jsf_portlet2.png"/> + </imageobject> + </mediaobject> + </figure> + + <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> + + <para>To support Portlets in JSF/Seam applications <property>JBoss Tools</property> works + with <property>JBoss Portlet Bridge</property>. Thus on the next page you should add JSF Portlet + capabilities by pointing to the Portletbridge Runtime location.</para> + + <figure> + <title>JSF Capabilities</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/jsf_portlet/jsf_portlet4.png"/> + </imageobject> + </mediaobject> + </figure> + + <tip> + <title>Tip:</title> + + <para>You can download JBoss Portlet Bridge 1.0.0.B4 from <ulink + url="http://www.jboss.org/portletbridge/download/">here</... + </tip> + + <para>Next click <emphasis> + <property>Finish</property> + </emphasis> to organize the Project.</para> + <para id="add_jsf_portlet">To add JSF Portlet to generated project you should call the + <property>Create Portlet wizard</property> by navigating to <emphasis> + <property>New > Other > JBoss Tools Web > Portlet > JSF/Seam + Portlet</property>.</emphasis></para> + + <figure> + <title>Calling New Portlet Wizard</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/jsf_portlet/jsf_portlet5.png"/> + </imageobject> + </mediaobject> + </figure> + + <para>As you see, the Seam and JSF Portlet wizards are merged into one. We set JSF + Configuration for the project, so default values in this wizard will be set as for a JSF + portlet.</para> + + <figure> + <title>Creating JSF Portlet</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/jsf_portlet/jsf_portlet6.png"/> + </imageobject> + </mediaobject> + </figure> + + <para>Click <emphasis> + <property>Finish</property> + </emphasis> to complete JSF Portlet creation. Now you can deploy the project the same + way as it was <link linkend="deploying_to_portal">described above</link>.</para> + + <para>In the Browser JSF Portlet looks as follows.</para> + + <figure> + <title>JSF Portlet in the Browser</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/jsf_portlet/jsf_portlet7.png"/> + </imageobject> + </mediaobject> + </figure> + </section> + + <section id="jsf_portlet_to_JSF_project"> + <title>Adding JSF Portlet to JSF Project</title> + + <para>How to organize a JSF Project you can find out in our <ulink + url="&jsfreflink;#new_jsf_project">JSF Tools Reference Guide</ulink>. Just + remember to point Target Runtime to JBoss Portal directory location.</para> + + <figure> + <title>Creating New JSF Project</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/jsf_portlet/jsf_portlet8.png"/> + </imageobject> + </mediaobject> + </figure> + + <para>Before adding a Portlet to the project you should enable necessary facets for it. + Right-click the created project and click <emphasis> + <property>Preferences</property> + </emphasis> to open the <property>Project Preferences</property> screen.</para> + <para>On the <property>Project Facets</property> page select the <emphasis> + <property>JBoss Core Portlet</property> + </emphasis> and <emphasis> + <property>JBoss JSF Portlet</property> + </emphasis> checkboxes. And then the screen will ask you to enable <emphasis> + <property>JavaServer Faces</property> + </emphasis> facet as well.</para> + + <figure> + <title>Project Facets</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/jsf_portlet/jsf_portlet9.png"/> + </imageobject> + </mediaobject> + </figure> + + <para>Notice, <emphasis> + <property>&quot;Further configuration required...&quot;</property> + </emphasis> warning appears at the bottom of the screen. It means that you should click + it to configure JSF and JSF Portlet Capabilities in the project.</para> + + <figure> + <title>JSF Capabilities</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/jsf_portlet/jsf_portlet10.png"/> + </imageobject> + </mediaobject> + </figure> + + <figure> + <title>Project Facets</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/jsf_portlet/jsf_portlet11.png"/> + </imageobject> + </mediaobject> + </figure> + + <para>After setting the path to Portletbridge Runtime location, click <emphasis> + <property>OK</property> + </emphasis> and then <emphasis> + <property>OK</property> + </emphasis> again.</para> + + <para>Now you can add JSF Portlet to the generated JSF Project. How to do it we showed in + <link linkend="add_jsf_portlet">the previous section</link>.</para> + </section> +</chapter> Added: trunk/portlet/docs/reference/en/modules/portlets_to_nonWTP_projects.xml =================================================================== --- trunk/portlet/docs/reference/en/modules/portlets_to_nonWTP_projects.xml (rev 0) +++ trunk/portlet/docs/reference/en/modules/portlets_to_nonWTP_projects.xml 2008-11-26 11:32:51 UTC (rev 12068) @@ -0,0 +1,25 @@ +<?xml version="1.0" encoding="UTF-8"?> +<chapter id="portlets_to_nonWTP_projects" xreflabel="portlets_to_nonWTP_projects"> + <?dbhtml filename="portlets_to_nonWTP_projects.html"?> + <title>Adding Portlets to non-WTP Projects</title> + + <para>Starting from <property>JBoss Tools 3.0.0.Beta1</property> version the JBoss Portlet + wizards no longer require a WTP project to be able to create Portlets.</para> + + <note> + <title>Note:</title> + <para>Please note, if the project does not have the proper portlet API jar's, the generated + classes will have compile errors.</para> + </note> + + <para>In conclusion, with this document you&apos;ve learnt how to get started with <property>JBoss + Portal</property> using <property>JBoss Tools</property> suite of Eclipse plugins. + The above chapters walked you through the steps on how to organize a web project with + portlets which includes a sample staff and deploy it onto the <property>JBoss + Portal</property>.</para> + + <para>If you still have questions or suggestions you are always welcome on our <ulink + url="http://www.jboss.com/index.html?module=bb&amp;op=viewforum&... + >Forum</ulink>. Your feedback will be very much appreciated.</para> + +</chapter> Added: trunk/portlet/docs/reference/en/modules/seam_portlet.xml =================================================================== --- trunk/portlet/docs/reference/en/modules/seam_portlet.xml (rev 0) +++ trunk/portlet/docs/reference/en/modules/seam_portlet.xml 2008-11-26 11:32:51 UTC (rev 12068) @@ -0,0 +1,139 @@ +<?xml version="1.0" encoding="UTF-8"?> +<chapter id="seam_portlet" xreflabel="seam_portlet"> + <?dbhtml filename="seam_portlet.html"?> + <title>Creating Seam Portlet</title> + + <para>This chapter covers the steps on how to configure Seam Portlet within Dynamic Web + Project and Seam Project by using the wizards <property>JBoss Tools</property> provides.</para> + + <section id="seam_portlet1"> + <title>Adding Seam Portlet to Dynamic Web Project</title> + + <para>To add Seam Portlet to a Dynamic Web Project first you should organize New Dynamic Web + Project with the Configuration setting to <emphasis> + <property>JBoss Seam Portlet Project v2.0</property>.</emphasis></para> + + <figure> + <title>Calling New Portlet Wizard</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/seam_portlet/seam_portlet1.png"/> + </imageobject> + </mediaobject> + </figure> + + <para>It will add all needed facets to your project. By clicking the <emphasis> + <property>Modify</property> + </emphasis> button you can observe the chosen configuration of facets as well as modify + it. As you can see, all JBoss Portlets are checked.</para> + + <figure> + <title>Project Facets</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/seam_portlet/seam_portlet2.png"/> + </imageobject> + </mediaobject> + </figure> + + <para>Next wizard pages are for adjusting the Project Web Modules and JSF Configuration. + They include default values, so you can skip them by pressing <emphasis> + <property>Next</property>.</emphasis></para> + + <para>On the <property>Seam Facet</property> page <ulink url="&seamlink;#seamFacet">set + Connection Profile</ulink> and hit <emphasis> + <property>Next</property>.</emphasis></para> + + <figure> + <title>Seam Facet Settings</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/seam_portlet/seam_portlet3.png"/> + </imageobject> + </mediaobject> + </figure> + + <para>Last wizard page will prompt you to set the path to Portletbridge Runtime + location.</para> + + <figure> + <title>Setting the Portletbridge Runtime</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/seam_portlet/seam_portlet4.png"/> + </imageobject> + </mediaobject> + </figure> + + <tip> + <title>Tip:</title> + + <para>Thus you should have JBoss Portlet Bridge downloaded and extracted somewhere on + your hard drive. You can download JBoss Portlet Bridge 1.0.0.B4 from <ulink + url="http://www.jboss.org/portletbridge/download/">here</... + </tip> + + <para>Now, to add Seam Portlet to the project you should follow to <emphasis> + <property>New > Other > JBoss Tools Web > Portlet > JSF/Seam + Portlet</property>.</emphasis> This will call the wizard for creating JSF/Seam + Portlets.</para> + + <figure> + <title>Calling the Create Portlet Wizard</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/seam_portlet/seam_portlet5.png"/> + </imageobject> + </mediaobject> + </figure> + + <para>As we set Seam Configuration for the Dynamic Web 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> + + <para>After creating the Seam Portlet, you should <link linkend="deploying_to_portal">deploy + the project to JBoss Portal</link> and start the Server. In a Browser + you&apos;ll see the following:</para> + + <figure> + <title>Seam Portlet in the Browser</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/seam_portlet/seam_portlet7.png"/> + </imageobject> + </mediaobject> + </figure> + </section> + + <section id="seam_portlet_to_seam_project"> + <title>Adding Seam Portlet to Seam Project</title> + + <para>First start a Seam Project by following to <emphasis> + <property>New > Other > Seam > Seam Web Project</property>. </emphasis> On the first + wizard page specify JBoss Portal directory location as <property>Target + Runtime</property> and <emphasis> + <property>JBoss Seam Portlet Project v2.0</property> + </emphasis> as <property>Configuration</property>.</para> + + <figure> + <title>Project Facets</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/seam_portlet/seam_portlet8.png"/> + </imageobject> + </mediaobject> + </figure> + + <para>Next steps will be the same as we did for the Dynamic Web Project in the <link + linkend="seam_portlet1">Adding Seam Portlet to Dynamic Web Project</link> + section.</para> + </section> +</chapter>