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

Author: mcaspers Date: 2011-01-17 23:58:56 -0500 (Mon, 17 Jan 2011) New Revision: 28339 Modified: trunk/portlet/docs/reference/en-US/intro.xml trunk/portlet/docs/reference/en-US/starting_project.xml Log: General Updates Modified: trunk/portlet/docs/reference/en-US/intro.xml =================================================================== --- trunk/portlet/docs/reference/en-US/intro.xml 2011-01-18 04:19:53 UTC (rev 28338) +++ trunk/portlet/docs/reference/en-US/intro.xml 2011-01-18 04:58:56 UTC (rev 28339) @@ -1,96 +1,94 @@ <?xml version="1.0" encoding="UTF-8"?> <chapter id="intro"> - <?dbhtml filename="intro.html"?> - <title>Introduction</title> + <?dbhtml filename="intro.html"?> + <title>Introduction</title> + + <para> + Starting from 3.0.0.Alpha1 version, the JBoss set of plugins includes tools for supporting <property>JBoss Portal</property> and JSR-186/JSR-286 portlets. Thus, this guide provides instructions on how to get started and manage <property>JBoss Portlet Tools</property>. + </para> + <section> + <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> can be found by visiting its home page at: <ulink url="http://www.jboss.org/jbossportal/">http://www.jboss.org...;. + </para> + + <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> - <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> - <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... + <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 <xref linkend="portlet_tools_tasks"/>). 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>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> + <para>The next table lists key features supplied by <property>JBoss Portlet Tools</property>.</para> - <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 <xref linkend="portlet_tools_tasks"/>). 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"> - <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*"/> - <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> - <thead> - <row> - <entry>Feature</entry> - <entry>Benefit</entry> - <entry>Chapter</entry> - </row> - </thead> + <tbody> - <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> + <xref linkend="portlet_tools_tasks"/> + </entry> + </row> - <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> - <xref linkend="portlet_tools_tasks"/> - </entry> - </row> + <row> + <entry> + <para>Java Portlet wizard</para> + </entry> - <row> - <entry> - <para>Java Portlet wizard</para> - </entry> + <entry> + <para>The wizard helps create a JSR-186/JSR-286 compliant portlets</para> + </entry> + <entry> + <xref linkend="java_portlet_wizard"/> + </entry> + </row> - <entry> - <para>The wizard helps create a JSR-186/JSR-286 compliant - portlets</para> - </entry> - <entry> - <xref linkend="java_portlet_wizard"/> - </entry> - </row> - - <row> - <entry> - <para>JSF/Seam Portlet wizard</para> - </entry> - <entry> - <para>This wizard helps create JSF/Seam portlets</para> - </entry> - <entry> - <xref linkend="jsf_seam_portlet_wizard"/> - </entry> - </row> - </tbody> - </tgroup> - </table> - </section> + <row> + <entry> + <para>JSF/Seam Portlet wizard</para> + </entry> + <entry> + <para>This wizard helps create JSF/Seam portlets</para> + </entry> + <entry> + <xref linkend="jsf_seam_portlet_wizard"/> + </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> + <para> + <property>JBoss Portlet Tools</property> needs the following minimum requirements:</para> <itemizedlist> <listitem> @@ -100,24 +98,28 @@ <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... + <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... + </para> <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> + <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... + <para>JBoss Portlet Bridge (optionally) from: <ulink url="http://www.jboss.org/portletbridge/downloads.html">http... + </para> </listitem> </itemizedlist> - - <para><property>JBoss Portlet Tools</property> is included as part of <property>JBoss Tools</property> project. + + <para> + <property>JBoss Portlet Tools</property> is included as part of the <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> + for <property>JBoss Tools</property> installation instructions.</para> + </section> </chapter> Modified: trunk/portlet/docs/reference/en-US/starting_project.xml =================================================================== --- trunk/portlet/docs/reference/en-US/starting_project.xml 2011-01-18 04:19:53 UTC (rev 28338) +++ trunk/portlet/docs/reference/en-US/starting_project.xml 2011-01-18 04:58:56 UTC (rev 28339) @@ -2,20 +2,16 @@ <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 + <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> + <para>Select <menuchoice><guimenuitem>File</guimenuitem><guimenuitem>New</guimenuitem><guimenuitem>Dynamic Web Project</guimenuitem></menuchoice> if you are in the <property>Web</property> perspective or select <menuchoice><guimenuitem>File</guimenuitem><guimenuitem>New</guimenuitem><guimenuitem>Other</guimenuitem><guimenuitem>Web</guimenuitem><guimenuitem>Dynamic Web Project</guimenuitem></menuchoice> in any other perspective. This will display the <property>New Dynamic Web Project</property> wizard.</para> <figure> <title>New Dynamic Web Project</title> @@ -27,19 +23,14 @@ </figure> </listitem> - <listitem><para>Specify the name of the project.</para></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> + <para>Click the <guibutton>New</guibutton> 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 the <guibutton>Next</guibutton> button. + </para> <figure> <title>New Server Runtime</title> @@ -52,12 +43,7 @@ </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> + <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 <guibutton>Browse</guibutton> button to point to the location of JBoss Portal + JBoss AS extracted. Click <guibutton>Next</guibutton> button to proceed.</para> <figure> <title>New Server Runtime Environment</title> @@ -73,8 +59,9 @@ <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> + </emphasis> to return to the previous wizard page. Click <emphasis> + <property>Finish</property>.</emphasis> + </para> <figure> <title>Target Server</title> @@ -89,7 +76,8 @@ <listitem> <para>Click <emphasis> <property>Modify</property> - </emphasis> in the <emphasis><property>Configuration</property></emphasis> area to enable + </emphasis> in the <emphasis><property>Configuration</property> + </emphasis> area to enable a portlet facet for the project.</para> <figure> @@ -105,9 +93,9 @@ <listitem> <para>In the <property>Project Facets</property> dialog, check <emphasis> <property>JBoss Core Portlet</property> - </emphasis> and press <emphasis> + </emphasis> and press <emphasis> <property>OK</property> - </emphasis>.</para> + </emphasis>.</para> <figure> <title>Enabling the JBoss Core Portlet Facet</title> @@ -122,7 +110,8 @@ <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> + <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 <xref linkend="preferences"/>.</para> </note> @@ -136,8 +125,10 @@ <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> + <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> @@ -151,14 +142,16 @@ <note> <title>Note:</title> <para>All types available under <emphasis> - <property>Portlet Implementation Library</property></emphasis> are fully described in the Wiki article at: + <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, + <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> @@ -169,19 +162,20 @@ </imageobject> </mediaobject> </figure> - </section> + </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. + <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> + <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> + Portlet</property>.</emphasis> + </para> <figure> <title>New Java Portlet</title> @@ -196,13 +190,17 @@ <listitem> <para>The <property>Create Portlet</property> wizard starts (for information about the wizard options, see <xref linkend="java_portlet_wizard"/> 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 + 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>org.example</property> + </emphasis> and <emphasis> + <property>TestPortlet</property> + </emphasis>). Then click <emphasis> <property>Next</property> - </emphasis>.</para> + </emphasis>.</para> <figure> <title>Specifying Class File Destination</title> @@ -214,84 +212,89 @@ </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> + <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>), + <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> + <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> + <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> + <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> + <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> + <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> + <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>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> + <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> + </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> + <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 + <para>It will deploy the portlet application and start <property>JBoss AS</property>.</para> - </listitem> + </listitem> - <listitem> - <para>Use the <emphasis>http://localhost:8080/portal/portal/default/default</emphasis> URL to see your + <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> + <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>