Author: irooskov(a)redhat.com Date: 2010-06-08 19:27:46 -0400 (Tue, 08 Jun 2010) New Revision: 22646 Modified: tags/jbosstools-3.1.1.GA/drools/docs/guvnor_ref/en-US/conclusion.xml tags/jbosstools-3.1.1.GA/drools/docs/guvnor_ref/en-US/functionality_overview.xml tags/jbosstools-3.1.1.GA/drools/docs/guvnor_ref/en-US/guvnor_preferences.xml tags/jbosstools-3.1.1.GA/drools/docs/guvnor_ref/en-US/introduction.xml tags/jbosstools-3.1.1.GA/drools/docs/guvnor_ref/en-US/master.xml tags/jbosstools-3.1.1.GA/drools/docs/guvnor_ref/en-US/master_output.xml Log: updated for 3.0.1 Modified: tags/jbosstools-3.1.1.GA/drools/docs/guvnor_ref/en-US/conclusion.xml =================================================================== --- tags/jbosstools-3.1.1.GA/drools/docs/guvnor_ref/en-US/conclusion.xml 2010-06-08 23:23:11 UTC (rev 22645) +++ tags/jbosstools-3.1.1.GA/drools/docs/guvnor_ref/en-US/conclusion.xml 2010-06-08 23:27:46 UTC (rev 22646) @@ -8,7 +8,7 @@ </keywordset> </chapterinfo> - <title>Conclusion</title> + <title>Summary</title> <para>As stated at the beginning of this document, the key goal of the <property>EGT</property> is to provide a way of interacting with Guvnor repository resources in a local Eclipse @@ -16,7 +16,39 @@ aspects of the current tooling that require revision going forward, we feel that the current state of the <property>EGT</property> is sufficient for the major use cases.</para> - <para>If you have some questions, comments or suggestions on the topic, please feel free to ask in the + <section> + <title>Other relevant resources on the topic</title> + <para>For more information visit the following resources:</para> + <itemizedlist> + <listitem> + <para>Guvnor <ulink url="http://www.jboss.org/community/wiki/Guvnor">wiki page</ulink></para> + </listitem> + + <listitem> + <para>Drools on <ulink url="http://www.jboss.org/drools/">JBoss.org</ulink>&l... + </listitem> + + <listitem> + <para> + <ulink url="http://www.jboss.org/tools/">JBoss Tools Home Page</ulink> + </para> + </listitem> + + <listitem> + <para> + <ulink url="http://download.jboss.org/jbosstools/nightly-docs/">The latest + JBossTools/JBDS documentation builds</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&... + </section> </chapter> Modified: tags/jbosstools-3.1.1.GA/drools/docs/guvnor_ref/en-US/functionality_overview.xml =================================================================== --- tags/jbosstools-3.1.1.GA/drools/docs/guvnor_ref/en-US/functionality_overview.xml 2010-06-08 23:23:11 UTC (rev 22645) +++ tags/jbosstools-3.1.1.GA/drools/docs/guvnor_ref/en-US/functionality_overview.xml 2010-06-08 23:27:46 UTC (rev 22646) @@ -8,273 +8,30 @@ </keywordset> </chapterinfo> - <title>Functionality Overview</title> + <title>Tasks</title> - <para>This chapter will introduce you to the <property>Guvnor Repository Exploring - perspective</property> and give an overview on all functionality the <property>Guvnor Tools</property> provides.</para> - - <section id="guvnor_perspective"> - <title>Guvnor Perspective</title> - - <para>The <property>Guvnor Repository Exploring perspective</property> contains two views - supplied by <property>EGT</property> – <property>Repository Explorer</property> and - <property>Version History</property>, that will be the center of most interaction - with Guvnor, and Eclipse standard views such as <property>Properties</property> and - <property>Resource Navigator</property> that 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 <emphasis> - <property>Window &gt; Open Perspective &gt; Other</property> - </emphasis> to get the perspective list:</para> - - <figure> - <title>Enabling the Guvnor Repository Perspective</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/functionality_overview/open_guvnor_perspectine.png"/> - </imageobject> - </mediaobject> - </figure> - - <para>And then choose <emphasis> - <property>Guvnor Repository Exploring</property>.</emphasis> This opens the - <property>Guvnor perspective</property>.</para> - </section> - - <section id="connection_wizard"> - <title>Guvnor Connection Wizard</title> - - <para>After opening the <property>Guvnor perspective</property>, the first task is to make a - connection to a Guvnor repository. This is handled by the <property>Guvnor Connection - wizard</property>. 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.</para> - - <para>The <property>Guvnor Connection wizard</property> can be started in the following - ways:</para> - - <itemizedlist> - <listitem> - <para>using the Eclipse menu <emphasis> - <property>File &gt; New &gt; Other &gt; Guvnor &gt; Guvnor - repository location</property> - </emphasis></para> - - <figure> - <title>New Guvnor Repository Location</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/functionality_overview/start_guvnor_connection1.png"/> - </imageobject> - </mediaobject> - </figure> - </listitem> - - <listitem> - <para>in the <property>Guvnor Repositories view</property> using the drop-down menu</para> - - <figure> - <title>Adding New Guvnor Connection</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/functionality_overview/start_guvnor_connection2.png"/> - </imageobject> - </mediaobject> - </figure> - </listitem> - - <listitem> - <para>using the menu button - ( <inlinemediaobject> - <imageobject> - <imagedata fileref="images/functionality_overview/guvnor_connection_button.png"/> - </imageobject> - </inlinemediaobject> ) - </para> - </listitem> - </itemizedlist> - - <para>Choosing either of these will start the <property>Guvnor Connection - wizard</property>.</para> - - <figure id="guvnor_connection_wizard"> - <title>Guvnor Connection Wizard</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/functionality_overview/guvnor_connection_wizard.png"/> - </imageobject> - </mediaobject> - </figure> - - <para>Default values appear in the <emphasis> - <property>Location</property>,</emphasis> - <emphasis> - <property>Port</property>,</emphasis> and <emphasis> - <property>Repository</property> - </emphasis> fields (See the <link linkend="guvnor_preferences">“Guvnor Preferences”</link> 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 <emphasis> - <property>Location</property> - </emphasis> field of a typical Guvnor repository URL such as:</para> - - <para> - <emphasis> - <property>http://localhost:8080/drools-guvnor/org.drools.guvnor.Guvnor/webdav</property> - </emphasis> - </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 <emphasis> - <property>Save user name and password</property>.</emphasis></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.</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.</para> - - <para>If authentication fails, the <property>EGT</property> will retry once and then issue - an authentication failure error.</para> - - <tip> - <title>Tip:</title> - <para>If an authentication failure error occurs, you can retry the same operation and - supply different authentication information.</para> - </tip> - - <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.</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.</para> - </note> - </section> - - <section id="guvnor_repositories_view"> - <title>Guvnor Repositories View</title> - - <para>The <property>Guvnor Repositories view</property> contains tree structures for Guvnor - repository contents.</para> - - <figure> - <title>Guvnor Repositories View</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/functionality_overview/guvnor_repository.png"/> - </imageobject> - </mediaobject> - </figure> - - <para>You can perform the following actions under the resources in the - <property>Guvnor Repositories view</property>:</para> - - <itemizedlist> - <listitem> - <para>create a new Guvnor repository connection. How to do this is describe above in the <link linkend="connection_wizard">&quot;Guvnor Connection Wizard&quot;</link> section.</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 <emphasis> - <property>Delete</property></emphasis> option in the context menu to remove a repository connection.</para> - </listitem> - - <listitem> - <para>refresh Guvnor repository resorces. Use the <emphasis> - <property>Refresh</property></emphasis> context menu item to reload a tree content 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 <emphasis><property>Go Home</property></emphasis> - ( <inlinemediaobject> - <imageobject> - <imagedata fileref="images/functionality_overview/go_home_button.png"/> - </imageobject> - </inlinemediaobject> ), <emphasis><property>Go Back</property></emphasis> - ( <inlinemediaobject> - <imageobject> - <imagedata fileref="images/functionality_overview/go_back_button.png"/> - </imageobject> - </inlinemediaobject> ) and <emphasis> - <property>Go Into</property></emphasis> - ( <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 <emphasis> - <property>&quot;defaultPackage&quot;</property></emphasis> node changes the tree view to:</para> - - <figure> - <title>Going Into the <emphasis>&quot;defaultPackage&quot;</emphasis></title> - <mediaobject> - <imageobject> - <imagedata fileref="images/functionality_overview/go_into_defaultPackage.png"/> - </imageobject> - </mediaobject> - </figure> - - <para>Clicking on the Go Home button ( <inlinemediaobject> - <imageobject> - <imagedata fileref="images/functionality_overview/go_home_button.png"/> - </imageobject> - </inlinemediaobject> ) or selecting <emphasis> - <property>Go Home</property></emphasis> in the context menu returns the tree to the top-level structure shown in the previous picture above. - </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 <property>Properties view</property> to update with details about that file: -</para> - - <figure> - <title>Guvnor Repository Files Properties</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/functionality_overview/repository_files_properties.png"/> - </imageobject> - </mediaobject> - </figure> - - <para></para> - </section> - + <para>This chapter will give an overview on all functionality the <property>Guvnor Tools</property> provides.</para> + + <section > + <title>Creating a New Guvnor Connection</title> + <para>As mentioned in the <link linkend="introduction">&quot;Introduction&quot;</link>, the main purpose + of 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 <link linkend="connection_wizard">Guvnor Connection + wizard</link>. </para> + </section> + <section id="local_copies"> - <title>Local Copies of Guvnor Files</title> - - <para>As mentioned in the <link linkend="introduction">&quot;Introduction&quot;</link>, the main purpose - of the <property>EGT</property> is to allow development using resources held in a Guvnor - repository. There are two method of getting local copies of Guvnor repository + <title>Getting Local Copies of Guvnor Files</title> + <para>There are two methods of getting local copies of Guvnor repository resources:</para> <orderedlist> <listitem> - <para>Drag-and-drop from the <property>Guvnor Repositories view</property></para> + <para>Drag-and-drop from the <link linkend="guvnor_repositories_view">Guvnor Repositories view</link></para> </listitem> <listitem> - <para>Using the <link linkend="resources_from_guvnor">Import from Guvnor + <para>Using the <link linkend="resources_from_guvnor">Resource from Guvnor wizard</link>, as described further in this document</para> </listitem> </orderedlist> @@ -305,10 +62,10 @@ above you can see the <emphasis> <property>Dummy rule.drl</property></emphasis> file with the decoration in the <property>Resource Navigator</property>. 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 the <link linkend="resource_decoration_preferences">Guvnor + changed in the <link linkend="resource_decoration_preferences">Guvnor Preferences</link>.)</para> - <para>Here we see that, <emphasis><property>Dummy role.drl</property></emphasis> is associated with a Guvnor repository + <para>Here we see that, <emphasis><property>Dummy rule.drl</property></emphasis> 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. The file <emphasis><property>Sample.drl</property>,</emphasis> however, is not associated with a Guvnor repository file. Further details about the association can be found in the standard Eclipse @@ -328,9 +85,9 @@ repository, the location within the repository, the version (date/time stamp) and the revision number.</para> </section> - + <section id="actions"> - <title>Actions for Local Guvnor Resources</title> + <title>Managing Guvnor Resources</title> <para>The <property>EGT</property> provides a number of actions (available through the <emphasis><property>Guvnor</property></emphasis> context menu on files) for working with files, both those associated with @@ -477,14 +234,7 @@ <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 <emphasis> <property>Commit</property> - </emphasis> action will<figure> - <title>Add to Guvnor Wizard</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/functionality_overview/add_toGuvnor_wizard.png"/> - </imageobject> - </mediaobject> - </figure> ask whether you wish to overwrite the current version in the + </emphasis> 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 @@ -496,7 +246,7 @@ <para>The <emphasis> <property>Show History</property> - </emphasis> action is enable for one Guvnor repository associated file and causes + </emphasis> action is enabled for one Guvnor repository associated file and causes the <link linkend="guvnor_history_view">Guvnor Resource History view</link> to be populated with revision history for the selected file.</para> </section> @@ -598,130 +348,6 @@ and removes local metadata for the Guvnor repository association.</para> </section> </section> - - <section id="guvnor_history_view"> - <title>Guvnor Resource History View</title> - - <para>The <property>Guvnor Resource History view</property> should 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.</para> - - <figure> - <title>Initial State of the Guvnor Resource History View</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/functionality_overview/resource_history_view.png"/> - </imageobject> - </mediaobject> - </figure> - - <para>The <property>Guvnor Resource History view</property> is populated by <emphasis> - <property>Show History</property> - </emphasis> actions in either the local <emphasis> - <property>Guvnor</property></emphasis> context menu or in the context menu for - a Guvnor repository file in the <link linkend="guvnor_repositories_view">Guvnor - Repositories view</link>. Once this action is performed, the <property>Guvnor - Resource History view</property> updates to show the revision history:</para> - - <figure> - <title>IGuvnor Resource History View</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/functionality_overview/resource_history_view2.png"/> - </imageobject> - </mediaobject> - </figure> - - <para>Here we see that the file <emphasis> - <property>test.txt</property> - </emphasis> has three revisions. Double clicking on a revision row (or the context menu <emphasis> - <property>Open (Read only)</property>)</emphasis> opens an Eclipse read-only editor - with the revision contents.</para> - - <figure> - <title>Eclipse Read-only Editor with the Revision Contents</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/functionality_overview/resource_history_view3.png"/> - </imageobject> - </mediaobject> - </figure> - <note> - <title>Note:</title> - <para>You can also use the <emphasis> - <property>Save As...</property> - </emphasis> option when a file is open in a read-only editor to save a local - writable copy of the contents. Doing so, however, will not associate the file - created with its Guvnor source.</para> - </note> - - </section> - - <section id="resources_from_guvnor"> - <title>Importing Guvnor Repository Resources</title> - - <para>In addition to the single file drag-and-drop from the <property>Guvnor Repositories - view</property>, 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 from the <emphasis> - <property>File &gt; Import &gt; Guvnor &gt; Resource from - Guvnor</property> - </emphasis> and the <emphasis> - <property>File &gt; New &gt; Other &gt; Guvnor &gt; Resource from - Guvnor</property> - </emphasis> menu items.</para> - <note> - <title>Note:</title> - - <para>Note that the wizard is identical but appears in both locations to accommodate - users who tend to view this functionality as being in either category.</para> - </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 <link linkend="guvnor_connection_wizard">Guvnor Connection wizard</link>).</para> - - <figure> - <title>Resource from Guvnor Wizard</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/functionality_overview/add_toGuvnor_wizard.png"/> - </imageobject> - </mediaobject> - </figure> - - <para>Once the source Guvnor repository is chosen, the wizard prompts for resource selection:</para> - - <figure> - <title>Resource Selection</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/functionality_overview/resource_from_guvnor.png"/> - </imageobject> - </mediaobject> - </figure> - - <para>Finally, the target location in the local workspace should be chosen:</para> - <figure> - <title>Choosing the Target Location</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/functionality_overview/resource_from_guvnor2.png"/> - </imageobject> - </mediaobject> - </figure> - - <para>On completion the wizard copies the selected files from the Guvnor repository to the local workspace. - If a file with the same name already exists in the destination, the wizard uses the Eclipse standard - &quot;prompt for rename&quot; dialog:</para> - - <figure> - <title>Prompt for Rename Dialog</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/functionality_overview/resource_from_guvnor3.png"/> - </imageobject> - </mediaobject> - </figure> - </section> + + </chapter> Modified: tags/jbosstools-3.1.1.GA/drools/docs/guvnor_ref/en-US/guvnor_preferences.xml =================================================================== --- tags/jbosstools-3.1.1.GA/drools/docs/guvnor_ref/en-US/guvnor_preferences.xml 2010-06-08 23:23:11 UTC (rev 22645) +++ tags/jbosstools-3.1.1.GA/drools/docs/guvnor_ref/en-US/guvnor_preferences.xml 2010-06-08 23:27:46 UTC (rev 22646) @@ -8,83 +8,461 @@ </keywordset> </chapterinfo> - <title>Guvnor Preferences</title> - - <para>The <property>EGT</property> provides a preference page in the <emphasis> - <property>Guvnor</property> - </emphasis> category:</para> - - <figure> - <title>Resource Selection</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/guvnor_preferences/guvnor_preferences.png"/> - </imageobject> - </mediaobject> - </figure> - - <para>The preferences cover two categories:</para> - <itemizedlist> - <listitem><para>Guvnor repository connections</para></listitem> - - <listitem><para>Local Guvnor - repository resource decorations.</para></listitem> - </itemizedlist> - - <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> - + <title>Reference</title> + <para>This chapter includes detailed reference information about Views and Wizards used to manage Guvnor Tools.</para> + + <section id="guvnor_perspective"> + <title>Guvnor Repository Exploring Perspective</title> + + <para>The <property>Guvnor Repository Exploring perspective</property> contains two views + supplied by <property>EGT</property> – <link linkend="guvnor_repositories_view">Guvnor Repositories view</link> and + <link linkend="guvnor_history_view">Guvnor Resource History view</link>, that will be the center of most interactions + with Guvnor, and Eclipse standard views such as <property>Properties</property> and + <property>Resource Navigator</property> that 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 <emphasis> + <property>Window &gt; Open Perspective &gt; Other</property> + </emphasis> to get the perspective list:</para> + + <figure> + <title>Enabling the Guvnor Repository Perspective</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/functionality_overview/open_guvnor_perspectine.png"/> + </imageobject> + </mediaobject> + </figure> + + <para>And then choose <emphasis> + <property>Guvnor Repository Exploring</property>.</emphasis> This opens the + <property>Guvnor perspective</property>.</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.</para> + + <para>The <property>Guvnor Connection wizard</property> can be started in the following + ways:</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.</para> + <para>using the Eclipse menu <emphasis> + <property>File &gt; New &gt; Other &gt; Guvnor &gt; Guvnor + repository location</property> + </emphasis></para> + + <figure> + <title>New Guvnor Repository Location</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/functionality_overview/start_guvnor_connection1.png"/> + </imageobject> + </mediaobject> + </figure> </listitem> + <listitem> - <para>The second is whether saving of authentication information in the Eclipse - platform key-ring should be enabled by default.</para> + <para>in the <property>Guvnor Repositories view</property> using the drop-down menu</para> + + <figure> + <title>Adding New Guvnor Connection</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/functionality_overview/start_guvnor_connection2.png"/> + </imageobject> + </mediaobject> + </figure> </listitem> + + <listitem> + <para>using the menu button + ( <inlinemediaobject> + <imageobject> + <imagedata fileref="images/functionality_overview/guvnor_connection_button.png"/> + </imageobject> + </inlinemediaobject> ) + </para> + </listitem> </itemizedlist> - - <para>As with the Guvnor repository URL template, actually whether to save a specific - instance of authentication information in the Eclipse platform key-ring can be - determined when actually creating the connection. That is, both of these preferences are - simply convenience values set to reasonable defaults.</para> + + <para>Choosing either of these will start the <property>Guvnor Connection + wizard</property>.</para> + + <figure id="guvnor_connection_wizard"> + <title>Guvnor Connection Wizard</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/functionality_overview/guvnor_connection_wizard.png"/> + </imageobject> + </mediaobject> + </figure> + + <para>Default values appear in the <emphasis> + <property>Location</property>,</emphasis> + <emphasis> + <property>Port</property>,</emphasis> and <emphasis> + <property>Repository</property> + </emphasis> fields (See the <link linkend="guvnor_preferences">“Guvnor Preferences”</link> 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 <emphasis> + <property>Location</property> + </emphasis> field of a typical Guvnor repository URL such as:</para> + + <para> + <emphasis> + <property>http://localhost:8080/drools-guvnor/org.drools.guvnor.Guvnor/webdav</property> + </emphasis> + </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 <emphasis> + <property>Save user name and password</property>.</emphasis></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.</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.</para> + + <para>If authentication fails, the <property>EGT</property> will retry once and then issue + an authentication failure error.</para> + + <tip> + <title>Tip:</title> + <para>If an authentication failure error occurs, you can retry the same operation and + supply different authentication information.</para> + </tip> + + <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.</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.</para> + </note> </section> - - <section id="resource_decoration_preferences"> - <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.</para> + + <section id="resources_from_guvnor"> + <title>Resource from Guvnor Wizard</title> + + <para>In addition to the single file drag-and-drop from the <property>Guvnor Repositories + view</property>, 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 from the <emphasis> + <property>File &gt; Import &gt; Guvnor &gt; Resource from + Guvnor</property> + </emphasis> and the <emphasis> + <property>File &gt; New &gt; Other &gt; Guvnor &gt; Resource from + Guvnor</property> + </emphasis> menu items.</para> + <note> + <title>Note:</title> - <para>In the <emphasis> - <property>File Decoration</property></emphasis> - 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 <emphasis> - <property>Text</property></emphasis> section, you can format the Guvnor metadata that is appended to the file - names:</para> + <para>Note that the wizard is identical but appears in both locations to accommodate + users who tend to view this functionality as being in either category.</para> + </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 <link linkend="guvnor_connection_wizard">Guvnor Connection wizard</link>).</para> + + <figure> + <title>Resource from Guvnor Wizard</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/functionality_overview/add_toGuvnor_wizard.png"/> + </imageobject> + </mediaobject> + </figure> + + <para>Once the source Guvnor repository is chosen, the wizard prompts for resource selection:</para> + + <figure> + <title>Resource Selection</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/functionality_overview/resource_from_guvnor.png"/> + </imageobject> + </mediaobject> + </figure> + + <para>Finally, the target location in the local workspace should be chosen:</para> + <figure> + <title>Choosing the Target Location</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/functionality_overview/resource_from_guvnor2.png"/> + </imageobject> + </mediaobject> + </figure> + + <para>On completion the wizard copies the selected files from the Guvnor repository to the local workspace. + If a file with the same name already exists in the destination, the wizard uses the Eclipse standard + &quot;prompt for rename&quot; dialog:</para> + + <figure> + <title>Prompt for Rename Dialog</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/functionality_overview/resource_from_guvnor3.png"/> + </imageobject> + </mediaobject> + </figure> + </section> + + <section id="guvnor_repositories_view"> + <title>Guvnor Repositories View</title> + + <para>The <property>Guvnor Repositories view</property> contains tree structures for Guvnor + repository contents.</para> + + <figure> + <title>Guvnor Repositories View</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/functionality_overview/guvnor_repository.png"/> + </imageobject> + </mediaobject> + </figure> + + <para>You can perform the following actions under the resources in the + <property>Guvnor Repositories view</property>:</para> + <itemizedlist> <listitem> - <para>Whether to show an indicator (&gt;) when the local file has changes not committed back to the - Guvnor repository</para> + <para>create a new Guvnor repository connection. How to do this is describe above in the <link linkend="connection_wizard">&quot;Guvnor Connection Wizard&quot;</link> section.</para> </listitem> + <listitem> - <para>Whether to show the revision number</para> + <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 <emphasis> + <property>Delete</property></emphasis> option in the context menu to remove a repository connection.</para> </listitem> + <listitem> - <para>Whether to show the date/time stamp</para> - </listitem> - </itemizedlist> - - <para>Any changes to these preferences take effect immediately upon clicking the <emphasis> - <property>Apply</property></emphasis> and then <emphasis> - <property>Ok</property></emphasis> buttons.</para> + <para>refresh Guvnor repository resorces. Use the <emphasis> + <property>Refresh</property></emphasis> context menu item to reload a tree content 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 <emphasis><property>Go Home</property></emphasis> + ( <inlinemediaobject> + <imageobject> + <imagedata fileref="images/functionality_overview/go_home_button.png"/> + </imageobject> + </inlinemediaobject> ), <emphasis><property>Go Back</property></emphasis> + ( <inlinemediaobject> + <imageobject> + <imagedata fileref="images/functionality_overview/go_back_button.png"/> + </imageobject> + </inlinemediaobject> ) and <emphasis> + <property>Go Into</property></emphasis> + ( <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 <emphasis> + <property>&quot;defaultPackage&quot;</property></emphasis> node changes the tree view to:</para> + + <figure> + <title>Going Into the <emphasis>&quot;defaultPackage&quot;</emphasis></title> + <mediaobject> + <imageobject> + <imagedata fileref="images/functionality_overview/go_into_defaultPackage.png"/> + </imageobject> + </mediaobject> + </figure> + + <para>Clicking on the Go Home button ( <inlinemediaobject> + <imageobject> + <imagedata fileref="images/functionality_overview/go_home_button.png"/> + </imageobject> + </inlinemediaobject> ) or selecting <emphasis> + <property>Go Home</property></emphasis> in the context menu returns the tree to the top-level structure shown in the previous picture above. + </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 <property>Properties view</property> to update with details about that file: + </para> + + <figure> + <title>Guvnor Repository Files Properties</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/functionality_overview/repository_files_properties.png"/> + </imageobject> + </mediaobject> + </figure> + + <para></para> </section> + + <section id="guvnor_history_view"> + <title>Guvnor Resource History View</title> + + <para>The <property>Guvnor Resource History view</property> should 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.</para> + + <figure> + <title>Initial State of the Guvnor Resource History View</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/functionality_overview/resource_history_view.png"/> + </imageobject> + </mediaobject> + </figure> + + <para>The <property>Guvnor Resource History view</property> is populated by <emphasis> + <property>Show History</property> + </emphasis> actions in either the local <emphasis> + <property>Guvnor</property></emphasis> context menu or in the context menu for + a Guvnor repository file in the <link linkend="guvnor_repositories_view">Guvnor + Repositories view</link>. Once this action is performed, the <property>Guvnor + Resource History view</property> updates to show the revision history:</para> + + <figure> + <title>Guvnor Resource History View</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/functionality_overview/resource_history_view2.png"/> + </imageobject> + </mediaobject> + </figure> + + <para>Here we see that the file <emphasis> + <property>test.txt</property> + </emphasis> has seven revisions. Double clicking on a revision row (or the context menu <emphasis> + <property>Open (Read only)</property>)</emphasis> opens an Eclipse read-only editor + with the revision contents.</para> + + <figure> + <title>Eclipse Read-only Editor with the Revision Contents</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/functionality_overview/resource_history_view3.png"/> + </imageobject> + </mediaobject> + </figure> + <note> + <title>Note:</title> + <para>You can also use the <emphasis> + <property>Save As...</property> + </emphasis> option when a file is open in a read-only editor to save a local + writable copy of the contents. Doing so, however, will not associate the file + created with its Guvnor source.</para> + </note> + + </section> + + <section id="preferences"> + <title>Guvnor Preferences</title> + + + <para>The <property>EGT</property> provides a preference page in the <emphasis> + <property>Guvnor</property> + </emphasis> category:</para> + + <figure> + <title>Resource Selection</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/guvnor_preferences/guvnor_preferences.png"/> + </imageobject> + </mediaobject> + </figure> + + <para>The preferences cover two categories:</para> + <itemizedlist> + <listitem><para>Guvnor repository connections</para></listitem> + + <listitem><para>Local Guvnor + repository resource decorations.</para></listitem> + </itemizedlist> + + <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> + + <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.</para> + </listitem> + <listitem> + <para>The second is whether saving of authentication information in the Eclipse + platform key-ring should be enabled by default.</para> + </listitem> + </itemizedlist> + + <para>As with the Guvnor repository URL template, actually whether to save a specific + instance of authentication information in the Eclipse platform key-ring can be + determined when actually creating the connection. That is, both of these preferences are + simply convenience values set to reasonable defaults.</para> + </section> + + <section id="resource_decoration_preferences"> + <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.</para> + + <para>In the <emphasis> + <property>File Decoration</property></emphasis> + 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 <emphasis> + <property>Text</property></emphasis> section, you can format the Guvnor metadata that is appended to the file + names:</para> + <itemizedlist> + <listitem> + <para>Whether to show an indicator (&gt;) when the local file has changes not committed back to the + Guvnor repository</para> + </listitem> + <listitem> + <para>Whether to show the revision number</para> + </listitem> + <listitem> + <para>Whether to show the date/time stamp</para> + </listitem> + </itemizedlist> + + <para>Any changes to these preferences take effect immediately upon clicking the <emphasis> + <property>Apply</property></emphasis> and then <emphasis> + <property>Ok</property></emphasis> buttons.</para> + </section> + </section> </chapter> Modified: tags/jbosstools-3.1.1.GA/drools/docs/guvnor_ref/en-US/introduction.xml =================================================================== --- tags/jbosstools-3.1.1.GA/drools/docs/guvnor_ref/en-US/introduction.xml 2010-06-08 23:23:11 UTC (rev 22645) +++ tags/jbosstools-3.1.1.GA/drools/docs/guvnor_ref/en-US/introduction.xml 2010-06-08 23:27:46 UTC (rev 22646) @@ -8,15 +8,7 @@ comprehensive reference, there should be enough detail included for early adopters using these tools.</para> - <para>The <property>Guvnor repository</property> is not intended as a Source Code Management - (SCM) solution, and the <property>EGT</property> are not intended to be Eclipse “team - provider” extensions or replacements. 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> + <para>First, have a look at the key features of <property>Guvnor Tools:</property></para> <section id="drools_key_features"> <title>Guvnor Tools Key Features</title> @@ -82,15 +74,14 @@ <row> <entry> - <para>Resources from Guvnor Wizard</para> + <para>Resource from Guvnor wizard</para> </entry> <entry> <para>The wizard helps to get local copies of Guvnor repository resources.</para> </entry> <entry> - <link linkend="resources_from_guvnor">Importing Guvnor Repository - Resources</link> + <link linkend="resources_from_guvnor">Resource from Guvnor wizard</link> </entry> </row> @@ -106,7 +97,7 @@ and those not associated.</para> </entry> <entry> - <link linkend="actions">Actions for Local Guvnor Resources</link> + <link linkend="actions">Managing Guvnor Resources</link> </entry> </row> @@ -114,12 +105,23 @@ </tgroup> </table> </section> - + <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 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"> - <title>How to start with Guvnor Tools</title> + <title>Requirements and Installation</title> <para><property>Guvnor Tools</property> is a part of the <property>JBoss Tools</property> - project. Thus to get started with <property>Guvnor Tools</property>, you should have the following:</para> + project. Thus to get started with Guvnor Tools, you should have the following:</para> <itemizedlist> <listitem> @@ -128,50 +130,38 @@ </listitem> <listitem> - <para>JBoss Server 4.2 or higher with Guvnor repository deployed. Thus, you should - download <ulink - url="http://download.jboss.org/drools/release/5.0.0.25561.CR1/drools... - >Guvnor CR1</ulink> and extract it to the deploy directory of the - server.</para> + <para>JBoss Server 4.2 or higher with Guvnor repository deployed.</para> </listitem> </itemizedlist> - - <para>Now refer to the <link linkend="functionality_overview">&quot;Functionality - Overview&quot;</link> section to find out what you can do with Guvnor and - Eclipse synchronisation tool.</para> - </section> - - <section> - <title>Other relevant resources on the topic</title> - - <itemizedlist> + <para>To have JBoss Server with Guvnor repository deployed, 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 a JBoss AS 5 and a <property>Guvnor Tools</property> doesn't work when deployed to the server, + you should do the following to get Guvnor Tools running:</para> + <orderedlist> <listitem> - <para>Guvnor <ulink url="http://www.jboss.org/community/wiki/Guvnor">wiki page</ulink></para> + <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.</para> </listitem> - <listitem> - <para>Drools on <ulink url="http://www.jboss.org/drools/">JBoss.org</ulink>&l... + <para>Remove the JAXP libraries (xercesImpl-2.8.0.jar, xml-apis-2.*)</para> </listitem> - <listitem> - <para> - <ulink url="http://www.jboss.org/tools/">JBoss Tools Home Page</ulink> - </para> + <para>Remove the EL libraries (el-*)</para> </listitem> - - <listitem> - <para> - <ulink url="http://download.jboss.org/jbosstools/nightly-docs/">The latest - JBossTools/JBDS documentation builds</ulink> - </para> - </listitem> - - <listitem> - <para> - <ulink url="http://docs.jboss.org/tools/">JBossTools/JBDS - release documentation</ulink></para> - </listitem> - </itemizedlist> - + </orderedlist> + <para>After this, Guvnor should operate as normal. + During deployment, you would see the following exception in the log which indicates that the experiemental + JBoss Security based ACL integration has defined some EJB3/JPA stuff in guvnor that has 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 <link linkend="functionality_overview">&quot;Tasks&quot;</link> + section to find out what you can do with Guvnor and + Eclipse synchronisation tool.</para> </section> + </chapter> Modified: tags/jbosstools-3.1.1.GA/drools/docs/guvnor_ref/en-US/master.xml =================================================================== --- tags/jbosstools-3.1.1.GA/drools/docs/guvnor_ref/en-US/master.xml 2010-06-08 23:23:11 UTC (rev 22645) +++ tags/jbosstools-3.1.1.GA/drools/docs/guvnor_ref/en-US/master.xml 2010-06-08 23:27:46 UTC (rev 22646) @@ -2,7 +2,7 @@ <!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN" "http://www.docbook.org/xml/4.3/docbookx.dtd" -[<!ENTITY introduction SYSTEM "introduction.xml"> +[ <!ENTITY introduction SYSTEM "introduction.xml"> <!ENTITY functionality_overview SYSTEM "functionality_overview.xml"> <!ENTITY guvnor_preferences SYSTEM "guvnor_preferences.xml"> <!ENTITY conclusion SYSTEM "conclusion.xml"> @@ -40,7 +40,7 @@ <author><firstname>Olga</firstname><surname>Chikvina</surname></author> <copyright> - <year>2009</year> + <year>2009</year> <year>2010</year> <holder>JBoss by Red Hat</holder> </copyright> @@ -61,6 +61,5 @@ &introduction; &functionality_overview; &guvnor_preferences; - &conclusion; - + &conclusion; </book> Modified: tags/jbosstools-3.1.1.GA/drools/docs/guvnor_ref/en-US/master_output.xml =================================================================== --- tags/jbosstools-3.1.1.GA/drools/docs/guvnor_ref/en-US/master_output.xml 2010-06-08 23:23:11 UTC (rev 22645) +++ tags/jbosstools-3.1.1.GA/drools/docs/guvnor_ref/en-US/master_output.xml 2010-06-08 23:27:46 UTC (rev 22646) @@ -2,10 +2,10 @@ <!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN" "http://www.docbook.org/xml/4.3/docbookx.dtd" -[<!ENTITY introduction SYSTEM "modules/introduction.xml"> -<!ENTITY functionality_overview SYSTEM "modules/functionality_overview.xml"> -<!ENTITY guvnor_preferences SYSTEM "modules/guvnor_preferences.xml"> -<!ENTITY conclusion SYSTEM "modules/conclusion.xml"> +[ <!ENTITY introduction SYSTEM "introduction.xml"> +<!ENTITY functionality_overview SYSTEM "functionality_overview.xml"> +<!ENTITY guvnor_preferences SYSTEM "guvnor_preferences.xml"> +<!ENTITY conclusion SYSTEM "conclusion.xml"> <!ENTITY seamlink "../../seam/html_single/index.html"> <!ENTITY aslink "../../as/html_single/index.html"> @@ -58,7 +58,7 @@ <toc></toc> -<chapter id="introduction" xml:base="file:///home/vchukhutsina/repos/ochik_jboss/drools/docs/guvnor_ref/en/modules/introduction.xml" xreflabel="introduction"> +<chapter id="introduction" xml:base="file:///home/vchukhutsina/repos/ochik_jboss/drools/docs/guvnor_ref/en-US/introduction.xml" xreflabel="introduction"> <title>Introduction</title> <para>The purpose of this document is to describe briefly the functionality present in the @@ -66,15 +66,7 @@ comprehensive reference, there should be enough detail included for early adopters using these tools.</para> - <para>The <property moreinfo="none">Guvnor repository</property> is not intended as a Source Code Management - (SCM) solution, and the <property moreinfo="none">EGT</property> are not intended to be Eclipse “team - provider” extensions or replacements. 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 moreinfo="none">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 moreinfo="none">EGT</property>.</para> + <para><diffmk:wrapper diffmk:change="added">First, have a look at the key features of </diffmk:wrapper><property moreinfo="none"><diffmk:wrapper diffmk:change="changed">Guvnor Tools:</diffmk:wrapper></property></para> <section id="drools_key_features"> <title>Guvnor Tools Key Features</title> @@ -140,15 +132,14 @@ <row> <entry> - <para>Resources from Guvnor Wizard</para> + <para><diffmk:wrapper diffmk:change="changed">Resource from Guvnor wizard</diffmk:wrapper></para> </entry> <entry> <para>The wizard helps to get local copies of Guvnor repository resources.</para> </entry> <entry> - <link linkend="resources_from_guvnor">Importing Guvnor Repository - Resources</link> + <link linkend="resources_from_guvnor"><diffmk:wrapper diffmk:change="changed">Resource from Guvnor wizard</diffmk:wrapper></link> </entry> </row> @@ -164,7 +155,7 @@ and those not associated.</para> </entry> <entry> - <link linkend="actions">Actions for Local Guvnor Resources</link> + <link linkend="actions"><diffmk:wrapper diffmk:change="changed">Managing Guvnor Resources</diffmk:wrapper></link> </entry> </row> @@ -172,69 +163,69 @@ </tgroup> </table> </section> - + <section diffmk:change="added" id="what_is_guvnor_tools"> + <title diffmk:change="added"><diffmk:wrapper diffmk:change="added">What is Guvnor Tools?</diffmk:wrapper></title> + <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">The </diffmk:wrapper><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">Guvnor repository</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added"> is not intended as a Source Code Management + (SCM) solution, and the </diffmk:wrapper><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">EGT</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added"> is not intended to be 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 </diffmk:wrapper><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">EGT</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added"> + 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 + </diffmk:wrapper><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">EGT</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added">.</diffmk:wrapper></para> + </section> <section id="how_to_start"> - <title>How to start with Guvnor Tools</title> + <title><diffmk:wrapper diffmk:change="changed">Requirements and Installation</diffmk:wrapper></title> - <para><property moreinfo="none">Guvnor Tools</property> is a part of the <property moreinfo="none">JBoss Tools</property> - project. Thus to get started with <property moreinfo="none">Guvnor Tools</property>, you should have the following:</para> + <para><property moreinfo="none">Guvnor Tools</property> is a part of the <property moreinfo="none">JBoss Tools</property><diffmk:wrapper diffmk:change="added"> + project. Thus to get started with Guvnor Tools, you should have the following:</diffmk:wrapper></para> <itemizedlist> <listitem> <para>Eclipse 3.4.x with Jboss Tools bundle of Eclipse plugins installed. How to - install JBoss Tools onto Eclipse you can find in the <ulink url="../../GettingStartedGuide/html_single/index.html#JBossToolsInstall">"JBoss Tools - Installation"</ulink> section.</para> + install JBoss Tools onto Eclipse you can find in the JBoss Tools Installation section.</para> </listitem> <listitem> - <para>JBoss Server 4.2 or higher with Guvnor repository deployed. Thus, you should - download <ulink url="http://download.jboss.org/drools/release/5.0.0.25561.CR1/drools... CR1</ulink> and extract it to the deploy directory of the - server.</para> + <para><diffmk:wrapper diffmk:change="added">JBoss Server 4.2 or higher with Guvnor repository deployed.</diffmk:wrapper></para> </listitem> </itemizedlist> - - <para>Now refer to the <link linkend="functionality_overview">"Functionality - Overview"</link> section to find out what you can do with Guvnor and - Eclipse synchronisation tool.</para> - </section> - - <section> - <title>Other relevant resources on the topic</title> - - <itemizedlist> + <para><diffmk:wrapper diffmk:change="added">To have JBoss Server with Guvnor repository deployed, you should + download </diffmk:wrapper><ulink diffmk:change="added" url="http://www.jboss.org/drools/downloads.html"><diffmk:... diffmk:change="added">Drools Guvnor</diffmk:wrapper></ulink><diffmk:wrapper diffmk:change="added">. + When downloading you may choose either web based Guvnor to deploy to your + JBoss Server or Standalone Guvnor with JBoss AS.</diffmk:wrapper></para> + <para><diffmk:wrapper diffmk:change="added">If you use a JBoss AS 5 and a </diffmk:wrapper><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">Guvnor Tools</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added"> doesn't work when deployed to the server, + you should do the following to get Guvnor Tools running:</diffmk:wrapper></para> + <orderedlist continuation="restarts" diffmk:change="added" inheritnum="ignore"> <listitem> - <para>Guvnor <ulink url="http://www.jboss.org/community/wiki/Guvnor">wiki page</ulink></para> + <para><diffmk:wrapper diffmk:change="added">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.</diffmk:wrapper></para> </listitem> - <listitem> - <para>Drools on <ulink url="http://www.jboss.org/drools/">JBoss.org</ulink>&l... + <para><diffmk:wrapper diffmk:change="added">Remove the JAXP libraries (xercesImpl-2.8.0.jar, xml-apis-2.*)</diffmk:wrapper></para> </listitem> - <listitem> - <para> - <ulink url="http://www.jboss.org/tools/">JBoss Tools Home Page</ulink> - </para> + <para><diffmk:wrapper diffmk:change="added">Remove the EL libraries (el-*)</diffmk:wrapper></para> </listitem> + </orderedlist> + <para><diffmk:wrapper diffmk:change="added">After this, Guvnor should operate as normal. + During deployment, you would see the following exception in the log which indicates that the experiemental + JBoss Security based ACL integration has defined some EJB3/JPA stuff in guvnor that has not been configured.</diffmk:wrapper></para> + <programlisting diffmk:change="added" format="linespecific"><diffmk:wrapper diffmk:change="added">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 + </diffmk:wrapper></programlisting> + <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">Now refer to the </diffmk:wrapper><link diffmk:change="added" linkend="functionality_overview"><diffmk:wrapper diffmk:change="added">"Tasks"</diffmk:wrapper></link><diffmk:wrapper diffmk:change="added"> + section to find out what you can do with Guvnor and + Eclipse synchronisation tool.</diffmk:wrapper></para> + </section> - <listitem> - <para> - <ulink url="http://download.jboss.org/jbosstools/nightly-docs/">The latest - JBossTools/JBDS documentation builds</ulink> - </para> - </listitem> - - <listitem> - <para> - <ulink url="http://docs.jboss.org/tools/">JBossTools/JBDS - release documentation</ulink></para> - </listitem> - </itemizedlist> - - </section> </chapter> -<chapter id="functionality_overview" xml:base="file:///home/vchukhutsina/repos/ochik_jboss/drools/docs/guvnor_ref/en/modules/functionality_overview.xml" xreflabel="functionality_overview"> +<chapter id="functionality_overview" xml:base="file:///home/vchukhutsina/repos/ochik_jboss/drools/docs/guvnor_ref/en-US/functionality_overview.xml" xreflabel="functionality_overview"> <?dbhtml filename="functionality_overview.html"?> <chapterinfo> <keywordset> @@ -243,274 +234,31 @@ </keywordset> </chapterinfo> - <title>Functionality Overview</title> + <title><diffmk:wrapper diffmk:change="changed">Tasks</diffmk:wrapper></title> - <para>This chapter will introduce you to the <property moreinfo="none">Guvnor Repository Exploring - perspective</property> and give an overview on all functionality the <property moreinfo="none">Guvnor Tools</property> provides.</para> - - <section id="guvnor_perspective"> - <title>Guvnor Perspective</title> - - <para>The <property moreinfo="none">Guvnor Repository Exploring perspective</property> contains two views - supplied by <property moreinfo="none">EGT</property> – <property moreinfo="none">Repository Explorer</property> and - <property moreinfo="none">Version History</property>, that will be the center of most interaction - with Guvnor, and Eclipse standard views such as <property moreinfo="none">Properties</property> and - <property moreinfo="none">Resource Navigator</property> that are also useful.</para> - - <para>While each of these views can be opened and positioned independently within an Eclipse - workbench, the <property moreinfo="none">Guvnor perspective</property> provides a convenient method of - getting a suggested layout. In the Eclipse workbench menu, choose <emphasis> - <property moreinfo="none">Window &gt; Open Perspective &gt; Other</property> - </emphasis> to get the perspective list:</para> - - <figure float="0"> - <title>Enabling the Guvnor Repository Perspective</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/functionality_overview/open_guvnor_perspectine.png"></imagedata> - </imageobject> - </mediaobject> - </figure> - - <para>And then choose <emphasis> - <property moreinfo="none">Guvnor Repository Exploring</property>.</emphasis> This opens the - <property moreinfo="none">Guvnor perspective</property>.</para> - </section> - - <section id="connection_wizard"> - <title>Guvnor Connection Wizard</title> - - <para>After opening the <property moreinfo="none">Guvnor perspective</property>, the first task is to make a - connection to a Guvnor repository. This is handled by the <property moreinfo="none">Guvnor Connection - wizard</property>. This wizard appears in a number of places within the - <property moreinfo="none">EGT</property> (as detailed below), but in this section we will cover only - the two most basic entry points.</para> - - <para>The <property moreinfo="none">Guvnor Connection wizard</property> can be started in the following - ways:</para> - - <itemizedlist> - <listitem> - <para>using the Eclipse menu <emphasis> - <property moreinfo="none">File &gt; New &gt; Other &gt; Guvnor &gt; Guvnor - repository location</property> - </emphasis></para> - - <figure float="0"> - <title>New Guvnor Repository Location</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/functionality_overview/start_guvnor_connection1.png"></imagedata> - </imageobject> - </mediaobject> - </figure> - </listitem> - - <listitem> - <para>in the <property moreinfo="none">Guvnor Repositories view</property> using the drop-down menu</para> - - <figure float="0"> - <title>Adding New Guvnor Connection</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/functionality_overview/start_guvnor_connection2.png"></imagedata> - </imageobject> - </mediaobject> - </figure> - </listitem> - - <listitem> - <para>using the menu button - ( <inlinemediaobject> - <imageobject> - <imagedata fileref="images/functionality_overview/guvnor_connection_button.png"></imagedata> - </imageobject> - </inlinemediaobject> ) - </para> - </listitem> - </itemizedlist> - - <para>Choosing either of these will start the <property moreinfo="none">Guvnor Connection - wizard</property>.</para> - - <figure float="0" id="guvnor_connection_wizard"> - <title>Guvnor Connection Wizard</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/functionality_overview/guvnor_connection_wizard.png"></imagedata> - </imageobject> - </mediaobject> - </figure> - - <para>Default values appear in the <emphasis> - <property moreinfo="none">Location</property>,</emphasis> - <emphasis> - <property moreinfo="none">Port</property>,</emphasis> and <emphasis> - <property moreinfo="none">Repository</property> - </emphasis> fields (See the <link linkend="guvnor_preferences">“Guvnor Preferences”</link> 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 <emphasis> - <property moreinfo="none">Location</property> - </emphasis> field of a typical Guvnor repository URL such as:</para> - - <para> - <emphasis> - <property moreinfo="none">http://localhost:8080/drools-guvnor/org.drools.guvnor.Guvnor/webdav</property> - </emphasis> - </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's key-ring file based on the selection of <emphasis> - <property moreinfo="none">Save user name and password</property>.</emphasis></para> - - <note> - <title>Note:</title> - <para>If the authentication information is not stored in the key-ring, then the - <property moreinfo="none">EGT</property> uses a session authentication, what means that the - credentials supplied are used only for 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 moreinfo="none">EGT</property> will prompt - for authentication information when it has to access the Guvnor repository.</para> - - <para>If authentication fails, the <property moreinfo="none">EGT</property> will retry once and then issue - an authentication failure error.</para> - - <tip> - <title>Tip:</title> - <para>If an authentication failure error occurs, you can retry the same operation and - supply different authentication information.</para> - </tip> - - <para>Note that the <property moreinfo="none">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.</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 moreinfo="none">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.</para> - </note> - </section> - - <section id="guvnor_repositories_view"> - <title>Guvnor Repositories View</title> - - <para>The <property moreinfo="none">Guvnor Repositories view</property> contains tree structures for Guvnor - repository contents.</para> - - <figure float="0"> - <title>Guvnor Repositories View</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/functionality_overview/guvnor_repository.png"></imagedata> - </imageobject> - </mediaobject> - </figure> - - <para>You can perform the following actions under the resources in the - <property moreinfo="none">Guvnor Repositories view</property>:</para> - - <itemizedlist> - <listitem> - <para>create a new Guvnor repository connection. How to do this is describe above in the <link linkend="connection_wizard">"Guvnor Connection Wizard"</link> section.</para> - </listitem> - - <listitem> - <para>remove a Guvnor repository connection. Use the Delete button - ( <inlinemediaobject> - <imageobject> - <imagedata fileref="images/functionality_overview/delete_connection_button.png"></imagedata> - </imageobject> - </inlinemediaobject> ) in the tool-bar or the <emphasis> - <property moreinfo="none">Delete</property></emphasis> option in the context menu to remove a repository connection.</para> - </listitem> - - <listitem> - <para>refresh Guvnor repository resorces. Use the <emphasis> - <property moreinfo="none">Refresh</property></emphasis> context menu item to reload a tree content for the selected node.</para> - </listitem> - - <listitem> - <para>make use of "drill-into" functionality. It's represented by a number of tool-bar/context menu items such as <emphasis><property moreinfo="none">Go Home</property></emphasis> - ( <inlinemediaobject> - <imageobject> - <imagedata fileref="images/functionality_overview/go_home_button.png"></imagedata> - </imageobject> - </inlinemediaobject> ), <emphasis><property moreinfo="none">Go Back</property></emphasis> - ( <inlinemediaobject> - <imageobject> - <imagedata fileref="images/functionality_overview/go_back_button.png"></imagedata> - </imageobject> - </inlinemediaobject> ) and <emphasis> - <property moreinfo="none">Go Into</property></emphasis> - ( <inlinemediaobject> - <imageobject> - <imagedata fileref="images/functionality_overview/go_into_button.png"></imagedata> - </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 <emphasis> - <property moreinfo="none">"defaultPackage"</property></emphasis> node changes the tree view to:</para> - - <figure float="0"> - <title>Going Into the <emphasis>"defaultPackage"</emphasis></title> - <mediaobject> - <imageobject> - <imagedata fileref="images/functionality_overview/go_into_defaultPackage.png"></imagedata> - </imageobject> - </mediaobject> - </figure> - - <para>Clicking on the Go Home button ( <inlinemediaobject> - <imageobject> - <imagedata fileref="images/functionality_overview/go_home_button.png"></imagedata> - </imageobject> - </inlinemediaobject> ) or selecting <emphasis> - <property moreinfo="none">Go Home</property></emphasis> in the context menu returns the tree to the top-level structure shown in the previous picture above. - </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 <property moreinfo="none">Properties view</property> to update with details about that file: -</para> - - <figure float="0"> - <title>Guvnor Repository Files Properties</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/functionality_overview/repository_files_properties.png"></imagedata> - </imageobject> - </mediaobject> - </figure> - - <para></para> - </section> - + <para><diffmk:wrapper diffmk:change="changed">This chapter will give an overview on all functionality the </diffmk:wrapper><property moreinfo="none">Guvnor Tools</property> provides.</para> + + <section diffmk:change="added"> + <title><diffmk:wrapper diffmk:change="changed">Creating a New Guvnor Connection</diffmk:wrapper></title> + <para><diffmk:wrapper diffmk:change="added">As mentioned in the </diffmk:wrapper><link diffmk:change="added" linkend="introduction"><diffmk:wrapper diffmk:change="added">"Introduction"</diffmk:wrapper></link><diffmk:wrapper diffmk:change="added">, the main purpose + of the </diffmk:wrapper><property moreinfo="none">EGT</property><diffmk:wrapper diffmk:change="added"> 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 </diffmk:wrapper><link linkend="connection_wizard"><diffmk:wrapper diffmk:change="changed">Guvnor Connection + wizard</diffmk:wrapper></link><diffmk:wrapper diffmk:change="added">. </diffmk:wrapper></para> + </section> + <section id="local_copies"> - <title>Local Copies of Guvnor Files</title> + <title><diffmk:wrapper diffmk:change="changed">Getting Local Copies of Guvnor Files</diffmk:wrapper></title> + <para><diffmk:wrapper diffmk:change="added">There are two methods of getting local copies of Guvnor repository + resources:</diffmk:wrapper></para> - <para>As mentioned in the <link linkend="introduction">"Introduction"</link>, the main purpose - of the <property moreinfo="none">EGT</property> is to allow development using resources held in a Guvnor - repository. There are two method of getting local copies of Guvnor repository - resources:</para> - <orderedlist continuation="restarts" inheritnum="ignore"> <listitem> - <para>Drag-and-drop from the <property moreinfo="none">Guvnor Repositories view</property></para> + <para>Drag-and-drop from the <link diffmk:change="added" linkend="guvnor_repositories_view">Guvnor Repositories view</link></para> </listitem> <listitem> - <para>Using the <link linkend="resources_from_guvnor">Import from Guvnor - wizard</link>, as described further in this document</para> + <para>Using the <link linkend="resources_from_guvnor"><diffmk:wrapper diffmk:change="changed">Resource from Guvnor + wizard</diffmk:wrapper></link>, as described further in this document</para> </listitem> </orderedlist> @@ -538,12 +286,12 @@ Eclipse Common Navigator framework, such as the Eclipse <property moreinfo="none">Resource Navigator</property> and the Java <property moreinfo="none">Package Explorer</property>. On the image above you can see the <emphasis> - <property moreinfo="none">Dummy rule.drl</property></emphasis> file with the decoration in the <property moreinfo="none">Resource Navigator</property>. The Guvnor icon decorator is on the top right of the file image, and the Guvnor + <property moreinfo="none">Dummy rule.drl</property></emphasis> file with the decoration in the <property moreinfo="none">Resource Navigator</property><diffmk:wrapper diffmk:change="changed">. 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 the <link linkend="resource_decoration_preferences">Guvnor + changed in the </diffmk:wrapper><link linkend="resource_decoration_preferences">Guvnor Preferences</link>.)</para> - <para>Here we see that, <emphasis><property moreinfo="none">Dummy role.drl</property></emphasis> is associated with a Guvnor repository + <para>Here we see that, <emphasis><property moreinfo="none"><diffmk:wrapper diffmk:change="changed">Dummy rule.drl</diffmk:wrapper></property></emphasis> 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. The file <emphasis><property moreinfo="none">Sample.drl</property>,</emphasis> however, is not associated with a Guvnor repository file. Further details about the association can be found in the standard Eclipse @@ -563,9 +311,9 @@ repository, the location within the repository, the version (date/time stamp) and the revision number.</para> </section> - + <section id="actions"> - <title>Actions for Local Guvnor Resources</title> + <title><diffmk:wrapper diffmk:change="changed">Managing Guvnor Resources</diffmk:wrapper></title> <para>The <property moreinfo="none">EGT</property> provides a number of actions (available through the <emphasis><property moreinfo="none">Guvnor</property></emphasis> context menu on files) for working with files, both those associated with @@ -711,18 +459,11 @@ <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 <emphasis> <property moreinfo="none">Commit</property> - </emphasis> action will<figure float="0"> - <title>Add to Guvnor Wizard</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/functionality_overview/add_toGuvnor_wizard.png"></imagedata> - </imageobject> - </mediaobject> - </figure> ask whether you wish to overwrite the current version in the + </emphasis><diffmk:wrapper diffmk:change="added"> 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> + Guvnor repository.</diffmk:wrapper></para> </section> <section id="show_history_action"> @@ -730,8 +471,8 @@ <para>The <emphasis> <property moreinfo="none">Show History</property> - </emphasis> action is enable for one Guvnor repository associated file and causes - the <link linkend="guvnor_history_view">Guvnor Resource History view</link> to be + </emphasis><diffmk:wrapper diffmk:change="changed"> action is enabled for one Guvnor repository associated file and causes + the </diffmk:wrapper><link linkend="guvnor_history_view">Guvnor Resource History view</link> to be populated with revision history for the selected file.</para> </section> @@ -832,70 +573,179 @@ and removes local metadata for the Guvnor repository association.</para> </section> </section> + - <section id="guvnor_history_view"> - <title>Guvnor Resource History View</title> - <para>The <property moreinfo="none">Guvnor Resource History view</property> should 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.</para> + </chapter> +<chapter diffmk:change="added" id="guvnor_preferences" xml:base="file:///home/vchukhutsina/repos/ochik_jboss/drools/docs/guvnor_ref/en-US/guvnor_preferences.xml" xreflabel="guvnor_preferences"> + <?dbhtml filename="guvnor_preferences.html"?> + <chapterinfo diffmk:change="added"> + <keywordset diffmk:change="added"> + <keyword diffmk:change="added"><diffmk:wrapper diffmk:change="added">JBoss Tools</diffmk:wrapper></keyword> + <keyword diffmk:change="added"><diffmk:wrapper diffmk:change="added">Eclipse Guvnor Tools</diffmk:wrapper></keyword> + </keywordset> + </chapterinfo> - <figure float="0"> - <title>Initial State of the Guvnor Resource History View</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/functionality_overview/resource_history_view.png"></imagedata> - </imageobject> - </mediaobject> - </figure> - - <para>The <property moreinfo="none">Guvnor Resource History view</property> is populated by <emphasis> - <property moreinfo="none">Show History</property> - </emphasis> actions in either the local <emphasis> - <property moreinfo="none">Guvnor</property></emphasis> context menu or in the context menu for - a Guvnor repository file in the <link linkend="guvnor_repositories_view">Guvnor - Repositories view</link>. Once this action is performed, the <property moreinfo="none">Guvnor - Resource History view</property> updates to show the revision history:</para> - - <figure float="0"> - <title>IGuvnor Resource History View</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/functionality_overview/resource_history_view2.png"></imagedata> - </imageobject> - </mediaobject> - </figure> - - <para>Here we see that the file <emphasis> - <property moreinfo="none">test.txt</property> - </emphasis> has three revisions. Double clicking on a revision row (or the context menu <emphasis> - <property moreinfo="none">Open (Read only)</property>)</emphasis> opens an Eclipse read-only editor - with the revision contents.</para> - - <figure float="0"> - <title>Eclipse Read-only Editor with the Revision Contents</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/functionality_overview/resource_history_view3.png"></imagedata> - </imageobject> - </mediaobject> - </figure> + <title diffmk:change="added"><diffmk:wrapper diffmk:change="added">Reference</diffmk:wrapper></title> + <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">This chapter includes detailed reference information about Views and Wizards used to manage Guvnor Tools.</diffmk:wrapper></para> + + <section diffmk:change="added" id="guvnor_perspective"> + <title><diffmk:wrapper diffmk:change="changed">Guvnor Repository Exploring Perspective</diffmk:wrapper></title> + + <para>The <property moreinfo="none"><diffmk:wrapper diffmk:change="added">Guvnor Repository Exploring perspective</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added"> contains two views + supplied by </diffmk:wrapper><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">EGT</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added"> – </diffmk:wrapper><link diffmk:change="added" linkend="guvnor_repositories_view"><diffmk:wrapper diffmk:change="added">Guvnor Repositories view</diffmk:wrapper></link><diffmk:wrapper diffmk:change="added"> and + </diffmk:wrapper><link diffmk:change="added" linkend="guvnor_history_view">Guvnor Resource History view</link><diffmk:wrapper diffmk:change="added">, that will be the center of most interactions + with Guvnor, and Eclipse standard views such as </diffmk:wrapper><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">Properties</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added"> and + </diffmk:wrapper><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">Resource Navigator</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added"> that are also useful.</diffmk:wrapper></para> + + <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">While each of these views can be opened and positioned independently within an Eclipse + workbench, the </diffmk:wrapper><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">Guvnor perspective</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added"> provides a convenient method of + getting a suggested layout. In the Eclipse workbench menu, choose </diffmk:wrapper><emphasis diffmk:change="added"> + <property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">Window &gt; Open Perspective &gt; Other</diffmk:wrapper></property> + </emphasis><diffmk:wrapper diffmk:change="added"> to get the perspective list:</diffmk:wrapper></para> + + <figure float="0"> + <title><diffmk:wrapper diffmk:change="changed">Enabling the Guvnor Repository Perspective</diffmk:wrapper></title> + <mediaobject> + <imageobject> + <imagedata fileref="images/functionality_overview/open_guvnor_perspectine.png"/> + </imageobject> + </mediaobject> + </figure> + + <para><diffmk:wrapper diffmk:change="added">And then choose </diffmk:wrapper><emphasis diffmk:change="added"> + <property moreinfo="none"><diffmk:wrapper diffmk:change="changed">Guvnor Repository Exploring</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added">.</diffmk:wrapper></emphasis><diffmk:wrapper diffmk:change="added"> This opens the + </diffmk:wrapper><property moreinfo="none"><diffmk:wrapper diffmk:change="added">Guvnor perspective</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added">.</diffmk:wrapper></para> + </section> + + <section diffmk:change="added" id="connection_wizard"> + <title diffmk:change="added"><diffmk:wrapper diffmk:change="added">Guvnor Connection Wizard</diffmk:wrapper></title> + + <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">This wizard appears in a number of places within the + </diffmk:wrapper><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">EGT</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added"> (as detailed below), but in this section we will cover only + the two most basic entry points.</diffmk:wrapper></para> + + <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">The </diffmk:wrapper><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">Guvnor Connection wizard</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added"> can be started in the following + ways:</diffmk:wrapper></para> + + <itemizedlist diffmk:change="added"> + <listitem diffmk:change="added"> + <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">using the Eclipse menu </diffmk:wrapper><emphasis> + <property moreinfo="none"><diffmk:wrapper diffmk:change="changed">File &gt; New &gt; Other &gt; Guvnor &gt; Guvnor + repository location</diffmk:wrapper></property> + </emphasis></para> + + <figure diffmk:change="added" float="0"> + <title diffmk:change="added"><diffmk:wrapper diffmk:change="added">New Guvnor Repository Location</diffmk:wrapper></title> + <mediaobject diffmk:change="added"> + <imageobject diffmk:change="added"> + <imagedata diffmk:change="added" fileref="images/functionality_overview/start_guvnor_connection1.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + </listitem> + + <listitem diffmk:change="added"> + <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">in the </diffmk:wrapper><property moreinfo="none"><diffmk:wrapper diffmk:change="changed">Guvnor Repositories view</diffmk:wrapper></property><diffmk:wrapper diffmk:change="changed"> using the drop-down menu</diffmk:wrapper></para> + + <figure float="0"> + <title><diffmk:wrapper diffmk:change="changed">Adding New Guvnor Connection</diffmk:wrapper></title> + <mediaobject> + <imageobject> + <imagedata fileref="images/functionality_overview/start_guvnor_connection2.png"/> + + </imageobject> + </mediaobject> + </figure> + </listitem> + + <listitem diffmk:change="added"> + <para><diffmk:wrapper diffmk:change="added">using the menu button + ( </diffmk:wrapper><inlinemediaobject diffmk:change="added"> + <imageobject diffmk:change="added"> + <imagedata diffmk:change="added" fileref="images/functionality_overview/guvnor_connection_button.png"></imagedata> + </imageobject> + </inlinemediaobject><diffmk:wrapper diffmk:change="added"> ) + </diffmk:wrapper></para> + </listitem> + </itemizedlist> + + <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">Choosing either of these will start the </diffmk:wrapper><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">Guvnor Connection + wizard</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added">.</diffmk:wrapper></para> + + <figure diffmk:change="added" float="0" id="guvnor_connection_wizard"> + <title diffmk:change="added"><diffmk:wrapper diffmk:change="added">Guvnor Connection Wizard</diffmk:wrapper></title> + <mediaobject diffmk:change="added"> + <imageobject diffmk:change="added"> + <imagedata diffmk:change="added" fileref="images/functionality_overview/guvnor_connection_wizard.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">Default values appear in the </diffmk:wrapper><emphasis diffmk:change="added"> + <property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">Location</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added">,</diffmk:wrapper></emphasis> + <emphasis> + <property moreinfo="none"><diffmk:wrapper diffmk:change="added">Port</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added">,</diffmk:wrapper></emphasis><diffmk:wrapper diffmk:change="added"> and </diffmk:wrapper><emphasis diffmk:change="added"> + <property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">Repository</diffmk:wrapper></property> + </emphasis><diffmk:wrapper diffmk:change="added"> fields (See the </diffmk:wrapper><link diffmk:change="added" linkend="guvnor_preferences"><diffmk:wrapper diffmk:change="added">“Guvnor Preferences”</diffmk:wrapper></link><diffmk:wrapper diffmk:change="added"> 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 </diffmk:wrapper><emphasis diffmk:change="added"> + <property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">Location</diffmk:wrapper></property> + </emphasis><diffmk:wrapper diffmk:change="added"> field of a typical Guvnor repository URL such as:</diffmk:wrapper></para> + + <para diffmk:change="added"> + <emphasis> + <property moreinfo="none"><diffmk:wrapper diffmk:change="changed">http://localhost:8080/drools-guvnor/org.drools.guvnor.Guvnor/webdav</diffmk:wrapper></property> + </emphasis> + </para> + + <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">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's key-ring file based on the selection of </diffmk:wrapper><emphasis diffmk:change="added"> + <property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">Save user name and password</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added">.</diffmk:wrapper></emphasis></para> + + <note diffmk:change="added"> + <title><diffmk:wrapper diffmk:change="changed">Note:</diffmk:wrapper></title> + <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">If the authentication information is not stored in the key-ring, then the + </diffmk:wrapper><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">EGT</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added"> uses a session authentication, what means that the + credentials supplied are used only for the lifetime of the Eclipse workbench + instance.</diffmk:wrapper></para> + </note> + + <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">If authentication information is not stored in the key-ring or the authentication + information (key-ring or session) is not valid, the </diffmk:wrapper><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">EGT</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added"> will prompt + for authentication information when it has to access the Guvnor repository.</diffmk:wrapper></para> + + <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">If authentication fails, the </diffmk:wrapper><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">EGT</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added"> will retry once and then issue + an authentication failure error.</diffmk:wrapper></para> + + <tip diffmk:change="added"> + <title diffmk:change="added"><diffmk:wrapper diffmk:change="added">Tip:</diffmk:wrapper></title> + <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">If an authentication failure error occurs, you can retry the same operation and + supply different authentication information.</diffmk:wrapper></para> + </tip> + + <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">Note that the </diffmk:wrapper><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">EGT</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added"> 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.</diffmk:wrapper></para> + <note> <title>Note:</title> - <para>You can also use the <emphasis> - <property moreinfo="none">Save As...</property> - </emphasis> option when a file is open in a read-only editor to save a local - writable copy of the contents. Doing so, however, will not associate the file - created with its Guvnor source.</para> + <para><diffmk:wrapper diffmk:change="added">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 </diffmk:wrapper><property moreinfo="none"><diffmk:wrapper diffmk:change="changed">EGT</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added">, 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.</diffmk:wrapper></para> </note> - </section> - + <section id="resources_from_guvnor"> - <title>Importing Guvnor Repository Resources</title> - - <para>In addition to the single file drag-and-drop from the <property moreinfo="none">Guvnor Repositories - view</property>, the <property moreinfo="none">EGT</property> also includes a wizard for copying one + <title><diffmk:wrapper diffmk:change="changed">Resource from Guvnor Wizard</diffmk:wrapper></title> + + <para>In addition to the single file drag-and-drop from the <property moreinfo="none"><diffmk:wrapper diffmk:change="changed">Guvnor Repositories + view</diffmk:wrapper></property>, the <property moreinfo="none">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 from the <emphasis> <property moreinfo="none">File &gt; Import &gt; Guvnor &gt; Resource from @@ -906,153 +756,298 @@ </emphasis> menu items.</para> <note> <title>Note:</title> - + <para>Note that the wizard is identical but appears in both locations to accommodate users who tend to view this functionality as being in either category.</para> </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 <link linkend="guvnor_connection_wizard">Guvnor Connection wizard</link>).</para> - - <figure float="0"> - <title>Resource from Guvnor Wizard</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/functionality_overview/add_toGuvnor_wizard.png"></imagedata> - </imageobject> - </mediaobject> - </figure> + <figure float="0"> + <title>Resource from Guvnor Wizard</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/functionality_overview/add_toGuvnor_wizard.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + <para>Once the source Guvnor repository is chosen, the wizard prompts for resource selection:</para> - - <figure float="0"> - <title>Resource Selection</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/functionality_overview/resource_from_guvnor.png"></imagedata> - </imageobject> - </mediaobject> - </figure> + <figure float="0"> + <title>Resource Selection</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/functionality_overview/resource_from_guvnor.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + <para>Finally, the target location in the local workspace should be chosen:</para> - <figure float="0"> - <title>Choosing the Target Location</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/functionality_overview/resource_from_guvnor2.png"></imagedata> - </imageobject> - </mediaobject> - </figure> + <figure float="0"> + <title>Choosing the Target Location</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/functionality_overview/resource_from_guvnor2.png"></imagedata> + </imageobject> + </mediaobject> + </figure> <para>On completion the wizard copies the selected files from the Guvnor repository to the local workspace. If a file with the same name already exists in the destination, the wizard uses the Eclipse standard "prompt for rename" dialog:</para> - - <figure float="0"> - <title>Prompt for Rename Dialog</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/functionality_overview/resource_from_guvnor3.png"></imagedata> - </imageobject> - </mediaobject> - </figure> + + <figure float="0"> + <title>Prompt for Rename Dialog</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/functionality_overview/resource_from_guvnor3.png"></imagedata> + </imageobject> + </mediaobject> + </figure> </section> -</chapter> - -<chapter id="guvnor_preferences" xml:base="file:///home/vchukhutsina/repos/ochik_jboss/drools/docs/guvnor_ref/en/modules/guvnor_preferences.xml" xreflabel="guvnor_preferences"> - <?dbhtml filename="guvnor_preferences.html"?> - <chapterinfo> - <keywordset> - <keyword>JBoss Tools</keyword> - <keyword>Eclipse Guvnor Tools</keyword> - </keywordset> - </chapterinfo> - - <title>Guvnor Preferences</title> - - <para>The <property moreinfo="none">EGT</property> provides a preference page in the <emphasis> - <property moreinfo="none">Guvnor</property> - </emphasis> category:</para> - - <figure float="0"> - <title>Resource Selection</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/guvnor_preferences/guvnor_preferences.png"></imagedata> - </imageobject> - </mediaobject> - </figure> - - <para>The preferences cover two categories:</para> - <itemizedlist> - <listitem><para>Guvnor repository connections</para></listitem> + <section diffmk:change="added" id="guvnor_repositories_view"> + <title diffmk:change="added"><diffmk:wrapper diffmk:change="added">Guvnor Repositories View</diffmk:wrapper></title> + + <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">The </diffmk:wrapper><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">Guvnor Repositories view</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added"> contains tree structures for Guvnor + repository contents.</diffmk:wrapper></para> + + <figure diffmk:change="added" float="0"> + <title diffmk:change="added"><diffmk:wrapper diffmk:change="added">Guvnor Repositories View</diffmk:wrapper></title> + <mediaobject diffmk:change="added"> + <imageobject diffmk:change="added"> + <imagedata diffmk:change="added" fileref="images/functionality_overview/guvnor_repository.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">You can perform the following actions under the resources in the + </diffmk:wrapper><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">Guvnor Repositories view</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added">:</diffmk:wrapper></para> + + <itemizedlist diffmk:change="added"> + <listitem diffmk:change="added"> + <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">create a new Guvnor repository connection. How to do this is describe above in the </diffmk:wrapper><link diffmk:change="added" linkend="connection_wizard"><diffmk:wrapper diffmk:change="added">"Guvnor Connection Wizard"</diffmk:wrapper></link><diffmk:wrapper diffmk:change="added"> section.</diffmk:wrapper></para> + </listitem> - <listitem><para>Local Guvnor - repository resource decorations.</para></listitem> - </itemizedlist> - - <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> - - <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.</para> + <listitem diffmk:change="added"> + <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">remove a Guvnor repository connection. Use the Delete button + ( </diffmk:wrapper><inlinemediaobject diffmk:change="added"> + <imageobject diffmk:change="added"> + <imagedata diffmk:change="added" fileref="images/functionality_overview/delete_connection_button.png"></imagedata> + </imageobject> + </inlinemediaobject><diffmk:wrapper diffmk:change="added"> ) in the tool-bar or the </diffmk:wrapper><emphasis diffmk:change="added"> + <property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">Delete</diffmk:wrapper></property></emphasis><diffmk:wrapper diffmk:change="added"> option in the context menu to remove a repository connection.</diffmk:wrapper></para> </listitem> - <listitem> - <para>The second is whether saving of authentication information in the Eclipse - platform key-ring should be enabled by default.</para> + + <listitem diffmk:change="added"> + <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">refresh Guvnor repository resorces. Use the </diffmk:wrapper><emphasis diffmk:change="added"> + <property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">Refresh</diffmk:wrapper></property></emphasis><diffmk:wrapper diffmk:change="added"> context menu item to reload a tree content for the selected node.</diffmk:wrapper></para> </listitem> + + <listitem diffmk:change="added"> + <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">make use of "drill-into" functionality. It's represented by a number of tool-bar/context menu items such as </diffmk:wrapper><emphasis diffmk:change="added"><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">Go Home</diffmk:wrapper></property></emphasis><diffmk:wrapper diffmk:change="added"> + ( </diffmk:wrapper><inlinemediaobject diffmk:change="added"> + <imageobject diffmk:change="added"> + <imagedata diffmk:change="added" fileref="images/functionality_overview/go_home_button.png"></imagedata> + </imageobject> + </inlinemediaobject><diffmk:wrapper diffmk:change="added"> ), </diffmk:wrapper><emphasis diffmk:change="added"><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">Go Back</diffmk:wrapper></property></emphasis><diffmk:wrapper diffmk:change="added"> + ( </diffmk:wrapper><inlinemediaobject diffmk:change="added"> + <imageobject diffmk:change="added"> + <imagedata diffmk:change="added" fileref="images/functionality_overview/go_back_button.png"></imagedata> + </imageobject> + </inlinemediaobject><diffmk:wrapper diffmk:change="added"> ) and </diffmk:wrapper><emphasis diffmk:change="added"> + <property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">Go Into</diffmk:wrapper></property></emphasis><diffmk:wrapper diffmk:change="added"> + ( </diffmk:wrapper><inlinemediaobject diffmk:change="added"> + <imageobject diffmk:change="added"> + <imagedata diffmk:change="added" fileref="images/functionality_overview/go_into_button.png"></imagedata> + </imageobject> + </inlinemediaobject><diffmk:wrapper diffmk:change="added"> ).</diffmk:wrapper></para> + </listitem> </itemizedlist> - - <para>As with the Guvnor repository URL template, actually whether to save a specific - instance of authentication information in the Eclipse platform key-ring can be - determined when actually creating the connection. That is, both of these preferences are - simply convenience values set to reasonable defaults.</para> + + <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">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 </diffmk:wrapper><emphasis diffmk:change="added"> + <property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">"defaultPackage"</diffmk:wrapper></property></emphasis><diffmk:wrapper diffmk:change="added"> node changes the tree view to:</diffmk:wrapper></para> + + <figure diffmk:change="added" float="0"> + <title diffmk:change="added"><diffmk:wrapper diffmk:change="added">Going Into the </diffmk:wrapper><emphasis diffmk:change="added"><diffmk:wrapper diffmk:change="added">"defaultPackage"</diffmk:wrapper></emphasis></title> + <mediaobject diffmk:change="added"> + <imageobject diffmk:change="added"> + <imagedata diffmk:change="added" fileref="images/functionality_overview/go_into_defaultPackage.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">Clicking on the Go Home button ( </diffmk:wrapper><inlinemediaobject diffmk:change="added"> + <imageobject diffmk:change="added"> + <imagedata diffmk:change="added" fileref="images/functionality_overview/go_home_button.png"></imagedata> + </imageobject> + </inlinemediaobject><diffmk:wrapper diffmk:change="added"> ) or selecting </diffmk:wrapper><emphasis diffmk:change="added"> + <property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">Go Home</diffmk:wrapper></property></emphasis><diffmk:wrapper diffmk:change="added"> in the context menu returns the tree to the top-level structure shown in the previous picture above. + </diffmk:wrapper></para> + + <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">There are a number of operations that can be performed on Guvnor repository files. Selecting a file in + the Guvnor repository causes the Eclipse </diffmk:wrapper><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">Properties view</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added"> to update with details about that file: + </diffmk:wrapper></para> + + <figure diffmk:change="added" float="0"> + <title diffmk:change="added"><diffmk:wrapper diffmk:change="added">Guvnor Repository Files Properties</diffmk:wrapper></title> + <mediaobject diffmk:change="added"> + <imageobject diffmk:change="added"> + <imagedata diffmk:change="added" fileref="images/functionality_overview/repository_files_properties.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para diffmk:change="added"></para> </section> + + <section diffmk:change="added" id="guvnor_history_view"> + <title diffmk:change="added"><diffmk:wrapper diffmk:change="added">Guvnor Resource History View</diffmk:wrapper></title> + + <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">The </diffmk:wrapper><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">Guvnor Resource History view</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added"> should 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.</diffmk:wrapper></para> + + <figure diffmk:change="added" float="0"> + <title diffmk:change="added"><diffmk:wrapper diffmk:change="added">Initial State of the Guvnor Resource History View</diffmk:wrapper></title> + <mediaobject diffmk:change="added"> + <imageobject diffmk:change="added"> + <imagedata diffmk:change="added" fileref="images/functionality_overview/resource_history_view.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">The </diffmk:wrapper><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">Guvnor Resource History view</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added"> is populated by </diffmk:wrapper><emphasis diffmk:change="added"> + <property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">Show History</diffmk:wrapper></property> + </emphasis><diffmk:wrapper diffmk:change="added"> actions in either the local </diffmk:wrapper><emphasis diffmk:change="added"> + <property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">Guvnor</diffmk:wrapper></property></emphasis><diffmk:wrapper diffmk:change="added"> context menu or in the context menu for + a Guvnor repository file in the </diffmk:wrapper><link diffmk:change="added" linkend="guvnor_repositories_view"><diffmk:wrapper diffmk:change="added">Guvnor + Repositories view</diffmk:wrapper></link><diffmk:wrapper diffmk:change="added">. Once this action is performed, the </diffmk:wrapper><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">Guvnor + Resource History view</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added"> updates to show the revision history:</diffmk:wrapper></para> + + <figure diffmk:change="added" float="0"> + <title diffmk:change="added"><diffmk:wrapper diffmk:change="added">Guvnor Resource History View</diffmk:wrapper></title> + <mediaobject diffmk:change="added"> + <imageobject diffmk:change="added"> + <imagedata diffmk:change="added" fileref="images/functionality_overview/resource_history_view2.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">Here we see that the file </diffmk:wrapper><emphasis diffmk:change="added"> + <property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">test.txt</diffmk:wrapper></property> + </emphasis><diffmk:wrapper diffmk:change="added"> has seven revisions. Double clicking on a revision row (or the context menu </diffmk:wrapper><emphasis diffmk:change="added"> + <property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">Open (Read only)</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added">)</diffmk:wrapper></emphasis><diffmk:wrapper diffmk:change="added"> opens an Eclipse read-only editor + with the revision contents.</diffmk:wrapper></para> + + <figure diffmk:change="added" float="0"> + <title diffmk:change="added"><diffmk:wrapper diffmk:change="added">Eclipse Read-only Editor with the Revision Contents</diffmk:wrapper></title> + <mediaobject diffmk:change="added"> + <imageobject diffmk:change="added"> + <imagedata diffmk:change="added" fileref="images/functionality_overview/resource_history_view3.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + <note diffmk:change="added"> + <title diffmk:change="added"><diffmk:wrapper diffmk:change="added">Note:</diffmk:wrapper></title> + <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">You can also use the </diffmk:wrapper><emphasis diffmk:change="added"> + <property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">Save As...</diffmk:wrapper></property> + </emphasis><diffmk:wrapper diffmk:change="added"> option when a file is open in a read-only editor to save a local + writable copy of the contents. Doing so, however, will not associate the file + created with its Guvnor source.</diffmk:wrapper></para> + </note> + + </section> + + <section diffmk:change="added" id="preferences"> + <title>Guvnor Preferences</title> + + + <para>The <property moreinfo="none">EGT</property> provides a preference page in the <emphasis> + <property moreinfo="none">Guvnor</property> + </emphasis> category:</para> + + <figure float="0"> + <title>Resource Selection</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/guvnor_preferences/guvnor_preferences.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>The preferences cover two categories:</para> + <itemizedlist diffmk:change="added"> + <listitem><para>Guvnor repository connections</para></listitem> + + <listitem><para><diffmk:wrapper diffmk:change="changed">Local Guvnor + repository resource decorations.</diffmk:wrapper></para></listitem> + </itemizedlist> + + <section id="repo_connection_preferences"> + <title>Guvnor Repository Connection Preferences</title> + <para><diffmk:wrapper diffmk:change="changed">There are two preferences that can be set for Guvnor repository connections, that are + used when creating new connections:</diffmk:wrapper></para> + + <itemizedlist> + <listitem diffmk:change="added"> + <para><diffmk:wrapper diffmk:change="changed">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.</diffmk:wrapper></para> + </listitem> + <listitem diffmk:change="added"> + <para><diffmk:wrapper diffmk:change="changed">The second is whether saving of authentication information in the Eclipse + platform key-ring should be enabled by default.</diffmk:wrapper></para> + </listitem> + </itemizedlist> + + <para><diffmk:wrapper diffmk:change="changed">As with the Guvnor repository URL template, actually whether to save a specific + instance of authentication information in the Eclipse platform key-ring can be + determined when actually creating the connection. That is, both of these preferences are + simply convenience values set to reasonable defaults.</diffmk:wrapper></para> + </section> + + <section id="resource_decoration_preferences"> + <title>Local Guvnor Repository Resource Decoration Preferences</title> + + <para>The second category of preferences provided by the <property moreinfo="none">EGT</property><diffmk:wrapper diffmk:change="changed"> 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 </diffmk:wrapper><property moreinfo="none">EGT</property><diffmk:wrapper diffmk:change="changed"> decorate + its local resources to avoid messy conflicts with SCM packages.</diffmk:wrapper></para> + + <para>In the <emphasis> + <property moreinfo="none">File Decoration</property></emphasis><diffmk:wrapper diffmk:change="changed"> + 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 </diffmk:wrapper><emphasis> + <property moreinfo="none">Text</property></emphasis><diffmk:wrapper diffmk:change="changed"> section, you can format the Guvnor metadata that is appended to the file + names:</diffmk:wrapper></para> + <itemizedlist diffmk:change="added"> + <listitem diffmk:change="added"> + <para><diffmk:wrapper diffmk:change="changed">Whether to show an indicator (&gt;) when the local file has changes not committed back to the + Guvnor repository</diffmk:wrapper></para> + </listitem> + <listitem diffmk:change="added"> + <para>Whether to show the revision number</para> + </listitem> + <listitem diffmk:change="added"> + <para>Whether to show the date/time stamp</para> + </listitem> + </itemizedlist> + + <para>Any changes to these preferences take effect immediately upon clicking the <emphasis> + <property moreinfo="none">Apply</property></emphasis> and then <emphasis> + <property moreinfo="none">Ok</property></emphasis> buttons.</para> + </section> + </section> - <section id="resource_decoration_preferences"> - <title>Local Guvnor Repository Resource Decoration Preferences</title> - <para>The second category of preferences provided by the <property moreinfo="none">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 moreinfo="none">EGT</property> decorate - its local resources to avoid messy conflicts with SCM packages.</para> - - <para>In the <emphasis> - <property moreinfo="none">File Decoration</property></emphasis> - 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 <emphasis> - <property moreinfo="none">Text</property></emphasis> section, you can format the Guvnor metadata that is appended to the file - names:</para> - <itemizedlist> - <listitem> - <para>Whether to show an indicator (&gt;) when the local file has changes not committed back to the - Guvnor repository</para> - </listitem> - <listitem> - <para>Whether to show the revision number</para> - </listitem> - <listitem> - <para>Whether to show the date/time stamp</para> - </listitem> - </itemizedlist> - - <para>Any changes to these preferences take effect immediately upon clicking the <emphasis> - <property moreinfo="none">Apply</property></emphasis> and then <emphasis> - <property moreinfo="none">Ok</property></emphasis> buttons.</para> - </section> -</chapter> - - -<chapter id="conclusion" xml:base="file:///home/vchukhutsina/repos/ochik_jboss/drools/docs/guvnor_ref/en/modules/conclusion.xml" xreflabel="conclusion"> + </chapter> +<chapter id="conclusion" xml:base="file:///home/vchukhutsina/repos/ochik_jboss/drools/docs/guvnor_ref/en-US/conclusion.xml" xreflabel="conclusion"> <?dbhtml filename="conclusion.html"?> <chapterinfo> <keywordset> @@ -1061,7 +1056,7 @@ </keywordset> </chapterinfo> - <title>Conclusion</title> + <title><diffmk:wrapper diffmk:change="changed">Summary</diffmk:wrapper></title> <para>As stated at the beginning of this document, the key goal of the <property moreinfo="none">EGT</property> is to provide a way of interacting with Guvnor repository resources in a local Eclipse @@ -1069,9 +1064,40 @@ aspects of the current tooling that require revision going forward, we feel that the current state of the <property moreinfo="none">EGT</property> is sufficient for the major use cases.</para> - <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>.</para> + <section diffmk:change="added"> + <title diffmk:change="added"><diffmk:wrapper diffmk:change="added">Other relevant resources on the topic</diffmk:wrapper></title> + <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">For more information visit the following resources:</diffmk:wrapper></para> + <itemizedlist diffmk:change="added"> + <listitem diffmk:change="added"> + <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">Guvnor </diffmk:wrapper><ulink diffmk:change="added" url="http://www.jboss.org/community/wiki/Guvnor"><diffmk:... diffmk:change="added">wiki page</diffmk:wrapper></ulink></para> + </listitem> + + <listitem diffmk:change="added"> + <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">Drools on </diffmk:wrapper><ulink diffmk:change="added" url="http://www.jboss.org/drools/"><diffmk:wrapper diffmk:change="added">JBoss.org</diffmk:wrapper></ulink></para> + </listitem> + + <listitem diffmk:change="added"> + <para diffmk:change="added"> + <ulink diffmk:change="added" url="http://www.jboss.org/tools/"><diffmk:wrapper diffmk:change="added">JBoss Tools Home Page</diffmk:wrapper></ulink> + </para> + </listitem> + + <listitem diffmk:change="added"> + <para> + <ulink diffmk:change="added" url="http://download.jboss.org/jbosstools/nightly-docs/"><... diffmk:change="added">The latest + JBossTools/JBDS documentation builds</diffmk:wrapper></ulink> + </para> + </listitem> + + <listitem diffmk:change="added"> + <para diffmk:change="added"> + <ulink diffmk:change="added" url="http://docs.jboss.org/tools/"><diffmk:wrapper diffmk:change="added">JBossTools/JBDS + release documentation</diffmk:wrapper></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&... + >Jboss Tools Forum</ulink>.</para> </section> </chapter> - - + </book>