[jboss-svn-commits] JBL Code SVN: r18683 - in labs/jbossrules/branches/irooskov_docs/drools-docs: drools-docs-examples/en and 5 other directories.
jboss-svn-commits at lists.jboss.org
jboss-svn-commits at lists.jboss.org
Wed Mar 5 01:21:31 EST 2008
Author: irooskov at redhat.com
Date: 2008-03-05 01:21:31 -0500 (Wed, 05 Mar 2008)
New Revision: 18683
Modified:
labs/jbossrules/branches/irooskov_docs/drools-docs/drools-docs-brms/en/master.xml
labs/jbossrules/branches/irooskov_docs/drools-docs/drools-docs-examples/en/master.xml
labs/jbossrules/branches/irooskov_docs/drools-docs/drools-docs-solver/en/master.xml
labs/jbossrules/branches/irooskov_docs/drools-docs/drools-docs-userguide/en/Chapter-Decision_Tables/Section-Spreadsheet.xml
labs/jbossrules/branches/irooskov_docs/drools-docs/drools-docs-userguide/en/Chapter-IDE/Section-QuickStart.xml
labs/jbossrules/branches/irooskov_docs/drools-docs/drools-docs-userguide/en/Chapter-Install/Section-Checkout.xml
labs/jbossrules/branches/irooskov_docs/drools-docs/drools-docs-userguide/en/Chapter-Install/Section-Eclipse.xml
labs/jbossrules/branches/irooskov_docs/drools-docs/drools-docs-userguide/en/Chapter-Install/Section-Install.xml
labs/jbossrules/branches/irooskov_docs/drools-docs/drools-docs-userguide/en/Chapter-Install/Section-Maven_build.xml
labs/jbossrules/branches/irooskov_docs/drools-docs/drools-docs-userguide/en/Chapter-Install/Section-Setup.xml
labs/jbossrules/branches/irooskov_docs/drools-docs/drools-docs-userguide/en/Chapter-Rule_Engine/Section-The_Drools_Rule_Engine.xml
Log:
corrected some spelling and grammer while reading through to decide on book split and layout
Modified: labs/jbossrules/branches/irooskov_docs/drools-docs/drools-docs-brms/en/master.xml
===================================================================
--- labs/jbossrules/branches/irooskov_docs/drools-docs/drools-docs-brms/en/master.xml 2008-03-05 04:42:13 UTC (rev 18682)
+++ labs/jbossrules/branches/irooskov_docs/drools-docs/drools-docs-brms/en/master.xml 2008-03-05 06:21:31 UTC (rev 18683)
@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8"?>
-<book xmlns:xi="http://www.w3.org/2003/XInclude">
+<book xmlns:xi="http://www.w3.org/2001/XInclude">
<bookinfo>
<title>Drools BRMS</title>
Modified: labs/jbossrules/branches/irooskov_docs/drools-docs/drools-docs-examples/en/master.xml
===================================================================
--- labs/jbossrules/branches/irooskov_docs/drools-docs/drools-docs-examples/en/master.xml 2008-03-05 04:42:13 UTC (rev 18682)
+++ labs/jbossrules/branches/irooskov_docs/drools-docs/drools-docs-examples/en/master.xml 2008-03-05 06:21:31 UTC (rev 18683)
@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8"?>
-<book xmlns:xi="http://www.w3.org/2003/XInclude">
+<book xmlns:xi="http://www.w3.org/2001/XInclude">
<bookinfo>
<title>Drools Examples</title>
Modified: labs/jbossrules/branches/irooskov_docs/drools-docs/drools-docs-solver/en/master.xml
===================================================================
--- labs/jbossrules/branches/irooskov_docs/drools-docs/drools-docs-solver/en/master.xml 2008-03-05 04:42:13 UTC (rev 18682)
+++ labs/jbossrules/branches/irooskov_docs/drools-docs/drools-docs-solver/en/master.xml 2008-03-05 06:21:31 UTC (rev 18683)
@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8"?>
-<book xmlns:xi="http://www.w3.org/2003/XInclude">
+<book xmlns:xi="http://www.w3.org/2001/XInclude">
<bookinfo>
<title>Drools Solver (experimental)</title>
Modified: labs/jbossrules/branches/irooskov_docs/drools-docs/drools-docs-userguide/en/Chapter-Decision_Tables/Section-Spreadsheet.xml
===================================================================
--- labs/jbossrules/branches/irooskov_docs/drools-docs/drools-docs-userguide/en/Chapter-Decision_Tables/Section-Spreadsheet.xml 2008-03-05 04:42:13 UTC (rev 18682)
+++ labs/jbossrules/branches/irooskov_docs/drools-docs/drools-docs-userguide/en/Chapter-Decision_Tables/Section-Spreadsheet.xml 2008-03-05 06:21:31 UTC (rev 18683)
@@ -3,7 +3,7 @@
<title>Decision tables in spreadsheets</title>
<para>Decision tables are a "precise yet compact" (ref. Wikipedia) way of
- representing conditional logic, and are well suited to "business" level
+ representing conditional logic, and are well suited to business level
rules.</para>
<para>Drools supports managing rules in a Spreadsheet format. Formats
@@ -76,8 +76,8 @@
</mediaobject>
</screenshot>
- <para>In the above examples, the technical aspects of the decision table
- have been collapsed away (standard spreadsheet feature).</para>
+ <para>The examples presented showcase the technical aspects of the decision table
+ and how these aspects can been collapsed and hidden (standard spreadsheet feature).</para>
<para>The rules start from row 17 (each row results in a rule). The
conditions are in column C, D, E etc.. (off screen are the actions). You
@@ -86,7 +86,8 @@
is conventional to use color to make it obvious what the different areas
of the table mean.</para>
- <para>Note that although the decision tables look like they process top
+ <note>
+ <para>Although the decision tables look like they process top
down, this is not necessarily the case. It is ideal if you can author
rules in such a way as order does not matter (simply as it makes
maintenance easier, you are not trying to shift rows around all the time).
@@ -98,7 +99,8 @@
rules can be grouped where they share common templates - yet at the end of
the day they are all combined into a one rule package). Decision tables
are essentially a tool to generate DRL rules automatically.</para>
-
+ </note>
+
<screenshot>
<screeninfo>A real world example using multiple tables for grouping like
rules</screeninfo>
@@ -153,7 +155,7 @@
<para>Now you can see the hidden magic that makes it work. The RuleSet
keyword indicates the name to be used in the "rule package" that all the
rules will come under (the name is optional, it will have a default but
- you MUST have the "RuleSet" keyword) in the cell immediately to the right.
+ you <emphasis>MUST</emphasis> have the "RuleSet" keyword) in the cell immediately to the right.
The other keywords visible in Column C are: Import, Sequential which will
be covered later - just note that in general the keywords make up
name/value pairs. The RuleTable keyword is important as it indicates that
@@ -164,7 +166,7 @@
start (columns to the left are ignored).</para>
<para>Referring to row 14 (the row immediately after RuleTable): the
- keywords CONDITION and ACTION indicate that the data in the columns below
+ keywords <emphasis>CONDITION</emphasis> and <emphasis>ACTION</emphasis> indicate that the data in the columns below
are for either the LHS or the RHS parts of a rule. There are other
attributes on the rule which can also be optionally set this way.</para>
@@ -188,7 +190,7 @@
<para>Row 18 to 19 shows data, which will be combined (interpolated) with
the templates in row 15, to generate rules. If a cell contains no data,
then its template is ignored (eg it means that condition, or action, does
- not apply for that rule-row). Rule rows are read until there is a BLANK
+ not apply for that rule-row). Rule rows are read until there is a <emphasis>BLANK</emphasis>
row. You can have multiple RuleTables in a sheet. Row 20 contains another
keyword, and a value - the row positions of keywords like this do not
matter (most people put them at the top) but their column should be the
@@ -219,7 +221,7 @@
<title>Syntax of templates</title>
<para>The syntax of what goes in the templates is dependent on if it is
- a CONDITION column or ACTION column. In most cases, it is identical to
+ a <emphasis>CONDITION</emphasis> column or <emphasis>ACTION</emphasis> column. In most cases, it is identical to
"vanilla" DRL for the LHS or RHS respectively. This means in the LHS,
the constraint language must be used, and in the RHS it is a snippet of
code to be executed.</para>
@@ -238,13 +240,13 @@
that ObjectType. If there isn't, then they are just rendered as is (with
values substituted). If you put just a plain field (as in the example
above) then it will assume you mean equality. If you put another
- operator at the end of the snippet, then the values will put
+ operator at the end of the snippet, then the values will be
interpolated at the end of the constraint, otherwise it will look for
"$param" as outlined previously.</para>
<para>For consequences: How snippets are rendered also depends on if
there is anything in the row immediately above it. If there is nothing
- there, the output is simple the interpolated snippets. If there is
+ there, the output is simply the interpolated snippets. If there is
something there (which would typically be a bound variable or a global
like in the example above) then it will append it as a method call on
that object (refer to the above example).</para>
@@ -258,14 +260,14 @@
</mediaobject>
</screenshot> The above shows how the Person ObjectType declaration
spans 2 columns in the spreadsheet, thus both constraints will appear as
- Person(age == ... , type == ...). As before, as only the field names are
- present in the snippet, they imply an equality test. <screenshot>
+ Person(age == ... , type == ...). As before, only the field names are
+ present in the snippet, implying an equality test. <screenshot>
<mediaobject>
<imageobject>
<imagedata fileref="with_param.png" />
</imageobject>
</mediaobject>
- </screenshot> The above condition example shows how you use
+ </screenshot> The above condition example shows how touse
interpolation to place the values in the snippet (in this case it would
result in Person(age == "42")).<screenshot>
<mediaobject>
@@ -273,26 +275,25 @@
<imagedata fileref="operator_completion.png" />
</imageobject>
</mediaobject>
- </screenshot> The above condition example show that if you put an
- operator on the end by itself, the values will be placed after the
+ </screenshot> The above condition example shows that if an operator is put on the end by itself, the values will be placed after the
operator automatically. <screenshot>
<mediaobject>
<imageobject>
<imagedata fileref="with_binding.png" />
</imageobject>
</mediaobject>
- </screenshot> You can of course put a binding in before the column
- (the constraints will be added from the cells below). You can put
- anything in the ObjectType row (eg it could be a pre condition for the
+ </screenshot> A binding can go in before the column
+ (the constraints will be added from the cells below).
+ Anything can go in the ObjectType row (eg it could be a pre condition for the
columns in the spreadsheet columns that follow).<screenshot>
<mediaobject>
<imageobject>
<imagedata fileref="consequence.png" />
</imageobject>
</mediaobject>
- </screenshot> This shows how the consequence could be done the by
+ </screenshot> This shows how the consequence could be done by
simple interpolation (just leave the cell above blank, the same applies
- to condition columns) - with this style you can put whatever you want in
+ to condition columns) - with this style anything can go in
the consequence (not just one method call).</para>
</section>
@@ -478,7 +479,7 @@
drools-decisiontables module. There is really only one class to look at:
SpreadsheetCompiler. This class will take spreadsheets in various formats,
and generate rules in DRL (which you can then use in the normal way). Also
- note that if you like you can just use the SpreadsheetComiler to generate
+ note that if you like you can just use the SpreadsheetCompiler to generate
partial rule files, and assemble it into a complete rule package after the
fact (this allows to you seperate technical and non technical aspects of
the rules if needed).</para>
Modified: labs/jbossrules/branches/irooskov_docs/drools-docs/drools-docs-userguide/en/Chapter-IDE/Section-QuickStart.xml
===================================================================
--- labs/jbossrules/branches/irooskov_docs/drools-docs/drools-docs-userguide/en/Chapter-IDE/Section-QuickStart.xml 2008-03-05 04:42:13 UTC (rev 18682)
+++ labs/jbossrules/branches/irooskov_docs/drools-docs/drools-docs-userguide/en/Chapter-IDE/Section-QuickStart.xml 2008-03-05 06:21:31 UTC (rev 18683)
@@ -16,11 +16,11 @@
<para>This guide will cover some of the features of JBoss Drools, in as far
as the IDE touches on them (it is assumed that the reader has some
familiarity with rule engines, and Drools in particular. It is important to
- note that none of the underlying features of the rule engine are dependent
+ note that none of the underlying features of the rule engine is dependent
on Eclipse, and integrators are free to use their tools of choice, as always
! Plenty of people use IntelliJ with rules, for instance.</para>
- <para>Note you can get the plug in either as a zip to download, or from an
+ <para>Note you can get the plugin either as a zip to download, or from an
update site (refer to the chapter on installation).</para>
<figure>
@@ -147,7 +147,8 @@
projects at all, this is just a convenience for people who are already
using eclipse as their Java IDE.</para>
- <para>Important note: The Drools plug in adds a "Drools Builder"
+<note>
+<para>The Drools plug in adds a "Drools Builder"
capability to your eclipse instance. This means you can enable a builder
on any project that will build and validate your rules when resources
change. This happens automatically with the Rule Project Wizard, but you
@@ -158,12 +159,13 @@
or put the large rules into .rule files, where you can still use the rule
editor, but it won't build them in the background - to fully validate the
rules you will need to run them in a unit test of course.</para>
+</note>
</section>
<section>
<title>Creating a new rule and wizards</title>
- <para>You can create a rule simple as an empty text ".drl" file, or use
+ <para>You can create a rule simply as an empty text ".drl" file, or use
the wizard to do so. The wizard menu can be invoked by Control+N, or
choosing it from the toolbar (there will be a menu with the JBoss Drools
icon).</para>
@@ -179,7 +181,7 @@
</figure>
<para>The wizard will ask for some basic options for generating a rule
- resource. These are just hints, you can change your mind later !. In terms
+ resource. These are just hints, you can change your mind later. In terms
of location, typically you would create a top level /rules directory to
store your rules if you are creating a rule project, and store it in a
suitably named subdirectory. The package name is mandatory, and is similar
@@ -196,9 +198,8 @@
</mediaobject>
</figure>
- <para>This result of this wizard is to generate a rule skeleton to work
- from. As with all wizards, they are candy: you don't have to use them if
- you don't want !</para>
+ <para>The purpose of this wizard is to generate a rule skeleton to work
+ from.</para>
</section>
<section>
@@ -268,7 +269,7 @@
</figure>
<para>
- To create a rule this way, use the wizard menu. It will create a instance of a .brl file and open an editor. The guided editor works based on a .package file in the same directory as the .brl file. In this "package" file - you have the package name and import statements - just like you would in the top of a normal DRL file. So the first time you create a brl rule - you will need to ppulate the package file with the fact classes you are interested in. Once you have this the guided editor will be able to prompt you with facts/fields and build rules graphically.
+ To create a rule this way, use the wizard menu. It will create an instance of a .brl file and open an editor. The guided editor works based on a .package file in the same directory as the .brl file. In this "package" file - you have the package name and import statements - just like you would in the top of a normal DRL file. So the first time you create a brl rule - you will need to populate the package file with the fact classes you are interested in. Once this has been done, the guided editor will be able to prompt you with facts/fields and build rules graphically.
</para>
<para>
@@ -288,7 +289,7 @@
<para>When debugging an application using a Drools engine, these views
can be used to check the state of the Drools engine itself: the Working
- Memory View, the Agenda View the Global Data View. To be able to use
+ Memory View, the Agenda View and the Global Data View. To be able to use
these views, create breakpoints in your code invoking the working memory.
For example, the line where you call workingMemory.fireAllRules() is a
good candidate. If the debugger halts at that joinpoint, you should select
@@ -422,7 +423,7 @@
<para>Open the log by clicking the Open Log action (first action in the
Audit View) and select the file. The Audit view now shows all events
- that where logged during the executing of the rules. There are different
+ that where logged during the execution of the rules. There are different
types of events (each with a different icon):</para>
<orderedlist>
Modified: labs/jbossrules/branches/irooskov_docs/drools-docs/drools-docs-userguide/en/Chapter-Install/Section-Checkout.xml
===================================================================
--- labs/jbossrules/branches/irooskov_docs/drools-docs/drools-docs-userguide/en/Chapter-Install/Section-Checkout.xml 2008-03-05 04:42:13 UTC (rev 18682)
+++ labs/jbossrules/branches/irooskov_docs/drools-docs/drools-docs-userguide/en/Chapter-Install/Section-Checkout.xml 2008-03-05 06:21:31 UTC (rev 18683)
@@ -93,7 +93,7 @@
- <para>Although, we highly recommend command line tools to work with repository you can also use both eclipse's integrated SVN client or TortoiseSVN</para>
+ <para>Although, we highly recommend command line tools to work with the repository, you can also use both eclipse's integrated SVN client or TortoiseSVN</para>
<para>Setup TortoiseSVN to checkout from the subversion repository and click
<literal>'OK'</literal> Once the checkout has finished you should see the
Modified: labs/jbossrules/branches/irooskov_docs/drools-docs/drools-docs-userguide/en/Chapter-Install/Section-Eclipse.xml
===================================================================
--- labs/jbossrules/branches/irooskov_docs/drools-docs/drools-docs-userguide/en/Chapter-Install/Section-Eclipse.xml 2008-03-05 04:42:13 UTC (rev 18682)
+++ labs/jbossrules/branches/irooskov_docs/drools-docs/drools-docs-userguide/en/Chapter-Install/Section-Eclipse.xml 2008-03-05 06:21:31 UTC (rev 18683)
@@ -6,7 +6,7 @@
<title>Generating Eclipse Projects</title>
<para>The drools project has eclipse projects checked in for convenience.
- However, these are originally generated by maven 2. If you have maven 2
+ However, these were originally generated by Maven 2. If you have Maven 2
installed, you can also regenerate the eclipse projects automatically, or
even generate it for IntelliJ etc, see the instructions below for this
(most people can ignore this section)</para>
@@ -17,8 +17,8 @@
<primary>eclipse</primary>
</indexterm>Eclipse projects, but it is not able to generate Eclipse
plugin projects. To generate the Eclipse projects for drools-core,
- drools-compiler and drools-jsr94 type <literal>'mvn
- eclipse:eclipse'</literal>.</para>
+ drools-compiler and drools-jsr94 type <command>'mvn
+ eclipse:eclipse'</command>.</para>
<screenshot>
<screeninfo>Start Maven Eclipse project generation</screeninfo>
@@ -47,7 +47,7 @@
<para>With the <indexterm>
<primary>eclipse</primary>
</indexterm>Eclispe project files generated they can now be imported
- into eclipse. When starting Eclipse open the workspace in the root of your
+ into eclipse. When starting Eclipse, open the workspace in the root of your
subversion checkout.</para>
<screenshot>
@@ -139,7 +139,7 @@
<section>
<title>Exporting the IDE Plugin</title>
- <para>The drools-ide project was checked out out using subversion and is
+ <para>The drools-ide project was checked out using subversion and is
ready for exporting.</para>
<screenshot>
@@ -182,7 +182,7 @@
</mediaobject>
</screenshot>
- <para>Once the plugin has been built open the output directory and copy
+ <para>Once the plugin has been built, open the output directory and copy
the jar to the Eclipse plugin directory.</para>
<screenshot>
@@ -206,7 +206,7 @@
</screenshot>
<para>At this point if Eclipse is already open it will need to be
- restarted. At which point you show now see the new Drools menu icon and
+ restarted. Now restarted, you should see the new Drools menu icon and
drl's should have icons and be provided with syntax highlighting and
intellisense.</para>
@@ -235,16 +235,19 @@
<title>Building the update site</title>
<para>There is also an update site for the plug in. For developers who
- want to update the update site (ha) you will need to get to the update
+ want to contribute to the update site, you will need to get to the update
site project (or create a new one). They are kept in SVN, but in
/jbossrules/update instead of /trunk. They are plain vanilla eclipse
feature and site projects.</para>
- <para>PLEASE REMEMBER that the plug in in the downloads directory, as a
- zip, should also be updated at the same time as the update site (as they
- are alternative ways ot getting the same plug in).</para>
+ <note>
+ <para>
+ PLEASE REMEMBER that the plug (.zip) in in the downloads directory should also be updated at the same time as the update site (as they
+ are alternative ways ot getting the same plug in).
+ </para>
+ </note>
- <para>Eclipse refreshing plugins in features and sites seems to not work,
+ <para>Eclipse refreshing plugins in features and sites can be temperamental,
so what is best is to manually edit the site.xml project and the
feature.xml. To do this, open the site.xml file in the drools-ide-update
project, it should look something like this: <programlisting><?xml version="1.0" encoding="UTF-8"?>
@@ -260,9 +263,9 @@
the name of the feature jar to have a new version number at the
end.</para>
- <para>Go into the /feature directory, and unzip the feature jar to get to
- the feature.xml. (the feature jar really just contains the feature.xml).
- Open the feature.xml, and it should look like: <programlisting><?xml version="1.0" encoding="UTF-8"?>
+ <para>Go into the <emphasis>feature</emphasis> directory, and unzip the feature jar to get to
+ the <filename>feature.xml</filename> (the feature jar really just contains the feature.xml).
+ Open <filename>feature.xml</filename>, and it should look like: <programlisting><?xml version="1.0" encoding="UTF-8"?>
<feature
id="org.drools.ide"
label="Drools Rule Workbench"
Modified: labs/jbossrules/branches/irooskov_docs/drools-docs/drools-docs-userguide/en/Chapter-Install/Section-Install.xml
===================================================================
--- labs/jbossrules/branches/irooskov_docs/drools-docs/drools-docs-userguide/en/Chapter-Install/Section-Install.xml 2008-03-05 04:42:13 UTC (rev 18682)
+++ labs/jbossrules/branches/irooskov_docs/drools-docs/drools-docs-userguide/en/Chapter-Install/Section-Install.xml 2008-03-05 06:21:31 UTC (rev 18683)
@@ -14,7 +14,7 @@
eclipse plugin is generally as simple as unzipping a file into your eclipse
plugin directory.</para>
- <para>Use of the eclipse plug in is not required. Rule files are just
+ <para>Use of the eclipse plugin is not required. Rule files are just
textual input (or spreadsheets as the case may be) and the IDE (also known
as the Rule Workbench) is just a convenience. People have integrated the
rule engine in many ways, there is no "one size fits all".</para>
@@ -80,13 +80,13 @@
spreadsheet parsing ability, and "antlr" which provides the parsing for
the rule language itself.</para>
- <para>NOTE: if you are using Drools in J2EE or servlet containers and you
+ <note>If you are using Drools in J2EE or servlet containers and you
come across classpath issues with "JDT", then you can switch to the janino
compiler. Set the system property "drools.compiler": For example:
- -Ddrools.compiler=JANINO.</para>
+ <example>-Ddrools.compiler=JANINO</example>.</note>
<para>For up to date info on dependencies in a release, consult the
- README_DEPENDENCIES.txt file, which can be found in the lib directory of
+ <filename>README_DEPENDENCIES.txt</filename> file, which can be found in the lib directory of
the download bundle, or in the root of the project directory.</para>
</section>
@@ -109,10 +109,10 @@
<para>The rule workbench (for Eclipse) requires that you have eclipse 3.2
or greater, as well as Eclipse GEF 3.2 or greater. You can install it
- either by downloading the plugin or, or using the update site.</para>
+ either by downloading the plugin or using the update site.</para>
<para>Another option is to use the JBoss IDE, which comes with all the
- plug in requirements pre packaged, as well as a choice of other tools
+ plugin requirements pre packaged, as well as a choice of other tools
separate to rules. You can choose just to install rules from the "bundle"
that JBoss IDE ships with.</para>
@@ -120,11 +120,11 @@
<title>Installing GEF (a required dependency)</title>
<para>GEF is the eclipse Graphical Editing Framework, which is used for
- graph viewing components in the plug in.</para>
+ graph viewing components in the plugin.</para>
<para>If you don't have GEF installed, you can install it using the
built in update mechanism (or downloading GEF from the eclipse.org
- website not recommended). JBoss IDE has GEF already, as do many other "distributions" of
+ website; not recommended). JBoss IDE has GEF already, as do many other "distributions" of
Eclipse, so this step may be redundant for some people.</para>
<para>First you open the Help->Software updates->Find and install
@@ -141,7 +141,7 @@
</mediaobject>
</screenshot>
- <para>Next you choose the GEF plug in:</para>
+ <para>Next you choose the GEF plugin:</para>
<screenshot>
<mediaobject>
@@ -151,9 +151,9 @@
</mediaobject>
</screenshot>
- <para>Press next, and agree to install the plug in (an eclipse restart
+ <para>Press next, and agree to install the plugin (an eclipse restart
may be required). Once this is completed, then you can continue on
- installing the rules plug in.</para>
+ installing the rules plugin.</para>
</section>
<section>
@@ -168,15 +168,15 @@
<section>
<title>Installing from the update site</title>
- <para>Using the update site is a handy way to install the plug in, and
+ <para>Using the update site is a handy way to install the plugin, and
keep it up to date (the eclipse platform will check for updates as
needed). It gives you a good chance of staying up to date with
improvements, fixes etc.</para>
- <para>Some firewalls may cause trouble with using update sites in
+ <para>Some firewalls may cause trouble when using update sites in
eclipse, if you have issues, then install it manually from the plugin.
- Also, if you have previously installed the plug in manually, you will
- need to manually remove it from your plug in directory.</para>
+ Also, if you have previously installed the plugin manually, you will
+ need to manually remove it from your plugin directory.</para>
<para>Step 1. Use the eclipse help menu to find the feature installer.
<screenshot>
@@ -189,9 +189,8 @@
</mediaobject>
</screenshot></para>
- <para>Step 2: Choose the option for installing a new feature (obviously
- in future, if you want to check for updates, you use the other option
- !). <screenshot>
+ <para>Step 2: Choose the option for installing a new feature (
+ in the future, if you want to check for updates, you will use the "Search for updates of the currently installed features" option). <screenshot>
<screeninfo>Search for new features</screeninfo>
<mediaobject>
@@ -249,7 +248,7 @@
<para>Step 7: The license agreement. Choose the option to accept the
license agreement. Once this happens, the workbench will start
- downloading. Might be an opportune time to go have a coffee. <screenshot>
+ downloading. This may take several minutes. <screenshot>
<screeninfo>License</screeninfo>
<mediaobject>
@@ -292,7 +291,7 @@
</mediaobject>
</screenshot></para>
- <para>Now go have another coffee, and then take a look at the chapter on
+ <para>This may be an opportune time to take a look at the chapter on
the Rule Workbench for what you can do with it.</para>
</section>
</section>
Modified: labs/jbossrules/branches/irooskov_docs/drools-docs/drools-docs-userguide/en/Chapter-Install/Section-Maven_build.xml
===================================================================
--- labs/jbossrules/branches/irooskov_docs/drools-docs/drools-docs-userguide/en/Chapter-Install/Section-Maven_build.xml 2008-03-05 04:42:13 UTC (rev 18682)
+++ labs/jbossrules/branches/irooskov_docs/drools-docs/drools-docs-userguide/en/Chapter-Install/Section-Maven_build.xml 2008-03-05 06:21:31 UTC (rev 18683)
@@ -6,24 +6,27 @@
<title>Building the Source</title>
<para>Now that we have the source the next step is to build and install
- the source. Since version 3.1 Drools uses <indexterm> Maven 2 </indexterm> to build the system. There are two profiles
+ the source. Since version 3.1 Drools uses Maven 2 to build the system. There are two profiles
available which enable the associated modules "documentation" and
"eclipse"; this enables quicker building of the core modules for
developers. The eclipse profile will download eclipse into the
- drools-eclipse folder, which is over 100MB download (It depends on your operating system), however this only
- needs to be done once; if you wish you can move that eclipse download into
+ drools-eclipse folder. This download can be over 100MB depending on your operating system, however this only
+ needs to be done once. If you wish you can move that eclipse download into
another location and specify it with
-DlocalEclipseDrop=/folder/jboss-rules/local-eclipse-drop-mirror. The
following builds all the jars, the documentation and the eclipse zip with
a local folder specified to avoid downloading eclipse:</para>
- <para><programlisting>mvn -Declipse -Ddocumentation clean install -DlocalEclipseDrop=/folder/jboss-rules/local-eclipse-drop-mirror </programlisting></para>
+<screen>
+mvn -Declipse -Ddocumentation clean install -DlocalEclipseDrop=/folder/jboss-rules/local-eclipse-drop-mirror
+</screen>
<para>You can produce distribution builds, which puts everything into
- zips, as follows:
-<programlisting>mvn -Declipse -Ddocumentation clean install -DlocalEclipseDrop=/folder/jboss-rules/local-eclipse-drop-mirror
+ zips, as follows:</para>
+<screen>
+mvn -Declipse -Ddocumentation clean install -DlocalEclipseDrop=/folder/jboss-rules/local-eclipse-drop-mirror
mvn -Ddocumentation -Declipse -Dmaven.test.skip package javadoc:javadoc assembly:assembly -DlocalEclipseDrop=/folder/jboss-rules/local-eclipse-drop-mirror
-</programlisting></para>
+</screen>
<para>Note that install must be done first as javadoc:javadoc won't work
unless the jars are in the local maven repo, but the tests can be skipped
@@ -57,7 +60,7 @@
<para>
The building of the manual is now integrated into the maven build process, and is built by either using the profile (-Ddocumentation) switch or
- cding into the main directory. The manual can still be built from ant command line too by cding into the documentation/manual itself.
+ coding into the main directory. The manual can still be built from ant command line too by cding into the documentation/manual itself.
</para>
<para>Drools uses <indexterm>
Modified: labs/jbossrules/branches/irooskov_docs/drools-docs/drools-docs-userguide/en/Chapter-Install/Section-Setup.xml
===================================================================
--- labs/jbossrules/branches/irooskov_docs/drools-docs/drools-docs-userguide/en/Chapter-Install/Section-Setup.xml 2008-03-05 04:42:13 UTC (rev 18682)
+++ labs/jbossrules/branches/irooskov_docs/drools-docs/drools-docs-userguide/en/Chapter-Install/Section-Setup.xml 2008-03-05 06:21:31 UTC (rev 18683)
@@ -2,14 +2,13 @@
<section>
<title>Setup from source</title>
- <para>As Drools is an open source project, instructions for building from
- source are part of the manual ! Building from source means you can stay on
+ <para>As Drools is an open source project, instructions for building from the
+ source code is part of the manual. Building from source means you can stay on
top with the latest features. Whilst aspects of Drools are quite
complicated, many users have found ways to become contributors.</para>
- <para>Drools works with JDK1.5 and above. you will need also need to have
- the following tools installed. Minimum requirement version numbers
- provided.</para>
+ <para>Drools works with JDK1.5 and above and you will need to have
+ the following tools installed, with the minimum requirement version numbers listed below.</para>
<itemizedlist>
<listitem>
Modified: labs/jbossrules/branches/irooskov_docs/drools-docs/drools-docs-userguide/en/Chapter-Rule_Engine/Section-The_Drools_Rule_Engine.xml
===================================================================
--- labs/jbossrules/branches/irooskov_docs/drools-docs/drools-docs-userguide/en/Chapter-Rule_Engine/Section-The_Drools_Rule_Engine.xml 2008-03-05 04:42:13 UTC (rev 18682)
+++ labs/jbossrules/branches/irooskov_docs/drools-docs/drools-docs-userguide/en/Chapter-Rule_Engine/Section-The_Drools_Rule_Engine.xml 2008-03-05 06:21:31 UTC (rev 18683)
@@ -451,7 +451,7 @@
<title>Shadow Facts</title>
<para>A shadow fact is a shallow copy of an asserted object. Shadow
- facts are cached copies of object asserted to the working memory. The
+ facts are cached copies of objects asserted to the working memory. The
term shadow facts is commonly known as a feature of JESS (Java Expert
System Shell).</para>
@@ -481,13 +481,13 @@
<para>Although shadow facts are a great way of ensuring the engine
integrity, they add some overhead to the the reasoning process. As so,
Drools 4.0 supports fine grained control over them with the ability to
- enable/disable them for each individual class. To disable shadow fact
- for all classes set the following property in a configuration file or
+ enable/disable them for each individual class. To disable shadow facts
+ for all classes, set the following property in a configuration file or
system property:</para>
<programlisting>drools.shadowProxy = false</programlisting>
- <para>Alternatively, it is possible to disable through an API
+ <para>Alternatively, it is possible to disable them through an API
call:</para>
<programlisting>RuleBaseConfiguration conf = new RuleBaseConfiguration();
@@ -504,14 +504,14 @@
<para>As shown above, a space separated list is used to specify more
than one class, and '*' is used as a wild card.</para>
- <remark>IMPORTANT: disabling shadow facts for a class inhibits the
- ability of the engine keep track of changes to that class attributes. It
+ <important>Disabling shadow facts for a class inhibits the
+ ability of the engine to keep track of changes to that classes attributes. It
means, once asserted, a fact of that class MUST NOT change any of its
attributes or the engine may start to present unpredictable behavior. It
does not help to use update(). The only way to safely change an
attribute of a fact whose shadow fact is disabled is to call
modifyRetract() before changing the attribute, change the attribute and
- call modifyAssert().</remark>
+ call modifyAssert().</important>
</section>
<section>
@@ -528,8 +528,8 @@
<programlisting>Cheese stilton = new Cheese("stilton");
FactHandle stiltonHandle = workingMemory.insert( stilton, true ); //specifies that this is a dynamic fact </programlisting>
- <para>To make a JavaBean dynamic add a PropertyChangeSupport field
- memory along with two add/remove mothods and make sure that each setter
+ <para>To make a JavaBean dynamic, add a PropertyChangeSupport field
+ memory along with two add/remove methods and make sure that each setter
notifies the PropertyChangeSupport instance of the change.</para>
<programlisting>private final PropertyChangeSupport changes = new PropertyChangeSupport( this );
@@ -567,7 +567,7 @@
external source). For instance, if a new working memory is created, and
no facts are asserted, calling the fireAllRules will cause the Initial
Fact to propagate, possibly activating rules (otherwise, nothing would
- happen as there area no other facts to start with).</para>
+ happen as there are no other facts to start with).</para>
</section>
</section>
@@ -631,7 +631,7 @@
calling fireAllRules() at the end; session finished. Should the session
need access to any results information they can use the executeWithResults
method, which returns a StatelessSessionResult. The reason for this is in
- remoting situations you do not always want the return payload, so this way
+ remote situations you do not always want the return payload, so this way
its optional.</para>
<para>setAgendaFilter, setGlobal and setGlobalResolver share their state
@@ -775,11 +775,11 @@
<section>
<title>Agenda Groups</title>
- <para>Agenda groups are a way to partition rules (activations, actually)
+ <para>Agenda groups are a way to partition rules (activations)
on the agenda. At any one time, only one group has "focus" which means
that the activations for rules in that group will only take effect - you
can also have rules "auto focus" which means the focus for its agenda
- group is taken when that rules conditions are true.</para>
+ group is taken when the conditions for the rule are true.</para>
<para>They are sometimes known as "modules" in CLIPS terminology. Agenda
groups are a handy way to create a "flow" between grouped rules. You can
@@ -790,7 +790,7 @@
<para>Each time setFocus(...) is called it pushes that Agenda Group onto
a stack, when the focus group is empty it is popped off and the next one
- of the stack evaluates. An Agenda Group can appear in multiple locations
+ on the stack is evaluated. An Agenda Group can appear in multiple locations
on the stack. The default Agenda Group is "MAIN", all rules which do not
specify an Agenda Group are placed there, it is also always the first
group on the Stack and given focus as default.</para>
@@ -869,7 +869,7 @@
"WM_BEHAVIOR_PRESERVE". When the property is set to discard we use the
existing handle and replace the existing instance with the new Object -
this is the default behavior - otherwise we override it to STATED but we
- create an new FactHandle.</para>
+ create a new FactHandle.</para>
<para>This can be confusing on a first read, so hopefully the flow charts
below help. When it says that it returns a new FactHandle, this also
@@ -933,7 +933,7 @@
manageable.</para>
</section>
- <section>
+ <important>
<title>Important note: Equality for Java objects</title>
<para>It is important to note that for Truth Maintenance (and logical
@@ -947,13 +947,13 @@
true for each other and if their hashCode methods return the same
values. See the Java API for more details (but do keep in mind you MUST
override both equals and hashCode).</para>
- </section>
+ </important>
</section>
<section>
<title>Event Model</title>
- <para>The event package provides means to be notified of rule engine
+ <para>The event package provides the means to be notified of rule engine
events, including rules firing, objects being asserted, etc. This allows
you to separate out logging/auditing activities from the main part of your
application (and the rules) - as events are a cross cutting
@@ -1015,7 +1015,7 @@
DefaultAgendaEventListener, DefaultWorkingMemoryEventListener,
DefaultRuleFlowEventListener. The following shows how to extend
DefaultAgendaEventListener and add it to the session - the example prints
- statements for only when rules are fired:</para>
+ statements only when rules are fired:</para>
<programlisting>session.addEventListener( new DefaultAgendaEventListener() {
public void afterActivationFired(AfterActivationFiredEvent event) {
@@ -1048,7 +1048,7 @@
<orderedlist>
<listitem>
<para>Order the Rules by salience and position in the ruleset (just
- sets a sequence attribute on the rule terminal node). 4</para>
+ sets a sequence attribute on the rule terminal node).</para>
</listitem>
<listitem>
@@ -1069,7 +1069,7 @@
<listitem>
<para>Assert all objects, when all assertions are finished and thus
- right-input node memories are populated check the Command list and
+ right-input node memories are populated, check the Command list and
execute each in turn.</para>
</listitem>
@@ -1080,7 +1080,7 @@
</listitem>
<listitem>
- <para>Iterate the array of Activations, executing populated element in
+ <para>Iterate through the array of Activations, executing each populated element in
turn.</para>
</listitem>
@@ -1092,7 +1092,7 @@
</orderedlist>
<para>The LeftInputAdapterNode no longer creates a Tuple, adding the
- Object, and then propagate the Tuple – instead a Command Object is created
+ Object, and then propagating the Tuple – instead a Command Object is created
and added to a list in the Working Memory. This Command Object holds a
reference to the LeftInputAdapterNode and the propagated Object. This
stops any left-input propagations at insertion time, so that we know that
@@ -1108,12 +1108,15 @@
as we know there will be no further object assertions and thus
propagations into the right-input memory.</para>
- <para>There is no longer an Agenda, with a priority queue to schedule the
+ <para>There is no longer an Agenda, with a priority queue to schedule
+the
Tuples, instead there is simply an array for the number of rules. The
sequence number of the RuleTerminalNode indicates the element with the
- array to place the Activation. Once all Command Objects have finished we
+ array to place the Activation. Once all Command Objects have finished
+we
can iterate our array checking each element in turn and firing the
- Activations if they exist. To improve performance in the array we remember
+ Activations if they exist. To improve performance in the array we
+remember to
record the first and last populated cells. The network is constructed
where each RuleTerminalNode is given a sequence number, based on a
salience number and its order of being added to the network.</para>
@@ -1121,7 +1124,7 @@
<para>Typically the right-input node memories are HashMaps, for fast
Object retraction, as we know there will be no Object retractions, we can
use a list when the values of the Object are not indexed. For larger
- numbers of Objects indexed HashMaps provide a performance increase; if we
+ numbers of indexed Objects, HashMaps provide a performance increase; if we
know an Object type has a low number of instances then indexing is
probably not of an advantage and an Object list can be used.</para>
More information about the jboss-svn-commits
mailing list