[jbosstools-commits] JBoss Tools SVN: r29397 - trunk/drools/docs/guvnor_ref/en-US.

Author: mcaspers Date: 2011-02-28 21:30:39 -0500 (Mon, 28 Feb 2011) New Revision: 29397 Modified: trunk/drools/docs/guvnor_ref/en-US/Book_Info.xml trunk/drools/docs/guvnor_ref/en-US/conclusion.xml trunk/drools/docs/guvnor_ref/en-US/functionality_overview.xml trunk/drools/docs/guvnor_ref/en-US/guvnor_preferences.xml trunk/drools/docs/guvnor_ref/en-US/introduction.xml Log: General Documentation Updates Modified: trunk/drools/docs/guvnor_ref/en-US/Book_Info.xml =================================================================== --- trunk/drools/docs/guvnor_ref/en-US/Book_Info.xml 2011-03-01 01:58:39 UTC (rev 29396) +++ trunk/drools/docs/guvnor_ref/en-US/Book_Info.xml 2011-03-01 02:30:39 UTC (rev 29397) @@ -7,7 +7,7 @@ <productname>JBoss Developer Studio</productname> <productnumber>4.0</productnumber> <edition>4.0.0</edition> - <pubsnumber>9</pubsnumber> + <pubsnumber>10</pubsnumber> <abstract> <para>The Eclipse Guvnor Tools Reference Guide explains how to use the Eclipse Guvnor Tools to gain access to resources controled by the Guvnor repository policies.</para> </abstract> Modified: trunk/drools/docs/guvnor_ref/en-US/conclusion.xml =================================================================== --- trunk/drools/docs/guvnor_ref/en-US/conclusion.xml 2011-03-01 01:58:39 UTC (rev 29396) +++ trunk/drools/docs/guvnor_ref/en-US/conclusion.xml 2011-03-01 02:30:39 UTC (rev 29397) @@ -30,21 +30,15 @@ <listitem> <para> - <ulink url="http://www.jboss.org/tools/">JBoss Tools Home Page</ulink> + <ulink url="http://www.jboss.com/products/devstudio/">JBoss Developer Studio Home Page</ulink> </para> </listitem> <listitem> <para> - <ulink url="http://download.jboss.org/jbosstools/nightly-docs/">The latest JBossTools/JBDS documentation builds</ulink> + <ulink url="http://docs.redhat.com/docs/en-US/JBoss_Developer_Studio/index.... release documentation</ulink> </para> </listitem> - - <listitem> - <para> - <ulink url="http://docs.jboss.org/tools/">JBossTools/JBDS release documentation</ulink> - </para> - </listitem> </itemizedlist> <para> If you have some questions, comments or suggestions on the topic, please feel free to ask in the <ulink url="http://www.jboss.org/index.html?module=bb&amp;op=viewforum&... Tools Forum</ulink>. Modified: trunk/drools/docs/guvnor_ref/en-US/functionality_overview.xml =================================================================== --- trunk/drools/docs/guvnor_ref/en-US/functionality_overview.xml 2011-03-01 01:58:39 UTC (rev 29396) +++ trunk/drools/docs/guvnor_ref/en-US/functionality_overview.xml 2011-03-01 02:30:39 UTC (rev 29397) @@ -10,12 +10,12 @@ <title>Tasks</title> - <para>This chapter will give an overview on all functionality the <property>Guvnor Tools</property> provides.</para> + <para>This chapter provides an overview of the functionality provided by the <property>Guvnor Tools</property>.</para> <section> <title>Creating a New Guvnor Connection</title> <para> - As mentioned in the <xref linkend="introduction"/> section, the main purposeof the <property>EGT</property> is to allow development using resources held in a Guvnor repository. The first task is to make a connection to a Guvnor repository. This is handled by the <guilabel>Connection Wizard</guilabel> (see <xref linkend="connection_wizard"/>). + As mentioned in <xref linkend="introduction"/>, the main purpose of the <productname>EGT</productname> is to allow development using resources held in a Guvnor repository. The first task is to make a connection to a Guvnor repository. This is handled by the <guilabel>Connection Wizard</guilabel> (see <xref linkend="connection_wizard"/>). </para> </section> @@ -25,10 +25,10 @@ <orderedlist> <listitem> - <para>Drag-and-drop from the Guvnor Repositories View, as described in the <xref linkend="guvnor_repositories_view"/> section</para> + <para>Drag-and-drop from the Guvnor Repositories View, as described in <xref linkend="guvnor_repositories_view"/></para> </listitem> <listitem> - <para>Using the Resource from Guvnor Wizard, as described in the <xref linkend="resources_from_guvnor"/> section</para> + <para>Using the Resource from Guvnor Wizard, as described in <xref linkend="resources_from_guvnor"/></para> </listitem> </orderedlist> @@ -50,11 +50,11 @@ </para> <para> - The <property>EGT</property> decorates local resources associated with Guvnor repository master copies. This decoration appears in Eclipse views conforming to the Eclipse Common Navigator framework, such as the Eclipse <guilabel>Resource Navigator</guilabel> and the Java <guilabel>Package Explorer</guilabel>. In the image above you can see the <filename>Dummy rule.drl</filename> file with the decoration in the <guilabel>Resource Navigator</guilabel>. The Guvnor icon decorator is on the top right of the file image, and the Guvnor revision details are appended to the file name. The presence/location of these can be changed in the <guilabel>Local Guvnor Repository Resource Decoration Preferences</guilabel> (see the <xref linkend="resource_decoration_preferences"/> section). + The <property>EGT</property> decorates local resources associated with Guvnor repository master copies. This decoration appears in Eclipse views conforming to the Eclipse Common Navigator framework, such as the Eclipse <guilabel>Resource Navigator</guilabel> and the Java <guilabel>Package Explorer</guilabel>. In the image above you can see the <filename>Dummy rule.drl</filename> file with the decoration in the <guilabel>Resource Navigator</guilabel>. The Guvnor icon decorator is on the top right of the file image, and the Guvnor revision details are appended to the file name. The location of these can be changed in the <guilabel>Local Guvnor Repository Resource Decoration Preferences</guilabel> (see the <xref linkend="resource_decoration_preferences"/> section). </para> <para> - Here we see that the <filename>Dummy rule.drl</filename> file is associated with a Guvnor repository resource and the local copy is based on revision 0, with a <code>02-10-2008, 4:21:53</code> date/time stamp. However, the file <filename>Sample.drl</filename> is not associated with a Guvnor repository file. Further details about the association can be found in the standard Eclipse properties page, accessed via the <guilabel>Properties</guilabel> option in the context menu: + Here we see that the <filename>Dummy rule.drl</filename> file is associated with a Guvnor repository resource, and the local copy is based on revision 0, with a <code>02-10-2008, 4:21:53</code> date/time stamp. However, the file <filename>Sample.drl</filename> is not associated with a Guvnor repository file. Further details about the association can be found in the standard Eclipse properties page, accessed via the <guilabel>Properties</guilabel> option in the context menu: </para> <figure> @@ -127,7 +127,7 @@ <title>Update Action</title> <para> - The <guilabel>Update</guilabel> action is available for one or more Guvnor resources that are not in synchronization with the Guvnor repository master copies. These resources would not be in synchronization due to one or or both of the following conditions: + The <guilabel>Update</guilabel> action is available for one or more Guvnor resources that are not synchronized with the Guvnor repository master copies. These resources would not synchronized due to one or or both of the following conditions: </para> <orderedlist> @@ -147,7 +147,7 @@ <section id="add_action"> <title>Add Action</title> - <para>The <guilabel>Add</guilabel> action is available for one or more local files that are not associated with a Guvnor repository master copy. Choosing the <guilabel>Add</guilabel> action launches the <guilabel>Add to Guvnor wizard</guilabel>:</para> + <para>The <guilabel>Add</guilabel> action is available for one or more local files that are not associated with a Guvnor repository master copy. Choosing the <guilabel>Add</guilabel> action launches the <guilabel>Add to Guvnor</guilabel> wizard:</para> <figure> <title>Add to Guvnor Wizard</title> @@ -159,7 +159,7 @@ </figure> <para> - The first page of the wizard asks for the selection of the target Guvnor repository and gives the choice to create a new Guvnor repository connection (in which case the second page is the same as the <xref linkend="guvnor_connection_wizard"/>). Once the target Guvnor repository is chosen, the wizard then asks for the folder location to add the selection files: + The first page of the wizard asks for the selection of the target Guvnor repository, and provides the option of creating a new Guvnor repository connection (in which case the second page is the same as <xref linkend="guvnor_connection_wizard"/>). Once the target Guvnor repository is chosen, the wizard then asks for the folder location to add the selection files: </para> <figure> @@ -171,22 +171,22 @@ </mediaobject> </figure> - <para>Here the <filename>&quot;defaultPackage&quot;</filename> folder is selected as the destination location.</para> + <para>Here the <filename>defaultPackage</filename> folder is selected as the destination location.</para> <note> <title>Note:</title> <para> - Note that the <filename>&quot;snapshot&quot;</filename> folder in the Guvnor repository is read-only for <property>EGT</property>, and hence not visible as a candidate location in this wizard. The Guvnor repository web administration tools must be used to add snapshot content. + Note that the <filename>snapshot</filename> folder in the Guvnor repository is read-only for <property>EGT</property>, and hence not visible as a candidate location in this wizard. The Guvnor repository web administration tools must be used to add snapshot content. </para> </note> <para> - Clicking on the <guibutton>Finish</guibutton> adds the selected files to the Guvnor repository and creates an association between the local and Guvnor repository files. + Clicking on the <guibutton>Finish</guibutton> button adds the selected files to the Guvnor repository and creates an association between the local and Guvnor repository files. </para> <note> <title>Note:</title> - <para>Note that the wizard will not allow for overwrite of existing Guvnor repository files. Another target location must be chosen.</para> + <para>Note that the wizard will not allow existing Guvnor repository files to be overwritten. Another target location must be chosen.</para> </note> </section> @@ -194,11 +194,11 @@ <title>Commit Action</title> <para> - The <guilabel>Commit</guilabel> action is enabled for one or more Guvnor repository associated files that have local changes. The <guilabel>Commit</guilabel> action will write the local changes back to the associated Guvnor repository files and update the association for the new revision created. + The <guilabel>Commit</guilabel> action is enabled for one or more Guvnor repository associated files that have local changes. The <guilabel>Commit</guilabel> action will write the local changes back to the associated Guvnor repository files, and update the association for the new revision created. </para> <para> - If a local change is based on an older revision of a file that is currently in the Guvnor repository (for example, someone else changed the same file), then the <guilabel>Commit</guilabel> action will ask whether you wish to overwrite the current version in the Guvnor repository with the local content. When such conflicts occur, however, you should use the Eclipse Guvnor version tools, along with Eclipse standard tools, to determine the differences and merge content based on the current version in the Guvnor repository. + If a local change is based on an older revision of a file than is currently in the Guvnor repository (for example, someone else changed the same file), then the <guilabel>Commit</guilabel> action will ask whether you wish to overwrite the current version in the Guvnor repository with the local content. When such conflicts occur, however, you should use the Eclipse Guvnor version tools, along with Eclipse standard tools, to determine the differences and merge content based on the current version in the Guvnor repository. </para> </section> @@ -206,7 +206,7 @@ <title>Show History Action</title> <para> - The <guilabel>Show History</guilabel> action is enabled for one Guvnor repository associated file and causes the <xref linkend="guvnor_history_view"/> to be populated with revision history for the selected file. + The <guilabel>Show History</guilabel> action is enabled for one Guvnor repository associated file, and populates the <xref linkend="guvnor_history_view"/> with revision history for the selected file. </para> </section> @@ -226,7 +226,7 @@ </mediaobject> </figure> - <para>Once the revision is selected, the action opens the Eclipse <guilabel>Compare editor</guilabel> (read-only):</para> + <para>Once the revision is selected, the action opens the Eclipse <guilabel>Compare editor</guilabel> (in a read-only mode):</para> <figure> <title>Eclipse Compare Editor</title> <mediaobject> @@ -237,7 +237,7 @@ </figure> <para> - This editor uses Eclipse-standard comparison techniques to show the differences in the two versions. In cases where there are no differences, the editor will not open, rather a dialog saying that there are no differences will appear. + This editor uses the standard Eclipse comparison techniques to show the differences in the two versions. In cases where there are no differences, the editor will not open, and instead a dialog saying that there are no differences will be displayed. </para> <figure> <title>Alert Dialog</title> @@ -253,7 +253,7 @@ <title>Switch to Version Action</title> <para>The <guilabel>Switch to Version</guilabel> action is enabled for one Guvnor repository associated file.</para> - <para>First the <guilabel>Switch to Version</guilabel> action prompts for selection of version:</para> + <para>First the <guilabel>Switch to Version</guilabel> action prompts for the selection of a version:</para> <figure> <title>Select Version Window</title> @@ -273,7 +273,7 @@ <title>Delete Action</title> <para> - The <guilabel>Delete</guilabel> action is enabled for one or more Guvnor repository associated files. After confirmation via a dialog, the <guilabel>Delete</guilabel> action removes the files in the Guvnor repository and deletes local metadata for the Guvnor repository association. + The <guilabel>Delete</guilabel> action is enabled for one or more Guvnor repository associated files. After the action has been confirmed using the dialog shown below, the <guilabel>Delete</guilabel> action removes the files in the Guvnor repository and deletes local metadata for the Guvnor repository association. </para> <figure> Modified: trunk/drools/docs/guvnor_ref/en-US/guvnor_preferences.xml =================================================================== --- trunk/drools/docs/guvnor_ref/en-US/guvnor_preferences.xml 2011-03-01 01:58:39 UTC (rev 29396) +++ trunk/drools/docs/guvnor_ref/en-US/guvnor_preferences.xml 2011-03-01 02:30:39 UTC (rev 29397) @@ -15,11 +15,11 @@ <title>Guvnor Repository Exploring Perspective</title> <para> - The <property>Guvnor Repository Exploring perspective</property> contains two views supplied by <property>EGT</property> – <xref linkend="guvnor_repositories_view"/> and <xref linkend="guvnor_history_view"/>, that will be the center of most interactions with Guvnor, and Eclipse standard views such as <guilabel>Properties</guilabel> and <guilabel>Resource Navigator</guilabel> that are also useful. + The <property>Guvnor Repository Exploring perspective</property> contains two views supplied by <property>EGT</property>, described in <xref linkend="guvnor_repositories_view"/> and <xref linkend="guvnor_history_view"/>, that will be the center of most interactions with Guvnor. Eclipse standard views such as <guilabel>Properties</guilabel> and <guilabel>Resource Navigator</guilabel> are also useful. </para> <para> - While each of these views can be opened and positioned independently within an Eclipse workbench, the <property>Guvnor perspective</property> provides a convenient method of getting a suggested layout. In the Eclipse workbench menu, choose <menuchoice><guimenuitem>Window</guimenuitem><guimenuitem>Open Perspective</guimenuitem><guimenuitem>Other</guimenuitem></menuchoice> to get the perspective list: + While each of these views can be opened and positioned independently within an Eclipse workbench, the <property>Guvnor perspective</property> provides a convenient method for displaying a common layout. In the Eclipse workbench menu, select <menuchoice><guimenuitem>Window</guimenuitem><guimenuitem>Open Perspective</guimenuitem><guimenuitem>Other</guimenuitem></menuchoice> to view the perspective list: </para> <figure> @@ -31,14 +31,14 @@ </mediaobject> </figure> - <para>And then choose <guimenuitem>Guvnor Repository Exploring</guimenuitem>. This opens the <guilabel>Guvnor perspective</guilabel>.</para> + <para>Selecting the <guimenuitem>Guvnor Repository Exploring</guimenuitem> option will open the <guilabel>Guvnor</guilabel> perspective.</para> </section> <section id="connection_wizard"> <title>Guvnor Connection Wizard</title> <para> - This wizard appears in a number of places within the <property>EGT</property> (as detailed below), but in this section we will cover only the two most basic entry points. + The Guvnor Connection wizard appears in a number of places within the <property>EGT</property> (as detailed below), but in this section we will cover only the two most basic entry points. </para> <para>The <guilabel>Guvnor Connection wizard</guilabel> can be started in the following ways:</para> @@ -46,7 +46,7 @@ <itemizedlist> <listitem> <para> - Using the Eclipse menu <menuchoice><guimenuitem>File</guimenuitem><guimenuitem>New</guimenuitem><guimenuitem>Other</guimenuitem> <guimenuitem>Guvnor</guimenuitem><guimenuitem>Guvnor repository location</guimenuitem></menuchoice> + Selecting <menuchoice><guimenuitem>File</guimenuitem><guimenuitem>New</guimenuitem><guimenuitem>Other</guimenuitem> <guimenuitem>Guvnor</guimenuitem><guimenuitem>Guvnor repository location</guimenuitem></menuchoice> within Eclipse </para> <figure> @@ -60,7 +60,7 @@ </listitem> <listitem> - <para>In the <guilabel>Guvnor Repositories view</guilabel> using the drop-down menu</para> + <para>In the <guilabel>Guvnor Repositories</guilabel> view using the drop-down menu</para> <figure> <title>Adding New Guvnor Connection</title> @@ -83,7 +83,7 @@ </listitem> </itemizedlist> - <para>Choosing either of these will start the <guilabel>Guvnor Connection wizard</guilabel>.</para> + <para>Choosing either of these will start the <guilabel>Guvnor Connection</guilabel> wizard.</para> <figure id="guvnor_connection_wizard"> <title>Guvnor Connection Wizard</title> @@ -95,7 +95,7 @@ </figure> <para> - Default values appear in the <guilabel>Location</guilabel>,<guilabel>Port</guilabel> and <guilabel>Repository</guilabel> fields (See the <xref linkend="guvnor_preferences"/> section below for details about how to change these default values.) Of course, any of these fields can be edited by typing in the corresponding text box. Drag-and-drop or paste into the <guilabel>Location</guilabel> field of a typical Guvnor repository URL such as: + Default values appear in the <guilabel>Location</guilabel>, <guilabel>Port</guilabel> and <guilabel>Repository</guilabel> fields (See <xref linkend="guvnor_preferences"/> for details about on changing these default values). Of course, any of these fields can be edited by editing the corresponding text box. Drag-and-drop or paste into the <guilabel>Location</guilabel> field a typical Guvnor repository URL such as: </para> <para> @@ -103,18 +103,18 @@ </para> <para> - Results in the URL being parsed into the respective fields as well. The authentication information (user name and password) can optionally be stored in the Eclipse workbench&apos;s key-ring file based on the selection of <guilabel>Save user name and password</guilabel>. + This results in the URL being parsed into the respective fields as well. The authentication information (user name and password) can optionally be stored in the Eclipse workbench&apos;s key-ring file based on the selection of <guilabel>Save user name and password</guilabel>. </para> <note> <title>Note:</title> <para> - If the authentication information is not stored in the key-ring, then the <property>EGT</property> uses a session authentication, what means that the credentials supplied are used only for the lifetime of the Eclipse workbench instance. + If the authentication information is not stored in the key-ring, then the <property>EGT</property> uses a session authentication, what means that the credentials supplied are only used during the lifetime of the Eclipse workbench instance. </para> </note> <para> - If authentication information is not stored in the key-ring or the authentication information (key-ring or session) is not valid, the <property>EGT</property> will prompt for authentication information when it has to access the Guvnor repository. + If authentication information is not stored in the key-ring, or the authentication information (key-ring or session) is not valid, the <property>EGT</property> will prompt for the authentication information once it has to access the Guvnor repository. </para> <para>If authentication fails, the <property>EGT</property> will retry once and then issue an authentication failure error.</para> @@ -125,13 +125,13 @@ </note> <para> - Note that the <property>EGT</property> calls the Guvnor repository at various times, such as when determining if resource updates are available. Thus if you use session authentication, the authentication dialog will appear at different times during the Eclipse workbench session, depending on what actions you take. For ease of use, we recommend saving the authentication information in the Eclipse key-ring. + Note that the <property>EGT</property> calls the Guvnor repository at various times, such as when it is determining if any resource updates are available. Thus if you use session authentication, the authentication dialog will appear at different times during the Eclipse workbench session, depending on what actions you take. For ease of use, we recommend saving the authentication information in the Eclipse key-ring. </para> <note> <title>Note:</title> <para> - The Eclipse key-ring file is distinct from key-ring files found in some platforms such as Mac OS X and many forms of Linux. Thus, sometimes if you access a Guvnor repository outside the <property>EGT</property>, the key-ring files might become unsynchronized and you will be unexpectedly prompted for authentication in Eclipse. This is nuisance, but your usual credentials should apply in this case. + The Eclipse key-ring file is distinct from key-ring files found in some platforms such as Mac OS X and many forms of Linux. Thus, sometimes if you access a Guvnor repository outside the <property>EGT</property>, the key-ring files might become outdated, and you will be unexpectedly prompted for your credentials in Eclipse. This is nuisance, but in this case you can simply re-enter the appropriate username and password. </para> </note> </section> @@ -140,7 +140,7 @@ <title>Resource from Guvnor Wizard</title> <para> - In addition to the single file drag-and-drop from the <guilabel>Guvnor Repositories view</guilabel>, the <property>EGT</property> also includes a wizard for copying one or more files from a Guvnor repository to the local workspace (and setting the association with the Guvnor repository). This wizard is available by selecting <menuchoice><guimenuitem>File</guimenuitem><guimenuitem>Import</guimenuitem><guimenuitem>Guvnor</guimenuitem><guimenuitem>Resource from Guvnor</guimenuitem></menuchoice> or <menuchoice><guimenuitem>File</guimenuitem><guimenuitem>New</guimenuitem><guimenuitem>Other</guimenuitem><guimenuitem>Guvnor</guimenuitem><guimenuitem>Resource from Guvnor</guimenuitem></menuchoice>. + In addition to the single file drag-and-drop features provided within the <guilabel>Guvnor Repositories</guilabel> view, the <property>EGT</property> also includes a wizard for copying one or more files from a Guvnor repository to the local workspace (and setting the association with the Guvnor repository). This wizard is available by selecting <menuchoice><guimenuitem>File</guimenuitem><guimenuitem>Import</guimenuitem><guimenuitem>Guvnor</guimenuitem><guimenuitem>Resource from Guvnor</guimenuitem></menuchoice> or <menuchoice><guimenuitem>File</guimenuitem><guimenuitem>New</guimenuitem><guimenuitem>Other</guimenuitem><guimenuitem>Guvnor</guimenuitem><guimenuitem>Resource from Guvnor</guimenuitem></menuchoice>. </para> <note> <title>Note:</title> @@ -151,7 +151,7 @@ </note> <para> - The first page of the wizard asks for the selection of the source Guvnor repository and gives the choice to create a new Guvnor repository connection (in which case the second page is the same as the <xref linkend="guvnor_connection_wizard"/>). + The first page of the wizard asks for the selection of the source Guvnor repository and gives the option to create a new Guvnor repository connection (in which case the second page is the same as the <xref linkend="guvnor_connection_wizard"/>). </para> <figure> @@ -163,7 +163,7 @@ </mediaobject> </figure> - <para>Once the source Guvnor repository is chosen, the wizard prompts for resource selection:</para> + <para>Once the source Guvnor repository is chosen, the wizard prompts for the resources to be copied:</para> <figure> <title>Resource Selection</title> @@ -201,7 +201,7 @@ <section id="guvnor_repositories_view"> <title>Guvnor Repositories View</title> - <para>The <guilabel>Guvnor Repositories view</guilabel> contains tree structures representing Guvnor repository contents.</para> + <para>The <guilabel>Guvnor Repositories</guilabel> view contains tree structures representing the contents of Guvnor repositories.</para> <figure> <title>Guvnor Repositories View</title> @@ -212,34 +212,34 @@ </mediaobject> </figure> - <para>You can perform the following actions under the resources in the <guilabel>Guvnor Repositories view</guilabel>:</para> + <para>You can perform the following actions under the resources in the <guilabel>Guvnor Repositories</guilabel> view:</para> <itemizedlist> <listitem> - <para>create a new Guvnor repository connection. How to do this is describe above in the <xref linkend="connection_wizard"/> section.</para> + <para>Create a new Guvnor repository connection. This process is described above in <xref linkend="connection_wizard"/>.</para> </listitem> <listitem> <para> - Remove a Guvnor repository connection. Use the Delete button ( <inlinemediaobject><imageobject><imagedata fileref="images/functionality_overview/delete_connection_button.png"/></imageobject></inlinemediaobject> ) in the tool-bar or the <guimenuitem>Delete</guimenuitem> option in the context menu to remove a repository connection. + Remove a Guvnor repository connection. Use the Delete button ( <inlinemediaobject><imageobject><imagedata fileref="images/functionality_overview/delete_connection_button.png"/></imageobject></inlinemediaobject> ) in the toolbar or the <guimenuitem>Delete</guimenuitem> option in the context menu to remove a repository connection. </para> </listitem> <listitem> <para> - Refresh Guvnor repository resorces. Use the <guimenuitem>Refresh</guimenuitem> context menu item to reload a tree content for the selected node. + Refresh Guvnor repository resorces. Use the <guimenuitem>Refresh</guimenuitem> context menu item to reload the tree for the selected node. </para> </listitem> <listitem> <para> - Make use of &quot;drill-into&quot; functionality. It&apos;s represented by a number of tool-bar/context menu items such as <guibutton>Go Home</guibutton> ( <inlinemediaobject><imageobject><imagedata fileref="images/functionality_overview/go_home_button.png"/></imageobject></inlinemediaobject> ), <guibutton>Go Back</guibutton> ( <inlinemediaobject><imageobject><imagedata fileref="images/functionality_overview/go_back_button.png"/></imageobject></inlinemediaobject> ) and <guibutton>Go Into</guibutton> ( <inlinemediaobject><imageobject><imagedata fileref="images/functionality_overview/go_into_button.png"/></imageobject></inlinemediaobject> ). + Make use of &quot;drill-into&quot; functionality. It&apos;s represented by a number of toolbar and context menu items such as <guibutton>Go Home</guibutton> ( <inlinemediaobject><imageobject><imagedata fileref="images/functionality_overview/go_home_button.png"/></imageobject></inlinemediaobject> ), <guibutton>Go Back</guibutton> ( <inlinemediaobject><imageobject><imagedata fileref="images/functionality_overview/go_back_button.png"/></imageobject></inlinemediaobject> ) and <guibutton>Go Into</guibutton> ( <inlinemediaobject><imageobject><imagedata fileref="images/functionality_overview/go_into_button.png"/></imageobject></inlinemediaobject> ). </para> </listitem> </itemizedlist> <para> - Drill-down is useful when working with deeply nested tree structures and when you wish to concentrate on only branch of the tree. For example, drilling into the <guilabel>defaultPackage</guilabel> node changes the tree view to: + Drill-down is useful when working with deeply nested tree structures, and when you wish to concentrate on only a single branch of the tree. For example, drilling into the <guilabel>defaultPackage</guilabel> node changes the tree view to: </para> <figure> @@ -257,7 +257,7 @@ </para> <para> - There are a number of operations that can be performed on Guvnor repository files. Selecting a file in the Guvnor repository causes the Eclipse <guilabel>Properties view</guilabel> to update with details about that file: + There are a number of operations that can be performed on Guvnor repository files. Selecting a file in the Guvnor repository causes the Eclipse <guilabel>Properties</guilabel> view to display the details of that file: </para> <figure> @@ -276,7 +276,7 @@ <title>Guvnor Resource History View</title> <para> - The <guilabel>Guvnor Resource History view</guilabel> shows details about revision history for selected files, both local and those in Guvnor repositories. The initial state of this view is shown on the figure below. + The <guilabel>Guvnor Resource History</guilabel> view displays details about the revision history for the selected files, both local and those in Guvnor repositories. The initial state of this view is shown on the figure below. </para> <figure> @@ -289,7 +289,7 @@ </figure> <para> - The <guilabel>Guvnor Resource History view</guilabel> is populated by <guilabel>Show History</guilabel> actions in either the local <guilabel>Guvnor</guilabel> context menu or in the context menu for a Guvnor repository file in the <xref linkend="guvnor_repositories_view"/>. Once this action is performed, the <guilabel>Guvnor Resource History view</guilabel> updates to show the revision history: + The <guilabel>Guvnor Resource History</guilabel> view is populated by <guilabel>Show History</guilabel> actions in either the local <guilabel>Guvnor</guilabel> context menu or in the context menu for a Guvnor repository file in the Guvnor Repositories View (see <xref linkend="guvnor_repositories_view"/>). Once this action is performed, the <guilabel>Guvnor Resource History</guilabel> view is refreshed to display the revision history: </para> <figure> @@ -302,7 +302,7 @@ </figure> <para> - Here we see that the file <filename>test.txt</filename> has seven revisions. Double clicking on a revision row (or the context menu <guimenuitem>Open (Read only)</guimenuitem>) opens an Eclipse read-only editor with the revision contents. + Here we see that the file <filename>test.txt</filename> has seven revisions. Double clicking on a revision row or selecting the <guimenuitem>Open (Read only)</guimenuitem> option from the context menu opens an Eclipse read-only editor with the revision contents. </para> <figure> @@ -350,17 +350,17 @@ <section id="repo_connection_preferences"> <title>Guvnor Repository Connection Preferences</title> - <para>There are two preferences that can be set for Guvnor repository connections, that are used when creating new connections:</para> + <para>There are two preferences that can be set for Guvnor repository connections, which are used when creating new connections:</para> <itemizedlist> <listitem> <para> - The first is a default Guvnor repository URL template, which can make it easier to create multiple similar connections by simply changing part of the field, such as the host name. + The first is a default Guvnor repository URL template, which can simplify the process of creating additional similar connections by simply changing part of the field, such as the host name. </para> </listitem> <listitem> <para> - The second is whether authentication information should be saved in the Eclipse platform key-ring by default.</para> + The second defines whether or not authentication information should be saved in the Eclipse platform key-ring by default.</para> </listitem> </itemizedlist> @@ -373,11 +373,11 @@ <title>Local Guvnor Repository Resource Decoration Preferences</title> <para> - The second category of preferences provided by the <property>EGT</property> deals with how the decoration of local resources associated with Guvnor repository resources is presented. Since the Guvnor repository is not a substitute for a SCM, and since SCM tools in Eclipse tend to decorate local resources, it is useful to be able to control just how the <property>EGT</property> decorate its local resources to avoid messy conflicts with SCM packages. + The second category of preferences provided by the <property>EGT</property> can be used to define how the decoration of local resources associated with Guvnor repository resources is presented. Since the Guvnor repository is not a substitute for a SCM, and since SCM tools in Eclipse tend to decorate local resources, it is useful to be able to control how the <property>EGT</property> decorate its local resources to avoid messy conflicts with SCM packages. </para> <para> - In the <guilabel>File Decoration</guilabel> section of the preference page, you can choose the location (Top right, Top left, Bottom right, Bottom left) of the decoration icon, or you can choose not to display it. In the <guilabel>Text</guilabel> section, you can format the Guvnor metadata that is appended to the file names: + In the <guilabel>File Decoration</guilabel> section of the preference page, you can choose the location (Top right, Top left, Bottom right, Bottom left) of the decoration icon, or you can choose not to display it. In the <guilabel>Text</guilabel> section, you can format the Guvnor metadata which is appended to the file names: </para> <itemizedlist> <listitem> Modified: trunk/drools/docs/guvnor_ref/en-US/introduction.xml =================================================================== --- trunk/drools/docs/guvnor_ref/en-US/introduction.xml 2011-03-01 01:58:39 UTC (rev 29396) +++ trunk/drools/docs/guvnor_ref/en-US/introduction.xml 2011-03-01 02:30:39 UTC (rev 29397) @@ -38,7 +38,7 @@ <para>Guvnor Repositories View</para> </entry> <entry> - <para>The purpose of the view is to enable access to Guvnor repository resources in a standard tree format</para> + <para>The purpose of this view is to enable access to Guvnor repository resources in a standard tree format</para> </entry> <entry> <xref linkend="guvnor_repositories_view"/> @@ -50,7 +50,7 @@ <para>Guvnor Connection Wizard</para> </entry> <entry> - <para>The wizard helps to create a connection to a Guvnor repository.</para> + <para>This wizard helps to create a connection to a Guvnor repository.</para> </entry> <entry> <xref linkend="connection_wizard"/> @@ -74,7 +74,7 @@ <para>Resource from Guvnor wizard</para> </entry> <entry> - <para>The wizard helps to get local copies of Guvnor repository resources.</para> + <para>This wizard helps to get local copies of Guvnor repository resources.</para> </entry> <entry> <xref linkend="resources_from_guvnor"/> @@ -102,7 +102,7 @@ <section id="what_is_guvnor_tools"> <title>What is Guvnor Tools?</title> <para> - The <property>Guvnor repository</property> is not intended as a Source Code Management (SCM) solution, and the <property>EGT</property> is not intended to be an Eclipse “team provider” extension or replacement. Rather, the Guvnor repository is a location where certain artifacts (such as rules and SOA policy definitions) are controlled (“governed”) by policies defined by the deployment environment. The purpose of the <property>EGT</property> is then to enable access to resources held by the Guvnor repository, so they can be used in development. Thus, limited capabilities for reading, writing, adding, and removing Guvnor repository resources are provided in the <property>EGT</property>. + The <property>Guvnor repository</property> is not intended to be a Source Code Management (SCM) solution, and the <property>EGT</property> is not intended to be an Eclipse “team provider” extension or replacement. Rather, the Guvnor repository is a location where certain artifacts (such as rules and SOA policy definitions) are controlled (“governed”) by policies defined by the deployment environment. The purpose of the <property>EGT</property> is then to enable access to resources held by the Guvnor repository, so they can be used in development. Thus, limited capabilities for reading, writing, adding, and removing Guvnor repository resources are provided in the <property>EGT</property>. </para> </section> <section id="how_to_start"> @@ -115,7 +115,8 @@ <itemizedlist> <listitem> <para> - Eclipse IDE with installed JBoss Tools plugins. How to install JBoss Tools onto Eclipse you can find in the JBoss Tools Installation section. + <!--Eclipse IDE with installed JBoss Tools plugins. How to install JBoss Tools onto Eclipse you can find in the JBoss Tools Installation section.--> + JBoss Developer Studio, which can be downloaded through the <ulink url="https://access.redhat.com">RedHat customer portal</ulink>. </para> </listitem> @@ -127,30 +128,28 @@ To deploy JBoss Server with the Guvnor repository, you should download <ulink url="http://www.jboss.org/drools/downloads.html">Drools Guvnor</ulink>. When downloading you may choose either web based Guvnor to deploy to your JBoss Server or Standalone Guvnor with JBoss AS. </para> <para> - If you use JBoss AS 5 and <property>Guvnor Tools</property> doesn't work when deployed to the server, you should do the following to get Guvnor Tools running: + If you use JBoss AS 5 and <property>Guvnor Tools</property> doesn't work when deployed to the server, you should perform the following steps to get Guvnor Tools running: </para> <orderedlist> <listitem> <para> - Remove the JBoss Security libraries (authorization-spi-2.0.2.CR6.jar, identity-*, acl-spi-2.0.2.CR6.jar) from drools WAR file (not the app server itself). The JBoss Security libraries are provided in AS 5. + Remove the JBoss Security libraries (<filename>authorization-spi-2.0.2.CR6.jar</filename>, <filename>identity-*</filename>, <filename>acl-spi-2.0.2.CR6.jar</filename>) from drools WAR file (not the app server itself). The JBoss Security libraries are provided in AS 5. </para> </listitem> <listitem> - <para>Remove the JAXP libraries (xercesImpl-2.8.0.jar, xml-apis-2.*)</para> + <para>Remove the JAXP libraries (<filename>xercesImpl-2.8.0.jar</filename>, <filename>xml-apis-2.*</filename>)</para> </listitem> <listitem> - <para>Remove the EL libraries (el-*)</para> + <para>Remove the EL libraries (<filename>el-*</filename>)</para> </listitem> </orderedlist> <para> - After this, Guvnor should operate as normal. During deployment, you would see the following exception in the log which indicates that the experimental JBoss Security based ACL integration has defined some EJB3/JPA stuff in guvnor that has not been configured. + When these steps have been performed, Guvnor should operate as normal. During deployment, you would see the following exception in the log which indicates that the experimental JBoss Security based ACL integration has defined some EJB3/JPA features in guvnor that have not been configured. </para> <programlisting>ERROR [AbstractKernelController] Error installing to Start: name=persistence.unit:unitName=#ACL state=Create java.lang.RuntimeException: Specification violation [EJB3 JPA 6.2.1.2] - You have not defined a non-jta-data-source for a RESOURCE_LOCAL enabled persistence context named: ACL </programlisting> - <para> - Now refer to the <xref linkend="functionality_overview"/> section to find out what you can do with Guvnor and Eclipse synchronization tool.</para> </section> </chapter>