JBoss Tools SVN: r28343 - trunk/deltacloud/plugins/org.jboss.tools.deltacloud.ui/src/org/jboss/tools/internal/deltacloud/ui/wizards.
by jbosstools-commits@lists.jboss.org
Author: adietish
Date: 2011-01-18 05:20:07 -0500 (Tue, 18 Jan 2011)
New Revision: 28343
Modified:
trunk/deltacloud/plugins/org.jboss.tools.deltacloud.ui/src/org/jboss/tools/internal/deltacloud/ui/wizards/ManageKeysPage.java
Log:
added author
Modified: trunk/deltacloud/plugins/org.jboss.tools.deltacloud.ui/src/org/jboss/tools/internal/deltacloud/ui/wizards/ManageKeysPage.java
===================================================================
--- trunk/deltacloud/plugins/org.jboss.tools.deltacloud.ui/src/org/jboss/tools/internal/deltacloud/ui/wizards/ManageKeysPage.java 2011-01-18 05:51:43 UTC (rev 28342)
+++ trunk/deltacloud/plugins/org.jboss.tools.deltacloud.ui/src/org/jboss/tools/internal/deltacloud/ui/wizards/ManageKeysPage.java 2011-01-18 10:20:07 UTC (rev 28343)
@@ -71,6 +71,7 @@
/**
* @author Jeff Johnston
* @author André Dietisheim
+ * @author Rob Stryker
*/
public class ManageKeysPage extends WizardPage {
15 years, 2 months
JBoss Tools SVN: r28342 - trunk/portlet/docs/reference/en-US.
by jbosstools-commits@lists.jboss.org
Author: mcaspers
Date: 2011-01-18 00:51:43 -0500 (Tue, 18 Jan 2011)
New Revision: 28342
Modified:
trunk/portlet/docs/reference/en-US/Revision_History.xml
trunk/portlet/docs/reference/en-US/jsf_portlet.xml
trunk/portlet/docs/reference/en-US/seam_portlet.xml
Log:
General Updates
Modified: trunk/portlet/docs/reference/en-US/Revision_History.xml
===================================================================
--- trunk/portlet/docs/reference/en-US/Revision_History.xml 2011-01-18 05:29:40 UTC (rev 28341)
+++ trunk/portlet/docs/reference/en-US/Revision_History.xml 2011-01-18 05:51:43 UTC (rev 28342)
@@ -2,31 +2,51 @@
<!DOCTYPE Book PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
]>
<appendix>
- <title>Revision History</title>
- <simpara>
- <revhistory>
- <revision>
- <revnumber>1</revnumber><date>Wed Jun 09 2010</date>
- <author>
- <firstname>JBoss Tools</firstname><surname>Documentation Team</surname><email>irooskov(a)redhat.com</email>
- </author>
- <revdescription>
- <simplelist>
- <member>General updates</member>
- </simplelist>
- </revdescription>
- </revision>
- <revision>
- <revnumber>0</revnumber><date>Fri Nov 20 2009</date>
- <author>
- <firstname>Isaac</firstname><surname>Rooskov</surname><email>irooskov(a)redhat.com</email>
- </author>
- <revdescription>
- <simplelist>
- <member>Initial creation of book by publican</member>
- </simplelist>
- </revdescription>
- </revision>
- </revhistory>
- </simpara>
+ <title>Revision History</title>
+ <simpara>
+ <revhistory>
+ <revision>
+ <revnumber>2</revnumber>
+ <date>Tue Jan 18 2011</date>
+ <author>
+ <firstname>JBoss Tools</firstname>
+ <surname>Documentation Team</surname>
+ <email>mcaspers(a)redhat.com</email>
+ </author>
+ <revdescription>
+ <simplelist>
+ <member>General updates</member>
+ </simplelist>
+ </revdescription>
+ </revision>
+ <revision>
+ <revnumber>1</revnumber>
+ <date>Wed Jun 09 2010</date>
+ <author>
+ <firstname>JBoss Tools</firstname>
+ <surname>Documentation Team</surname>
+ <email>irooskov(a)redhat.com</email>
+ </author>
+ <revdescription>
+ <simplelist>
+ <member>General updates</member>
+ </simplelist>
+ </revdescription>
+ </revision>
+ <revision>
+ <revnumber>0</revnumber>
+ <date>Fri Nov 20 2009</date>
+ <author>
+ <firstname>Isaac</firstname>
+ <surname>Rooskov</surname>
+ <email>irooskov(a)redhat.com</email>
+ </author>
+ <revdescription>
+ <simplelist>
+ <member>Initial creation of book by publican</member>
+ </simplelist>
+ </revdescription>
+ </revision>
+ </revhistory>
+ </simpara>
</appendix>
Modified: trunk/portlet/docs/reference/en-US/jsf_portlet.xml
===================================================================
--- trunk/portlet/docs/reference/en-US/jsf_portlet.xml 2011-01-18 05:29:40 UTC (rev 28341)
+++ trunk/portlet/docs/reference/en-US/jsf_portlet.xml 2011-01-18 05:51:43 UTC (rev 28342)
@@ -78,7 +78,7 @@
</listitem>
<listitem>
- <para>On the <property>JBoss Portlet Capabilities</property> page, select <emphasis><property>Portlet Target Runtime Provider</property></emphasis> and click the <guibutton>Next</guibutton> button.</emphasis>
+ <para>On the <property>JBoss Portlet Capabilities</property> page, select <emphasis><property>Portlet Target Runtime Provider</property></emphasis> and click the <guibutton>Next</guibutton> button.
</para>
<figure>
Modified: trunk/portlet/docs/reference/en-US/seam_portlet.xml
===================================================================
--- trunk/portlet/docs/reference/en-US/seam_portlet.xml 2011-01-18 05:29:40 UTC (rev 28341)
+++ trunk/portlet/docs/reference/en-US/seam_portlet.xml 2011-01-18 05:51:43 UTC (rev 28342)
@@ -2,219 +2,218 @@
<section id="seam_portlet">
<title>Creating and Deploying a Seam Portlet</title>
- <para>This chapter covers the steps on how to configure a Seam portlet within a Seam
- project with the help of the <property>JBoss Portlet Tools</property> features.</para>
-
- <section id="seam_portlet1">
- <title>Creating a Seam Project with JBoss Portlet Capabilities</title>
+ <para>
+ This chapter covers the steps required to configure a Seam portlet within a Seam project with the help of the <property>JBoss Portlet Tools</property> features.
+ </para>
- <para>Follow one of two ways of creating a Seam project with JBoss Portlet capabilities enabled:</para>
- <orderedlist>
- <listitem>
- <para>Create a dynamic Web project with the <emphasis><property>Seam</property></emphasis>
- and <emphasis><property>JBoss Portlets</property></emphasis> facets enabled (see <xref linkend="create_dyn_web_proj_seam"/>)</para>
- </listitem>
- <listitem><para>Or create a Seam project with the JBoss Seam portlet configuration using the wizard JBoss Seam Tools provides
- and follow all the wizard steps to enable JBoss Portlet capabilities (see <xref linkend="create_seam_proj"/>)</para></listitem>
- </orderedlist>
+ <section id="seam_portlet1">
+ <title>Creating a Seam Project with JBoss Portlet Capabilities</title>
+
+ <para>One of the following two procedures can be used to create a Seam project with JBoss Portlet capabilities enabled:</para>
+ <orderedlist>
+ <listitem>
+ <para>
+ Create a dynamic Web project with the <emphasis><property>Seam</property></emphasis> and <emphasis><property>JBoss Portlets</property></emphasis> facets enabled (see <xref linkend="create_dyn_web_proj_seam"/>)
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ Create a Seam project with the JBoss Seam portlet configuration using the wizard JBoss Seam Tools provides and follow all the wizard steps to enable JBoss Portlet capabilities (see <xref linkend="create_seam_proj"/>)
+ </para>
+ </listitem>
+ </orderedlist>
- <section id="create_dyn_web_proj_seam">
- <title>Creating a Dynamic Web Project with Seam and JBoss Portlet Capabilities</title>
+ <section id="create_dyn_web_proj_seam">
+ <title>Creating a Dynamic Web Project with Seam and JBoss Portlet Capabilities</title>
- <para>To create a dynamic Web project with Seam and JBoss Portlet capabilities you should take the following steps:</para>
+ <para>To create a dynamic Web project with Seam and JBoss Portlet capabilities you should complete the following steps:</para>
- <orderedlist>
- <listitem>
- <para>In the <emphasis><property>File</property></emphasis> menu, go to
- <emphasis><property>New > Other > Web > Dynamic Web Project</property>.</emphasis> The <property>New Dynamic Web Project</property>
- wizard starts.</para>
+ <orderedlist>
+ <listitem>
+ <para> Select. <menuchoice><guimenuitem>File</guimenuitem><guimenuitem>New</guimenuitem><guimenuitem>Other</guimenuitem><guimenuitem>Web</guimenuitem><guimenuitem>Dynamic Web Project</guimenuitem></menuchoice>. The <property>New Dynamic Web Project</property> wizard will then be displayed.</para>
- <figure>
- <title>Creating a New Dynamic Web Project</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/seam_portlet/seam_portlet1.png"/>
- </imageobject>
- </mediaobject>
- </figure>
- </listitem>
+ <figure>
+ <title>Creating a New Dynamic Web Project</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/seam_portlet/seam_portlet1.png"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ </listitem>
- <listitem>
- <para>Give the project a name and follow the steps 3, 4, 5 of the
- <xref linkend="jboss_core_portlet"/> procedure to set the target runtime.</para>
- </listitem>
+ <listitem>
+ <para>Give the project a name and follow the steps 3, 4, 5 of the <xref linkend="jboss_core_portlet"/> procedure to set the target runtime.</para>
+ </listitem>
- <listitem>
- <para>In the <emphasis><property>Configuration</property></emphasis> area of the first wizard page,
- select <emphasis>
- <property>JBoss Seam Portlet Project v2.0</property>.</emphasis> It will add needed facets to the project.</para>
+ <listitem>
+ <para>
+ In the <emphasis><property>Configuration</property></emphasis> area of the first wizard page, select <emphasis><property>JBoss Seam Portlet Project v2.0</property>.</emphasis> It will add needed facets to the project.
+ </para>
- <note>
- <title>Tip:</title>
- <para>If you now click the <emphasis><property>Modify</property></emphasis> button, you should see the
- <emphasis><property>JavaServer Faces</property>,</emphasis> <emphasis><property>Jboss Portlets</property></emphasis>
- and <emphasis><property>Seam</property></emphasis> facets enabled.</para>
- </note>
+ <note>
+ <title>Tip:</title>
+ <para>If you now click the <guibutton>Modify</guibutton> button, you should see the<emphasis><property>JavaServer Faces</property>,</emphasis><emphasis><property>Jboss Portlets</property></emphasis> and <emphasis><property>Seam</property></emphasis> facets enabled.</para>
+ </note>
- <figure>
- <title>Project Facets</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/seam_portlet/seam_portlet2.png"/>
- </imageobject>
- </mediaobject>
- </figure>
- </listitem>
+ <figure>
+ <title>Project Facets</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/seam_portlet/seam_portlet2.png"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ </listitem>
- <listitem>
- <para>The next two pages are for adjusting the project Java and Web modules.
- They include the default values, so you can skip them by pressing <emphasis>
- <property>Next</property>.</emphasis></para>
- </listitem>
+ <listitem>
+ <para>
+ The next two pages are for adjusting the project Java and Web modules. They include the default values, so you can skip them by clicking the <guibutton>Next</guibutton> button.
+ </para>
+ </listitem>
- <listitem>
- <para>On the <property>Jboss Portlet Capabilities</property> page, select
- <emphasis><property>Portlet Target Runtime Provider</property></emphasis> as the portlet implementation library.</para>
+ <listitem>
+ <para>
+ On the <property>Jboss Portlet Capabilities</property> page, select <emphasis><property>Portlet Target Runtime Provider</property></emphasis> as the portlet implementation library.
+ </para>
- <note>
- <title>Tip:</title>
- <para>All types of the portlet implementation library are described more closely in the wiki article at:
- <ulink url="http://www.jboss.org/community/wiki/PortletFacetLibraries">http://www.jboss.org/community/wiki/PortletFacetLibraries</ulink>.</para>
- </note>
- </listitem>
+ <note>
+ <title>Tip:</title>
+ <para>
+ All types of the portlet implementation library are described more closely in the wiki article at: <ulink url="http://www.jboss.org/community/wiki/PortletFacetLibraries">http://www.jboss.org/community/wiki/PortletFacetLibraries</ulink>.
+ </para>
+ </note>
+ </listitem>
- <listitem>
- <para>The next page is for configuring JSF capabilities. As it contains the default values, just click
- <emphasis><property>Next</property></emphasis> to proceed.</para>
- </listitem>
+ <listitem>
+ <para>
+ The next page is for configuring JSF capabilities. As it contains the default values, just click the <guibutton>Next</guibutton> button to proceed.
+ </para>
+ </listitem>
- <listitem>
- <para>On the <property>Seam Facet</property> page, set a Seam runtime and
- a connection profile.</para>
+ <listitem>
+ <para>On the <property>Seam Facet</property> page, set a Seam runtime and a connection profile.</para>
- <note>
- <title>Tip:</title>
- <para>For details about how to set a Seam runtime and a connection profile, see
- Configure Seam Facet Settings in the Chapter 2 of the
- Seam Dev Tools Reference Guide.</para>
- </note>
+ <note>
+ <title>Tip:</title>
+ <para>
+ For details about how to set a Seam runtime and a connection profile, see Configure Seam Facet Settings in the Chapter 2 of the Seam Dev Tools Reference Guide.
+ </para>
+ </note>
- <figure>
- <title>Seam Facet Settings</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/seam_portlet/seam_portlet3.png"/>
- </imageobject>
- </mediaobject>
- </figure>
- </listitem>
+ <figure>
+ <title>Seam Facet Settings</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/seam_portlet/seam_portlet3.png"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ </listitem>
- <listitem>
- <para>On the <property>JBoss JSF Portlet Capabilities</property> page, select the
- <emphasis><property>JSF Portlet Target Runtime Provider</property></emphasis> type of the implementation library.</para>
+ <listitem>
+ <para>
+ On the <property>JBoss JSF Portlet Capabilities</property> page, select the <emphasis><property>JSF Portlet Target Runtime Provider</property></emphasis> type of the implementation library.
+ </para>
- <note>
- <title>Tip:</title>
- <para>If you have <property>JBoss Portlet Bridge</property> downloaded,
- alternatively you can select <emphasis><property>JSF Portletbridge Runtime Provider</property></emphasis> and then provide a path to
- the <property>JBoss Portlet Bridge</property> distribution.</para>
- </note>
+ <note>
+ <title>Tip:</title>
+ <para>
+ If you have <property>JBoss Portlet Bridge</property> downloaded, alternatively you can select <emphasis><property>JSF Portletbridge Runtime Provider</property></emphasis> and then provide a path to the <property>JBoss Portlet Bridge</property> distribution.
+ </para>
+ </note>
- <figure>
- <title>Setting Portlet Bridge Provider</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/jsf_portlet/jsf_portlet4.png"/>
- </imageobject>
- </mediaobject>
- </figure>
+ <figure>
+ <title>Setting Portlet Bridge Provider</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/jsf_portlet/jsf_portlet4.png"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>It will add <property>JBoss Portlet Bridge</property> libraries to the project classpath.</para>
+ </listitem>
- <para>It will add <property>JBoss Portlet Bridge</property> libraries to the project classpath.</para>
- </listitem>
-
- <listitem>
- <para>Hit <emphasis><property>Finish</property></emphasis> to complete the project creation.</para>
- </listitem>
- </orderedlist>
- </section>
+ <listitem>
+ <para>Click the <guibutton>Finish</guibutton> button to complete the project creation.</para>
+ </listitem>
+ </orderedlist>
+ </section>
- <section id="create_seam_proj">
- <title>Creating a Seam Project with JBoss Portlet Capabilities</title>
+ <section id="create_seam_proj">
+ <title>Creating a Seam Project with JBoss Portlet Capabilities</title>
- <para>The steps to create a Seam project with JBoss Portlet capabilities are as follows:</para>
+ <para>The steps to create a Seam project with JBoss Portlet capabilities are as follows:</para>
- <orderedlist>
- <listitem>
- <para>In the <emphasis><property>File</property></emphasis> menu, go to <emphasis>
- <property>New > Other > Seam > Seam Web Project</property>.</emphasis> The <property>New Seam Project</property>
- wizard appears.</para>
- </listitem>
+ <orderedlist>
+ <listitem>
+ <para> Select <menuchoice><guimenuitem>File</guimenuitem><guimenuitem>New</guimenuitem><guimenuitem>Other</guimenuitem><guimenuitem>Seam</guimenuitem><guimenuitem>Seam Web Project</guimenuitem></menuchoice>. The <property>New Seam Project</property> wizard will be displayed.</para>
+ </listitem>
- <listitem>
- <para>Next steps are the same as in the <xref
- linkend="create_dyn_web_proj_seam"/>
- procedure starting from the step 2.</para>
- </listitem>
- </orderedlist>
- </section>
- </section>
-
- <section id="seam_portlet_to_seam_project">
- <title>Adding a Seam Portlet to the Project and Deploying It to JBoss Portal</title>
+ <listitem>
+ <para>Next steps are the same as in the <xref linkend="create_dyn_web_proj_seam"/> procedure starting from the step 2.</para>
+ </listitem>
+ </orderedlist>
+ </section>
+ </section>
+
+ <section id="seam_portlet_to_seam_project">
+ <title>Adding a Seam Portlet to the Project and Deploying It to JBoss Portal</title>
- <para>The previous section has shown you how to create a Web project with Seam and JBoss Portlet capabilities. Now you can create a Seam portlet
- and deploy it to <property>JBoss Portal</property> by following the next procedure:</para>
-
- <orderedlist>
- <listitem>
- <para>In the <emphasis><property>File</property></emphasis> or context menu of the project go to
- <emphasis><property>New > Other > JBoss Tools Web > Portlet > JSF/Seam
- Portlet</property>.</emphasis></para>
+ <para>
+ The previous section has demonstrated how to create a Web project with Seam and JBoss Portlet capabilities. Now you can create a Seam portlet and deploy it to <property>JBoss Portal</property> by following the next procedure:
+ </para>
+
+ <orderedlist>
+ <listitem>
+ <para>
+ Select <menuchoice><guimenuitem>File</guimenuitem><guimenuitem>New</guimenuitem><guimenuitem>Other</guimenuitem><guimenuitem>JBoss Tools Web</guimenuitem><guimenuitem>Portlet</guimenuitem><guimenuitem>JSF/Seam Portlet</guimenuitem></menuchoice>.
+ </para>
- <figure>
- <title>Calling the Create Portlet Wizard</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/seam_portlet/seam_portlet5.png"/>
- </imageobject>
- </mediaobject>
- </figure>
- </listitem>
+ <figure>
+ <title>Calling the Create Portlet Wizard</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/seam_portlet/seam_portlet5.png"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ </listitem>
- <listitem>
- <para>The <property>Create Portlet</property> wizard starts (for more information about wizard options, see
- <xref linkend="jsf_seam_portlet_wizard"/> in the guide reference).
- As the Seam configuration is set for the project, the wizard puts the values as for Seam portlet.</para>
+ <listitem>
+ <para>
+ The <property>Create Portlet</property> wizard is displayed (for more information about wizard options, see <xref linkend="jsf_seam_portlet_wizard"/> in the guide reference). As the Seam configuration is set for the project, the wizard enters the values for the for Seam portlet.
+ </para>
- <figure>
- <title>Creating Seam Portlet</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/seam_portlet/seam_portlet6.png"/>
- </imageobject>
- </mediaobject>
- </figure>
- </listitem>
+ <figure>
+ <title>Creating Seam Portlet</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/seam_portlet/seam_portlet6.png"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ </listitem>
- <listitem>
- <para>Next two pages are filled out with default values, just press <emphasis><property>Next</property></emphasis> to
- proceed. On the last one click <emphasis><property>Finish</property></emphasis> to complete.</para>
- </listitem>
+ <listitem>
+ <para>Next two pages are filled out with default values, just click the <guibutton>Next</guibutton> button to proceed. On the last one click the <guibutton>Finish</guibutton> button to complete the procedure.</para>
+ </listitem>
- <listitem>
- <para>To deploy and run the portlet on <property>JBoss Portal</property> complete the steps described in the
- <xref linkend="deploying_to_portal"/> procedure. Just use the following URL to see it in the browser:
- <emphasis>http://localhost:8080/portal/portal/default/SeamPortlet</emphasis>.</para>
+ <listitem>
+ <para>
+ To deploy and run the portlet on <property>JBoss Portal</property> complete the steps described in the <xref linkend="deploying_to_portal"/> procedure. Just use the following URL to see it in the browser: <emphasis>http://localhost:8080/portal/portal/default/SeamPortlet</emphasis>.
+ </para>
- <figure>
- <title>Seam Portlet in the Browser Window</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/seam_portlet/seam_portlet7.png"/>
- </imageobject>
- </mediaobject>
- </figure>
- </listitem>
- </orderedlist>
- </section>
+ <figure>
+ <title>Seam Portlet in the Browser Window</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/seam_portlet/seam_portlet7.png"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ </listitem>
+ </orderedlist>
+ </section>
</section>
15 years, 2 months
JBoss Tools SVN: r28341 - trunk/portlet/docs/reference/en-US.
by jbosstools-commits@lists.jboss.org
Author: mcaspers
Date: 2011-01-18 00:29:40 -0500 (Tue, 18 Jan 2011)
New Revision: 28341
Modified:
trunk/portlet/docs/reference/en-US/jsf_portlet.xml
trunk/portlet/docs/reference/en-US/starting_project.xml
Log:
General Updates
Modified: trunk/portlet/docs/reference/en-US/jsf_portlet.xml
===================================================================
--- trunk/portlet/docs/reference/en-US/jsf_portlet.xml 2011-01-18 05:07:51 UTC (rev 28340)
+++ trunk/portlet/docs/reference/en-US/jsf_portlet.xml 2011-01-18 05:29:40 UTC (rev 28341)
@@ -2,256 +2,250 @@
<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>
+ <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>
+ <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 (see
- <xref linkend="create_dyn_web_proj_jsf"/>)</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 (see
- <xref linkend="create_jsf_proj"/>)</para></listitem>
- </orderedlist>
+ <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 (see <xref linkend="create_dyn_web_proj_jsf"/>)
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ Or create a JSF project using the wizard provided by JBoss JSF Tools, then enable JSF and JBoss Portlet facets and add JBoss Portlet capabilities (see
+ <xref linkend="create_jsf_proj"/>)
+ </para>
+ </listitem>
+ </orderedlist>
- <para>Refer to the further sections for the procedures on how to do this.</para>
+ <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>
+ <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>
+ <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 > New > Other > Web > Dynamic Web Project</property>.</emphasis></para>
+ <orderedlist>
+ <listitem>
+ <para>
+ Start the <emphasis><property>Dynamic Web Project</property></emphasis> wizard navigating to <menuchoice><guimenuitem>File</guimenuitem><guimenuitem>New</guimenuitem><guimenuitem>Other</guimenuitem><guimenuitem>Web</guimenuitem><guimenuitem>Dynamic Web Project</guimenuitem></menuchoice>.
+ </para>
- <note>
- <title>Tip:</title>
- <para>You can also select the <property>Java EE</property> perspective and then go to
- <emphasis><property>File > New > Dynamic Web Project</property>.</emphasis></para>
- </note>
+ <note>
+ <title>Tip:</title>
+ <para>
+ You can also select the <property>Java EE</property> perspective and then selecting <menuchoice><guimenuitem>File</guimenuitem><guimenuitem>New</guimenuitem><guimenuitem>Dynamic Web Project</guimenuitem></menuchoice>.
+ </para>
+ </note>
- <figure>
- <title>Setting the JSF Configuration</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/jsf_portlet/jsf_portlet1.png"/>
- </imageobject>
- </mediaobject>
- </figure>
- </listitem>
+ <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
- <xref linkend="jboss_core_portlet"/> procedure.</para>
- </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 <xref linkend="jboss_core_portlet"/> 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>
+ <listitem>
+ <para>In the <emphasis><property>Configuration</property></emphasis>area, click the <guibutton>Modify</guibutton> button and enable <emphasis><property>JavaServer Faces</property>,</emphasis><emphasis><property>JBoss Core Portlet</property></emphasis> and <emphasis><property>JBoss JSF Portlet</property></emphasis> facets. Click the <guibutton>OK</guibutton> button.
+ </para>
- <figure>
- <title>Enabling the Portlet Facets</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/jsf_portlet/jsf_portlet2.png"/>
- </imageobject>
- </mediaobject>
- </figure>
- </listitem>
+ <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>You may leave the next two wizard pages with their defaults, just press the <guibutton>Next</guibutton> button 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>
+ <listitem>
+ <para>On the <property>JBoss Portlet Capabilities</property> page, select <emphasis><property>Portlet Target Runtime Provider</property></emphasis> and click the <guibutton>Next</guibutton> button.</emphasis>
+ </para>
- <figure>
- <title>JBoss Portlet Capabilities</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/jsf_portlet/jsf_portlet2a.png"/>
- </imageobject>
- </mediaobject>
- </figure>
+ <figure>
+ <title>JBoss Portlet Capabilities</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/jsf_portlet/jsf_portlet2a.png"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
- <note>
- <title>Tip:</title>
- <para>All types of the portlet implementation library are described more closely in the wiki article at:
+ <note>
+ <title>Tip:</title>
+ <para>All types of the portlet implementation library are described more closely in the wiki article at:
<ulink url="http://www.jboss.org/community/wiki/PortletFacetLibraries">http://www.jboss.org/community/wiki/PortletFacetLibraries</ulink>.</para>
- </note>
- </listitem>
+ </note>
+ </listitem>
- <listitem>
- <para>Next wizard page is for configuring JSF capabilities. You can leave everything as it
- is here.</para>
+ <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>
+ <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>
+ <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>
+ <figure>
+ <title>JBoss JSF PortletCapabilities</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/jsf_portlet/jsf_portlet4.png"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
- <note>
- <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>
- </note>
+ <note>
+ <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>
+ </note>
- <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">http://community.jboss.org/wiki/PortletFacetLibraries</ulink>.</para>
- </note>
- </listitem>
+ <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">http://community.jboss.org/wiki/PortletFacetLibraries</ulink>.
+ </para>
+ </note>
+ </listitem>
- <listitem>
- <para>Click <emphasis><property>Finish</property>.</emphasis> The project will be created in the workbench.</para>
- </listitem>
- </orderedlist>
- </section>
+ <listitem>
+ <para>Click the <guibutton>Finish</guibutton> button. 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>
+ <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
- <xref linkend="jboss_core_portlet"/> procedure).</para>
+ <para>
+ For information on how to organize a JSF project you can read 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 with steps 3, 4 and 5 in the <xref linkend="jboss_core_portlet"/> procedure).
+ </para>
- <figure>
- <title>Creating New JSF Project</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/jsf_portlet/jsf_portlet8.png"/>
- </imageobject>
- </mediaobject>
- </figure>
+ <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>
+ <para>To add the JBoss Portlet capabilities to the JSF project you should complete the next steps:</para>
+
+ <orderedlist>
+ <listitem>
+ <para>Right-click the project and click <guimenuitem>Properties</guimenuitem> 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>
+ <figure>
+ <title>Project Facets</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/jsf_portlet/jsf_portlet9.png"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ </listitem>
- <listitem>
- <para>Notice, <emphasis>
- <property>"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>Modify Faceted Project</property> wizard appears.</para>
- </listitem>
+ <listitem>
+ <para>Notice that the <emphasis><property>"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>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
- <xref linkend="jboss_core_portlet"/> procedure.
- Hit <emphasis><property>OK</property>.</emphasis></para>
- </listitem>
+ <listitem>
+ <para>Complete all wizard pages the same way as described in the steps 5, 6, 7 of the <xref linkend="jboss_core_portlet"/> procedure. Click the <guibutton>OK</guibutton> button.
+ </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>
+ <listitem>
+ <para>
+ To apply the changes click the <guibutton>Apply</guibutton> button and then the <guibutton>OK</guibutton> button 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>
+ <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 demonstrated 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
- <xref linkend="jsf_seam_portlet_wizard"/> in the guide reference).</para>
+ <orderedlist>
+ <listitem>
+ <para>Display the <property>Create Portlet</property> wizard by selecting <menuchoice><guimenuitem>New</guimenuitem><guimenuitem>Other</guimenuitem><guimenuitem>JBoss Tools Web</guimenuitem><guimenuitem>Portlet</guimenuitem><guimenuitem>JSF/Seam Portlet</guimenuitem></menuchoice> from the context menu of the project (for information about the wizard options, see <xref linkend="jsf_seam_portlet_wizard"/> 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>
+ <figure>
+ <title>Calling New Portlet Wizard</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/jsf_portlet/jsf_portlet5.png"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
- <note>
- <title>Tip:</title>
- <para>As you see, the JSF and Seam Portlet wizards are merged into one. We have set the JSF
+ <note>
+ <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>
- </note>
- </listitem>
+ </note>
+ </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>
+ Leave all the wizard pages with default values by clicking the <guibutton>Next</guibutton> button, on the last one click the <guibutton>Finish</guibutton> button to complete the JSF portlet creation.
+ </para>
+ </listitem>
- <listitem>
- <para>Complete the steps described in the <xref linkend="deploying_to_portal"/> 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>
+ <listitem>
+ <para>
+ Complete the steps described in the <xref linkend="deploying_to_portal"/> 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>
+ <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>
</section>
Modified: trunk/portlet/docs/reference/en-US/starting_project.xml
===================================================================
--- trunk/portlet/docs/reference/en-US/starting_project.xml 2011-01-18 05:07:51 UTC (rev 28340)
+++ trunk/portlet/docs/reference/en-US/starting_project.xml 2011-01-18 05:29:40 UTC (rev 28341)
@@ -233,8 +233,7 @@
</listitem>
<listitem>
- <para>Select <emphasis><property>JBoss Portal 2.7 Server</property>
- </emphasis> created before and click the <guibutton>Next</guibutton> button.
+ <para>Select <emphasis><property>JBoss Portal 2.7 Server</property></emphasis> created before and click the <guibutton>Next</guibutton> button.
</para>
</listitem>
15 years, 2 months
JBoss Tools SVN: r28340 - trunk/portlet/docs/reference/en-US.
by jbosstools-commits@lists.jboss.org
Author: mcaspers
Date: 2011-01-18 00:07:51 -0500 (Tue, 18 Jan 2011)
New Revision: 28340
Modified:
trunk/portlet/docs/reference/en-US/starting_project.xml
Log:
General Updates
Modified: trunk/portlet/docs/reference/en-US/starting_project.xml
===================================================================
--- trunk/portlet/docs/reference/en-US/starting_project.xml 2011-01-18 04:58:56 UTC (rev 28339)
+++ trunk/portlet/docs/reference/en-US/starting_project.xml 2011-01-18 05:07:51 UTC (rev 28340)
@@ -56,11 +56,8 @@
</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>
+ At this point a new JBoss Server instance will be created. On the next page you can verify the runtime information and configuration. If something is incorrect, press the <guibutton>Back</guibutton> button to return to the previous wizard page. Click the <guibutton>Finish</guibutton> button.
</para>
<figure>
@@ -74,11 +71,9 @@
</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>
+ <para>
+ Click the <guibutton>Modify</guibutton> button in the <emphasis><property>Configuration</property></emphasis> area to enable a portlet facet for the project.
+ </para>
<figure>
<title>Setting the Project Configuration</title>
@@ -91,11 +86,7 @@
</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>
+ <para>In the <property>Project Facets</property> dialog, check <emphasis><property>JBoss Core Portlet</property></emphasis> and click the <guibutton>OK</guibutton> button.</para>
<figure>
<title>Enabling the JBoss Core Portlet Facet</title>
@@ -108,27 +99,23 @@
<note>
<title>Note:</title>
- <para>If the portlet libraries aren'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
- <xref linkend="preferences"/>.</para>
+ <para>
+ If the portlet libraries aren'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 <xref linkend="preferences"/>.</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>
+ <para>
+ The <property>Java</property> and <property>Web Module</property> pages are for configuring Java and Web modules in the project. Here the default values are fine, 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>
+ <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 the <guibutton>Finish</guibutton> button to complete the project creation.
+ </para>
<figure>
<title>Including the Portlet Libraries Provided by Target Runtime</title>
@@ -152,7 +139,7 @@
<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>
+ creates an empty <filename>portlet.xml</filename> file and adds the JBoss Portlet library to the project classpath.</para>
<figure>
<title>Portlet Project Structure Overview</title>
@@ -167,14 +154,15 @@
<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>
+ <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 > Other > JBoss Tools Web > Portlet > Java
- Portlet</property>.</emphasis>
+ <para>
+ Right-click the project and select <menuchoice><guimenuitem>New</guimenuitem><guimenuitem>Other</guimenuitem><guimenuitem>JBoss Tools Web</guimenuitem><guimenuitem>Portlet</guimenuitem><guimenuitem>Java
+ Portlet</guimenuitem></menuchoice>.
</para>
<figure>
@@ -188,19 +176,7 @@
</listitem>
<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
- (for instance, <emphasis>
- <property>org.example</property>
- </emphasis> and <emphasis>
- <property>TestPortlet</property>
- </emphasis>). Then click <emphasis>
- <property>Next</property>
- </emphasis>.</para>
+ <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 (for instance, <emphasis><property>org.example</property></emphasis> and <emphasis><property>TestPortlet</property></emphasis>). Then click the <guibutton>Next</guibutton> button.</para>
<figure>
<title>Specifying Class File Destination</title>
@@ -213,14 +189,15 @@
</listitem>
<listitem>
- <para>You may leave the next three pages with default values, on the last one hit <emphasis>
- <property>Finish</property>.</emphasis>
+ <para>
+ You may leave the next three pages with default values, on the last one click the <guibutton>Finish</guibutton> button.
</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>
+ <para>
+ Once a Java portlet is created, new resources are added to the project structure: a Java portlet class (<filename>TestPortlet.java</filename>), <filename>default-object.xml</filename> and <filename>portlet-instances.xml</filename> files and the <filename>portlet.xml</filename> descriptor is updated as well.
+ </para>
<figure>
<title>Structure of the Project with a Java Portlet</title>
@@ -231,7 +208,7 @@
</mediaobject>
</figure>
- <para>Thus, now the project is ready to be built and deployed.</para>
+ <para>Now the project is ready to be built and deployed.</para>
</section>
<section id="deploying_to_portal">
@@ -241,9 +218,9 @@
<orderedlist>
<listitem>
- <para>Right-click the project and do <emphasis>
- <property>Run As > Run On Server</property>.
- </emphasis> The <property>Run On Server</property> wizard starts.</para>
+ <para>
+ Right-click the project and select <menuchoice><guimenuitem>Run As</guimenuitem><guimenuitem>Run On Server</guimenuitem></menuchoice>. The <guilabel>Run On Server</guilabel> wizard starts.
+ </para>
<figure>
<title>Running the Java Portlet on Server</title>
@@ -257,15 +234,13 @@
<listitem>
<para>Select <emphasis><property>JBoss Portal 2.7 Server</property>
- </emphasis> created before and click <emphasis><property>Next</property>.</emphasis>
+ </emphasis> created before and click the <guibutton>Next</guibutton> button.
</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>
+ On the <emphasis><property>Add and Remove</property></emphasis> page move the created project to the right and click <guilabel>Finish</guilabel>.
</para>
<figure>
@@ -277,13 +252,11 @@
</mediaobject>
</figure>
- <para>It will deploy the portlet application and start <property>JBoss
- AS</property>.</para>
+ <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>
+ <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>
15 years, 2 months
JBoss Tools SVN: r28339 - trunk/portlet/docs/reference/en-US.
by jbosstools-commits@lists.jboss.org
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/jbossportal/</ulink>.
+ </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/jbossportal/</ulink>.</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>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/Matrixofsupportedplatformsruntimesand...">compatible 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">http://www.jboss.org/jbossportal/download/index.html</ulink></para>
+ <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">http://www.jboss.org/jbossportal/download/index.html</ulink>
+ </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://www.jboss.org/portletbridge/downloads.html</ulink></para>
+ <para>JBoss Portlet Bridge (optionally) from: <ulink url="http://www.jboss.org/portletbridge/downloads.html">http://www.jboss.org/portletbridge/downloads.html</ulink>
+ </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">http://www.jboss.org/tools/download/installation.html</ulink>
- 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 > 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 > 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'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">http://www.jboss.org/community/wiki/PortletFacetLibraries</ulink>.</para>
</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 > Other > JBoss Tools Web > Portlet > 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 > 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>
15 years, 2 months
JBoss Tools SVN: r28338 - trunk/bpel/docs/reference/en-US.
by jbosstools-commits@lists.jboss.org
Author: mcaspers
Date: 2011-01-17 23:19:53 -0500 (Mon, 17 Jan 2011)
New Revision: 28338
Modified:
trunk/bpel/docs/reference/en-US/Revision_History.xml
trunk/bpel/docs/reference/en-US/reference.xml
trunk/bpel/docs/reference/en-US/summary.xml
Log:
General Updates
Modified: trunk/bpel/docs/reference/en-US/Revision_History.xml
===================================================================
--- trunk/bpel/docs/reference/en-US/Revision_History.xml 2011-01-18 04:03:30 UTC (rev 28337)
+++ trunk/bpel/docs/reference/en-US/Revision_History.xml 2011-01-18 04:19:53 UTC (rev 28338)
@@ -2,20 +2,37 @@
<!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>Tue Jul 06 2010</date>
- <author>
- <firstname>Isaac</firstname><surname>Rooskov</surname><email>irooskov(a)redhat.com</email>
- </author>
- <revdescription>
- <simplelist>
- <member>Initial creation of book by publican</member>
- </simplelist>
- </revdescription>
- </revision>
- </revhistory>
- </simpara>
+ <title>Revision History</title>
+ <simpara>
+ <revhistory>
+ <revision>
+ <revnumber>1</revnumber>
+ <date>Tue Jan 18 2011</date>
+ <author>
+ <firstname>Matthew</firstname>
+ <surname>Casperson</surname>
+ <email>mcaspers(a)redhat.com</email>
+ </author>
+ <revdescription>
+ <simplelist>
+ <member>General updates</member>
+ </simplelist>
+ </revdescription>
+ </revision>
+ <revision>
+ <revnumber>0</revnumber>
+ <date>Tue Jul 06 2010</date>
+ <author>
+ <firstname>Isaac</firstname>
+ <surname>Rooskov</surname>
+ <email>irooskov(a)redhat.com</email>
+ </author>
+ <revdescription>
+ <simplelist>
+ <member>Initial creation of book by publican</member>
+ </simplelist>
+ </revdescription>
+ </revision>
+ </revhistory>
+ </simpara>
</appendix>
Modified: trunk/bpel/docs/reference/en-US/reference.xml
===================================================================
--- trunk/bpel/docs/reference/en-US/reference.xml 2011-01-18 04:03:30 UTC (rev 28337)
+++ trunk/bpel/docs/reference/en-US/reference.xml 2011-01-18 04:19:53 UTC (rev 28338)
@@ -14,8 +14,7 @@
<title>Wizards</title>
<section>
<title>New BPEL project Wizard</title>
- <para>This wizard helps to create new BPEL project.It is available with clicking
- <property>File->New->Other->BPEL project</property> in the menu bar.</para>
+ <para>This wizard helps to create new BPEL project. It is available by selecting <menuchoice><guimenuitem>File</guimenuitem><guimenuitem>New</guimenuitem><guimenuitem>Other</guimenuitem><guimenuitem>BPEL project</guimenuitem></menuchoice> in the menu bar.</para>
<figure>
<title>New BPEL Project Wizard</title>
<mediaobject>
@@ -28,7 +27,7 @@
<itemizedlist>
<listitem><para>On the page you can adjust the name of the project and the directory where it will be created.</para>
<para>If "<property>Use default</property>" option is checked the output directory will be the workspace,
- othervise the user should specify it by himself using <property>Browse</property> button.</para>
+ otherwise the user should specify it by himself using <guibutton>Browse</guibutton> button.</para>
<figure>
<title>New BPEL Project Wizard</title>
<mediaobject>
@@ -42,8 +41,7 @@
</section>
<section>
<title>Apache ODE Deployment Descriptor Wizard</title>
- <para>Using this wizard user can create ODE deployment descriptor (deploy.xml) and place it in the temporary directory.It is available with clicking
- <property>File->New->Other->Apache ODE Deployment Descriptor Wizard</property> in the menu bar.</para>
+ <para>Using this wizard user can create ODE deployment descriptor (<filename>deploy.xml</filename>) and place it in the temporary directory.It is available by selecting <menuchoice><guimenuitem>File</guimenuitem><guimenuitem>New</guimenuitem><guimenuitem>Other</guimenuitem><guimenuitem>Apache ODE Deployment Descriptor Wizard</guimenuitem></menuchoice> in the menu bar.</para>
<figure>
<title>New BPEL Project Wizard</title>
<mediaobject>
@@ -52,15 +50,14 @@
</imageobject>
</mediaobject>
</figure>
- <para>On the page you can adjust the name of the deployment descriptor and
- the directory where it will be created.Note,that you should use <property>
- /PROJECT_NAME/bpelContent</property> directory as an output one.</para>
+ <para>
+ On the page you can adjust the name of the deployment descriptor and the directory where it will be created.Note,that you should use <filename>/PROJECT_NAME/bpelContent</filename> directory as an output one.
+ </para>
</section>
<section>
<title>New BPEL Process file Wizard</title>
- <para>Using <property>New BPEL Process file Wizard</property>
- user can create BPEL process file and WSDL file if it is necessary.
+ <para>Using the <property>New BPEL Process file Wizard</property> it is possible to create a BPEL process file and a WSDL file.
The wizard includes several pages:</para>
<itemizedlist>
<listitem><para>The first page has the following options to set:</para>
@@ -185,8 +182,7 @@
</listitem>
</itemizedlist>
<note>
- <para>Process files that are used in the BPEL project must be under the <property>bpelContent</property> folder. Only in this case
- these files can be deployed to JBoss server.
+ <para>Process files that are used in the BPEL project must be under the <property>bpelContent</property> folder. Only in this case these files can be deployed to JBoss server.
</para>
</note>
</section>
@@ -196,9 +192,8 @@
<section>
<title>Business Process Editor</title>
<para>Business Process Editor is intended to facilitate the process of changing and
- adding new logic to BPEL process file.You can open <emphasis>.bpel</emphasis>
- in this editor by right click the file in the project explorer and selecting
- <property>Open With...->Business Process Editor</property>
+ adding new logic to BPEL process file. You can open <emphasis>.bpel</emphasis>
+ in this editor by right click the file in the project explorer and selecting <menuchoice><guimenuitem>Open With...</guimenuitem><guimenuitem>Business Process Editor</guimenuitem></menuchoice>
</para>
<figure>
<title>Business Process Editor</title>
@@ -233,11 +228,9 @@
</imageobject>
</mediaobject>
</figure>
- <para>The <property>Palette</property> represents different elements of the BPEL activities
- organized into functional categories.
- Using it the user can easily add new elements to the sequence activity.
- To do this,he should just click the required element and then drug
- and drop it to the place on the Visual Pane where it should be added.</para>
+ <para>
+ The <property>Palette</property> represents different elements of the BPEL activities organized into functional categories. Using it the developer can easily add new elements to the sequence activity. To do this, click the required element and then drag and drop it to the place on the Visual Pane where it should be added.
+ </para>
</listitem>
<listitem><para>Behavior Components View:</para>
<figure>
@@ -250,7 +243,7 @@
</figure>
<para>Execution behavior components are grouped into the <property>
Behavior Components View</property>.
- The view is also fully syncronized with Properties view where you can customize all
+ The view is also fully synchronized with Properties view where you can customize all
the properties of the component.</para>
<figure>
<title>Process Structure View of Business Process Editor</title>
@@ -260,13 +253,11 @@
</imageobject>
</mediaobject>
</figure>
- <para>To add an element to some component group click plus(<inlinemediaobject>
+ <para>To add an element to some component group click the plus (<inlinemediaobject>
<imageobject>
<imagedata fileref="images/reference/bpel_ref_10.png"/>
</imageobject>
- </inlinemediaobject>) icon,
- for its deleting you should click the element and
- use its <property>Delete</property> option in the popup menu.</para>
+ </inlinemediaobject>) icon, and to delete it click the element and use select the <guilabel>Delete</guilabel> option in the popup menu.</para>
</listitem>
</itemizedlist>
@@ -275,8 +266,7 @@
</section>
<section>
<title>Source tab</title>
- <para>Source tab can be used for editing BPEL process file directly.
- The validation of file structure is also available.
+ <para>Source tab can be used for editing BPEL process file directly. It is also possible to validate the file structure.
</para>
<figure>
<title>Validation error in Source tab</title>
@@ -286,8 +276,7 @@
</imageobject>
</mediaobject>
</figure>
- <para>If the user wants to disable/unable validation he can do it by following
- <property>Window->Preferences->Validation</property>.</para>
+ <para>If the user wants to disable/unable validation he can do it by selecting <menuchoice><guimenuitem>Window</guimenuitem><guimenuitem>Preferences</guimenuitem><guimenuitem>Validation</guimenuitem></menuchoice>.</para>
<figure>
<title>Validation configuration</title>
<mediaobject>
@@ -300,10 +289,7 @@
</section>
<section>
<title>ODE Deployment Descriptor Editor</title>
- <para>To deploy your process in Ode you need to create a
- simple deployment descriptor with basic information and
- <property>ODE Deployment Descriptor Editor</property> facilitates the process of descriptor configuration.
- You can see how the descriptor file,opened in the editor looks like on the picture below:
+ <para>To deploy your process in ODE you need to create a simple deployment descriptor with basic information, using the <property>ODE Deployment Descriptor Editor</property> to facilitate the process of descriptor configuration. You can see how the descriptor file opened in the editor looks like in the picture below:
</para>
<figure>
<title>ODE Deployment Descriptor Editor</title>
@@ -313,8 +299,7 @@
</imageobject>
</mediaobject>
</figure>
- <para>The table below describes the configuration options of the
- ODE Deployment Descriptor Editor:</para>
+ <para>The table below describes the configuration options of the ODE Deployment Descriptor Editor:</para>
<table>
<title>ODE Deployment Descriptor Editor.Options.</title>
<tgroup cols="3">
@@ -352,19 +337,13 @@
</row>
<row><entry>Run this process in memory</entry>
- <entry>for performance purposes,
- you can define the process as being
- executed only in-memory.</entry>
+ <entry>for performance purposes, you can define the process as being executed only in-memory.</entry>
</row>
<row>
<entry>Inbound Interfaces(Services)</entry>
<entry>Associated Port</entry>
- <entry>Click Associated Port and the dropdown list with all available port names will appear.
- Select the one you need ,other fields will be filled automatically.
- This action configure the services
- provided by the process and
- bind each service to an endpoint
+ <entry>Click Associated Port and the dropdown list with all available port names will appear. Select the one you need, and the other fields will be filled automatically. This action configure the services provided by the process and binds each service to an endpoint
</entry>
</row>
@@ -372,10 +351,7 @@
<row>
<entry>Outbound Interfaces(Invokes)</entry>
<entry>Associated Port</entry>
- <entry>Click Associated Port and the dropdown list with all available port names will appear.
- Select the one you need, other fields will be filled automatically.
- This action configure the services
- invoked by the process</entry>
+ <entry>Click Associated Port and the dropdown list with all available port names will appear. Select the one you need, and the other fields will be filled automatically. This action configure the services invoked by the process</entry>
</row>
<row>
<entry>Process-level Monitoring Events</entry>
@@ -404,17 +380,13 @@
</listitem>
</itemizedlist>
</entry>
- <entry>Using ODE's deployment descriptor, it's also
- possible to make events generation to
- filtrate which ones get created.
- All option just duplicates the default behaviour,
- when nothing is specified in the deployment.</entry>
+ <entry>Using ODE's deployment descriptor, it's also possible to make events generation to filter which ones get created.
+ All the options simply revert to the default behavior when nothing is specified in the deployment.</entry>
</row>
<row>
<entry>Scope-level Monitoring Events</entry>
<entry>Scope</entry>
- <entry>This section makes it possible to
- define filtering for each scope of your process.
+ <entry>This section makes it possible to define filtering for each scope of your process.
</entry>
</row>
</tbody>
Modified: trunk/bpel/docs/reference/en-US/summary.xml
===================================================================
--- trunk/bpel/docs/reference/en-US/summary.xml 2011-01-18 04:03:30 UTC (rev 28337)
+++ trunk/bpel/docs/reference/en-US/summary.xml 2011-01-18 04:19:53 UTC (rev 28338)
@@ -2,13 +2,9 @@
<chapter>
<?dbhtml filename="summary.html"?>
<title>Summary</title>
- <para>In conclusion, with this document you know all the capabilities of BPEL Tools
- and could easily start with them.
- The chapters above walked you through the steps on how to create and configure BPEL process and
- deployment descriptor files.
- If you have questions or suggestions concerned both the documentation and tools behavior,
- you are welcome to JBoss Tools Users forum.
- Please, use Jira to report bugs and requests on documentation.</para>
+ <para>
+ This document highlights the capabilities of BPEL Tools, as well as providing the steps required to create and configure BPEL process and deployment descriptor files. If you have questions or suggestions concerned both the documentation and tools behavior, you are welcome to JBoss Tools Users forum. Please, use Jira to report bugs and requests on documentation.
+ </para>
<section>
<title>Other relevant resources on the topic</title>
15 years, 2 months
JBoss Tools SVN: r28337 - trunk/bpel/docs/reference/en-US.
by jbosstools-commits@lists.jboss.org
Author: mcaspers
Date: 2011-01-17 23:03:30 -0500 (Mon, 17 Jan 2011)
New Revision: 28337
Modified:
trunk/bpel/docs/reference/en-US/install.xml
trunk/bpel/docs/reference/en-US/overview.xml
trunk/bpel/docs/reference/en-US/tasks.xml
Log:
General Updates
Modified: trunk/bpel/docs/reference/en-US/install.xml
===================================================================
--- trunk/bpel/docs/reference/en-US/install.xml 2011-01-18 02:47:05 UTC (rev 28336)
+++ trunk/bpel/docs/reference/en-US/install.xml 2011-01-18 04:03:30 UTC (rev 28337)
@@ -1,62 +1,55 @@
<?xml version="1.0" encoding="ISO-8859-1"?>
<chapter id="install">
- <title>Installation JBoss BPEL Tools</title>
- <section id="installeclipse">
- <title>Installation JBoss BPEL editor</title>
- <para>At first, you need Eclipse 3.6. You can get it from <ulink url="http://www.eclipse.org/downloads/download.php?file=/technology/epp/downlo...">Eclipse Web Site</ulink>.
- </para>
- <para>The JBoss BPEL editor is included into JBoss Tools.
- You have some methods to install JBoss Tools.
- See <ulink url="http://www.jboss.org/tools/download/installation.html">Installing JBoss Tools</ulink> for more information.</para>
- <para>If you want to install only the JBoss BPEL editor, you can install it from <ulink url="http://jboss.org/tools/download/dev.html">JBoss Tools</ulink> page separately.
- Please, note, that only JBoss Tools 3.1 or higher version includes JBoss BPEL editor.
- </para>
- </section>
- <section>
- <title>Prerequisites</title>
- <para>For installation and configuring BPEL engine into a JBossAS environment
- you will need the following: </para>
- <itemizedlist>
- <listitem><para> JBossAS (version 5.1.0.GA or higher),
- available from <ulink url="http://www.jboss.org/jbossas">
- http://www.jboss.org/jbossas</ulink>.</para></listitem>
- <listitem><para>RiftSaw (version 2.1 or higher), available from <ulink url="http://www.jboss.org/riftsaw">http://www.jboss.org/riftsaw</ulink>.</para></listitem>
- <listitem><para>Ant, available from <ulink url="http://ant.apache.org">here</ulink>.</para></listitem>
- </itemizedlist>
-
- </section>
- <section id="installRuntime">
- <title>Installation JBoss BPEL Runtime</title>
- <itemizedlist>
- <listitem>
- <para>Unpack the JBossAS installation archive into the required location.
- </para>
- </listitem>
- <listitem>
- <para>Unpack the RiftSaw distribution into the location
- alongside the JBossAS installation:</para>
- <itemizedlist>
- <listitem>
- <para>Edit the <property>install/deployment.properties</property> file to update
- the JBossAS location settings.
- </para>
- </listitem>
- <listitem>
- <para>From the <property>install</property> folder,
- run: <property>ant deploy -Ddatabase=hsql</property>
- to deploy RiftSaw to JBossAS.
- </para>
- </listitem>
- </itemizedlist>
- </listitem>
- <listitem>
- <para>Then in the
- <property>${RiftSaw}/install</property> folder run the command:
- <property>ant deploy -Ddatabase=hsql -Dws.stack=native -Dws.version=3.2.2.GA</property>
-It will help you to download the web service stack, and then upgrade it for JBoss AS. Anyway, you can do it step by step by following the guide from <ulink url="http://www.jboss.org/riftsaw/documentation">JBoss RiftSaw documents</ulink> or the README file in <property moreinfo="none">${RiftSaw}/install</property>
- </para>
- </listitem>
- </itemizedlist>
-
- </section>
+ <title>Installation JBoss BPEL Tools</title>
+ <section id="installeclipse">
+ <title>Installation JBoss BPEL editor</title>
+ <para>
+ To begin you need a copy of Eclipse 3.6. You can get it from <ulink url="http://www.eclipse.org/downloads/download.php?file=/technology/epp/downlo...">Eclipse Web Site</ulink>.
+ </para>
+ <para>The JBoss BPEL editor is included with JBoss Tools. There are a number of different JBoss Tools installation methods. See <ulink url="http://www.jboss.org/tools/download/installation.html">Installing JBoss Tools</ulink> for more information.</para>
+ <para>
+ If you want to install only the JBoss BPEL editor, you can install it from <ulink url="http://jboss.org/tools/download/dev.html">JBoss Tools</ulink> page separately. Please note that only JBoss Tools 3.1 or higher version includes JBoss BPEL editor.
+ </para>
+ </section>
+ <section>
+ <title>Prerequisites</title>
+ <para>For installation and configuring BPEL engine into a JBossAS environment you will need the following: </para>
+ <itemizedlist>
+ <listitem>
+ <para> JBossAS (version 5.1.0.GA or higher), available from <ulink url="http://www.jboss.org/jbossas">http://www.jboss.org/jbossas</ulink>.</para>
+ </listitem>
+ <listitem>
+ <para>RiftSaw (version 2.1 or higher), available from <ulink url="http://www.jboss.org/riftsaw">http://www.jboss.org/riftsaw</ulink>.</para>
+ </listitem>
+ <listitem>
+ <para>Ant, available from <ulink url="http://ant.apache.org">here</ulink>.</para>
+ </listitem>
+ </itemizedlist>
+
+ </section>
+ <section id="installRuntime">
+ <title>Installation JBoss BPEL Runtime</title>
+ <itemizedlist>
+ <listitem>
+ <para>Unpack the JBossAS installation archive into the required location.</para>
+ </listitem>
+ <listitem>
+ <para>Unpack the RiftSaw distribution into the location alongside the JBossAS installation:</para>
+ <itemizedlist>
+ <listitem>
+ <para>Edit the <filename>install/deployment.properties</filename> file to update the JBossAS location settings.</para>
+ </listitem>
+ <listitem>
+ <para>From the <filename>install</filename> folder run: <command>ant deploy -Ddatabase=hsql</command> to deploy RiftSaw to JBossAS.</para>
+ </listitem>
+ </itemizedlist>
+ </listitem>
+ <listitem>
+ <para>
+ Then in the <filename>${RiftSaw}/install</filename> folder run the command: <command>ant deploy -Ddatabase=hsql -Dws.stack=native -Dws.version=3.2.2.GA</command> It will help you to download the web service stack, and then upgrade it for JBoss AS. Alternatively, you can do it step by step by following the guide from <ulink url="http://www.jboss.org/riftsaw/documentation">JBoss RiftSaw documents</ulink> or the README file in <filename>${RiftSaw}/install</filename>
+ </para>
+ </listitem>
+ </itemizedlist>
+
+ </section>
</chapter>
\ No newline at end of file
Modified: trunk/bpel/docs/reference/en-US/overview.xml
===================================================================
--- trunk/bpel/docs/reference/en-US/overview.xml 2011-01-18 02:47:05 UTC (rev 28336)
+++ trunk/bpel/docs/reference/en-US/overview.xml 2011-01-18 04:03:30 UTC (rev 28337)
@@ -1,67 +1,80 @@
<?xml version="1.0" encoding="ISO-8859-1"?>
<chapter id="overview">
- <title>JBoss BPEL project Overview</title>
+ <title>JBoss BPEL project Overview</title>
- <para>JBoss BPEL project is a WS-BPEL 2.0 project that gives a way to create, edit, validate and deploy BPEL files to JBoss BPEL runtime. It is based on Eclipse
- <ulink url="http://www.eclipse.org/bpel/">BPEL
- project </ulink>. </para>
-
- <para>It improves the Eclipse BPEL project in the following way: </para>
- <itemizedlist>
- <listitem><para> Implements close integration with JBoss BPEL runtime. Adds a new project type for the deployment to JBoss BPEL runtime.</para></listitem>
- <listitem><para> Supports two ways of deployment: one way is to deploy a bpel project directly to JBoss BPEL runtime. The other way is to deploy bpel files in JBoss ESB project to JBoss BPEL runtime. </para></listitem>
- <listitem><para> Improves the BPEL validator and increases Eclipse BPEL editor's quality. </para></listitem>
- </itemizedlist>
-
- <para>
- <ulink url="http://docs.oasis-open.org/wsbpel/2.0/OS/wsbpel-v2.0-OS.html">WS-BPEL 2.0</ulink>
- stands for Web Service Business Process Execution Language. Like EAI, BPEL is an XML-based language,
- but BPEL is more specific and targeted. A programmer uses BPEL to join sometimes
- disparate functions into an integrated process, resulting in a seamless use of the Internet to
- conduct business transactions ranging from simple money exchanges to complex calculations and
- asset reallocation.
+ <para>JBoss BPEL is based on WS-BPEL 2.0 to provide a way to create, edit, validate and deploy BPEL files to JBoss BPEL runtime. It is based on Eclipse <ulink url="http://www.eclipse.org/bpel/">BPEL project</ulink>. </para>
+
+ <para>It improves the Eclipse BPEL project in the following way: </para>
+ <itemizedlist>
+ <listitem>
+ <para> Implements close integration with JBoss BPEL runtime. Adds a new project type for the deployment to JBoss BPEL runtime.</para>
+ </listitem>
+ <listitem>
+ <para> Supports two ways of deployment. The first way is to deploy a BPEL project directly to JBoss BPEL runtime. The second way is to deploy BPEL files in JBoss ESB project to JBoss BPEL runtime. </para>
+ </listitem>
+ <listitem>
+ <para> Improves the BPEL validator and improves the quality of the Eclipse BPEL editor. </para>
+ </listitem>
+ </itemizedlist>
+
+ <para>
+ <ulink url="http://docs.oasis-open.org/wsbpel/2.0/OS/wsbpel-v2.0-OS.html">WS-BPEL 2.0</ulink> stands for Web Service Business Process Execution Language. Like EAI, BPEL is an XML-based language, but BPEL is more specific and targeted. A programmer uses BPEL to join sometimes disparate functions into an integrated process, resulting in a seamless use of the Internet to conduct business transactions ranging from simple money exchanges to complex calculations and asset reallocation.
</para>
-<section>
- <title>Key Features of JBoss BPEL project</title>
- <para>Let's start with looking through the table of the main features of JBoss BPEL editor project: </para>
-
- <table>
-
- <title>Key Functionality for JBoss BPEL editor project</title>
- <tgroup cols="2">
- <colspec colnum="1" align="left" colwidth="2*"/>
- <colspec colnum="2" colwidth="4*"/>
- <thead>
- <row>
- <entry>Feature</entry>
- <entry>Benefit</entry>
-
- </row>
- </thead>
- <tbody>
- <row>
- <entry><para>WS-BPEL 2.0 support</para></entry>
- <entry><para>JBoss BPEL project supports the newest WS-BPEL 2.0 specifications. </para></entry>
- </row>
- <row>
- <entry><para>Close integration with JBoss BPEL runtime</para></entry>
- <entry><para>There are two ways to deploy BPEL files to JBoss BPEL runtime.
- The user can deploy a BPEL project as a whole and can deploy BPEL files in
- JBoss ESB project to JBoss BPEL runtime. </para></entry>
- </row>
- <row>
- <entry><para>BPEL file editor</para></entry>
- <entry><para>The user can use the editor separately to edit a BPEL file. </para></entry>
- </row>
- <row>
- <entry><para>BPEL file validator</para></entry>
- <entry><para>The validator can give the error messages about BPEL files to the user. </para></entry>
- </row>
- </tbody>
- </tgroup>
- </table>
-
-</section>
+ <section>
+ <title>Key Features of JBoss BPEL project</title>
+ <para>The table below lists the main features of the JBoss BPEL editor: </para>
+ <table>
+
+ <title>Key Functionality for JBoss BPEL editor project</title>
+ <tgroup cols="2">
+ <colspec colnum="1" align="left" colwidth="2*"/>
+ <colspec colnum="2" colwidth="4*"/>
+ <thead>
+ <row>
+ <entry>Feature</entry>
+ <entry>Benefit</entry>
+
+ </row>
+ </thead>
+ <tbody>
+ <row>
+ <entry>
+ <para>WS-BPEL 2.0 support</para>
+ </entry>
+ <entry>
+ <para>JBoss BPEL project supports the newest WS-BPEL 2.0 specifications. </para>
+ </entry>
+ </row>
+ <row>
+ <entry>
+ <para>Close integration with JBoss BPEL runtime</para>
+ </entry>
+ <entry>
+ <para>There are two ways to deploy BPEL files to JBoss BPEL runtime. The user can deploy a BPEL project as a whole and can deploy BPEL files in JBoss ESB project to JBoss BPEL runtime. </para>
+ </entry>
+ </row>
+ <row>
+ <entry>
+ <para>BPEL file editor</para>
+ </entry>
+ <entry>
+ <para>The user can use the editor separately to edit a BPEL file. </para>
+ </entry>
+ </row>
+ <row>
+ <entry>
+ <para>BPEL file validator</para>
+ </entry>
+ <entry>
+ <para>The validator can provide a list of BPEL file errors to the user. </para>
+ </entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </table>
+
+ </section>
+
</chapter>
\ No newline at end of file
Modified: trunk/bpel/docs/reference/en-US/tasks.xml
===================================================================
--- trunk/bpel/docs/reference/en-US/tasks.xml 2011-01-18 02:47:05 UTC (rev 28336)
+++ trunk/bpel/docs/reference/en-US/tasks.xml 2011-01-18 04:03:30 UTC (rev 28337)
@@ -1,485 +1,527 @@
<?xml version="1.0" encoding="ISO-8859-1"?>
<chapter id="tasks">
- <title>Tasks</title>
- <section id="detail">
- <title>Creating and editing a BPEL project</title>
- <para>In the chapter we describe the necessary steps to create a new BPEL project and edit the BPEL files.
- You can get the source of the example from <property>
- riftsaw/samples/quickstart/hello_world</property>.
- Here and further in the guide we will create
- a simple echo example, used to respond to a sent message with a
- modified version of the request message being returned in a response.
- First of all, you should create a BPEL project.
-
+ <title>Tasks</title>
+ <section id="detail">
+ <title>Creating and editing a BPEL project</title>
+ <para>
+ In this chapter we describe the necessary steps to create a new BPEL project and edit the BPEL files. You can get the example source code from <filename>riftsaw/samples/quickstart/hello_world</filename>. In this guide we will create a simple echo example, used to respond to a sent message with a modified version of the request message.
+ </para>
+ <para>The first step is to create a BPEL project.</para>
+ <section id="createproject">
+ <title>Creating a BPEL project</title>
+ <para>
+ Create the project by selecting <menuchoice><guimenuitem>New</guimenuitem><guimenuitem>Project...</guimenuitem><guimenuitem>BPEL 2.0</guimenuitem><guimenuitem>BPEL Project</guimenuitem></menuchoice> from the menu bar. Then click the <guibutton>Next</guibutton> button.
+ </para>
+ <figure>
+ <title>New BPEL Project</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/detail_createproject_1.png"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ <para>On this page of the <property>New BPEL Project Wizard</property> enter a project name in the <property>Project Name</property>
+ field, e.g enter <property>HelloWorld</property>.</para>
+
+ <figure>
+ <title>New BPEL Project Wizard</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/detail_createproject_2.png"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ <para>
+ Click the <guibutton>Finish</guibutton> button. So you have created the BPEL project named <property>HelloWorld</property>. Its structure is like this:
+ </para>
+ <figure>
+ <title>The BPEL Project structure</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/detail_createproject_3.png"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ </section>
+ <section id="createprocess">
+ <title>Creating a BPEL process</title>
+ <para>
+ Now you should create a BPEL process. You can create it by selecting <menuchoice><guimenuitem>New</guimenuitem><guimenuitem>Others...</guimenuitem><guimenuitem>BPEL 2.0</guimenuitem><guimenuitem>New BPEL Process File</guimenuitem></menuchoice>.
+ </para>
+ <figure>
+ <title>New BPEL Process File</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/detail_createprocess_1.png"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ <para>Click the <guibutton>Next</guibutton> button. Enter the following information:</para>
+ <table>
+
+ <title>Fields and values</title>
+ <tgroup cols="2">
+ <colspec colnum="1" align="left" colwidth="2*"/>
+ <colspec colnum="2" colwidth="4*"/>
+ <thead>
+ <row>
+ <entry>Field</entry>
+ <entry>Value</entry>
+ </row>
+ </thead>
+ <tbody>
+ <row>
+ <entry>
+ <para>BPEL Process Name</para>
+ </entry>
+ <entry>
+ <para>Enter a process name. For example, <property>HelloWorld</property>.</para>
+ </entry>
+ </row>
+ <row>
+ <entry>
+ <para>Namespace</para>
+ </entry>
+ <entry>
+ <para>Enter or select a namespace for the BPEL process.</para>
+ </entry>
+ </row>
+ <row>
+ <entry>
+ <para>Template</para>
+ </entry>
+ <entry>
+ <para>
+ Select the necessary template for the BPEL process. When you select the template, you will see the information about the template below on the page. In our case you should select <property>Synchronous BPEL Process</property>.
+ </para>
+ </entry>
+ </row>
+
+ </tbody>
+ </tgroup>
+ </table>
+
+ <figure>
+ <title>New BPEL Process File Wizard</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/detail_createprocess_2.png"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ <para>Click the <guibutton>Next</guibutton> button. On the second page, you can custom your WSDL service details. Enter the following information:</para>
+ <table>
+
+ <title>Fields and values</title>
+ <tgroup cols="2">
+ <colspec align="left" colnum="1" colwidth="2*"></colspec>
+ <colspec colnum="2" colwidth="4*"></colspec>
+ <thead>
+ <row>
+ <entry>Field</entry>
+ <entry>Value</entry>
+ </row>
+ </thead>
+ <tbody>
+ <row>
+ <entry>
+ <para>Service Name</para>
+ </entry>
+ <entry>
+ <para>A wsdl service name for the BPEL process. The default is, <property moreinfo="none">HelloWorld</property>.</para>
+ </entry>
+ </row>
+ <row>
+ <entry>
+ <para>Port Name</para>
+ </entry>
+ <entry>
+ <para>A wsdl port name for the BPEL process. The default is, <property moreinfo="none">HelloWorldPort</property>.</para>
+ </entry>
+ </row>
+ <row>
+ <entry>
+ <para>Service Address</para>
+ </entry>
+ <entry>
+ <para>An address of the WSDL service for the BPEL process. The default is, <property moreinfo="none">http://localhost:8080/HelloWorld</property>.</para>
+ </entry>
+ </row>
+ <row>
+ <entry>
+ <para>Binding Protocol</para>
+ </entry>
+ <entry>
+ <para>The binding protocal that you use in the wsdl. You can choose SOAP or HTTP. The default is, <property moreinfo="none">SOAP</property>.</para>
+ </entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </table>
+
+ <figure float="0">
+ <title>Create WSDL file for the BPEL Process wizardpage</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/detail_createprocess_2a.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>
+ Click the <guibutton>Next</guibutton> button. On the third page, you can choose a folder for the process file from the projects in your workspace. If not choose, The default folder <filename>HelloWorld/bpelContent</filename> is selected. Click the <guibutton>Finish</guibutton> button.
+ </para>
+ <note>
+ <para>
+ All of your files that are used in your BPEL project must be under the <filename>bpelContent</filename> folder of a BPEL project. Only in this case these files can be deployed to JBoss server.
</para>
- <section id="createproject">
- <title>Creating a BPEL project</title>
- <para>Create the project by selecting
- <emphasis><property>New > Project... > BPEL 2.0 > BPEL Project</property></emphasis> from the menu bar.
- Then click the <property>Next</property> button.
- </para>
- <figure>
- <title>New BPEL Project</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/detail_createproject_1.png"/>
- </imageobject>
- </mediaobject>
- </figure>
- <para>On this page of the <property>New BPEL Project Wizard</property> enter a project name in the <property>Project Name</property>
- field,e.g enter <property>HelloWorld</property>.</para>
-
- <figure>
- <title>New BPEL Project Wizard</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/detail_createproject_2.png"/>
- </imageobject>
- </mediaobject>
- </figure>
- <para>Click the <property>Finish</property> button.
- So you have created the BPEL project named <property>HelloWorld</property>.
- Its structure is like this: </para>
- <figure>
- <title>The BPEL Project structure</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/detail_createproject_3.png"/>
- </imageobject>
- </mediaobject>
- </figure>
- </section>
- <section id="createprocess">
- <title>Creating a BPEL process</title>
- <para>Now you should create a BPEL process. You can create it by selecting
- <emphasis><property>New > Others... > BPEL 2.0 > New BPEL Process File</property></emphasis>.
- </para>
- <figure>
- <title>New BPEL Process File</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/detail_createprocess_1.png"/>
- </imageobject>
- </mediaobject>
- </figure>
- <para>Click the <property>Next</property> button. Enter the following information:</para>
- <table>
-
- <title>Fields and values</title>
- <tgroup cols="2">
- <colspec colnum="1" align="left" colwidth="2*"/>
- <colspec colnum="2" colwidth="4*"/>
- <thead>
- <row>
- <entry>Field</entry>
- <entry>Value</entry>
- </row>
- </thead>
- <tbody>
- <row>
- <entry><para>BPEL Process Name</para></entry>
- <entry><para>enter a process name. For example, <property>HelloWorld</property>.</para></entry>
- </row>
- <row>
- <entry><para>Namespace</para></entry>
- <entry><para>enter or select a namespace for the BPEL process.</para></entry>
- </row>
- <row>
- <entry><para>Template</para></entry>
- <entry><para>Select the necessary template for the BPEL process.
- When you select the template, you will see the information
- about the template below on the page.In our case you should
- select <property>Synchronous BPEL Process</property>.</para></entry>
- </row>
-
- </tbody>
- </tgroup>
- </table>
-
- <figure>
- <title>New BPEL Process File Wizard</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/detail_createprocess_2.png"/>
- </imageobject>
- </mediaobject>
- </figure>
- <para>Click the <property moreinfo="none">Next</property> button. On the second page, you can custom your wsdl service details. Enter the following information:</para>
- <table>
-
- <title>Fields and values</title>
- <tgroup cols="2">
- <colspec align="left" colnum="1" colwidth="2*"></colspec>
- <colspec colnum="2" colwidth="4*"></colspec>
- <thead>
- <row>
- <entry>Field</entry>
- <entry>Value</entry>
- </row>
- </thead>
- <tbody>
- <row>
- <entry><para>Service Name</para></entry>
- <entry><para>a wsdl service name for the BPEL process. The default is, <property moreinfo="none">HelloWorld</property>.</para></entry>
- </row>
- <row>
- <entry><para>Port Name</para></entry>
- <entry><para>a wsdl port name for the BPEL process. The default is, <property moreinfo="none">HelloWorldPort</property>.</para></entry>
- </row>
- <row>
- <entry><para>Service Address</para></entry>
- <entry><para>an address of the wsdl service for the BPEL process. The default is, <property moreinfo="none">http://localhost:8080/HelloWorld</property>.</para></entry>
- </row>
- <row>
- <entry><para>Binding Protocol</para></entry>
- <entry><para>the binding protocal that you use in the wsdl. You can choose SOAP or HTTP. The default is, <property moreinfo="none">SOAP</property>.</para></entry>
- </row>
- </tbody>
- </tgroup>
- </table>
-
- <figure float="0">
- <title>Create WSDL file for the BPEL Process wizardpage</title>
- <mediaobject >
- <imageobject>
- <imagedata fileref="images/detail_createprocess_2a.png"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
-
- <para>Click the <property moreinfo="none">Next</property> button. On the third page, you can choose a folder for the process file from the projects in your workspace. If not choose, The default folder <property moreinfo="none">HelloWorld/bpelContent</property> is selected.
- Click <property>Finish</property>.
- </para>
- <note>
- <para>All of your files that are used in your BPEL project must be under the <property>bpelContent</property> folder of a BPEL project. Only in this case these files can be deployed to JBoss server.
- </para>
- </note>
-
- <para>Up to now, you have got a simple BPEL process as on the screen below.</para>
- <figure>
- <title>A simple BPEL Process File</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/detail_createprocess_3.png"/>
- </imageobject>
- </mediaobject>
- </figure>
- <para>The next step, you can do is to edit the BPEL process file and then deploy it to JBoss server. </para>
- </section>
- <section id="editprocess">
- <title>Editing a BPEL process file</title>
- <para>If the <emphasis><property>Properties view</property></emphasis> and <emphasis><property>Palette view</property></emphasis> are not opened, you can open the views by right-clicking the BPEL editor and selecting
- <property>Show in Properties</property>, <property>Show Palette in Palette view</property>. Then you should have the view like this:
- </para>
- <figure>
- <title>The BPEL editor view</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/detail_editprocess_1.png"/>
- </imageobject>
- </mediaobject>
- </figure>
- <para>In the <emphasis><property>Palette view</property></emphasis>, you can drag a BPEL element to the BPEL editor and drop it in the place you want.</para>
- <para>In the <emphasis><property>Properties view</property></emphasis>, you can get the information about every element of the BPEL process.
- In the BPEL editor select any element you want,and then
- the element's properties will be shown in the Properties view.The table below describes the tabs of the Properties view:
- </para>
- <table>
-
- <title>Tabs of the Property view</title>
- <tgroup cols="2">
- <colspec colnum="1" align="left" colwidth="2*"/>
- <colspec colnum="2" colwidth="4*"/>
- <thead>
- <row>
- <entry>Tab</entry>
- <entry>Description</entry>
- </row>
- </thead>
- <tbody>
- <row>
- <entry><para>Description</para></entry>
- <entry><para>Shows the descriptive information about the element,e.g. <property>Name</property> of the element.</para></entry>
- </row>
- <row>
- <entry><para>Details</para></entry>
- <entry><para>Shows the detailed and important information about the element.
- It is the most important section of an element.
- Most of the properties of an element are set in this section.</para></entry>
- </row>
- <row>
- <entry><para>Join Behavior</para></entry>
- <entry><para>Shows the <property>Join Failure</property> property of the element.</para></entry>
- </row>
- <row>
- <entry><para>Documentation</para></entry>
- <entry><para>Shows the <property>documentation</property> sub-element of an element.</para></entry>
- </row>
- <row>
- <entry><para>Other</para></entry>
- <entry><para>Every BPEL element has its own sections: Correlation section, Message Exchange section, and so on. We will
- introduce them while using them.</para></entry>
- </row>
- </tbody>
- </tgroup>
- </table>
- <para>In order to see how a simple BPEL process works in action, you should do some steps as below: </para>
- <itemizedlist>
- <listitem>
- <para>Modify two variables of the process:</para>
- <itemizedlist>
- <listitem><para>Click on the details tab of the input variable,
- select <property>Browse...</property>.
- Then choose <property>string</property> primitive from the list.</para>
- <figure>
- <title>Edit variable in <property>process</property> file</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/bpel_task_1.png"/>
- </imageobject>
- </mediaobject>
- </figure>
- </listitem>
- <listitem>
- <para>Select <property>xsd</property> as a namespace in the popup menu.</para>
- </listitem>
- </itemizedlist>
-
- </listitem>
- <listitem>
- <para>Add an <property>Assign</property> element between the <property>receiveInput</property> element and <property>replyOutput</property> element.</para>
- </listitem>
- <listitem>
- <para>Click the <property>Assign</property> element in the BPEL editor in order to get the properties information of it in the Properties view.
- </para>
- </listitem>
- <listitem>
- <para>Set its name in the <property>Description</property> tab as <property>assignHelloMesg</property>.</para>
- <para>In the <property>Details</property> section of Properties view,
- you should click the <property>New</property> button to add a <property>copy</property> sub-element to the element.
- Assign "Variable to Variable"(input:string to output). At this time, an "<property>initializer</property>" popup dialog appears. Click on the <property>Yes</property> button in the dialog.
- </para>
- <figure>
- <title>Add <property>Assign</property> to the process</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/bpel_task_3.png"/>
- </imageobject>
- </mediaobject>
- </figure>
- <para>Then you should click <property>New</property> once more and select Expression to Variable
- (assign <code>concat($input,' World'))</code> to <property>result:string</property>. </para>
- <figure>
- <title>Add <property>Expression assign</property> to the process</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/bpel_task_2.png"/>
- </imageobject>
- </mediaobject>
- </figure>
- </listitem>
- </itemizedlist>
- </section>
-
- <section id="wsdl">
- <title>Adding Service to WSDL file</title>
- <para></para>
- <para>The HelloWorldArtifacts.wsdl has been added a service when you create a BPEL process file. You have a default service in this WSDL file. But if you want to add a service by yourself, you can follow the steps as below: </para>
- <itemizedlist>
-
- <listitem>
- <para>Open the file "<property>HelloWorldArtifacts.wsdl</property>" in the "<property>HelloWorld</property>" project by double-clicking the file. Right-click the WSDL editor and select
- <property>Add Service</property>. A new service should appear in the editor. Name it <property>HelloWorldProcessService</property>. It has the Port
- named <property>NewPort</property>. Select it, right-click on it and rename it to <property>HelloWorldProcessPort</property> in the Properties
- view.
- </para>
- <figure>
- <title>Add <property>Service</property> to the WSDL file</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/detail_editprocess_3.png"/>
- </imageobject>
- </mediaobject>
- </figure>
- </listitem>
- <listitem>
- <para>Right-click somewhere in the whitespace of the WSDL editor and select
- <property>Add Binding</property>. A new Binding component will appear in the editor. Name it <property>HelloWorldSOAPBinding</property>. Select it, in the
- General tab of the Properties view and select <property>HelloWorld</property> as a port type in the <property>PortType</property>. Then click on the
- <property>Generate Binding Content...</property> button to open the <property>Binding Wizard</property>. In the wizard, select <property>SOAP </property>
- as the <property>Protocol</property>. Finally, click the <property>Finish</property> button to close the wizard.
- </para>
- <figure>
- <title>Add a <property>Binding</property> to the WSDL file</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/detail_editprocess_4.png"/>
- </imageobject>
- </mediaobject>
- </figure>
- </listitem>
- <listitem>
- <para>Click the <property>HelloWorldProcessPort</property> property in the General section of the Properties view, select <property>HelloWorldSOAPBinding</property> in
- the <property>Binding</property> combobox. In the <property>Address</property> field input <ulink url="http://localhost:8080/bpel/processes/HelloWorld?wsdl">http://localhost:8080/bpel/processes/HelloWorld?wsdl</ulink>.
- </para>
- <figure>
- <title>Add the <property>HelloWorldSOAPBinding</property> to the <property>HelloWorldProcessPort</property></title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/detail_editprocess_5.png"/>
- </imageobject>
- </mediaobject>
- </figure>
- </listitem>
- <listitem><para>You should also change some service part configurations.
- To do this,click part element in the WSDL editor,
- then put the following data in the Properties view.
- </para>
- <figure>
- <title>Configuration of service part</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/detail_editprocess_5.png"/>
- </imageobject>
- </mediaobject>
- </figure>
- </listitem>
- </itemizedlist>
-
- <para>Now you have finished creating a simple BPEL process.As a next step, you can deploy the BPEL project to JBoss BPEL Runtime.</para>
-
- </section>
-
- </section>
- <section id="deploy">
- <title>Deploy a JBoss BPEL project to JBoss BPEL Runtime</title>
- <section id="createdeploy">
- <title>Creating a deploy.xml file</title>
- <para>If you want to deploy a BPEL project to JBoss BPEL Runtime, you should create a bpel-deploy.xml file.
- JBoss tools can help you to create it:
- </para>
- <itemizedlist>
- <listitem>
- <para>Create the deploy.xml by selecting
- <emphasis><property>New > Other... > BPEL 2.0 > Apache ODE Deployment Descriptor</property></emphasis>. Click the <property>Next</property> button.
- </para>
- <figure>
- <title>New BPEL Deploy file</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/deploy_createdeploy_1.png"/>
- </imageobject>
- </mediaobject>
- </figure>
- </listitem>
- <listitem>
- <para>On the next wizard page you should enter the following information:</para>
- <para><emphasis><property>BPEL Project</property></emphasis>: Click the <property>Browse...</property> button to select the BPEL project in your workspace which you want to deploy to the runtime.
- Please note, that you should select the <property>bpelContent</property> folder in your new BPEL project as a value of <property>BPEL Project</property> field because the deploy.xml should be created in this place.
- </para>
- <para><emphasis><property>File name</property></emphasis>: The default value is deploy.xml. Please, don't change it.</para>
- <para>Click on <property>Finish</property> button to close the wizard and a new deploy.xml file will be created.</para>
- <figure>
- <title>New BPEL Deploy file Wizard</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/deploy_createdeploy_2.png"/>
- </imageobject>
- </mediaobject>
- </figure>
- </listitem>
- <listitem>
- <para>Double-click the deploy.xml file to open it in ODE Descriptor Deployment Editor.
- In the <property>Inbound Interfaces</property> section, click the
- <property>Associated Port</property> column and select <property>HelloWorldProcessPort</property>
- in the dropdown box.The <property>Related Service</property> and <property>Binding Used</property>
- columns should be automatically filled in. Save the <emphasis><property>deploy.xml</property></emphasis>.
- </para>
- <figure>
- <title>deploy.xml file editor</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/deploy_createdeploy_3.png"/>
- </imageobject>
- </mediaobject>
- </figure>
- </listitem>
- </itemizedlist>
- </section>
- <section id="createruntime">
- <title>Creating JBoss BPEL Server</title>
- <para>Suppose you have installed the <property>JBoss BPEL Runtime-RiftSaw</property> as it was described in <xref linkend="installRuntime"/>, now you can create a server for JBoss BPEL runtime.</para>
- <itemizedlist>
- <listitem>
- <para>Open the <property>Servers</property> view by selecting
- <emphasis><property>Windows > Show View > Other... > Server > Servers</property></emphasis>.
- </para>
- </listitem>
- <listitem>
- <para>Right-click the Servers view and select
- <emphasis><property>New > Server</property></emphasis> to open the New Server Wizard:
- </para>
- <figure>
- <title>New Server Wizard</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/deploy_createdeploy_4.png"/>
- </imageobject>
- </mediaobject>
- </figure>
- </listitem>
- <listitem>
- <para>Select <property>JBoss AS 5.1 </property>as a server type. </para>
- <note>
- <para>Please note, that only JBoss As 5.1 or higher version supports BPEL.</para>
- </note>
- </listitem>
- <listitem>
-
- <para>Click the <property>Next</property> button. On the next page, you should input your <emphasis><property>JBoss As</property></emphasis> location. Then click the <property>Next</property> button and
- you will get the page like this:
- </para>
- <figure>
- <title>Add resource to the server</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/deploy_createdeploy_5.png"/>
- </imageobject>
- </mediaobject>
- </figure>
- </listitem>
- <listitem>
- <para>Select <property>HelloWorld</property>, then click the <property>Add </property> button to add the project to the server.
- Then click on the <property>Finish</property> button.
- </para>
- <para>Start the server by right-clicking on the server and selecting the <property>Start</property> item. </para>
-
- <figure>
- <title>The started server</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/deploy_createdeploy_6.png"/>
- </imageobject>
- </mediaobject>
- </figure>
- <para>If some aspects of server creation is not clear, please, read <ulink url="http://download.jboss.org/jbosstools/nightly-docs/en/as/html_single/index...">JBoss Server Manager Reference Guide</ulink> for more details.</para>
- </listitem>
- <listitem>
- <para>You can enter the link <ulink url="http://localhost:8080/bpel-console/app.html">http://localhost:8080/bpel-console/app.html</ulink> to the browser to get the deployed processes.</para>
- <figure>
- <title>The BPEL console</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/deploy_createdeploy_7.png"/>
- </imageobject>
- </mediaobject>
- </figure>
- </listitem>
- </itemizedlist>
- <para>If there's anything we didn't cover or you can't figure out, please feel free to visit our <ulink
- url="http://www.jboss.com/index.html?module=bb&op=viewforum&f=201"
- >JBoss Tools Users Forum</ulink> to ask questions.
- There we are also waiting for your suggestions and comments.</para>
- </section>
- </section>
+ </note>
+
+ <para>Up to now, you have got a simple BPEL process as on the screen below.</para>
+ <figure>
+ <title>A simple BPEL Process File</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/detail_createprocess_3.png"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ <para>In the next step, you can edit the BPEL process file and then deploy it to JBoss server. </para>
+ </section>
+ <section id="editprocess">
+ <title>Editing a BPEL process file</title>
+ <para>
+ If the <guilabel>Properties view</guilabel> and <guilabel>Palette view</guilabel> are not opened, you can open the views by right-clicking the BPEL editor and selecting <guilabel>Show in Properties</guilabel>, <guilabel>Show Palette in Palette view</guilabel>. Then you should have the view like this:
+ </para>
+ <figure>
+ <title>The BPEL editor view</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/detail_editprocess_1.png"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ <para>In the <guilabel>Palette</guilabel> view, you can drag a BPEL element to the BPEL editor and drop it in the place you want.</para>
+ <para>
+ In the <guilabel>Properties</guilabel> view, you can get the information about every element of the BPEL process. In the BPEL editor select any element you want,and then the element's properties will be shown in the <guilabel>Properties</guilabel> view. The table below describes the tabs of the <guilabel>Properties</guilabel> view:
+ </para>
+ <table>
+
+ <title>Tabs of the Property view</title>
+ <tgroup cols="2">
+ <colspec colnum="1" align="left" colwidth="2*"/>
+ <colspec colnum="2" colwidth="4*"/>
+ <thead>
+ <row>
+ <entry>Tab</entry>
+ <entry>Description</entry>
+ </row>
+ </thead>
+ <tbody>
+ <row>
+ <entry>
+ <para>Description</para>
+ </entry>
+ <entry>
+ <para>Shows the descriptive information about the element,e.g. <property>Name</property> of the element.</para>
+ </entry>
+ </row>
+ <row>
+ <entry>
+ <para>Details</para>
+ </entry>
+ <entry>
+ <para>
+ Shows the detailed and important information about the element. It is the most important section of an element. Most of the properties of an element are set in this section.
+ </para>
+ </entry>
+ </row>
+ <row>
+ <entry>
+ <para>Join Behavior</para>
+ </entry>
+ <entry>
+ <para>Shows the <property>Join Failure</property> property of the element.</para>
+ </entry>
+ </row>
+ <row>
+ <entry>
+ <para>Documentation</para>
+ </entry>
+ <entry>
+ <para>Shows the <property>documentation</property> sub-element of an element.</para>
+ </entry>
+ </row>
+ <row>
+ <entry>
+ <para>Other</para>
+ </entry>
+ <entry>
+ <para>
+ Every BPEL element has its own sections: Correlation section, Message Exchange section, and so on. We will introduce them while using them.
+ </para>
+ </entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </table>
+ <para>In order to see how a simple BPEL process works in action, you should do some steps as below: </para>
+ <itemizedlist>
+ <listitem>
+ <para>Modify two variables of the process:</para>
+ <itemizedlist>
+ <listitem>
+ <para>
+ Click on the details tab of the input variable, click the <guibutton>Browse...</guibutton> button. Then choose <property>string</property> primitive from the list.
+ </para>
+ <figure>
+ <title>Edit variable in <property>process</property> file</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/bpel_task_1.png"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ </listitem>
+ <listitem>
+ <para>Select <property>xsd</property> as a namespace in the popup menu.</para>
+ </listitem>
+ </itemizedlist>
+
+ </listitem>
+ <listitem>
+ <para>
+ Add an <property>Assign</property> element between the <property>receiveInput</property> element and <property>replyOutput</property> element.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ Click the <property>Assign</property> element in the BPEL editor in order to get the properties information of it in the Properties view.
+ </para>
+ </listitem>
+ <listitem>
+ <para>Set its name in the <property>Description</property> tab as <property>assignHelloMesg</property>.</para>
+ <para>
+ In the <property>Details</property> section of Properties view, you should click the <property>New</property> button to add a <property>copy</property> sub-element to the element. Assign "Variable to Variable"(input:string to output). At this time, an "<property>initializer</property>" popup dialog appears. Click on the <property>Yes</property> button in the dialog.
+ </para>
+ <figure>
+ <title>Add <property>Assign</property> to the process</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/bpel_task_3.png"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ <para>
+ Then you should click the <guibutton>New</guibutton> once more and select Expression to Variable (assign <code>concat($input,' World'))</code> to <property>result:string</property>.
+ </para>
+ <figure>
+ <title>Add <property>Expression assign</property> to the process</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/bpel_task_2.png"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ </listitem>
+ </itemizedlist>
+ </section>
+
+ <section id="wsdl">
+ <title>Adding Service to WSDL file</title>
+ <para></para>
+ <para>
+ The <filename>HelloWorldArtifacts.wsdl</filename> file has been added a service when you create a BPEL process file. You have a default service in this WSDL file. But if you want to add a service by yourself, you can follow the steps as below:
+ </para>
+ <itemizedlist>
+ <listitem>
+ <para>
+ Open the file <filename>HelloWorldArtifacts.wsdl</filename> in the "<property>HelloWorld</property>" project by double-clicking the file. Right-click the WSDL editor and select <guilabel>Add Service</guilabel>. A new service should appear in the editor. Name it <property>HelloWorldProcessService</property>. It has the Port named <property>NewPort</property>. Select it, right-click on it and rename it to <property>HelloWorldProcessPort</property> in the Properties view.
+ </para>
+ <figure>
+ <title>Add <property>Service</property> to the WSDL file</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/detail_editprocess_3.png"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ </listitem>
+ <listitem>
+ <para>
+ Right-click somewhere in the whitespace of the WSDL editor and select <guilabel>Add Binding</guilabel>. A new Binding component will appear in the editor. Name it <property>HelloWorldSOAPBinding</property>. Select it, in the General tab of the Properties view and select <property>HelloWorld</property> as a port type in the <property>PortType</property>. Then click on the <property>Generate Binding Content...</property> button to open the <property>Binding Wizard</property>. In the wizard, select <property>SOAP</property> as the <property>Protocol</property>. Finally, click the <guibutton>Finish</guibutton> button to close the wizard.
+ </para>
+ <figure>
+ <title>Add a <property>Binding</property> to the WSDL file</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/detail_editprocess_4.png"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ </listitem>
+ <listitem>
+ <para>
+ Click the <property>HelloWorldProcessPort</property> property in the General section of the Properties view, select <property>HelloWorldSOAPBinding</property> in the <property>Binding</property> combobox. In the <property>Address</property> field input <ulink url="http://localhost:8080/bpel/processes/HelloWorld?wsdl">http://localhost:8080/bpel/processes/HelloWorld?wsdl</ulink>.
+ </para>
+ <figure>
+ <title>Add the <property>HelloWorldSOAPBinding</property> to the <property>HelloWorldProcessPort</property>
+ </title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/detail_editprocess_5.png"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ </listitem>
+ <listitem>
+ <para>
+ You should also change some service part configurations. To do this, click part element in the WSDL editor, then put the following data in the Properties view.
+ </para>
+ <figure>
+ <title>Configuration of service part</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/detail_editprocess_5.png"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ </listitem>
+ </itemizedlist>
+
+ <para>Now you have finished creating a simple BPEL process. As a next step, you can deploy the BPEL project to JBoss BPEL Runtime.</para>
+
+ </section>
+
+ </section>
+ <section id="deploy">
+ <title>Deploy a JBoss BPEL project to JBoss BPEL Runtime</title>
+ <section id="createdeploy">
+ <title>Creating a deploy.xml file</title>
+ <para>
+ If you want to deploy a BPEL project to JBoss BPEL Runtime, you should create a <filename>bpel-deploy.xml</filename> file. JBoss tools can help you to create it:
+ </para>
+ <itemizedlist>
+ <listitem>
+ <para>
+ Create the deploy.xml by selecting <menuchoice><guimenuitem>New</guimenuitem><guimenuitem>Other...</guimenuitem><guimenuitem>BPEL 2.0</guimenuitem><guimenuitem>Apache ODE Deployment Descriptor</guimenuitem></menuchoice>. Click the <guibutton>Next</guibutton> button.
+ </para>
+ <figure>
+ <title>New BPEL Deploy file</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/deploy_createdeploy_1.png"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ </listitem>
+ <listitem>
+ <para>On the next wizard page you should enter the following information:</para>
+ <para>
+ <emphasis><property>BPEL Project</property> </emphasis>: Click the <guibutton>Browse...</guibutton> button to select the BPEL project in your workspace which you want to deploy to the runtime. Please note, that you should select the <filename>bpelContent</filename> folder in your new BPEL project as a value of <property>BPEL Project</property> field because the <filename>deploy.xml</filename> should be created in this place.
+ </para>
+ <para>
+ <emphasis><property>File name</property></emphasis>: The default value is <filename>deploy.xml</filename>. Please, don't change it.
+ </para>
+ <para>Click on the <guibutton>Finish</guibutton> button to close the wizard and a new <filename>deploy.xml</filename> file will be created.</para>
+ <figure>
+ <title>New BPEL Deploy file Wizard</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/deploy_createdeploy_2.png"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ </listitem>
+ <listitem>
+ <para>
+ Double-click the <filename>deploy.xml</filename> file to open it in ODE Descriptor Deployment Editor. In the <property>Inbound Interfaces</property> section, click the <property>Associated Port</property> column and select <property>HelloWorldProcessPort</property> in the dropdown box.The <property>Related Service</property> and <property>Binding Used</property> columns should be automatically filled in. Save the <filename>deploy.xml</filename>.
+ </para>
+ <figure>
+ <title>deploy.xml file editor</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/deploy_createdeploy_3.png"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ </listitem>
+ </itemizedlist>
+ </section>
+ <section id="createruntime">
+ <title>Creating JBoss BPEL Server</title>
+ <para>
+ Suppose you have installed the <property>JBoss BPEL Runtime-RiftSaw</property> as it was described in <xref linkend="installRuntime"/>, now you can create a server for JBoss BPEL runtime.
+ </para>
+ <itemizedlist>
+ <listitem>
+ <para>
+ Open the <property>Servers</property> view by selecting <menuchoice><guimenuitem>Windows</guimenuitem><guimenuitem>Show View</guimenuitem><guimenuitem>Other...</guimenuitem><guimenuitem>Server</guimenuitem><guimenuitem>Servers</guimenuitem></menuchoice>.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ Right-click the Servers view and select <menuchoice><guimenuitem>New</guimenuitem><guimenuitem>Server</guimenuitem></menuchoice> to open the New Server Wizard:
+ </para>
+ <figure>
+ <title>New Server Wizard</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/deploy_createdeploy_4.png"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ </listitem>
+ <listitem>
+ <para>Select <property>JBoss AS 5.1</property> as a server type. </para>
+ <note>
+ <para>Please note, that only JBoss As 5.1 or higher version supports BPEL.</para>
+ </note>
+ </listitem>
+ <listitem>
+
+ <para>
+ Click the <guibutton>Next</guibutton> button. On the next page, you should input your <emphasis><property>JBoss As</property> </emphasis> location. Then click the <guibutton>Next</guibutton> button and you will get the page like this:
+ </para>
+ <figure>
+ <title>Add resource to the server</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/deploy_createdeploy_5.png"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ </listitem>
+ <listitem>
+ <para>
+ Select <property>HelloWorld</property>, then click the <guibutton>Add</guibutton> button to add the project to the server. Then click on the <guibutton>Finish</guibutton> button.
+ </para>
+ <para>Start the server by right-clicking on the server and selecting the <guilabel>Start</guilabel> item. </para>
+
+ <figure>
+ <title>The started server</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/deploy_createdeploy_6.png"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ <para>If some aspects of server creation is not clear, please, read <ulink url="http://download.jboss.org/jbosstools/nightly-docs/en/as/html_single/index...">JBoss Server Manager Reference Guide</ulink> for more details.</para>
+ </listitem>
+ <listitem>
+ <para>You can enter the link <ulink url="http://localhost:8080/bpel-console/app.html">http://localhost:8080/bpel-console/app.html</ulink> to the browser to get the deployed processes.</para>
+ <figure>
+ <title>The BPEL console</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/deploy_createdeploy_7.png"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ </listitem>
+ </itemizedlist>
+ <para>If there's anything we didn't cover or you can't figure out, please feel free to visit our <ulink url="http://www.jboss.com/index.html?module=bb&op=viewforum&f=201">JBoss Tools Users Forum</ulink> to ask questions.
+ There we are also waiting for your suggestions and comments.</para>
+ </section>
+ </section>
</chapter>
15 years, 2 months
JBoss Tools SVN: r28336 - trunk/documentation/guides/GettingStartedGuide/en-US.
by jbosstools-commits@lists.jboss.org
Author: mcaspers
Date: 2011-01-17 21:47:05 -0500 (Mon, 17 Jan 2011)
New Revision: 28336
Modified:
trunk/documentation/guides/GettingStartedGuide/en-US/Revision_History.xml
Log:
General Updates
Modified: trunk/documentation/guides/GettingStartedGuide/en-US/Revision_History.xml
===================================================================
--- trunk/documentation/guides/GettingStartedGuide/en-US/Revision_History.xml 2011-01-18 02:44:27 UTC (rev 28335)
+++ trunk/documentation/guides/GettingStartedGuide/en-US/Revision_History.xml 2011-01-18 02:47:05 UTC (rev 28336)
@@ -7,7 +7,7 @@
<revhistory>
<revision>
<revnumber>2</revnumber>
- <date>Tue Jan 18 2010</date>
+ <date>Tue Jan 18 2011</date>
<author>
<firstname>JBoss Tools</firstname>
<surname>Documentation Team</surname>
15 years, 2 months
JBoss Tools SVN: r28335 - trunk/documentation/guides/GettingStartedGuide/en-US.
by jbosstools-commits@lists.jboss.org
Author: mcaspers
Date: 2011-01-17 21:44:27 -0500 (Mon, 17 Jan 2011)
New Revision: 28335
Modified:
trunk/documentation/guides/GettingStartedGuide/en-US/Book_Info.xml
Log:
General Updates
Modified: trunk/documentation/guides/GettingStartedGuide/en-US/Book_Info.xml
===================================================================
--- trunk/documentation/guides/GettingStartedGuide/en-US/Book_Info.xml 2011-01-18 02:43:05 UTC (rev 28334)
+++ trunk/documentation/guides/GettingStartedGuide/en-US/Book_Info.xml 2011-01-18 02:44:27 UTC (rev 28335)
@@ -7,7 +7,7 @@
<productname>JBoss Developer Studio</productname>
<productnumber>4.0</productnumber>
<edition>4.0.0</edition>
- <pubsnumber>5</pubsnumber>
+ <pubsnumber>6</pubsnumber>
<abstract>
<para>The Getting Started Guide explains the JBoss Developer Studio.</para>
</abstract>
15 years, 2 months
JBoss Tools SVN: r28334 - trunk/documentation/guides/GettingStartedGuide/en-US.
by jbosstools-commits@lists.jboss.org
Author: mcaspers
Date: 2011-01-17 21:43:05 -0500 (Mon, 17 Jan 2011)
New Revision: 28334
Modified:
trunk/documentation/guides/GettingStartedGuide/en-US/Revision_History.xml
trunk/documentation/guides/GettingStartedGuide/en-US/gsg_faq.xml
trunk/documentation/guides/GettingStartedGuide/en-US/rad_jsf_application.xml
Log:
General Updates
Modified: trunk/documentation/guides/GettingStartedGuide/en-US/Revision_History.xml
===================================================================
--- trunk/documentation/guides/GettingStartedGuide/en-US/Revision_History.xml 2011-01-18 02:28:29 UTC (rev 28333)
+++ trunk/documentation/guides/GettingStartedGuide/en-US/Revision_History.xml 2011-01-18 02:43:05 UTC (rev 28334)
@@ -1,4 +1,52 @@
<?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>1</revnumber><date>Wed Jun 09 2010</date><author><firstname>JBoss Tools</firstname><surname>Documentation Team</surname><email></email></author><revdescription><simplelist><member>General updates</member></simplelist></revdescription></revision><revision><revnumber>0</revnumber><date>Fri Nov 20 2009</date><author><firstname>Isaac</firstname><surname>Rooskov</surname><email>irooskov(a)redhat.com</email></author><revdescription><simplelist><member>Initial creation of book by publican</member></simplelist></revdescription></revision></revhistory></simpara></appendix>
+<appendix>
+ <title>Revision History</title>
+ <simpara>
+ <revhistory>
+ <revision>
+ <revnumber>2</revnumber>
+ <date>Tue Jan 18 2010</date>
+ <author>
+ <firstname>JBoss Tools</firstname>
+ <surname>Documentation Team</surname>
+ <email></email>
+ </author>
+ <revdescription>
+ <simplelist>
+ <member>General updates</member>
+ </simplelist>
+ </revdescription>
+ </revision>
+ <revision>
+ <revnumber>1</revnumber>
+ <date>Wed Jun 09 2010</date>
+ <author>
+ <firstname>JBoss Tools</firstname>
+ <surname>Documentation Team</surname>
+ <email></email>
+ </author>
+ <revdescription>
+ <simplelist>
+ <member>General updates</member>
+ </simplelist>
+ </revdescription>
+ </revision>
+ <revision>
+ <revnumber>0</revnumber>
+ <date>Fri Nov 20 2009</date>
+ <author>
+ <firstname>Isaac</firstname>
+ <surname>Rooskov</surname>
+ <email>irooskov(a)redhat.com</email>
+ </author>
+ <revdescription>
+ <simplelist>
+ <member>Initial creation of book by publican</member>
+ </simplelist>
+ </revdescription>
+ </revision>
+ </revhistory>
+ </simpara>
+</appendix>
Modified: trunk/documentation/guides/GettingStartedGuide/en-US/gsg_faq.xml
===================================================================
--- trunk/documentation/guides/GettingStartedGuide/en-US/gsg_faq.xml 2011-01-18 02:28:29 UTC (rev 28333)
+++ trunk/documentation/guides/GettingStartedGuide/en-US/gsg_faq.xml 2011-01-18 02:43:05 UTC (rev 28334)
@@ -1,88 +1,82 @@
<?xml version="1.0" encoding="UTF-8"?>
<chapter id="gsg_faq" role="updated">
- <?dbhtml filename="gsg_faq.html"?>
- <chapterinfo>
- <keywordset>
- <keyword>JBoss Developer Studio</keyword>
- <keyword>Eclipse</keyword>
- <keyword>Java</keyword>
- <keyword>JBoss</keyword>
- </keywordset>
- </chapterinfo>
- <title>FAQ</title>
+ <?dbhtml filename="gsg_faq.html"?>
+ <chapterinfo>
+ <keywordset>
+ <keyword>JBoss Developer Studio</keyword>
+ <keyword>Eclipse</keyword>
+ <keyword>Java</keyword>
+ <keyword>JBoss</keyword>
+ </keywordset>
+ </chapterinfo>
+ <title>FAQ</title>
- <para>For more information on <property>JBoss Developer Studio</property> features, refer to the
- following FAQ to get the answers on the most "popular" questions.</para>
+ <para>Refer to the following FAQ to get the answers on the most "popular" questions concerning <property>JBoss Developer Studio</property>.</para>
- <section id="question_1">
- <title>What should I do if Visual Page Editor does not start under Linux</title>
+ <section id="question_1">
+ <title>What should I do if the Visual Page Editor does not start under Linux</title>
- <para>Linux users may need to do the following to get the <property>Visual Page
- Editor</property> to work correctly on their machines.</para>
+ <para>Linux users may need to do the following to get the <property>Visual Page Editor</property> to work correctly on their machines.</para>
- <orderedlist>
- <listitem>
- <para>On Red Hat based Linux distributions install the xpLib.i386 package</para>
- </listitem>
- <listitem>
- <para>Type</para>
- <programlisting role="JAVA"><![CDATA[ln -s libstdc++.so.5.0.7 libstdc++.so.5
+ <orderedlist>
+ <listitem>
+ <para>On Red Hat based Linux distributions install the xpLib.i386 package</para>
+ </listitem>
+ <listitem>
+ <para>Type</para>
+ <programlisting role="JAVA"><![CDATA[ln -s libstdc++.so.5.0.7 libstdc++.so.5
]]></programlisting>
- </listitem>
- <listitem>
- <para>and/or use</para>
- <programlisting role="JAVA"><![CDATA[yum install libXp
+ </listitem>
+ <listitem>
+ <para>and/or use</para>
+ <programlisting role="JAVA"><![CDATA[yum install libXp
]]></programlisting>
- </listitem>
- <listitem>
- <para>Open the JBDS perspective. If you see the Help view open, close it and restart
- JBDS</para>
- </listitem>
- <listitem><para> If it doesn't help and you use Fedora Core Linux and Eclipse Version: 3.4.1,the issue can be produced because libswt-xulrunner-gtk-3449.so file doesn't present
- in eclipse-swt-3.4.1-5.fc10.x86_64.rpm/eclipse/plugins/org.eclipse.swt.gtk.linux.x86_64_3.4.1.v3449c.jar.To add this file to eclipse you should:
+ </listitem>
+ <listitem>
+ <para>Open the JBDS perspective. If you see the Help view open, close it and restart JBDS</para>
+ </listitem>
+ <listitem>
+ <para> If it doesn't help and you use Fedora Core Linux and Eclipse Version: 3.4.1,the issue can be produced because libswt-xulrunner-gtk-3449.so file doesn't present in eclipse-swt-3.4.1-5.fc10.x86_64.rpm/eclipse/plugins/org.eclipse.swt.gtk.linux.x86_64_3.4.1.v3449c.jar. To add this file to eclipse you should:
</para>
- <itemizedlist>
- <listitem>
- <para>Decompress eclipse/plugins/org.eclipse.swt.gtk.linux.x86_3.4.1.v3449c.jar form eclipse-SDK-3.4.1-linux-gtk-x86_64.tar.gz</para>
- </listitem>
- <listitem>
- <para>Copy <property>libswt-xulrunner-gtk-3449.so</property> file to your Fedora Eclipse location.</para>
- </listitem>
-
- <listitem>
- <para>Open the file eclipse.ini,which can be found in your Fedora Eclipse location and add the following line: </para>
- <programlisting role="JAVA"><![CDATA[-Dswt.library.path=/usr/lib/eclipse
-]]></programlisting><para>,where <code>/usr/lib/eclipse</code> is the path to your eclipse folder.</para>
- </listitem>
- </itemizedlist>
- </listitem>
- <listitem>
- <para>If none of these work, do the following:</para>
- <itemizedlist>
- <listitem>
- <para>Clear the Eclipse log file,
- <emphasis><workspace>\.metadata\.log</emphasis></para>
- </listitem>
- <listitem>
- <para>Start Eclipse with the -debug option:</para>
- <programlisting role="JAVA"><![CDATA[eclipse -debug
-]]></programlisting>
- </listitem>
- <listitem>
- <para>Post the Eclipse log file
- (<emphasis><workspace>\.metadata\.log</emphasis>) on
- the forums.</para>
- </listitem>
- </itemizedlist>
- </listitem>
- </orderedlist>
- </section>
-
- <section id="question_0x2">
- <title>Visual Editor starts OK, but the Missing Natures dialog appears</title>
+ <itemizedlist>
+ <listitem>
+ <para>Decompress eclipse/plugins/org.eclipse.swt.gtk.linux.x86_3.4.1.v3449c.jar form eclipse-SDK-3.4.1-linux-gtk-x86_64.tar.gz</para>
+ </listitem>
+ <listitem>
+ <para>Copy <property>libswt-xulrunner-gtk-3449.so</property> file to your Fedora Eclipse location.</para>
+ </listitem>
- <figure>
+ <listitem>
+ <para>Open the file <filename>eclipse.ini</filename>, which can be found in your Fedora Eclipse location and add the following line: </para>
+ <programlisting role="JAVA"><![CDATA[-Dswt.library.path=/usr/lib/eclipse]]></programlisting>
+ <para>,where <code>/usr/lib/eclipse</code> is the path to your eclipse folder.</para>
+ </listitem>
+ </itemizedlist>
+ </listitem>
+ <listitem>
+ <para>If none of these work, do the following:</para>
+ <itemizedlist>
+ <listitem>
+ <para>Clear the Eclipse log file,<filename><workspace>\.metadata\.log</filename>
+ </para>
+ </listitem>
+ <listitem>
+ <para>Start Eclipse with the -debug option:</para>
+ <programlisting role="JAVA"><![CDATA[eclipse -debug]]></programlisting>
+ </listitem>
+ <listitem>
+ <para>Post the Eclipse log file(<filename><workspace>\.metadata\.log</filename>) on the forums.</para>
+ </listitem>
+ </itemizedlist>
+ </listitem>
+ </orderedlist>
+ </section>
+
+ <section id="question_0x2">
+ <title>Visual Editor starts OK, but the Missing Natures dialog appears</title>
+
+ <figure>
<title>Missing Nature</title>
<mediaobject>
<imageobject>
@@ -92,165 +86,135 @@
</figure>
- <para>
+ <para>
Some functionality of Visual Editor may not work if a project doesn't have <property>org.jboss.tools.jsf.jsfnature</property> or <property>org.jboss.tools.jst.web.kb.kbnature</property> in <property>.project</property> configuration. To fix this problem and turn off the message box execute next steps:
-</para>
-<orderedlist>
-<listitem><para>
+ </para>
+ <orderedlist>
+ <listitem>
+ <para>
Right mouse button click on a project in Package Explorer.
- </para></listitem>
- <listitem><para>
- Select <property>Configure -> Add JSF Capabilities</property> from the context menu.
- </para></listitem>
- <listitem><para>
+ </para>
+ </listitem>
+ <listitem>
+ <para> Select <menuchoice><guimenuitem>Configure</guimenuitem><guimenuitem>Add JSF Capabilities</guimenuitem></menuchoice> from the context menu.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
Configure your project using Add JSF Capabilities wizard and press Finish.
-</para></listitem>
+</para>
+ </listitem>
-</orderedlist>
-<para>
-If you are shure that your project does not need JSF capabilities, just disable this message box by checking <property>Do not show this dialog again!</property> checkbox.
+ </orderedlist>
+ <para>
+If you are sure that your project does not need JSF capabilities, just disable this message box by checking <property>Do not show this dialog again!</property> checkbox.
</para>
</section>
- <section id="question_2">
- <title>Do I need to have JBoss Server installed to run JBoss Developer Studio?</title>
+ <section id="question_2">
+ <title>Do I need to have JBoss Server installed to run JBoss Developer Studio?</title>
- <para>No. <property>JBoss Developer Studio</property> already comes bundled with JBoss
- Server. We bundle it together so that you don't need to download any additional
- software and can test your application in a Web browser right away.</para>
- <para>If you want to use a different JBoss server installation, after <property>JBoss
- Developer Studio</property> is installed open Servers View (select
- <emphasis><property>Window > Show View > Others > Server
- > Servers</property>),</emphasis> then right click on this <emphasis>
- <property>view > New > Server</property>
- </emphasis> and follow the wizards steps to point to another Jboss Server
- installation.</para>
- <para><property>JBoss Developer Studio</property> works with any servlet container, not just
- JBoss. For more information on deployment, please see the Deploying Your Application
- section.</para>
- </section>
+ <para>No. <property>JBoss Developer Studio</property> already comes bundled with JBoss Server. We bundle it together so that you don't need to download any additional software and can test your application in a Web browser right away.</para>
+ <para>If you want to use a different JBoss server installation, after <property>JBoss Developer Studio</property> is installed open Servers View (select <menuchoice><guimenuitem>Window</guimenuitem><guimenuitem>Show View</guimenuitem><guimenuitem>Others</guimenuitem><guimenuitem>Server</guimenuitem><guimenuitem>Servers</guimenuitem></menuchoice>), then right click and select <menuchoice><guimenuitem>View</guimenuitem><guimenuitem>New</guimenuitem><guimenuitem>Server</guimenuitem></menuchoice> and follow the wizards steps to point to another Jboss Server installation.</para>
+ <para>
+ <property>JBoss Developer Studio</property> works with any servlet container, not just JBoss. For more information on deployment, please see the Deploying Your Application section.</para>
+ </section>
- <section id="question_3">
- <title>I have an existing Seam 1.2.1 project. Can I migrate/import the project to a JBDS
- Seam project?</title>
+ <section id="question_3">
+ <title>I have an existing Seam 1.2.1 project. Can I migrate/import the project to a JBDS Seam project?</title>
- <para>We highly recommend you to create Seam 1.2.1 project using the
- <property>JBDS</property>. In other case try to do manually:</para>
+ <para>We highly recommend you to create Seam 1.2.1 project using the <property>JBDS</property>. In other case try to do manually:</para>
- <itemizedlist>
- <listitem>
- <para>Create a Seam Web project to get the JBoss tools structure</para>
- </listitem>
- </itemizedlist>
- <para>Then from your Seam 1.2.1 seam-gen project start doing the following:</para>
- <itemizedlist>
- <listitem>
- <para>Copy <property>src</property> to <property>src</property></para>
- </listitem>
- <listitem>
- <para>Copy <property>view</property> to <property>Web content</property></para>
- </listitem>
- <listitem>
- <para>Copy resources individual files to where they are in the seam web project
- etc.</para>
- </listitem>
- </itemizedlist>
+ <itemizedlist>
+ <listitem>
+ <para>Create a Seam Web project to get the JBoss tools structure</para>
+ </listitem>
+ </itemizedlist>
+ <para>Then from your Seam 1.2.1 seam-gen project start doing the following:</para>
+ <itemizedlist>
+ <listitem>
+ <para>Copy <filename>src</filename> to <filename>src</filename>
+ </para>
+ </listitem>
+ <listitem>
+ <para>Copy <filename>view</filename> to <filename>Web content</filename>
+ </para>
+ </listitem>
+ <listitem>
+ <para>Copy resources individual files to where they are in the seam web project etc.</para>
+ </listitem>
+ </itemizedlist>
- </section>
- <section id="questio_4">
- <title>I have an existing Struts or JSF project. Can I open the project in JBDS?</title>
+ </section>
+ <section id="questio_4">
+ <title>I have an existing Struts or JSF project. Can I open the project in JBDS?</title>
- <para>Yes. From main menu select <emphasis>
- <property>File > Import > Other > JSF Project (or Struts
- Project)</property>
- </emphasis> and follow wizards steps.</para>
+ <para>Yes. From main menu select <menuchoice><guimenuitem>File</guimenuitem><guimenuitem>File</guimenuitem><guimenuitem>Import</guimenuitem><guimenuitem>Other</guimenuitem><guimenuitem>JSF Project (or Struts Project)</guimenuitem></menuchoice> and follow wizards steps.</para>
- </section>
+ </section>
- <section id="question_5">
- <title>Can I import a .war file?</title>
+ <section id="question_5">
+ <title>Can I import a .war file?</title>
- <para>Yes. Select <emphasis><property>File > Import > Web > WAR
- file</property>, </emphasis> then follow importing steps.</para>
- </section>
+ <para>Yes. Select <menuchoice><guimenuitem>File</guimenuitem><guimenuitem>Import</guimenuitem><guimenuitem>Web</guimenuitem><guimenuitem>WAR file</guimenuitem></menuchoice> then follow importing steps.</para>
+ </section>
- <section id="question_6">
- <title>Is it possible to increase the performance of Eclipse after installing your
- product?</title>
+ <section id="question_6">
+ <title>Is it possible to increase the performance of Eclipse after installing your product?</title>
- <para><property>JBoss Developer Studio</property> preconfigures eclipse via the eclipse.ini
- file to allocate extra memory, but if you for some reason need more memory then by
- default, you can manually make adjustments in this file. For example:</para>
- <programlisting role="XML">
- <![CDATA[-vmargs -Xms128m -Xmx512m -XX:MaxPermSize=128m
-]]></programlisting>
- </section>
+ <para>
+ <property>JBoss Developer Studio</property> preconfigures eclipse via the <filename>eclipse.ini</filename> file to allocate extra memory, but if you for some reason need more memory then by default, you can manually make adjustments in this file. For example:</para>
+ <programlisting role="XML"><![CDATA[-vmargs -Xms128m -Xmx512m -XX:MaxPermSize=128m]]></programlisting>
+ </section>
- <section id="question_7">
- <title>How can I add my own tag library to the JBoss Tools Palette?</title>
+ <section id="question_7">
+ <title>How can I add my own tag library to the JBoss Tools Palette?</title>
- <para>See the section on Adding Tag
- Libraries in the Visual Web Tools Guide.</para>
- </section>
+ <para>See the section on Adding Tag Libraries in the Visual Web Tools Guide.</para>
+ </section>
- <section id="question_8">
- <title>How to get Code Assist for Seam specific resources in an externally generated
- project?</title>
+ <section id="question_8">
+ <title>How to get Code Assist for Seam specific resources in an externally generated project?</title>
- <para>To get Code Assist for Seam specific resources in an externally generated project, you
- should enable Seam features in Project Preferences. Right click an imported project and
- navigate <emphasis>
- <property>Properties > Seam Settings</property>.</emphasis> Check <emphasis>
- <property>Seam support</property>
- </emphasis> box to enable all available Seam
- Settings.</para>
- </section>
+ <para>To get Code Assist for Seam specific resources in an externally generated project, you should enable Seam features in Project Preferences. Right click an imported project and navigate
+
+ <menuchoice><guimenuitem>Properties</guimenuitem><guimenuitem>Seam Settings</guimenuitem></menuchoice>. Check <emphasis><property>Seam support</property>
+ </emphasis> box to enable all available Seam Settings.</para>
+ </section>
- <section id="question_9">
- <title>How to import an example Seam project from jboss-eap directory?</title>
+ <section id="question_9">
+ <title>How to import an example Seam project from jboss-eap directory?</title>
- <para>To import an example Seam project from <emphasis>
- <property>jboss-eap</property>
- </emphasis> into your working directory, you should perform the following steps:</para>
+ <para>To import an example Seam project from <emphasis><property>jboss-eap</property></emphasis> into your working directory, you should perform the following steps:</para>
- <itemizedlist>
- <listitem>
- <para>Go to <emphasis>
- <property>New > Other > Java Project from Existing Buildfile</property>
- </emphasis></para>
- </listitem>
+ <itemizedlist>
+ <listitem>
+ <para>Select <menuchoice><guimenuitem>New</guimenuitem><guimenuitem>Other</guimenuitem><guimenuitem>Java Project from Existing Buildfile</guimenuitem></menuchoice></para>
+ </listitem>
- <listitem>
- <para>Point to the <emphasis>
- <property>build.xml</property>
- </emphasis> of any chosen project by pressing <emphasis>
- <property>Browse</property>
- </emphasis> button</para>
- </listitem>
+ <listitem>
+ <para>Point to the<filename>build.xml</filename> file of any chosen project by clicking the <guibutton>Browse</guibutton> button</para>
+ </listitem>
- <listitem>
- <para>Hit <emphasis>
- <property>Finish</property>
- </emphasis> to open the project</para>
- </listitem>
- </itemizedlist>
+ <listitem>
+ <para>Click the <guibutton>Finish</guibutton> button to open the project</para>
+ </listitem>
+ </itemizedlist>
- <para>As these seam examples are non WTP projects, next you should enable Seam support for
- them. To do that, right click the project and go to <emphasis>
- <property>Properties > Seam Settings</property>.</emphasis></para>
- </section>
+ <para>
+ As these seam examples are non WTP projects, next you should enable Seam support for them. To do that, right click the project and select <menuchoice><guimenuitem>Properties</guimenuitem><guimenuitem>Seam Settings</guimenuitem></menuchoice>.
+ </para>
+ </section>
- <section id="question_10">
- <title>Is a cross-platform project import possible for JBDS?</title>
+ <section id="question_10">
+ <title>Is a cross-platform project import possible for JBDS?</title>
- <para>Yes. You can easily import created in Linux JSF, Struts or Seam project to Windows and
- vice versa.</para>
+ <para>Yes. You can easily import created in Linux JSF, Struts or Seam project to Windows and vice versa.</para>
- <para>To do the transferring JSF, Struts or Seam project, go to <emphasis>
- <property>Menu > Import > General > Existing Projects into Workspace</property>,</emphasis>
- select the folder where your project stored and press <emphasis>
- <property>Finish</property>.</emphasis></para>
- </section>
+ <para>
+ To do the transferring JSF, Struts or Seam project, select <menuchoice><guimenuitem>Menu</guimenuitem><guimenuitem>Import</guimenuitem><guimenuitem>General</guimenuitem><guimenuitem>Existing Projects into Workspace</guimenuitem></menuchoice>.
+ </para>
+ </section>
</chapter>
Modified: trunk/documentation/guides/GettingStartedGuide/en-US/rad_jsf_application.xml
===================================================================
--- trunk/documentation/guides/GettingStartedGuide/en-US/rad_jsf_application.xml 2011-01-18 02:28:29 UTC (rev 28333)
+++ trunk/documentation/guides/GettingStartedGuide/en-US/rad_jsf_application.xml 2011-01-18 02:43:05 UTC (rev 28334)
@@ -317,7 +317,7 @@
<para>JBDS allows to quickly generate getters and setters for java bean.</para>
<itemizedlist>
<listitem>
- <para>Right click the <filename>NumberBean.java</filename> file </emphasis> in the Package Explorer view</para>
+ <para>Right click the <filename>NumberBean.java</filename> file in the Package Explorer view</para>
</listitem>
<listitem>
<para>Select <menuchoice><guimenuitem>Source</guimenuitem><guimenuitem>Generate Getters and Setters...</guimenuitem></menuchoice>
15 years, 2 months