[jbosstools-commits] JBoss Tools SVN: r21842 - in trunk/workingset/docs/reference/en-US: images and 2 other directories.

Author: abogachuk Date: 2010-04-30 13:33:55 -0400 (Fri, 30 Apr 2010) New Revision: 21842 Added: trunk/workingset/docs/reference/en-US/images/new_pattern/ trunk/workingset/docs/reference/en-US/images/new_pattern/add_new_pattern_dialog.png trunk/workingset/docs/reference/en-US/images/new_pattern/empty_preferences_page.png trunk/workingset/docs/reference/en-US/images/new_pattern/preference_page_with_added_pattern.png trunk/workingset/docs/reference/en-US/images/preferences_page/ trunk/workingset/docs/reference/en-US/images/preferences_page/preferences_page.png trunk/workingset/docs/reference/en-US/references.xml trunk/workingset/docs/reference/en-US/tasks.xml Modified: trunk/workingset/docs/reference/en-US/intro.xml trunk/workingset/docs/reference/en-US/master.xml Log: https://jira.jboss.org/jira/browse/TOOLSDOC-36 Update Workingset guide with draft version Added: trunk/workingset/docs/reference/en-US/images/new_pattern/add_new_pattern_dialog.png =================================================================== (Binary files differ) Property changes on: trunk/workingset/docs/reference/en-US/images/new_pattern/add_new_pattern_dialog.png ___________________________________________________________________ Name: svn:executable + * Name: svn:mime-type + application/octet-stream Added: trunk/workingset/docs/reference/en-US/images/new_pattern/empty_preferences_page.png =================================================================== (Binary files differ) Property changes on: trunk/workingset/docs/reference/en-US/images/new_pattern/empty_preferences_page.png ___________________________________________________________________ Name: svn:executable + * Name: svn:mime-type + application/octet-stream Added: trunk/workingset/docs/reference/en-US/images/new_pattern/preference_page_with_added_pattern.png =================================================================== (Binary files differ) Property changes on: trunk/workingset/docs/reference/en-US/images/new_pattern/preference_page_with_added_pattern.png ___________________________________________________________________ Name: svn:executable + * Name: svn:mime-type + application/octet-stream Added: trunk/workingset/docs/reference/en-US/images/preferences_page/preferences_page.png =================================================================== (Binary files differ) Property changes on: trunk/workingset/docs/reference/en-US/images/preferences_page/preferences_page.png ___________________________________________________________________ Name: svn:executable + * Name: svn:mime-type + application/octet-stream Modified: trunk/workingset/docs/reference/en-US/intro.xml =================================================================== --- trunk/workingset/docs/reference/en-US/intro.xml 2010-04-30 17:21:45 UTC (rev 21841) +++ trunk/workingset/docs/reference/en-US/intro.xml 2010-04-30 17:33:55 UTC (rev 21842) @@ -11,18 +11,21 @@ <title>Introduction</title> - <section> + <section id="whatisworkingset"> <title>What is Workingset?</title> <para>This introduction will help you to understand what is <property>Workingset Tools</property>.</para> </section> - <section><title>Key Features of Workingset Tools</title> + <section id="keyfeatures"> + <title>Key Features of Workingset Tools</title> + <para>The JBoss Workingset Tools make grouping though using regular expressions. </para> -</section> + </section> -<section> + <section id="resources"> <title>Other relevant resources on the topic</title> + <para>You can read about standard workingset in Eclipse on <ulink url="http://help.eclipse.org/help32/index.jsp?topic=/org.eclipse.pla... sets page in Workbench User Guide</ulink> </para> </section> </chapter> Modified: trunk/workingset/docs/reference/en-US/master.xml =================================================================== --- trunk/workingset/docs/reference/en-US/master.xml 2010-04-30 17:21:45 UTC (rev 21841) +++ trunk/workingset/docs/reference/en-US/master.xml 2010-04-30 17:33:55 UTC (rev 21842) @@ -3,7 +3,10 @@ "http://www.docbook.org/xml/4.3/docbookx.dtd" [<!ENTITY intro SYSTEM "intro.xml"> +<!ENTITY references SYSTEM "references.xml"> +<!ENTITY tasks SYSTEM "tasks.xml"> + <!ENTITY seamlink "../../seam/html_single/index.html"> <!ENTITY aslink "../../as/html_single/index.html"> <!ENTITY esblink "../../esb_ref_guide/html_single/index.html"> @@ -57,5 +60,7 @@ <toc/> &intro; + &tasks; + &references; </book> Added: trunk/workingset/docs/reference/en-US/references.xml =================================================================== --- trunk/workingset/docs/reference/en-US/references.xml (rev 0) +++ trunk/workingset/docs/reference/en-US/references.xml 2010-04-30 17:33:55 UTC (rev 21842) @@ -0,0 +1,129 @@ +<?xml version="1.0" encoding="UTF-8"?> +<chapter id="referencies"> + <title>References</title> + <section id="autoworkingsetspreferenciespage"> + <title>Automatics WorkingSets Preferences Page + </title> + <para>To configure <property>JBoss Workingset Tools</property> you can use <property>Automatics WorkingSets</property> preferences page. + The <property>Automatics WorkingSets Preferences Page</property> is available in <emphasis><property>Windows->Preferences</property></emphasis> menu. + </para> + <figure> + <title>Automatics WorkingSets Preferences Page</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/preferences_page/preferences_page.png"/> + </imageobject> + + </mediaobject> + </figure> + <para>On this page you are able to add, remove and change pattern order grouping patterns and turn on/off automatic grouping by selecting <emphasis><property>Automatic grouping of projects</property></emphasis> check box. </para> + + + </section> + <section id="patternsstructure"> + <title>Structure of the Grouping Pattern </title> + <para>Pattern consists of three part: &lt;searchpattern&gt;, &lt;replacepattern&gt;, &lt;exclusive&gt;. </para> + <para>They are described in following table.</para> + <table> + <title>Pattern structure</title> + <tgroup cols="3"> + <colspec colnum="1" align="left" colwidth="2*"/> + <colspec colnum="2" colwidth="4*"/> + <colspec colnum="3" align="left" colwidth="2*"/> + <thead> + <row> + <entry>Pattern component part + </entry> + + <entry>What part does + </entry> + <entry>Default value + </entry> + </row> + </thead> + <tbody> + <row> + <entry>&lt;searchpattern&gt;</entry> + <entry>searchpattern is a regular expression which are used to find project names. For example, the default value finds all projects started with org.jboss.tools and captures the text between the last two dots and uses it as capture group names. + </entry> + <entry>org\.jboss\.tools\.([^\.]+).* + </entry> + </row> + <row> + <entry>&lt;replacepattern&gt;</entry> + <entry>This expression sets name, which will be used for group. The $1 value saves names captured by searchpattern. + + </entry> + <entry>&amp;1 + </entry> + </row> + <row> + <entry>&lt;exclusive&gt;</entry> + <entry>This expression define how many names should be found. Set “true” if you want to get only one name and set “false” if you want to capture more the one. + + </entry> + <entry>true + </entry> + </row> + </tbody> + </tgroup> + </table> + + </section> + <section id="workprocess"> + <title>Principle of work</title> + <para>Let's look at work process on the default value (“org\.jboss\.tools\.([^\.]+).*,$1,true”) example. + </para> + <para>Workingset Tools will look through all project and add to a workingset each project which name starts with “org.jboss.tools.&lt;captured name&gt;.&lt;the rest of name&gt;”. For org.jboss.tools.vpe.util project, the vpe workingset will be created or if it's already existed this project will be added to it.</para> + </section> + <section id="examples"> + <title>Pattern examples</title> + + <para>There are some patterns example in the following table. </para> + <table> + <title>Pattern examples</title> + <tgroup cols="2"> + <colspec colnum="1" align="left" colwidth="5*"/> + <colspec colnum="2" align="right" colwidth="1*"/> + <thead> + <row> + <entry>Pattern </entry> + + <entry>Possible case of usage </entry> + </row> + </thead> + <tbody> + <row> + <entry>org\.([^\.]+).*,$1,false </entry> + <entry>May be used to create major group such as eclipse, jboss, hibernate, etc. </entry> + </row> + <row> + <entry>org\.hibernate\.eclipse\.([^\.]+).*,hibernate,true </entry> + <entry>May be used to group hibernate tools projects </entry> + </row> + <row> + <entry>org\.jboss\.ide\.eclipse\.([^\.]+).*,$1,true </entry> + <entry>May be used to put as and archives in their own group </entry> + </row> + <row> + <entry>org\.jbpm\.gd\.([^\.]+).*,jbpm,true </entry> + <entry>May be used to group JPBM projects </entry> + </row> + <row> + <entry>org\.jboss\.tools\.([^\.]+).*,$1-jbt,true </entry> + <entry>May be used to split out group for jboss tools </entry> + </row> + <row> + <entry>org\.eclipse\.([^\.]+).*,$1-eclipse,true</entry> + <entry>May be used to split out group for eclipse</entry> + </row> + + + </tbody> + </tgroup> + </table> + </section> + + + +</chapter> \ No newline at end of file Property changes on: trunk/workingset/docs/reference/en-US/references.xml ___________________________________________________________________ Name: svn:executable + * Added: trunk/workingset/docs/reference/en-US/tasks.xml =================================================================== --- trunk/workingset/docs/reference/en-US/tasks.xml (rev 0) +++ trunk/workingset/docs/reference/en-US/tasks.xml 2010-04-30 17:33:55 UTC (rev 21842) @@ -0,0 +1,43 @@ +<?xml version="1.0" encoding="UTF-8"?> +<chapter id="tasks"> + <title>Tasks</title> + <section> + <title>Create a new pattern to group projects. </title> + <para>To create a new grouping pattern you neen to open Windows->Preferences->Automatics WorkingSets page. + </para> + <figure> + <title>Automatics WorkingSets preferences page </title> + <mediaobject> + <imageobject> + <imagedata fileref="images/new_pattern/empty_preferences_page.png"/> + </imageobject> + + </mediaobject> + </figure> + <para>Then you should click New button. You will get a Add new pattern dialog. </para> + <figure> + <title>Add new pattern dialog</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/new_pattern/add_new_pattern_dialog.png"/> + </imageobject> + + </mediaobject> + </figure> + <para>As you see it's dialog contains a Pattern field. Here you can insert your pattern. We leave a default value. After entering pattern click OK. The pattern will be add to the Grouping patterns list. + </para> + <figure> + <title>Add new pattern dialog</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/new_pattern/preference_page_with_added_pattern.png"/> + </imageobject> + + </mediaobject> + </figure> + <para>Finally you need to select Automatic grouping of projects checkbox to start project proccesing.</para> + + + </section> + +</chapter> \ No newline at end of file Property changes on: trunk/workingset/docs/reference/en-US/tasks.xml ___________________________________________________________________ Name: svn:executable + *