[jbosstools-commits] JBoss Tools SVN: r22647 - in tags/jbosstools-3.1.1.GA/drools/docs/reference/en-US: images/create_new_project and 1 other directories.

Author: irooskov(a)redhat.com Date: 2010-06-08 19:30:47 -0400 (Tue, 08 Jun 2010) New Revision: 22647 Modified: tags/jbosstools-3.1.1.GA/drools/docs/reference/en-US/create_new_project.xml tags/jbosstools-3.1.1.GA/drools/docs/reference/en-US/debugging_rules.xml tags/jbosstools-3.1.1.GA/drools/docs/reference/en-US/editors.xml tags/jbosstools-3.1.1.GA/drools/docs/reference/en-US/images/create_new_project/create_new_project8.png tags/jbosstools-3.1.1.GA/drools/docs/reference/en-US/images/debugging_rules/debugging_rules1.png tags/jbosstools-3.1.1.GA/drools/docs/reference/en-US/master_output.xml Log: updated for 3.0.1 Modified: tags/jbosstools-3.1.1.GA/drools/docs/reference/en-US/create_new_project.xml =================================================================== --- tags/jbosstools-3.1.1.GA/drools/docs/reference/en-US/create_new_project.xml 2010-06-08 23:27:46 UTC (rev 22646) +++ tags/jbosstools-3.1.1.GA/drools/docs/reference/en-US/create_new_project.xml 2010-06-08 23:30:47 UTC (rev 22647) @@ -1,216 +1,216 @@ -<?xml version="1.0" encoding="UTF-8"?> -<chapter id="create_new_project" xreflabel="create_new_project"> - <chapterinfo> - <keywordset> - <keyword>JBoss Tools</keyword> - <keyword>Drools Tools</keyword> - </keywordset> - </chapterinfo> - - <title>Creating a New Drools Project</title> - - <para>In this chapter we are going to show you how to setup an executable sample Drools project - to start using rules immediately.</para> - - - - <section id="sample_drools_project"> - <title>Creating a Sample Drools Project</title> - - <para>First, we suggest that you use <property>Drools perspective</property> which is aimed - at work with Drools specific resources.</para> - - <para>To create a new Drools project follow to <emphasis> - <property>File > New > Drools Project</property>. </emphasis> This will open - <property>New Drools Project wizard</property> like on the figure below.</para> - - <para>On the first page type the project name and click - <emphasis><property>Next</property>.</emphasis></para> - - <figure> - <title>Creating a New Drools Project</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/create_new_project/create_new_project1.png"/> - </imageobject> - </mediaobject> - </figure> - - <para>Next you have a choice to add some default artifacts to it like sample rules, decision - tables or ruleflows and Java classes for them. Let&apos;s select first two check - boxes and press <emphasis> - <property>Next</property>. </emphasis></para> - - <figure> - <title>Selecting Drools Project Elements</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/create_new_project/create_new_project2.png"/> - </imageobject> - </mediaobject> - </figure> - - <para>Next page asks you to specify a Drools runtime. If you have not yet set it up, you - should do this now by clicking the <emphasis> - <property>Configure Workspace Settings</property> - </emphasis> link.</para> - - <figure> - <title>Configuring Drools Runtime</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/create_new_project/create_new_project3.png"/> - </imageobject> - </mediaobject> - </figure> - - <para>You should see the <property>Preferences window</property> where you can configure the - workspace settings for Drools runtimes. To create a new runtime, press the <emphasis> - <property>Add</property> - </emphasis> button. The appeared dialog prompts you to enter a - name for a new runtime and a path to the Drools runtime on your file system.</para> - - <note> - <title>Note:</title> - <para>A Drools runtime is a collection of jars on your file system that represent one - specific release of the Drools project jars. While creating a new runtime, you must - either point to the release of your choice, or you can simply create a new runtime - on your file system from the jars included in the Drools Eclipse plugin.</para> - </note> - - <figure> - <title>Adding a New Drools Runtime</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/create_new_project/create_new_project4.png"/> - </imageobject> - </mediaobject> - </figure> - - <para>Let&apos;s simply create a new Drools 5 runtime from the jars embedded in the - Drools Eclipse plugin. Thus, you should press <emphasis> - <property>Create a new Drools 5 runtime</property> - </emphasis> button and select the folder where you want this runtime to be created and - hit <emphasis> - <property>OK</property>.</emphasis></para> - - <para>You will see the newly created runtime show up in your list of Drools runtimes. Check - it and press <emphasis> - <property>OK</property>.</emphasis></para> - - <figure> - <title>Selecting a Drools Runtime</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/create_new_project/create_new_project5.png"/> - </imageobject> - </mediaobject> - </figure> - - <para>Now press <emphasis> - <property>Finish</property> - </emphasis> to complete the project creation.</para> - - <figure> - <title>Completing the Drools Project Creation</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/create_new_project/create_new_project6.png"/> - </imageobject> - </mediaobject> - </figure> - - <para>This will setup a basic structure, classpath and sample rules and test case to get you - started.</para> - </section> - - - <section id="structure_overview"> - <title>Drools Project Structure Overview</title> - - <para>Now let&apos;s look at the structure of the organized project. In the - <property>Package Explorer</property> you should see the following:</para> - - <figure> - <title>Drools Project in the Package Explorer</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/create_new_project/create_new_project7.png"/> - </imageobject> - </mediaobject> - </figure> - - <para>The newly created project contains an example rule file <emphasis> - <property>Sample.drl</property> - </emphasis> in the <emphasis> - <property>src/main/rules</property> - </emphasis> directory and an example java file <emphasis> - <property>DroolsTest.java</property> - </emphasis> that can be used to execute the rules in a Drools engine in the folder <emphasis> - <property>src/main/java</property> - </emphasis>, in the <emphasis> - <property>com.sample</property> - </emphasis> package. All the others jar&apos;s that are necessary during execution - are also added to the classpath in a custom classpath container called <property>Drools - Library</property>.</para> - - <tip> - <title>Tip:</title> - <para>Rules do not have to be kept in Java projects at all, this is just a convenience - for people who are already using eclipse as their Java IDE.</para> - </tip> - - </section> - - <section id="creating_rule"> - <title>Creating a New Rule</title> - - <para>Now we are going to add a new Rule resource to the project.</para> - - <para>You can either create an empty text <emphasis> - <property>.drl</property> - </emphasis> file or make use of the special <property>New Rule Resource - wizard</property> to do it.</para> - - <para>To open the wizard follow to <emphasis> - <property>File > New > Rule Resource</property> - </emphasis> or use the menu with the JBoss Drools icon on the toolbar.</para> - - <figure> - <title>Opening the New Rule Resource Wizard</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/create_new_project/create_new_project8.png"/> - </imageobject> - </mediaobject> - </figure> - - <para>On the wizard page first select <emphasis> - <property>/rules</property> - </emphasis> as a top level directory to store your rules and type the rule name. Next - it&apos;s mandatory to specify the rule package name. It defines a namespace that - groups rules together.</para> - - <figure> - <title>New Rule Resource Wizard</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/create_new_project/create_new_project9.png"/> - </imageobject> - </mediaobject> - </figure> - - <para>As a result the wizard generates a rule skeleton to get you started.</para> - - <figure> - <title>New Rule</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/create_new_project/create_new_project10.png"/> - </imageobject> - </mediaobject> - </figure> - - </section> - -</chapter> +<?xml version="1.0" encoding="UTF-8"?> +<chapter id="create_new_project" xreflabel="create_new_project"> + <chapterinfo> + <keywordset> + <keyword>JBoss Tools</keyword> + <keyword>Drools Tools</keyword> + </keywordset> + </chapterinfo> + + <title>Creating a New Drools Project</title> + + <para>In this chapter we are going to show you how to setup an executable sample Drools project + to start using rules immediately.</para> + + + + <section id="sample_drools_project"> + <title>Creating a Sample Drools Project</title> + + <para>First, we suggest that you use <property>Drools perspective</property> which is aimed + at work with Drools specific resources.</para> + + <para>To create a new Drools project follow to <emphasis> + <property>File > New > Drools Project</property>. </emphasis> This will open + <property>New Drools Project wizard</property> like on the figure below.</para> + + <para>On the first page type the project name and click + <emphasis><property>Next</property>.</emphasis></para> + + <figure> + <title>Creating a New Drools Project</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/create_new_project/create_new_project1.png"/> + </imageobject> + </mediaobject> + </figure> + + <para>Next you have a choice to add some default artifacts to it like sample rules, decision + tables or ruleflows and Java classes for them. Let&apos;s select first two check + boxes and press <emphasis> + <property>Next</property>. </emphasis></para> + + <figure> + <title>Selecting Drools Project Elements</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/create_new_project/create_new_project2.png"/> + </imageobject> + </mediaobject> + </figure> + + <para>Next page asks you to specify a Drools runtime. If you have not yet set it up, you + should do this now by clicking the <emphasis> + <property>Configure Workspace Settings</property> + </emphasis> link.</para> + + <figure> + <title>Configuring Drools Runtime</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/create_new_project/create_new_project3.png"/> + </imageobject> + </mediaobject> + </figure> + + <para>You should see the <property>Preferences window</property> where you can configure the + workspace settings for Drools runtimes. To create a new runtime, press the <emphasis> + <property>Add</property> + </emphasis> button. The appeared dialog prompts you to enter a + name for a new runtime and a path to the Drools runtime on your file system.</para> + + <note> + <title>Note:</title> + <para>A Drools runtime is a collection of jars on your file system that represent one + specific release of the Drools project jars. While creating a new runtime, you must + either point to the release of your choice, or you can simply create a new runtime + on your file system from the jars included in the Drools Eclipse plugin.</para> + </note> + + <figure> + <title>Adding a New Drools Runtime</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/create_new_project/create_new_project4.png"/> + </imageobject> + </mediaobject> + </figure> + + <para>Let&apos;s simply create a new Drools 5 runtime from the jars embedded in the + Drools Eclipse plugin. Thus, you should press <emphasis> + <property>Create a new Drools 5 runtime</property> + </emphasis> button and select the folder where you want this runtime to be created and + hit <emphasis> + <property>OK</property>.</emphasis></para> + + <para>You will see the newly created runtime show up in your list of Drools runtimes. Check + it and press <emphasis> + <property>OK</property>.</emphasis></para> + + <figure> + <title>Selecting a Drools Runtime</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/create_new_project/create_new_project5.png"/> + </imageobject> + </mediaobject> + </figure> + + <para>Now press <emphasis> + <property>Finish</property> + </emphasis> to complete the project creation.</para> + + <figure> + <title>Completing the Drools Project Creation</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/create_new_project/create_new_project6.png"/> + </imageobject> + </mediaobject> + </figure> + + <para>This will setup a basic structure, classpath and sample rules and test case to get you + started.</para> + </section> + + + <section id="structure_overview"> + <title>Drools Project Structure Overview</title> + + <para>Now let&apos;s look at the structure of the organized project. In the + <property>Package Explorer</property> you should see the following:</para> + + <figure> + <title>Drools Project in the Package Explorer</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/create_new_project/create_new_project7.png"/> + </imageobject> + </mediaobject> + </figure> + + <para>The newly created project contains an example rule file <emphasis> + <property>Sample.drl</property> + </emphasis> in the <emphasis> + <property>src/main/rules</property> + </emphasis> directory and an example java file <emphasis> + <property>DroolsTest.java</property> + </emphasis> that can be used to execute the rules in a Drools engine in the folder <emphasis> + <property>src/main/java</property> + </emphasis>, in the <emphasis> + <property>com.sample</property> + </emphasis> package. All the others jar&apos;s that are necessary during execution + are also added to the classpath in a custom classpath container called <property>Drools + Library</property>.</para> + + <tip> + <title>Tip:</title> + <para>Rules do not have to be kept in Java projects at all, this is just a convenience + for people who are already using eclipse as their Java IDE.</para> + </tip> + + </section> + + <section id="creating_rule"> + <title>Creating a New Rule</title> + + <para>Now we are going to add a new Rule package to the project.</para> + + <para>You can either create an empty text <emphasis> + <property>.drl</property> + </emphasis> file or make use of the special <property>New Rule Package...</property> + wizard to do it.</para> + + <para>To open the wizard follow to <emphasis> + <property>File > New > Rule Resource</property> + </emphasis> or use the menu with the JBoss Drools icon on the toolbar.</para> + + <figure> + <title>Opening the New Rule Package Wizard</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/create_new_project/create_new_project8.png"/> + </imageobject> + </mediaobject> + </figure> + + <para>On the wizard page first select <emphasis> + <property>/rules</property> + </emphasis> as a top level directory to store your rules and type the rule name. Next + it&apos;s mandatory to specify the rule package name. It defines a namespace that + groups rules together.</para> + + <figure> + <title>New Rule Package Wizard</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/create_new_project/create_new_project9.png"/> + </imageobject> + </mediaobject> + </figure> + + <para>As a result the wizard generates a rule skeleton to get you started.</para> + + <figure> + <title>New Rule</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/create_new_project/create_new_project10.png"/> + </imageobject> + </mediaobject> + </figure> + + </section> + +</chapter> \ No newline at end of file Modified: tags/jbosstools-3.1.1.GA/drools/docs/reference/en-US/debugging_rules.xml =================================================================== --- tags/jbosstools-3.1.1.GA/drools/docs/reference/en-US/debugging_rules.xml 2010-06-08 23:27:46 UTC (rev 22646) +++ tags/jbosstools-3.1.1.GA/drools/docs/reference/en-US/debugging_rules.xml 2010-06-08 23:30:47 UTC (rev 22647) @@ -1,137 +1,141 @@ -<?xml version="1.0" encoding="UTF-8"?> -<chapter id="debugging_rules" xreflabel="debugging_rules"> - <chapterinfo> - <keywordset> - <keyword>JBoss Tools</keyword> - <keyword>Drools Tools</keyword> - </keywordset> - </chapterinfo> - - <title>Debugging rules</title> - - <para>This chapter describes how to debug rules during the execution of your Drools application.</para> - - <section id="creating_breakpoints"> - <title>Creating Breakpoints</title> - - <para>At first, we&apos;ll focus on how to add - breakpoints in the consequences of your rules.</para> - - <para>Whenever such a breakpoint is uncounted - during the execution of the rules, the execution is halted. It&apos;s possible then inspect the - variables known at that point and use any of the default debugging actions to decide what - should happen next (step over, continue, etc). To inspect - the content of the working memory and agenda the Debug views can be used.</para> - - <para>You can add/remove rule breakpoints in <emphasis> - <property>.drl</property> - </emphasis> files in two ways, similar to adding breakpoints to Java files:</para> - - <itemizedlist> - <listitem> - <para>Double-click the ruler in the <property>Rule editor</property> at the line - where you want to add a breakpoint.</para> - <tip> - <title>Tip:</title> - <para>Note that rule breakpoints can only be created in the consequence of a - rule. Double-clicking on a line where no breakpoint is allowed will do - nothing.</para> - </tip> - <para>A breakpoint can be removed by double-clicking the ruler once more. </para> - </listitem> - - <listitem> - <para>Right-click the ruler. Select <emphasis> - <property>Toggle Breakpoint</property> - </emphasis> action in the appeared popup menu. Clicking the action will add a - breakpoint at the selected line or remove it if there is one already.</para> - </listitem> - </itemizedlist> - - <figure> - <title>Adding Breakpoints</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/debugging_rules/debugging_rules1.png"/> - </imageobject> - </mediaobject> - </figure> - - <para>The <property>Debug perspective</property> contains a <property>Breakpoints - view</property> which can be used to see all defined breakpoints, get their - properties, enable/disable or remove them, etc. You can switch to it by navigating to <emphasis> - <property>Window > Perspective > Others > Debug</property>.</emphasis></para> - </section> - - <section id="debugging"> - <title>Debugging</title> - - <para>Drools breakpoints are only enabled if you debug your application as a Drools - Application. To do this you should perform one of the actions:</para> - - <itemizedlist> - <listitem> - <para>Select the main class of your application. Right click it and select <emphasis> - <property>Debug As > Drools Application</property>.</emphasis></para> - </listitem> - </itemizedlist> - <figure> - <title>Debugging Drools Application</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/debugging_rules/debugging_rules2.png"/> - </imageobject> - </mediaobject> - </figure> - - <itemizedlist> - <listitem> - <para>Alternatively, you can also go to <emphasis> - <property>Debug As > Debug Configuration</property> - </emphasis> to open a new dialog for creating, managing and running debug - configurations.</para> - - <para>Select the <emphasis> - <property>Drools Application</property> - </emphasis> item in the left tree and click the <emphasis> - <property>New launch configuration</property> - </emphasis> button (leftmost icon in the toolbar above the tree). This will - create a new configuration and already fill in some of the properties (like the - Project and Main class) based on main class you selected in the beginning. All - properties shown here are the same as any standard Java program.</para> - </listitem> - </itemizedlist> - - <figure> - <title>New Debug Configuration</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/debugging_rules/debugging_rules3.png"/> - </imageobject> - </mediaobject> - </figure> - - <tip> - <title>Tip:</title> - <para>Remember to change the name of your debug configuration to something meaningful.</para> - </tip> - - <para>Next - click the <emphasis> - <property>Debug</property> - </emphasis> button on the bottom to start debugging your application. </para> - - <para>After enabling the debugging, the application starts executing and will halt if - any breakpoint is encountered. This can be a Drools rule breakpoint, or any other - standard Java breakpoint. Whenever a Drools rule breakpoint is encountered, the - corresponding <emphasis> - <property>.drl</property></emphasis> file is opened and the active line is highlighted. The Variables view - also contains all rule parameters and their value. You can then use the default Java - debug actions to decide what to do next (resume, terminate, step over, etc.). The debug - views can also be used to determine the contents of the working memory and agenda at - that time as well (you don't have to select a working memory now, the current executing - working memory is automatically shown).</para> - - - </section> -</chapter> +<?xml version="1.0" encoding="UTF-8"?> +<chapter id="debugging_rules" xreflabel="debugging_rules"> + <chapterinfo> + <keywordset> + <keyword>JBoss Tools</keyword> + <keyword>Drools Tools</keyword> + </keywordset> + </chapterinfo> + + <title>Debugging rules</title> + + <para>This chapter describes how to debug rules during the execution of your Drools application.</para> + + <section id="creating_breakpoints"> + <title>Creating Breakpoints</title> + + <para>At first, we&apos;ll focus on how to add + breakpoints in the consequences of your rules.</para> + + <para>Whenever such a breakpoint is uncounted + during the execution of the rules, the execution is halted. It&apos;s possible then inspect the + variables known at that point and use any of the default debugging actions to decide what + should happen next (step over, continue, etc). To inspect + the content of the working memory and agenda the Debug views can be used.</para> + + <para>To create breakpoints in the Package Explorer view or Navigator view of the Drools perspective, double-click the selected + <property>.drl</property> file to open it in the editor. In the example below we opened <property>Sample.drl</property> file. + </para> + + <para>You can add/remove rule breakpoints in the <emphasis> + <property>.drl</property> + </emphasis> files in two ways, similar to adding breakpoints to Java files:</para> + + <itemizedlist> + <listitem> + <para>Double-click the ruler in the <property>Rule editor</property> at the line + where you want to add a breakpoint.</para> + <tip> + <title>Tip:</title> + <para>Note that rule breakpoints can only be created in the consequence of a + rule. Double-clicking on a line where no breakpoint is allowed will do + nothing.</para> + </tip> + <para>A breakpoint can be removed by double-clicking the ruler once more. </para> + </listitem> + + <listitem> + <para>Right-click the ruler. Select <emphasis> + <property>Toggle Breakpoint</property> + </emphasis> action in the appeared popup menu. Clicking the action will add a + breakpoint at the selected line or remove it if there is one already.</para> + </listitem> + </itemizedlist> + + <figure> + <title>Adding Breakpoints</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/debugging_rules/debugging_rules1.png"/> + </imageobject> + </mediaobject> + </figure> + + <para>The <property>Debug perspective</property> contains a <property>Breakpoints + view</property> which can be used to see all defined breakpoints, get their + properties, enable/disable or remove them, etc. You can switch to it by navigating to <emphasis> + <property>Window > Perspective > Others > Debug</property>.</emphasis></para> + </section> + + <section id="debugging"> + <title>Debugging</title> + + <para>Drools breakpoints are only enabled if you debug your application as a Drools + Application. To do this you should perform one of the actions:</para> + + <itemizedlist> + <listitem> + <para>Select the main class of your application. Right click it and select <emphasis> + <property>Debug As > Drools Application</property>.</emphasis></para> + </listitem> + </itemizedlist> + <figure> + <title>Debugging Drools Application</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/debugging_rules/debugging_rules2.png"/> + </imageobject> + </mediaobject> + </figure> + + <itemizedlist> + <listitem> + <para>Alternatively, you can also go to <emphasis> + <property>Debug As > Debug Configuration</property> + </emphasis> to open a new dialog for creating, managing and running debug + configurations.</para> + + <para>Select the <emphasis> + <property>Drools Application</property> + </emphasis> item in the left tree and click the <emphasis> + <property>New launch configuration</property> + </emphasis> button (leftmost icon in the toolbar above the tree). This will + create a new configuration and already fill in some of the properties (like the + Project and Main class) based on main class you selected in the beginning. All + properties shown here are the same as any standard Java program.</para> + </listitem> + </itemizedlist> + + <figure> + <title>New Debug Configuration</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/debugging_rules/debugging_rules3.png"/> + </imageobject> + </mediaobject> + </figure> + + <tip> + <title>Tip:</title> + <para>Remember to change the name of your debug configuration to something meaningful.</para> + </tip> + + <para>Next + click the <emphasis> + <property>Debug</property> + </emphasis> button on the bottom to start debugging your application. </para> + + <para>After enabling the debugging, the application starts executing and will halt if + any breakpoint is encountered. This can be a Drools rule breakpoint, or any other + standard Java breakpoint. Whenever a Drools rule breakpoint is encountered, the + corresponding <emphasis> + <property>.drl</property></emphasis> file is opened and the active line is highlighted. The Variables view + also contains all rule parameters and their value. You can then use the default Java + debug actions to decide what to do next (resume, terminate, step over, etc.). The debug + views can also be used to determine the contents of the working memory and agenda at + that time as well (you don't have to select a working memory now, the current executing + working memory is automatically shown).</para> + + + </section> +</chapter> \ No newline at end of file Modified: tags/jbosstools-3.1.1.GA/drools/docs/reference/en-US/editors.xml =================================================================== --- tags/jbosstools-3.1.1.GA/drools/docs/reference/en-US/editors.xml 2010-06-08 23:27:46 UTC (rev 22646) +++ tags/jbosstools-3.1.1.GA/drools/docs/reference/en-US/editors.xml 2010-06-08 23:30:47 UTC (rev 22647) @@ -1,537 +1,537 @@ -<?xml version="1.0" encoding="UTF-8"?> -<chapter id="editors" xreflabel="editors"> - <chapterinfo> - <keywordset> - <keyword>JBoss Tools</keyword> - <keyword>Drools Tools</keyword> - </keywordset> - </chapterinfo> - - <title>Editors</title> - <section id="dsl_editor"> - <title>DSL Editor</title> - <para>A domain-specific language is a set of custom rules, - that is created specifically to solve problems in a particular domain - and is not intended to be able to solve problems outside it. - A DSL's configuration is stored in plain text. - </para> - <para>In Drools this configuration is presented by <property>.dsl</property> - files that can be created by <emphasis>right click on the project->New->Other->Drools->Domain Specific Language</emphasis>.</para> - <para>DSL Editor is a default editor for <property>.dsl</property> files:</para> - <figure> - <title>DSL Editor</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/editors/editors1a.png"/> - </imageobject> - </mediaobject> - </figure> - <para>In the table below all the components of the DSL Editor page are described:</para> - <table> - <title>DSL Editor Components.</title> - <tgroup cols="2"> - <colspec colnum="1" align="left" colwidth="1*"/> - <colspec colnum="2" align="left" colwidth="3*"/> - - <thead> - <row> - <entry>Components</entry> - <entry>Description</entry> - </row> - </thead> - <tbody> - <row> - <entry>Description</entry> - <entry>User's comments on a certain language message mapping</entry> - </row> - <row> - <entry>Table of language message mappings</entry> - <entry>The table is divided into 4 rows: - <itemizedlist id="rows"> - <listitem><para><emphasis>Language Expression</emphasis> :expression you want to use as a rule</para></listitem> - <listitem><para><emphasis>Rule Language Mapping</emphasis> :the implementation of the rules.This means that to this language expression the rule will be compiled - by the rule engine compiler.</para></listitem> - <listitem><para><emphasis>Object</emphasis> :name of the object</para></listitem> - <listitem><para><emphasis>Scope</emphasis> :indicates where the expression is - targeted: is it for the "condition" part of the rule ,"consequence" part, etc.</para></listitem> - </itemizedlist> - By clicking on some row's header you can sort the lines in the table according to the clicked row. - By double clicking on the line <link linkend="edit_wizard">Edit language mapping Wizard</link> will be open. - </entry> - </row> - <row> - <entry>Expression</entry> - <entry>Shows the language expression of the selected table line(language message mapping).</entry> - </row> - - <row> - <entry>Mapping</entry> - <entry>Shows the rule of language mapping for the selected table line(language message mapping).</entry> - </row> - <row> - <entry>Object</entry> - <entry>Shows the object for the selected table line(language message mapping)</entry> - </row> - - <row> - <entry id="sort">Sort By</entry> - <entry>Using this option you can change the type of lines sorting - in the table of language message mappings.To do this select from the drop down lins the method - of sorting you want and click <emphasis>Sort</emphasis> button.</entry> - </row> - <row> - <entry>Buttons</entry> - <entry><itemizedlist> - <listitem><para><emphasis>Edit</emphasis> :by clicking the button users can edit - selected in the table of language message mappings lines.For more information look - <link linkend="edit_wizard">Edit language mapping Wizard</link>section.</para></listitem> - <listitem><para><emphasis>Remove</emphasis> :if you click the button the selected mapping line will be deleted. </para></listitem> - <listitem><para><emphasis>Add</emphasis> :with this button you can add new mapping lines to the table.For more information look - <link linkend="add_wizard">Add language mapping Wizard</link>section. </para></listitem> - <listitem><para><emphasis>Sort</emphasis> : please, for more information go <link linkend="sort">here</link></para></listitem> - <listitem><para><emphasis>Copy</emphasis> :with this button you can add new mapping lines to the table - in which all the information will be copied from the selected mapping line.</para></listitem> - </itemizedlist> - </entry> - </row> - </tbody> - </tgroup> - </table> - <section id="edit_wizard"> - <title>Edit language mapping Wizard</title> - <para>This wizard can be opened by double clicking some line - in the table of language message mappings or by clicking the <emphasis>Edit</emphasis>button.</para> - <para>On the picture below you can see all the options,Edit language mapping Wizard allow to change.</para> - <para>Their names as well as the meaning of the options are correspond to the <link linkend="rows">rows</link> of the table.</para> - <figure> - <title>Edit language mapping Wizard</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/editors/editors1c.png"/> - </imageobject> - </mediaobject> - </figure> - <para>To change the mapping a user should edit the otions he want and finally click <emphasis>Ok</emphasis>.</para> - </section> - <section id="add_wizard"> - <title>Add language mapping Wizard</title> - <para>This wizard is equal to <link linkend="edit_wizard">Edit language mapping Wizard</link>. - It can be opened by clicking the <emphasis>Add</emphasis> button. - </para> - <para>The only difference is that instead of editing the information you should enter new one.</para> - <figure> - <title>Add language mapping Wizard</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/editors/editors1b.png"/> - </imageobject> - </mediaobject> - </figure> - </section> - </section> - <section id="ruleflow_editor"> - <title>Flow Editor</title> - <para>Drools tools also provide some functionality to define the order in - which rules should be executed.Ruleflow file allows you to specify - the order in which rule sets should be evaluated using a flow chart. - So you can define which rule sets should be evaluated in sequence or in parallel as well as - specify conditions under which rule sets should be evaluated.</para> - <para>Ruleflows can be set only by using the graphical flow editor which is part of the Drools plugin for Eclipse. - Once you have set up a Drools project,you can start adding ruleflows. - Add a ruleflow file(.rf) by clicking on the project and selecting "<emphasis>New -> Other...->Flow File</emphasis>":</para> - <figure> - <title>RuleFlow file creation</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/editors/editors1f.png"/> - </imageobject> - </mediaobject> - </figure> - <para>By default these ruleflow files (.rf) are opened in the graphical Flow editor. - You can see it on the picture below.</para> - <figure> - <title>Flow Editor</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/editors/editors1g.png"/> - </imageobject> - </mediaobject> - </figure> - <para>The Flow editor consists of a <emphasis>palette</emphasis>, a <emphasis>canvas</emphasis> - and an <emphasis>outline</emphasis> view. To add new elements to the canvas, select the - element you would like to create in the palette and then add it to the canvas by clicking on the preferred location. - </para> - <figure> - <title>Adding an element to the canvas</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/editors/editors1e.png"/> - </imageobject> - </mediaobject> - </figure> - <para>Clicking on the Select option in the palette and - then on the element in your ruleflow allows you to - view and set the properties of that element in the properies view.</para> - <figure> - <title>Properties view</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/editors/editors1d.png"/> - </imageobject> - </mediaobject> - </figure> - <para>Outline View is useful for big complex schemata where not all nodes are seen at one time. - So using your Outline view you can easly navigate between parts of a schema. </para> - <figure> - <title>Outline view usage</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/editors/editors9.png"/> - </imageobject> - </mediaobject> - </figure> - <section> - <title>Different types of control elements in Flow Palette</title> - <para>Flow editor supports three types of control elements. - They are:</para> - <table> <title>Flow Palette Components.Part 1</title> - <tgroup cols="3"> - <colspec colnum="1" align="left" colwidth="1*"/> - <colspec colnum="2" align="left" colwidth="1*"/> - <colspec colnum="3" align="left" colwidth="3*"/> - - <thead> - <row> - <entry>Component Picture</entry> - <entry>Component Name</entry> - <entry>Description</entry> - </row> - </thead> - <tbody> - <row> - <entry><inlinemediaobject> - <imageobject> - <imagedata fileref="images/editors/icon7.png"/> - </imageobject></inlinemediaobject></entry> - <entry>Select</entry> - <entry>Select a node on the canvas</entry> - </row> - <row> - <entry><inlinemediaobject> - <imageobject> - <imagedata fileref="images/editors/icon8.png"/> - </imageobject></inlinemediaobject></entry> - <entry>Marquee</entry> - <entry>Is used for selecting a group of elements</entry> - </row> - <row> - <entry><inlinemediaobject> - <imageobject> - <imagedata fileref="images/editors/icon9.png"/> - </imageobject></inlinemediaobject></entry> - <entry>Sequence Flow</entry> - <entry>Use this element to join two elements on the canvas</entry> - </row> - </tbody> - - </tgroup> - </table> - </section> - - <section> - <title>Different types of nodes in Flow Palette</title> - - <para>Currently, ruleflow supports seven types of nodes. - In the table below you can find information about them:</para> - <table> <title>Flow Palette Components.Part 2.</title> - <tgroup cols="3"> - <colspec colnum="1" align="left" colwidth="1*"/> - <colspec colnum="2" align="left" colwidth="1*"/> - <colspec colnum="3" align="left" colwidth="3*"/> - - <thead> - <row> - <entry>Component Picture</entry> - <entry>Component Name</entry> - <entry>Description</entry> - </row> - - </thead> - <tbody> - <row> - <entry><inlinemediaobject> - <imageobject> - <imagedata fileref="images/editors/icon1.png"/> - </imageobject></inlinemediaobject></entry> - <entry>Start Event</entry> - <entry>The start of the ruleflow. A ruleflow should have exactly - one start node. The <property>Start Event</property> can not have incoming - connections and should have one outgoing connection. Whenever the ruleflow process is started, - the executing is started here and is automatically proceeded to the first node - linked to this <property>Start Event</property></entry> - </row> - <row> - <entry><inlinemediaobject> - <imageobject> - <imagedata fileref="images/editors/icon2.png"/> - </imageobject></inlinemediaobject></entry> - <entry>End Event</entry> - <entry>A ruleflow file can have one or more <property>End Events</property>. - The <property>End Event</property> node should have one incoming connection - and can not have outgoing connections. When an end node is reached in the ruleflow, - the ruleflow is terminated (including other remaining active nodes when parallelism - is used).</entry> - </row> - <row> - <entry><inlinemediaobject> - <imageobject> - <imagedata fileref="images/editors/icon3.png"/> - </imageobject></inlinemediaobject></entry> - <entry>Rule Task</entry> - <entry>represents a set of rules. A <emphasis>Rule Task</emphasis> node should have one - incoming connection and one outgoing connection. - The <property>RuleFlowGroup</property> property which is used to specify the name of the - ruleflow-group that represents the set of rules of this <emphasis>Rule Task</emphasis> node. - When a <emphasis>Rule Task</emphasis> node is reached in the ruleflow, the engine will start - executing rules that are a part of the corresponding ruleflow-group. - Execution automatically continues to the next node when there are no - more active rules in this ruleflow-group. - </entry> - </row> - <row> - <entry><inlinemediaobject> - <imageobject> - <imagedata fileref="images/editors/icon4.png"/> - </imageobject></inlinemediaobject></entry> - <entry>Gateway[diverge]</entry> - <entry>allows you to create branches in your ruleflow. - A <property>Gateway[diverge]</property> node should have one incoming connection and two or more - outgoing connections.</entry> - </row> - <row> - <entry><inlinemediaobject> - <imageobject> - <imagedata fileref="images/editors/icon4.png"/> - </imageobject></inlinemediaobject></entry> - <entry>Gateway[converge]</entry> - <entry>allows you to synchronize multiple branches. - A <property>Gateway[diverge]</property>node should have two or more incoming connections and one - outgoing connection.</entry> - </row> - <row> - <entry><inlinemediaobject> - <imageobject> - <imagedata fileref="images/editors/icon5.png"/> - </imageobject></inlinemediaobject></entry> - <entry>Reusable Sup-Process</entry> - <entry>represents the invocation of another ruleflow from this ruleflow. - A subflow node should have one incoming connection and one outgoing connection. - It contains the property "processId" which specifies the id of the process that should be executed. - When a <property>Reusable Sup-Process</property> node is reached in the ruleflow, the engine will start the process with the given id. - The subflow node will only continue if that subflow process has terminated its execution. - Note that the subflow process is started as an independent process, - which means that the subflow process will not be terminated if this process reaches an end node.</entry> - </row> - <row> - <entry><inlinemediaobject> - <imageobject> - <imagedata fileref="images/editors/icon6.png"/> - </imageobject></inlinemediaobject></entry> - <entry>Script Task</entry> - <entry>represents an action that should be executed in this ruleflow. - An <property>Script Task</property> node should have one incoming connection and one outgoing - connection. It contains the property "action" which specifies the action that should be executed. - When a <property>Script Task</property> node is reached in the ruleflow, it will execute the action and - continue with the next node. An action should be specified as a piece of (valid) - MVEL code. </entry> - </row> - - </tbody> - </tgroup> - </table> - </section> - </section> - - <section id="textual_rule_editor"> - <title>The Rule Editor</title> - - <para>The <property>Rule editor</property> works on files that have a <emphasis> - <property>.drl</property> - </emphasis> (or <emphasis> - <property>.rule</property> - </emphasis> in the case of spreading rules across multiple rule files) extension.</para> - - <figure> - <title>New Rule</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/editors/editors1.png"/> - </imageobject> - </mediaobject> - </figure> - - <para>The editor follows the pattern of a normal text editor in eclipse, with all the normal - features of a text editor:</para> - - <itemizedlist> - <listitem> - <para> - <link linkend="rules_editor_content_assist">Content Assist</link> - </para> - </listitem> - - <listitem> - <para> - <link linkend="rules_editor_code_folding">Code Folding</link> - </para> - </listitem> - - <!-- <listitem> - <para> - <link linkend="rules_editor_error_reporting">Error Reporting</link> - </para> - </listitem>--> - - <listitem> - <para> - <link linkend="rules_editor_sync_with_outline">Synchronization with Outline - View</link> - </para> - </listitem> - </itemizedlist> - - <section id="rules_editor_content_assist"> - <title>Content Assist</title> - - <para>While working in the <property>Rule editor</property> you can get a content - assistance the usual way by pressing <emphasis> - <property>Ctrl + Space</property>.</emphasis></para> - - <para>Content Assist shows all possible keywords for the current cursor position.</para> - - <figure> - <title>Content Assist Demonstration</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/editors/editors2.png"/> - </imageobject> - </mediaobject> - </figure> - - <para>Content Assist inside of the <emphasis> - <property>Message</property> - </emphasis> suggests all available fields.</para> - - <figure> - <title>Content Assist Demonstration</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/editors/editors3.png"/> - </imageobject> - </mediaobject> - </figure> - - </section> - - <section id="rules_editor_code_folding"> - <title>Code Folding</title> - - <para>Code folding is also available in the <property>Rule editor</property>. To - hide/show sections of the file use the icons with minus/plus on the left vertical - line of the editor.</para> - - <figure> - <title>Code Folding</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/editors/editors4.png"/> - </imageobject> - </mediaobject> - </figure> - - </section> - - <!--section id="rules_editor_error_reporting"> - <title>Error Reporting</title> - - </section--> - - <section id="rules_editor_sync_with_outline"> - <title>Synchronization with Outline View</title> - - <para>The <property>Rule editor</property> works in synchronization with the - <property>Outline view</property> which shows the structure of the rules, - imports in the file and also globals and functions if the file has them.</para> - - <figure> - <title>Synchronization with Outline View</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/editors/editors5.png"/> - </imageobject> - </mediaobject> - </figure> - - <para>The view is updated on save. It provides a quick way of navigating around rules by - names in a file which may have hundreds of rules. The items are sorted - alphabetically by default.</para> - </section> - - <section id="rete_view"> - <title>The Rete Tree View</title> - - <para>The <property>Rete Tree view</property> shows you the current Rete Network for - your <emphasis> - <property>.drl</property> - </emphasis> file. Just click on the <emphasis> - <property>Rete Tree tab</property> - </emphasis> at the bottom of the <property>Rule editor</property>.</para> - - <figure> - <title>Rete Tree</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/editors/editors6.png"/> - </imageobject> - </mediaobject> - </figure> - - <para>Afterwards you can generate the current Rete Network visualization. You can push - and pull the nodes to arrange your optimal network overview.</para> - <para>If you got hundreds of nodes, select some of them with a frame. Then you can pull - groups of them.</para> - - <figure> - <title>Selecting the nodes in the Rete Tree with Frame</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/editors/editors7.png"/> - </imageobject> - </mediaobject> - </figure> - - <para>You can zoom in and out the Rete tree in case not all nodes are shown in the - current view. For this use the combo box or "+" and "-" icons on the toolbar.</para> - - <figure> - <title>Rete Tree Zooming</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/editors/editors8.png"/> - </imageobject> - </mediaobject> - </figure> - - <note> - <title>Note:</title> - - <para>The <property>Rete Tree view</property> works only in Drools Rule Projects, - where the Drools Builder is set in the project properties.</para> - </note> - <para>We hope, this guide helped you to get started with the JBoss BPMN Convert module. Besides, for additional information you are welcome on <ulink - url="http://www.jboss.com/index.html?module=bb&amp;op=viewforum&... forum</ulink>.</para> - </section> - - </section> - -</chapter> +<?xml version="1.0" encoding="UTF-8"?> +<chapter id="editors" xreflabel="editors"> + <chapterinfo> + <keywordset> + <keyword>JBoss Tools</keyword> + <keyword>Drools Tools</keyword> + </keywordset> + </chapterinfo> + + <title>Editors</title> + <section id="dsl_editor"> + <title>DSL Editor</title> + <para>A domain-specific language is a set of custom rules, + that is created specifically to solve problems in a particular domain + and is not intended to be able to solve problems outside it. + A DSL's configuration is stored in plain text. + </para> + <para>In Drools this configuration is presented by <property>.dsl</property> + files that can be created by <emphasis>right click on the project->New->Other->Drools->Domain Specific Language</emphasis>.</para> + <para>DSL Editor is a default editor for <property>.dsl</property> files:</para> + <figure> + <title>DSL Editor</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/editors/editors1a.png"/> + </imageobject> + </mediaobject> + </figure> + <para>In the table below all the components of the DSL Editor page are described:</para> + <table> + <title>DSL Editor Components.</title> + <tgroup cols="2"> + <colspec colnum="1" align="left" colwidth="1*"/> + <colspec colnum="2" align="left" colwidth="3*"/> + + <thead> + <row> + <entry>Components</entry> + <entry>Description</entry> + </row> + </thead> + <tbody> + <row> + <entry>Description</entry> + <entry>User's comments on a certain language message mapping</entry> + </row> + <row> + <entry>Table of language message mappings</entry> + <entry>The table is divided into 4 rows: + <itemizedlist id="rows"> + <listitem><para><emphasis>Language Expression</emphasis> :expression you want to use as a rule</para></listitem> + <listitem><para><emphasis>Rule Language Mapping</emphasis> :the implementation of the rules.This means that to this language expression the rule will be compiled + by the rule engine compiler.</para></listitem> + <listitem><para><emphasis>Object</emphasis> :name of the object</para></listitem> + <listitem><para><emphasis>Scope</emphasis> :indicates where the expression is + targeted: is it for the "condition" part of the rule ,"consequence" part, etc.</para></listitem> + </itemizedlist> + By clicking on some row's header you can sort the lines in the table according to the clicked row. + By double clicking on the line <link linkend="edit_wizard">Edit language mapping Wizard</link> will be open. + </entry> + </row> + <row> + <entry>Expression</entry> + <entry>Shows the language expression of the selected table line(language message mapping).</entry> + </row> + + <row> + <entry>Mapping</entry> + <entry>Shows the rule of language mapping for the selected table line(language message mapping).</entry> + </row> + <row> + <entry>Object</entry> + <entry>Shows the object for the selected table line(language message mapping)</entry> + </row> + + <row> + <entry id="sort">Sort By</entry> + <entry>Using this option you can change the type of lines sorting + in the table of language message mappings. To do this select from the drop down list the method + of sorting you want and click <emphasis>Sort</emphasis> button.</entry> + </row> + <row> + <entry>Buttons</entry> + <entry><itemizedlist> + <listitem><para><emphasis>Edit</emphasis> :by clicking the button users can edit + selected in the table of language message mappings lines.For more information look + <link linkend="edit_wizard">Edit language mapping Wizard</link>section.</para></listitem> + <listitem><para><emphasis>Remove</emphasis> :if you click the button the selected mapping line will be deleted. </para></listitem> + <listitem><para><emphasis>Add</emphasis> :with this button you can add new mapping lines to the table.For more information look + <link linkend="add_wizard">Add language mapping Wizard</link>section. </para></listitem> + <listitem><para><emphasis>Sort</emphasis> : please, for more information go <link linkend="sort">here</link></para></listitem> + <listitem><para><emphasis>Copy</emphasis> :with this button you can add new mapping lines to the table + in which all the information will be copied from the selected mapping line.</para></listitem> + </itemizedlist> + </entry> + </row> + </tbody> + </tgroup> + </table> + <section id="edit_wizard"> + <title>Edit language mapping Wizard</title> + <para>This wizard can be opened by double clicking some line + in the table of language message mappings or by clicking the <emphasis>Edit</emphasis> button.</para> + <para>On the picture below you can see all the options,Edit language mapping Wizard allow to change.</para> + <para>Their names as well as the meaning of the options are correspond to the <link linkend="rows">rows</link> of the table.</para> + <figure> + <title>Edit language mapping Wizard</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/editors/editors1c.png"/> + </imageobject> + </mediaobject> + </figure> + <para>To change the mapping a user should edit the otions he want and finally click <emphasis>Ok</emphasis>.</para> + </section> + <section id="add_wizard"> + <title>Add language mapping Wizard</title> + <para>This wizard is equal to <link linkend="edit_wizard">Edit language mapping Wizard</link>. + It can be opened by clicking the <emphasis>Add</emphasis> button. + </para> + <para>The only difference is that instead of editing the information you should enter new one.</para> + <figure> + <title>Add language mapping Wizard</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/editors/editors1b.png"/> + </imageobject> + </mediaobject> + </figure> + </section> + </section> + <section id="ruleflow_editor"> + <title>Flow Editor</title> + <para>Drools tools also provide some functionality to define the order in + which rules should be executed.Ruleflow file allows you to specify + the order in which rule sets should be evaluated using a flow chart. + So you can define which rule sets should be evaluated in sequence or in parallel as well as + specify conditions under which rule sets should be evaluated.</para> + <para>Ruleflows can be set only by using the graphical flow editor which is part of the Drools plugin for Eclipse. + Once you have set up a Drools project,you can start adding ruleflows. + Add a ruleflow file(.rf) by clicking on the project and selecting "<emphasis>New -> Other...->Flow File</emphasis>":</para> + <figure> + <title>RuleFlow file creation</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/editors/editors1f.png"/> + </imageobject> + </mediaobject> + </figure> + <para>By default these ruleflow files (.rf) are opened in the graphical Flow editor. + You can see it on the picture below.</para> + <figure> + <title>Flow Editor</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/editors/editors1g.png"/> + </imageobject> + </mediaobject> + </figure> + <para>The Flow editor consists of a <emphasis>palette</emphasis>, a <emphasis>canvas</emphasis> + and an <emphasis>outline</emphasis> view. To add new elements to the canvas, select the + element you would like to create in the palette and then add it to the canvas by clicking on the preferred location. + </para> + <figure> + <title>Adding an element to the canvas</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/editors/editors1e.png"/> + </imageobject> + </mediaobject> + </figure> + <para>Clicking on the Select option in the palette and + then on the element in your ruleflow allows you to + view and set the properties of that element in the properies view.</para> + <figure> + <title>Properties view</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/editors/editors1d.png"/> + </imageobject> + </mediaobject> + </figure> + <para>Outline View is useful for big complex schemata where not all nodes are seen at one time. + So using your Outline view you can easily navigate between parts of a schema. </para> + <figure> + <title>Outline view usage</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/editors/editors9.png"/> + </imageobject> + </mediaobject> + </figure> + <section> + <title>Different types of control elements in Flow Palette</title> + <para>Flow editor supports three types of control elements. + They are:</para> + <table> <title>Flow Palette Components.Part 1</title> + <tgroup cols="3"> + <colspec colnum="1" align="left" colwidth="1*"/> + <colspec colnum="2" align="left" colwidth="1*"/> + <colspec colnum="3" align="left" colwidth="3*"/> + + <thead> + <row> + <entry>Component Picture</entry> + <entry>Component Name</entry> + <entry>Description</entry> + </row> + </thead> + <tbody> + <row> + <entry><inlinemediaobject> + <imageobject> + <imagedata fileref="images/editors/icon7.png"/> + </imageobject></inlinemediaobject></entry> + <entry>Select</entry> + <entry>Select a node on the canvas</entry> + </row> + <row> + <entry><inlinemediaobject> + <imageobject> + <imagedata fileref="images/editors/icon8.png"/> + </imageobject></inlinemediaobject></entry> + <entry>Marquee</entry> + <entry>Is used for selecting a group of elements</entry> + </row> + <row> + <entry><inlinemediaobject> + <imageobject> + <imagedata fileref="images/editors/icon9.png"/> + </imageobject></inlinemediaobject></entry> + <entry>Sequence Flow</entry> + <entry>Use this element to join two elements on the canvas</entry> + </row> + </tbody> + + </tgroup> + </table> + </section> + + <section> + <title>Different types of nodes in Flow Palette</title> + + <para>Currently, ruleflow supports seven types of nodes. + In the table below you can find information about them:</para> + <table> <title>Flow Palette Components.Part 2.</title> + <tgroup cols="3"> + <colspec colnum="1" align="left" colwidth="1*"/> + <colspec colnum="2" align="left" colwidth="1*"/> + <colspec colnum="3" align="left" colwidth="3*"/> + + <thead> + <row> + <entry>Component Picture</entry> + <entry>Component Name</entry> + <entry>Description</entry> + </row> + + </thead> + <tbody> + <row> + <entry><inlinemediaobject> + <imageobject> + <imagedata fileref="images/editors/icon1.png"/> + </imageobject></inlinemediaobject></entry> + <entry>Start Event</entry> + <entry>The start of the ruleflow. A ruleflow should have exactly + one start node. The <property>Start Event</property> can not have incoming + connections and should have one outgoing connection. Whenever the ruleflow process is started, + the executing is started here and is automatically proceeded to the first node + linked to this <property>Start Event</property></entry> + </row> + <row> + <entry><inlinemediaobject> + <imageobject> + <imagedata fileref="images/editors/icon2.png"/> + </imageobject></inlinemediaobject></entry> + <entry>End Event</entry> + <entry>A ruleflow file can have one or more <property>End Events</property>. + The <property>End Event</property> node should have one incoming connection + and can not have outgoing connections. When an end node is reached in the ruleflow, + the ruleflow is terminated (including other remaining active nodes when parallelism + is used).</entry> + </row> + <row> + <entry><inlinemediaobject> + <imageobject> + <imagedata fileref="images/editors/icon3.png"/> + </imageobject></inlinemediaobject></entry> + <entry>Rule Task</entry> + <entry>represents a set of rules. A <emphasis>Rule Task</emphasis> node should have one + incoming connection and one outgoing connection. + The <property>RuleFlowGroup</property> property which is used to specify the name of the + ruleflow-group that represents the set of rules of this <emphasis>Rule Task</emphasis> node. + When a <emphasis>Rule Task</emphasis> node is reached in the ruleflow, the engine will start + executing rules that are a part of the corresponding ruleflow-group. + Execution automatically continues to the next node when there are no + more active rules in this ruleflow-group. + </entry> + </row> + <row> + <entry><inlinemediaobject> + <imageobject> + <imagedata fileref="images/editors/icon4.png"/> + </imageobject></inlinemediaobject></entry> + <entry>Gateway[diverge]</entry> + <entry>allows you to create branches in your ruleflow. + A <property>Gateway[diverge]</property> node should have one incoming connection and two or more + outgoing connections.</entry> + </row> + <row> + <entry><inlinemediaobject> + <imageobject> + <imagedata fileref="images/editors/icon4.png"/> + </imageobject></inlinemediaobject></entry> + <entry>Gateway[converge]</entry> + <entry>allows you to synchronize multiple branches. + A <property>Gateway[diverge]</property> node should have two or more incoming connections and one + outgoing connection.</entry> + </row> + <row> + <entry><inlinemediaobject> + <imageobject> + <imagedata fileref="images/editors/icon5.png"/> + </imageobject></inlinemediaobject></entry> + <entry>Reusable Sup-Process</entry> + <entry>represents the invocation of another ruleflow from this ruleflow. + A subflow node should have one incoming connection and one outgoing connection. + It contains the property "processId" which specifies the id of the process that should be executed. + When a <property>Reusable Sup-Process</property> node is reached in the ruleflow, the engine will start the process with the given id. + The subflow node will only continue if that subflow process has terminated its execution. + Note that the subflow process is started as an independent process, + which means that the subflow process will not be terminated if this process reaches an end node.</entry> + </row> + <row> + <entry><inlinemediaobject> + <imageobject> + <imagedata fileref="images/editors/icon6.png"/> + </imageobject></inlinemediaobject></entry> + <entry>Script Task</entry> + <entry>represents an action that should be executed in this ruleflow. + An <property>Script Task</property> node should have one incoming connection and one outgoing + connection. It contains the property "action" which specifies the action that should be executed. + When a <property>Script Task</property> node is reached in the ruleflow, it will execute the action and + continue with the next node. An action should be specified as a piece of (valid) + MVEL code. </entry> + </row> + + </tbody> + </tgroup> + </table> + </section> + </section> + + <section id="textual_rule_editor"> + <title>The Rule Editor</title> + + <para>The <property>Rule editor</property> works on files that have a <emphasis> + <property>.drl</property> + </emphasis> (or <emphasis> + <property>.rule</property> + </emphasis> in the case of spreading rules across multiple rule files) extension.</para> + + <figure> + <title>New Rule</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/editors/editors1.png"/> + </imageobject> + </mediaobject> + </figure> + + <para>The editor follows the pattern of a normal text editor in eclipse, with all the normal + features of a text editor:</para> + + <itemizedlist> + <listitem> + <para> + <link linkend="rules_editor_content_assist">Content Assist</link> + </para> + </listitem> + + <listitem> + <para> + <link linkend="rules_editor_code_folding">Code Folding</link> + </para> + </listitem> + + <!-- <listitem> + <para> + <link linkend="rules_editor_error_reporting">Error Reporting</link> + </para> + </listitem>--> + + <listitem> + <para> + <link linkend="rules_editor_sync_with_outline">Synchronization with Outline + View</link> + </para> + </listitem> + </itemizedlist> + + <section id="rules_editor_content_assist"> + <title>Content Assist</title> + + <para>While working in the <property>Rule editor</property> you can get a content + assistance the usual way by pressing <emphasis> + <property>Ctrl + Space</property>.</emphasis></para> + + <para>Content Assist shows all possible keywords for the current cursor position.</para> + + <figure> + <title>Content Assist Demonstration</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/editors/editors2.png"/> + </imageobject> + </mediaobject> + </figure> + + <para>Content Assist inside of the <emphasis> + <property>Message</property> + </emphasis> suggests all available fields.</para> + + <figure> + <title>Content Assist Demonstration</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/editors/editors3.png"/> + </imageobject> + </mediaobject> + </figure> + + </section> + + <section id="rules_editor_code_folding"> + <title>Code Folding</title> + + <para>Code folding is also available in the <property>Rule editor</property>. To + hide/show sections of the file use the icons with minus/plus on the left vertical + line of the editor.</para> + + <figure> + <title>Code Folding</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/editors/editors4.png"/> + </imageobject> + </mediaobject> + </figure> + + </section> + + <!--section id="rules_editor_error_reporting"> + <title>Error Reporting</title> + + </section--> + + <section id="rules_editor_sync_with_outline"> + <title>Synchronization with Outline View</title> + + <para>The <property>Rule editor</property> works in synchronization with the + <property>Outline view</property> which shows the structure of the rules, + imports in the file and also globals and functions if the file has them.</para> + + <figure> + <title>Synchronization with Outline View</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/editors/editors5.png"/> + </imageobject> + </mediaobject> + </figure> + + <para>The view is updated on save. It provides a quick way of navigating around rules by + names in a file which may have hundreds of rules. The items are sorted + alphabetically by default.</para> + </section> + + <section id="rete_view"> + <title>The Rete Tree View</title> + + <para>The <property>Rete Tree view</property> shows you the current Rete Network for + your <emphasis> + <property>.drl</property> + </emphasis> file. Just click on the <emphasis> + <property>Rete Tree tab</property> + </emphasis> at the bottom of the <property>Rule editor</property>.</para> + + <figure> + <title>Rete Tree</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/editors/editors6.png"/> + </imageobject> + </mediaobject> + </figure> + + <para>Afterwards you can generate the current Rete Network visualization. You can push + and pull the nodes to arrange your optimal network overview.</para> + <para>If you got hundreds of nodes, select some of them with a frame. Then you can pull + groups of them.</para> + + <figure> + <title>Selecting the nodes in the Rete Tree with Frame</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/editors/editors7.png"/> + </imageobject> + </mediaobject> + </figure> + + <para>You can zoom in and out the Rete tree in case not all nodes are shown in the + current view. For this use the combo box or "+" and "-" icons on the toolbar.</para> + + <figure> + <title>Rete Tree Zooming</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/editors/editors8.png"/> + </imageobject> + </mediaobject> + </figure> + + <note> + <title>Note:</title> + + <para>The <property>Rete Tree view</property> works only in Drools Rule Projects, + where the Drools Builder is set in the project properties.</para> + </note> + <para>We hope, this guide helped you to get started with the JBoss BPMN Convert module. Besides, for additional information you are welcome on <ulink + url="http://www.jboss.com/index.html?module=bb&amp;op=viewforum&... forum</ulink>.</para> + </section> + + </section> + +</chapter> \ No newline at end of file Modified: tags/jbosstools-3.1.1.GA/drools/docs/reference/en-US/images/create_new_project/create_new_project8.png =================================================================== (Binary files differ) Modified: tags/jbosstools-3.1.1.GA/drools/docs/reference/en-US/images/debugging_rules/debugging_rules1.png =================================================================== (Binary files differ) Modified: tags/jbosstools-3.1.1.GA/drools/docs/reference/en-US/master_output.xml =================================================================== --- tags/jbosstools-3.1.1.GA/drools/docs/reference/en-US/master_output.xml 2010-06-08 23:27:46 UTC (rev 22646) +++ tags/jbosstools-3.1.1.GA/drools/docs/reference/en-US/master_output.xml 2010-06-08 23:30:47 UTC (rev 22647) @@ -2,12 +2,12 @@ <!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 create_new_project SYSTEM "modules/create_new_project.xml"> -<!ENTITY create_new SYSTEM "modules/create_new.xml"> -<!ENTITY debugging_rules SYSTEM "modules/debugging_rules.xml"> -<!ENTITY views SYSTEM "modules/views.xml"> -<!ENTITY editors SYSTEM "modules/editors.xml"> +[<!ENTITY introduction SYSTEM "introduction.xml"> +<!ENTITY create_new_project SYSTEM "create_new_project.xml"> +<!ENTITY create_new SYSTEM "create_new.xml"> +<!ENTITY debugging_rules SYSTEM "debugging_rules.xml"> +<!ENTITY views SYSTEM "views.xml"> +<!ENTITY editors SYSTEM "editors.xml"> <!ENTITY seamlink "../../seam/html_single/index.html"> <!ENTITY aslink "../../as/html_single/index.html"> @@ -59,7 +59,7 @@ <toc></toc> -<chapter id="introduction" xml:base="file:///home/vchukhutsina/repos/ochik_jboss/drools/docs/reference/en/modules/introduction.xml" xreflabel="introduction"> +<chapter id="introduction" xml:base="file:///home/vchukhutsina/repos/ochik_jboss/drools/docs/reference/en-US/introduction.xml" xreflabel="introduction"> <title>Introduction</title> <section id="whatisDrools"> @@ -81,7 +81,7 @@ <para><property moreinfo="none">Drools Tools</property> come bundled with <property moreinfo="none">JBoss Tools</property> set of Eclipse plugins. How to install <property moreinfo="none">JBoss Tools</property> you can find in - the <ulink url="../../GettingStartedGuide/html_single/index.html#JBossToolsInstall">Getting Started Guide</ulink>.</para> + the Getting Started Guide.</para> </section> <section id="drools_key_features"> @@ -229,7 +229,7 @@ </chapter> -<chapter id="create_new_project" xml:base="file:///home/vchukhutsina/repos/ochik_jboss/drools/docs/reference/en/modules/create_new_project.xml" xreflabel="create_new_project"> +<chapter id="create_new_project" xml:base="file:///home/vchukhutsina/repos/ochik_jboss/drools/docs/reference/en-US/create_new_project.xml" xreflabel="create_new_project"> <chapterinfo> <keywordset> <keyword>JBoss Tools</keyword> @@ -395,19 +395,19 @@ <section id="creating_rule"> <title>Creating a New Rule</title> - <para>Now we are going to add a new Rule resource to the project.</para> + <para><diffmk:wrapper diffmk:change="changed">Now we are going to add a new Rule package to the project.</diffmk:wrapper></para> <para>You can either create an empty text <emphasis> <property moreinfo="none">.drl</property> - </emphasis> file or make use of the special <property moreinfo="none">New Rule Resource - wizard</property> to do it.</para> + </emphasis> file or make use of the special <property moreinfo="none"><diffmk:wrapper diffmk:change="changed">New Rule Package...</diffmk:wrapper></property><diffmk:wrapper diffmk:change="changed"> + wizard to do it.</diffmk:wrapper></para> <para>To open the wizard follow to <emphasis> <property moreinfo="none">File &gt; New &gt; Rule Resource</property> </emphasis> or use the menu with the JBoss Drools icon on the toolbar.</para> <figure float="0"> - <title>Opening the New Rule Resource Wizard</title> + <title><diffmk:wrapper diffmk:change="changed">Opening the New Rule Package Wizard</diffmk:wrapper></title> <mediaobject> <imageobject> <imagedata fileref="images/create_new_project/create_new_project8.png"></imagedata> @@ -422,7 +422,7 @@ groups rules together.</para> <figure float="0"> - <title>New Rule Resource Wizard</title> + <title><diffmk:wrapper diffmk:change="changed">New Rule Package Wizard</diffmk:wrapper></title> <mediaobject> <imageobject> <imagedata fileref="images/create_new_project/create_new_project9.png"></imagedata> @@ -444,9 +444,8 @@ </section> </chapter> - -<chapter id="debugging_rules" xml:base="file:///home/vchukhutsina/repos/ochik_jboss/drools/docs/reference/en/modules/debugging_rules.xml" xreflabel="debugging_rules"> +<chapter id="debugging_rules" xml:base="file:///home/vchukhutsina/repos/ochik_jboss/drools/docs/reference/en-US/debugging_rules.xml" xreflabel="debugging_rules"> <chapterinfo> <keywordset> <keyword>JBoss Tools</keyword> @@ -470,7 +469,11 @@ should happen next (step over, continue, etc). To inspect the content of the working memory and agenda the Debug views can be used.</para> - <para>You can add/remove rule breakpoints in <emphasis> + <para><diffmk:wrapper diffmk:change="added">To create breakpoints in the Package Explorer view or Navigator view of the Drools perspective, double-click the selected + </diffmk:wrapper><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">.drl</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added"> file to open it in the editor. In the example below we opened </diffmk:wrapper><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">Sample.drl</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added"> file. + </diffmk:wrapper></para> + + <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">You can add/remove rule breakpoints in the </diffmk:wrapper><emphasis> <property moreinfo="none">.drl</property> </emphasis> files in two ways, similar to adding breakpoints to Java files:</para> @@ -582,9 +585,8 @@ </section> </chapter> - -<chapter id="editors" xml:base="file:///home/vchukhutsina/repos/ochik_jboss/drools/docs/reference/en/modules/editors.xml" xreflabel="editors"> +<chapter id="editors" xml:base="file:///home/vchukhutsina/repos/ochik_jboss/drools/docs/reference/en-US/editors.xml" xreflabel="editors"> <chapterinfo> <keywordset> <keyword>JBoss Tools</keyword> @@ -660,9 +662,9 @@ <row> <entry id="sort">Sort By</entry> - <entry>Using this option you can change the type of lines sorting - in the table of language message mappings.To do this select from the drop down lins the method - of sorting you want and click <emphasis>Sort</emphasis> button.</entry> + <entry><diffmk:wrapper diffmk:change="changed">Using this option you can change the type of lines sorting + in the table of language message mappings. To do this select from the drop down list the method + of sorting you want and click </diffmk:wrapper><emphasis>Sort</emphasis> button.</entry> </row> <row> <entry>Buttons</entry> @@ -684,8 +686,8 @@ </table> <section id="edit_wizard"> <title>Edit language mapping Wizard</title> - <para>This wizard can be opened by double clicking some line - in the table of language message mappings or by clicking the <emphasis>Edit</emphasis>button.</para> + <para><diffmk:wrapper diffmk:change="changed">This wizard can be opened by double clicking some line + in the table of language message mappings or by clicking the </diffmk:wrapper><emphasis>Edit</emphasis><diffmk:wrapper diffmk:change="changed"> button.</diffmk:wrapper></para> <para>On the picture below you can see all the options,Edit language mapping Wizard allow to change.</para> <para>Their names as well as the meaning of the options are correspond to the <link linkend="rows">rows</link> of the table.</para> <figure float="0"> @@ -765,8 +767,8 @@ </imageobject> </mediaobject> </figure> - <para>Outline View is useful for big complex schemata where not all nodes are seen at one time. - So using your Outline view you can easly navigate between parts of a schema. </para> + <para><diffmk:wrapper diffmk:change="changed">Outline View is useful for big complex schemata where not all nodes are seen at one time. + So using your Outline view you can easily navigate between parts of a schema. </diffmk:wrapper></para> <figure float="0"> <title>Outline view usage</title> <mediaobject> @@ -900,8 +902,8 @@ </imageobject></inlinemediaobject></entry> <entry>Gateway[converge]</entry> <entry>allows you to synchronize multiple branches. - A <property moreinfo="none">Gateway[diverge]</property>node should have two or more incoming connections and one - outgoing connection.</entry> + A <property moreinfo="none">Gateway[diverge]</property><diffmk:wrapper diffmk:change="changed"> node should have two or more incoming connections and one + outgoing connection.</diffmk:wrapper></entry> </row> <row> <entry><inlinemediaobject> @@ -1113,15 +1115,10 @@ <para>The <property moreinfo="none">Rete Tree view</property> works only in Drools Rule Projects, where the Drools Builder is set in the project properties.</para> </note> - <para>We hope, this guide helped you to get started with the JBoss BPMN - Convert module. Besides, for additional information you are welcome on - <ulink url="http://www.jboss.com/index.html?module=bb&amp;op=viewforum&... forum</ulink>.</para> + <para>We hope, this guide helped you to get started with the JBoss BPMN Convert module. Besides, for additional information you are welcome on <ulink + url="http://www.jboss.com/index.html?module=bb&amp;op=viewforum&... forum</ulink>.</para> </section> </section> - -</chapter> - - -</book> +</chapter></book>