Author: mcaspers Date: 2011-03-01 22:19:37 -0500 (Tue, 01 Mar 2011) New Revision: 29437 Modified: trunk/bpel/docs/reference/en-US/Book_Info.xml 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 trunk/bpel/docs/reference/en-US/tasks.xml Log: General Documentation Updates Modified: trunk/bpel/docs/reference/en-US/Book_Info.xml =================================================================== --- trunk/bpel/docs/reference/en-US/Book_Info.xml 2011-03-02 02:50:26 UTC (rev 29436) +++ trunk/bpel/docs/reference/en-US/Book_Info.xml 2011-03-02 03:19:37 UTC (rev 29437) @@ -7,7 +7,7 @@ <productname>JBoss Developer Studio</productname> <productnumber>4.0</productnumber> <edition>4.0.0</edition> - <pubsnumber>8</pubsnumber> + <pubsnumber>9</pubsnumber> <abstract> <para>The JBoss BPEL User Guide explains how to use the BPEL Tools to create BPEL files quickly and with precision.</para> </abstract> Modified: trunk/bpel/docs/reference/en-US/Revision_History.xml =================================================================== --- trunk/bpel/docs/reference/en-US/Revision_History.xml 2011-03-02 02:50:26 UTC (rev 29436) +++ trunk/bpel/docs/reference/en-US/Revision_History.xml 2011-03-02 03:19:37 UTC (rev 29437) @@ -6,7 +6,21 @@ <simpara> <revhistory> <revision> - <revnumber>1-0</revnumber> + <revnumber>0-2</revnumber> + <date>Wed Mar 02 2011</date> + <author> + <firstname>Matthew</firstname> + <surname>Casperson</surname> + <email&gt;mcaspers(a)redhat.com&lt;/email&gt; + </author> + <revdescription> + <simplelist> + <member>Screenshot updates and general editing</member> + </simplelist> + </revdescription> + </revision> + <revision> + <revnumber>0-1</revnumber> <date>Tue Jan 18 2011</date> <author> <firstname>Matthew</firstname> Modified: trunk/bpel/docs/reference/en-US/reference.xml =================================================================== --- trunk/bpel/docs/reference/en-US/reference.xml 2011-03-02 02:50:26 UTC (rev 29436) +++ trunk/bpel/docs/reference/en-US/reference.xml 2011-03-02 03:19:37 UTC (rev 29437) @@ -14,7 +14,7 @@ <title>Wizards</title> <section> <title>New BPEL project Wizard</title> - <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> + <para>This wizard is provided to create a new BPEL project. It is available by selecting <menuchoice><guimenuitem>File</guimenuitem><guimenuitem>New</guimenuitem><guimenuitem>Other</guimenuitem><guimenuitem>BPEL project</guimenuitem></menuchoice>.</para> <figure> <title>New BPEL Project Wizard</title> <mediaobject> @@ -23,12 +23,12 @@ </imageobject> </mediaobject> </figure> - <para>It consists of two pages:</para> + <para>The wizard consists of two pages:</para> <itemizedlist> <listitem> <para>On the first 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, otherwise the user should specify it by himself using <guibutton>Browse</guibutton> button. + If the <guilabel>Use default location</guilabel> option is checked the output directory will be set to the workspace, otherwise a custom location can be specified by clicking the <guibutton>Browse</guibutton> button. </para> <figure> <title>New BPEL Project Wizard</title> @@ -40,7 +40,7 @@ </figure> </listitem> <listitem> - <para>On the second page you can specify the name of the Content Folder.</para> + <para>On the second page you can specify the name of the <guilabel>Content Folder</guilabel>.</para> <figure> <title>New BPEL Project Wizard</title> <mediaobject> @@ -54,7 +54,7 @@ </section> <section> <title>Apache ODE Deployment Descriptor Wizard</title> - <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> + <para>This wizard can be used to create an ODE deployment descriptor (<filename>deploy.xml</filename>) file 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>.</para> <figure> <title>New BPEL Project Wizard</title> <mediaobject> @@ -64,16 +64,16 @@ </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 <filename>/PROJECT_NAME/bpelContent</filename> directory as an output one. + On this 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 for the output. </para> </section> <section> <title>New BPEL Process file Wizard</title> - <para>Using the <property>New BPEL Process file Wizard</property> it is possible to create a BPEL process file and a WSDL file. + <para>Using the <guilabel>New BPEL Process file Wizard</guilabel> 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> + <listitem><para>The first page includes the following options:</para> <table> <title>New BPEL Process file Wizard. First Page Options.</title> <tgroup cols="3"> @@ -135,7 +135,7 @@ </figure> </listitem> - <listitem><para>The second page has the following options to set:</para> + <listitem><para>The second page include the following options:</para> <table> <title>New BPEL Process file Wizard. Second Page Options.</title> <tgroup cols="3"> @@ -195,7 +195,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 <filename>bpelContent</filename> folder. This is necessary for the files to be deployed to a JBoss server. </para> </note> </section> @@ -204,9 +204,8 @@ <title>Editors</title> <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 <menuchoice><guimenuitem>Open With...</guimenuitem><guimenuitem>Business Process Editor</guimenuitem></menuchoice> + <para> + The Business Process Editor is intended to facilitate the process of changing and adding new logic to a BPEL process file. You can open <filename>.bpel</filename> files in this editor by right click the file in the <guilabel>Project Explorer</guilabel> and selecting <menuchoice><guimenuitem>Open With...</guimenuitem><guimenuitem>Business Process Editor</guimenuitem></menuchoice>. </para> <figure> <title>Business Process Editor</title> @@ -216,10 +215,10 @@ </imageobject> </mediaobject> </figure> - <para>The editor consists of two tabs:<property>Design</property> tab and <property>Source</property> tab.</para> + <para>The editor consists of two tabs: the <guilabel>Design</guilabel> tab and the <guilabel>Source</guilabel> tab.</para> <section> <title>Design tab</title> - <para>Design tab is the main part of Business Process Editor.It consists of 3 parts:</para> + <para>The <guilabel>Design</guilabel> tab is the main part of the <guilabel>Business Process Editor</guilabel>. It consists of 3 parts:</para> <itemizedlist> <listitem><para>Visual Pane:</para> <figure> @@ -230,7 +229,7 @@ </imageobject> </mediaobject> </figure> - <para>The Visual Pane graphically displays the order in which the activities are executed.</para> + <para>The Visual Pane provides a graphical representation of the order in which the activities are executed.</para> </listitem> <listitem><para>Palette:</para> <figure> @@ -242,7 +241,7 @@ </mediaobject> </figure> <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. + The <guilabel>Palette</guilabel> view represents the different BPEL activities elements 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. </para> </listitem> <listitem><para>Behavior Components View:</para> @@ -254,10 +253,9 @@ </imageobject> </mediaobject> </figure> - <para>Execution behavior components are grouped into the <property> - Behavior Components View</property>. - The view is also fully synchronized with Properties view where you can customize all - the properties of the component.</para> + <para> + Execution behavior components are grouped into the <guilabel>Behavior Components</guilabel> view. This view is also fully synchronized with <guilabel>Properties</guilabel> view where you can customize all the properties of the component. + </para> <figure> <title>Process Structure View of Business Process Editor</title> <mediaobject> @@ -266,7 +264,7 @@ </imageobject> </mediaobject> </figure> - <para>To add an element to some component group click the plus (<inlinemediaobject> + <para>To add an element to a component group click the plus (<inlinemediaobject> <imageobject> <imagedata fileref="images/reference/bpel_ref_10.png"/> </imageobject> @@ -279,7 +277,7 @@ </section> <section> <title>Source tab</title> - <para>Source tab can be used for editing BPEL process file directly. It is also possible to validate the file structure. + <para>The <guilabel>Source</guilabel> tab can be used for directly editing BPEL process files. It is also possible to validate the file structure. </para> <figure> <title>Validation error in Source tab</title> @@ -289,7 +287,7 @@ </imageobject> </mediaobject> </figure> - <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> + <para>Validation can be enabled or disabled by selecting <menuchoice><guimenuitem>Window</guimenuitem><guimenuitem>Preferences</guimenuitem><guimenuitem>Validation</guimenuitem></menuchoice>.</para> <figure> <title>Validation configuration</title> <mediaobject> @@ -302,7 +300,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, 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>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 looks when it is opened in the editor in the image below: </para> <figure> <title>ODE Deployment Descriptor Editor</title> Modified: trunk/bpel/docs/reference/en-US/summary.xml =================================================================== --- trunk/bpel/docs/reference/en-US/summary.xml 2011-03-02 02:50:26 UTC (rev 29436) +++ trunk/bpel/docs/reference/en-US/summary.xml 2011-03-02 03:19:37 UTC (rev 29437) @@ -3,7 +3,7 @@ <?dbhtml filename="summary.html"?> <title>Summary</title> <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. + 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 please visit the JBoss Tools Users forum. </para> <section> Modified: trunk/bpel/docs/reference/en-US/tasks.xml =================================================================== --- trunk/bpel/docs/reference/en-US/tasks.xml 2011-03-02 02:50:26 UTC (rev 29436) +++ trunk/bpel/docs/reference/en-US/tasks.xml 2011-03-02 03:19:37 UTC (rev 29437) @@ -410,7 +410,7 @@ <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. + Create the <filename>deploy.xml</filename> file by selecting <menuchoice><guimenuitem>File</guimenuitem><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> @@ -424,10 +424,10 @@ <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. + <emphasis><property>BPEL Project</property> </emphasis>: Click the <guibutton>Browse...</guibutton> button to select the BPEL project in your workspace where you want to deploy to the runtime. Please note that you should select the <filename>bpelContent</filename> folder in your new BPEL project for the <property>BPEL Project</property> field because this is the correct location for the <filename>deploy.xml</filename> file. </para> <para> - <emphasis><property>File name</property></emphasis>: The default value is <filename>deploy.xml</filename>. Please, don't change it. + <emphasis><property>File name</property></emphasis>: The default value is <filename>deploy.xml</filename>. This should not be changed. </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> @@ -441,7 +441,7 @@ </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>. + Double-click the <filename>deploy.xml</filename> file to open it in <guilabel>ODE Descriptor Deployment Editor</guilabel>. In the <guilabel>Inbound Interfaces</guilabel> section, click the <guilabel>Associated Port</guilabel> column and select <guilabel>HelloWorldProcessPort</guilabel> in the dropdown box.The <guilabel>Related Service</guilabel> and <guilabel>Binding Used</guilabel> columns should be automatically filled in. Save the changes to the <filename>deploy.xml</filename> file. </para> <figure> <title>deploy.xml file editor</title> @@ -457,17 +457,17 @@ <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. + Once you have installed the <property>JBoss BPEL Runtime-RiftSaw</property><!-- as it was described in <xref linkend="installRuntime"/>-->, 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>. + Open the <guilabel>Servers</guilabel> 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: + Right-click the <guilabel>Servers</guilabel> view and select <menuchoice><guimenuitem>New</guimenuitem><guimenuitem>Server</guimenuitem></menuchoice> to open the <guilabel>New Server</guilabel> wizard: </para> <figure> <title>New Server Wizard</title> @@ -479,7 +479,7 @@ </figure> </listitem> <listitem> - <para>Select <property>JBoss AS 5.1</property> as a server type. </para> + <para>Select <guilabel>JBoss AS 5.1</guilabel> as a server type. </para> <note> <para>Please note, that only JBoss As 5.1 or higher version supports BPEL.</para> </note> @@ -487,7 +487,7 @@ <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: + Click the <guibutton>Next</guibutton> button. On the next page, you should input your <productname>JBoss As</productname> 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> @@ -500,7 +500,7 @@ </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. + Select <guilabel>HelloWorld</guilabel>, then click the <guibutton>Add</guibutton> button to add the project to the server. Finally, click the <guibutton>Finish</guibutton> button. </para> <para>Start the server by right-clicking on the server and selecting the <guilabel>Start</guilabel> item. </para> @@ -512,10 +512,10 @@ </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_si... Server Manager Reference Guide</ulink> for more details.</para> + <para>Read the <ulink url="http://download.jboss.org/jbosstools/nightly-docs/en/as/html_si... Server Manager Reference Guide</ulink> for more detail on this process.</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> + <para>You can enter the link <ulink url="http://localhost:8080/bpel-console/app.html">http://localhost:8080/bpel-console/app.html</ulink> in your web browser to access the deployed processes.</para> <figure> <title>The BPEL console</title> <mediaobject> @@ -526,8 +526,9 @@ </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&amp;op=viewforum&... Tools Users Forum</ulink> to ask questions. - There we are also waiting for your suggestions and comments.</para> + <para> + Please visit the <ulink url="http://www.jboss.com/index.html?module=bb&amp;op=viewforum&... Tools Users Forum</ulink> for more information and assistance. + </para> </section> </section> </chapter>