Author: abogachuk Date: 2010-05-04 10:52:27 -0400 (Tue, 04 May 2010) New Revision: 21891 Modified: trunk/drools/docs/guvnor_ref/en-US/conclusion.xml trunk/drools/docs/guvnor_ref/en-US/functionality_overview.xml trunk/drools/docs/guvnor_ref/en-US/guvnor_preferences.xml trunk/drools/docs/guvnor_ref/en-US/introduction.xml trunk/drools/docs/guvnor_ref/en-US/master.xml Log: https://jira.jboss.org/jira/browse/TOOLSDOC-6 Show java-doc is shown for EL content assist item. Screenshot has been made. TOOLSDOC-63 Eclipse Guvnor Tools Reference Guide restructureing and update. The Guide has been restructured. Modified: trunk/drools/docs/guvnor_ref/en-US/conclusion.xml =================================================================== --- trunk/drools/docs/guvnor_ref/en-US/conclusion.xml 2010-05-04 14:52:04 UTC (rev 21890) +++ trunk/drools/docs/guvnor_ref/en-US/conclusion.xml 2010-05-04 14:52:27 UTC (rev 21891) @@ -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> + + <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: trunk/drools/docs/guvnor_ref/en-US/functionality_overview.xml =================================================================== --- trunk/drools/docs/guvnor_ref/en-US/functionality_overview.xml 2010-05-04 14:52:04 UTC (rev 21890) +++ trunk/drools/docs/guvnor_ref/en-US/functionality_overview.xml 2010-05-04 14:52:27 UTC (rev 21891) @@ -8,265 +8,22 @@ </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 > <!-- id="new_connection" --> + <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 methods 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> @@ -329,8 +86,76 @@ the revision number.</para> </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> + <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 @@ -598,130 +423,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 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="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: trunk/drools/docs/guvnor_ref/en-US/guvnor_preferences.xml =================================================================== --- trunk/drools/docs/guvnor_ref/en-US/guvnor_preferences.xml 2010-05-04 14:52:04 UTC (rev 21890) +++ trunk/drools/docs/guvnor_ref/en-US/guvnor_preferences.xml 2010-05-04 14:52:27 UTC (rev 21891) @@ -8,83 +8,390 @@ </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> – <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>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> - - <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> + <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>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 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: trunk/drools/docs/guvnor_ref/en-US/introduction.xml =================================================================== --- trunk/drools/docs/guvnor_ref/en-US/introduction.xml 2010-05-04 14:52:04 UTC (rev 21890) +++ trunk/drools/docs/guvnor_ref/en-US/introduction.xml 2010-05-04 14:52:27 UTC (rev 21891) @@ -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> @@ -114,9 +106,20 @@ </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> 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> + </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 Guvnor Tools, you should have the following:</para> @@ -162,37 +165,4 @@ Eclipse synchronisation tool.</para> </section> - <section> - <title>Other relevant resources on the topic</title> - - <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> - - </section> </chapter> Modified: trunk/drools/docs/guvnor_ref/en-US/master.xml =================================================================== --- trunk/drools/docs/guvnor_ref/en-US/master.xml 2010-05-04 14:52:04 UTC (rev 21890) +++ trunk/drools/docs/guvnor_ref/en-US/master.xml 2010-05-04 14:52:27 UTC (rev 21891) @@ -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>