[jboss-svn-commits] JBL Code SVN: r18907 - in labs/jbossrules/branches/irooskov_docs/drools-docs: drools-docs-referenceguide/en/Chapter-Examples and 7 other directories.
jboss-svn-commits at lists.jboss.org
jboss-svn-commits at lists.jboss.org
Wed Mar 12 20:48:17 EDT 2008
Author: irooskov at redhat.com
Date: 2008-03-12 20:48:17 -0400 (Wed, 12 Mar 2008)
New Revision: 18907
Modified:
labs/jbossrules/branches/irooskov_docs/drools-docs/drools-docs-referenceguide/en/Chapter-Decision_Tables/Section-Spreadsheet.xml
labs/jbossrules/branches/irooskov_docs/drools-docs/drools-docs-referenceguide/en/Chapter-Examples/Section-Examples.xml
labs/jbossrules/branches/irooskov_docs/drools-docs/drools-docs-referenceguide/en/Chapter-Rule_Engine/Section-Rete_Algorithm.xml
labs/jbossrules/branches/irooskov_docs/drools-docs/drools-docs-referenceguide/en/Chapter-Rule_Engine/Section-Rules.xml
labs/jbossrules/branches/irooskov_docs/drools-docs/drools-docs-referenceguide/en/Chapter-Rule_Language/Section-DSL.xml
labs/jbossrules/branches/irooskov_docs/drools-docs/drools-docs-referenceguide/en/Chapter-Rule_Language/Section-Function.xml
labs/jbossrules/branches/irooskov_docs/drools-docs/drools-docs-referenceguide/en/Chapter-Rule_Language/Section-Package.xml
labs/jbossrules/branches/irooskov_docs/drools-docs/drools-docs-referenceguide/en/Chapter-Rule_Language/Section-Rule.xml
labs/jbossrules/branches/irooskov_docs/drools-docs/drools-docs-referenceguide/en/Chapter-Rule_Language/Section-RuleFlow.xml
labs/jbossrules/branches/irooskov_docs/drools-docs/drools-docs-referenceguide/en/Chapter-Rule_Language/Section-XML.xml
labs/jbossrules/branches/irooskov_docs/drools-docs/drools-docs-release_notes/en/Chapter-Release_Notes/Section-Upgrade_tips.xml
labs/jbossrules/branches/irooskov_docs/drools-docs/drools-docs-userguide/en/Chapter-Deployment/Section-Deployment.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-Rule_Engine/Section-The_Drools_Rule_Engine.xml
Log:
updated with jira fixes that were applied to the trunk doco
Modified: labs/jbossrules/branches/irooskov_docs/drools-docs/drools-docs-referenceguide/en/Chapter-Decision_Tables/Section-Spreadsheet.xml
===================================================================
--- labs/jbossrules/branches/irooskov_docs/drools-docs/drools-docs-referenceguide/en/Chapter-Decision_Tables/Section-Spreadsheet.xml 2008-03-13 00:25:01 UTC (rev 18906)
+++ labs/jbossrules/branches/irooskov_docs/drools-docs/drools-docs-referenceguide/en/Chapter-Decision_Tables/Section-Spreadsheet.xml 2008-03-13 00:48:17 UTC (rev 18907)
@@ -177,7 +177,7 @@
case, it will generate: Person(age=="42") etc (where 42 comes from row
18). In the above example, the "==" is implicit (if you just put a field
name, it will assume that you are looking for exact matches). Also note
- that you can have a ObjectType declaration span columns (via merged cells)
+ that you can have an ObjectType declaration span columns (via merged cells)
- and that means that all columns below the merged range will be combined
into the one set of constraints.</para>
@@ -341,7 +341,7 @@
<entry>Import</entry>
<entry>The cell to the right contains a comma separated list of
- java classes to import</entry>
+ Java classes to import</entry>
<entry>optional</entry>
</row>
@@ -420,7 +420,7 @@
<entry>Variables</entry>
<entry>The cell immediately to the right can contain global
- declarations which drools supports. This is a type, followed by a
+ declarations which Drools supports. This is a type, followed by a
variable name. (if multiple variables are needed, comma separate
them).</entry>
@@ -485,7 +485,7 @@
the rules if needed).</para>
<para>To get started, you can find a sample spreadsheet and base it on
- that. Alternatively, if you are using the plug in (Rule Workbench IDE) the
+ that. Alternatively, if you are using the plug-in (Rule Workbench IDE) the
wizard can generate a spreadsheet for you from a template (to edit it you
will need to use an xls compatible spreadsheet editor). <screenshot>
<screeninfo>Wizard in the IDE</screeninfo>
@@ -578,4 +578,5 @@
http://www.drools.org/Business+rules+in+decision+tables+explained</para>
</section>
</section>
+
</section>
\ No newline at end of file
Modified: labs/jbossrules/branches/irooskov_docs/drools-docs/drools-docs-referenceguide/en/Chapter-Examples/Section-Examples.xml
===================================================================
--- labs/jbossrules/branches/irooskov_docs/drools-docs/drools-docs-referenceguide/en/Chapter-Examples/Section-Examples.xml 2008-03-13 00:25:01 UTC (rev 18906)
+++ labs/jbossrules/branches/irooskov_docs/drools-docs/drools-docs-referenceguide/en/Chapter-Examples/Section-Examples.xml 2008-03-13 00:48:17 UTC (rev 18907)
@@ -31,7 +31,7 @@
PackageBuilder builder = new PackageBuilder();
-//this wil parse and compile in one step
+//this will parse and compile in one step
builder.addPackageFromDrl( source );
// Check the builder for errors
Modified: labs/jbossrules/branches/irooskov_docs/drools-docs/drools-docs-referenceguide/en/Chapter-Rule_Engine/Section-Rete_Algorithm.xml
===================================================================
--- labs/jbossrules/branches/irooskov_docs/drools-docs/drools-docs-referenceguide/en/Chapter-Rule_Engine/Section-Rete_Algorithm.xml 2008-03-13 00:25:01 UTC (rev 18906)
+++ labs/jbossrules/branches/irooskov_docs/drools-docs/drools-docs-referenceguide/en/Chapter-Rule_Engine/Section-Rete_Algorithm.xml 2008-03-13 00:48:17 UTC (rev 18907)
@@ -41,8 +41,7 @@
it. This way, if an application asserts a new account, it won't propagate to
the nodes for the Order object. In Drools when an object is asserted it
retrieves a list of valid ObjectTypesNodes via a lookup in a HashMap from
- the object's Class; if this list doesn't exist it scans all the ObjectTypde
- nodes finding valid matches which it caches in the list. This enables Drools
+ the object's Class; if this list doesn't exist it scans all the ObjectTypeNodes finding valid matches which it caches in the list. This enables Drools
to match against any Class type that matches with an
<literal>instanceof</literal> check.</para>
@@ -78,10 +77,10 @@
</mediaobject>
</figure>
- <para>Drools extends Rete by optimizing the propagation from ObjectTypdeNode
+ <para>Drools extends Rete by optimizing the propagation from ObjectTypeNode
to AlphaNode using hashing. Each time an AlphaNode is added to an
- ObjectTypdeNode it adds the literal value as a key to the HashMap with the
- AlphaNode as the value. When a new instance enters the ObjectTypde node,
+ ObjectTypeNode it adds the literal value as a key to the HashMap with the
+ AlphaNode as the value. When a new instance enters the ObjectType node,
rather than propagating to each AlphaNode, it can instead retrieve the
correct AlphaNode from the HashMap - avoiding unnecessary literal
checks.</para>
Modified: labs/jbossrules/branches/irooskov_docs/drools-docs/drools-docs-referenceguide/en/Chapter-Rule_Engine/Section-Rules.xml
===================================================================
--- labs/jbossrules/branches/irooskov_docs/drools-docs/drools-docs-referenceguide/en/Chapter-Rule_Engine/Section-Rules.xml 2008-03-13 00:25:01 UTC (rev 18906)
+++ labs/jbossrules/branches/irooskov_docs/drools-docs/drools-docs-referenceguide/en/Chapter-Rule_Engine/Section-Rules.xml 2008-03-13 00:48:17 UTC (rev 18907)
@@ -314,6 +314,7 @@
private String studentName;
private int score;
+ }
</programlisting>
<para>Java is Turing complete in that you can write code, among other
@@ -345,7 +346,7 @@
<programlisting>
- select
+select
*
from
Students s
Modified: labs/jbossrules/branches/irooskov_docs/drools-docs/drools-docs-referenceguide/en/Chapter-Rule_Language/Section-DSL.xml
===================================================================
--- labs/jbossrules/branches/irooskov_docs/drools-docs/drools-docs-referenceguide/en/Chapter-Rule_Language/Section-DSL.xml 2008-03-13 00:25:01 UTC (rev 18906)
+++ labs/jbossrules/branches/irooskov_docs/drools-docs/drools-docs-referenceguide/en/Chapter-Rule_Language/Section-DSL.xml 2008-03-13 00:48:17 UTC (rev 18907)
@@ -67,7 +67,7 @@
part on the right of the "=" is the mapping into the rule language (of
course the form of this depends on if you are talking about the RHS or the
LHS - if its the LHS, then its the normal LHS syntax, if its the RHS then
- its fragments of java code for instance).</para>
+ its fragments of Java code for instance).</para>
<para>The parser will take the expression you specify, and extract the
values that match where the {something} (named Tokens) appear in the
Modified: labs/jbossrules/branches/irooskov_docs/drools-docs/drools-docs-referenceguide/en/Chapter-Rule_Language/Section-Function.xml
===================================================================
--- labs/jbossrules/branches/irooskov_docs/drools-docs/drools-docs-referenceguide/en/Chapter-Rule_Language/Section-Function.xml 2008-03-13 00:25:01 UTC (rev 18906)
+++ labs/jbossrules/branches/irooskov_docs/drools-docs/drools-docs-referenceguide/en/Chapter-Rule_Language/Section-Function.xml 2008-03-13 00:48:17 UTC (rev 18907)
@@ -15,7 +15,7 @@
</figure>
<para>Functions are a way to put semantic code in your rule source file, as
- opposed to in normal java classes. They can't do anything more then what you
+ opposed to in normal Java classes. They can't do anything more then what you
can do with helper classes (in fact, the compiler generates the helper class
for you behind the scenes). The main advantage of using functions in a rule
is that you can keep the logic all in one place, and you can change the
@@ -33,7 +33,7 @@
</programlisting>
<para>Note that the "function" keyword is used, even though its not really
- part of java. Parameters to the function are just like a normal method (and
+ part of Java. Parameters to the function are just like a normal method (and
you don't have to have parameters if they are not needed). Return type is
just like a normal method.</para>
Modified: labs/jbossrules/branches/irooskov_docs/drools-docs/drools-docs-referenceguide/en/Chapter-Rule_Language/Section-Package.xml
===================================================================
--- labs/jbossrules/branches/irooskov_docs/drools-docs/drools-docs-referenceguide/en/Chapter-Rule_Language/Section-Package.xml 2008-03-13 00:25:01 UTC (rev 18906)
+++ labs/jbossrules/branches/irooskov_docs/drools-docs/drools-docs-referenceguide/en/Chapter-Rule_Language/Section-Package.xml 2008-03-13 00:48:17 UTC (rev 18907)
@@ -21,7 +21,7 @@
<para>The following rail road diagram shows all the components that may make
up a package. Note that a package MUST have a namespace and be declared
- using standard java conventions for package names; i.e. no spaces, unlike
+ using standard Java conventions for package names; i.e. no spaces, unlike
rule names which allow spaces. In terms of the order of elements, they can
appear in any order in the rule file, with the exception of the "package"
and "expander" statements being at the top of the file, before any rules
@@ -55,7 +55,7 @@
<para>Import statements work like import statements in Java. You need to
specify the fully qualified paths and type names for any objects you want
to use in the rules. Drools automatically imports classes from the same
- named java package and from the java.lang package.</para>
+ named Java package and from the java.lang package.</para>
</section>
<section>
Modified: labs/jbossrules/branches/irooskov_docs/drools-docs/drools-docs-referenceguide/en/Chapter-Rule_Language/Section-Rule.xml
===================================================================
--- labs/jbossrules/branches/irooskov_docs/drools-docs/drools-docs-referenceguide/en/Chapter-Rule_Language/Section-Rule.xml 2008-03-13 00:25:01 UTC (rev 18906)
+++ labs/jbossrules/branches/irooskov_docs/drools-docs/drools-docs-referenceguide/en/Chapter-Rule_Language/Section-Rule.xml 2008-03-13 00:48:17 UTC (rev 18907)
@@ -480,7 +480,7 @@
<title>JavaBeans as facts</title>
<para>A field is an accessible method on the object. If your model
- objects follow the java bean pattern, then fields are exposed using
+ objects follow the Java bean pattern, then fields are exposed using
"getXXX" or "isXXX" methods (these are methods that take no
arguments, and return something). You can access fields either by
using the bean-name convention (so "getType" can be accessed as
@@ -607,7 +607,7 @@
</indexterm>Regular Expression. Typically that regexp is a
String, but variables that resolve to a valid regexp are also
allowed. It is important to note that <emphasis>different from
- java</emphasis>, if you write a String regexp directly on the
+ Java</emphasis>, if you write a String regexp directly on the
source file, <emphasis>you don't need to escape '\'</emphasis>.
Example:</para>
@@ -627,7 +627,7 @@
fields. Returns true when the match is false. Typically that
regexp is a String, but variables that resolve to a valid regexp
are also allowed.It is important to note that
- <emphasis>different from java</emphasis>, if you write a String
+ <emphasis>different from Java</emphasis>, if you write a String
regexp directly on the source file, <emphasis>you don't need to
escape '\'</emphasis>. Example:</para>
@@ -751,7 +751,7 @@
<simplesect>
<title>Numeric</title>
- <para>All standard java numeric primitives are supported.</para>
+ <para>All standard Java numeric primitives are supported.</para>
<example>
<title>Numeric Literal Restriction</title>
@@ -851,7 +851,7 @@
<para>'likes' is our variable, our Declaration, that is bound to
the favouriteCheese field for any matching Person instance and
is used to constrain the type of Cheese in the following
- Pattern. Any valid java variable name can be used, including
+ Pattern. Any valid Java variable name can be used, including
'$'; which you will often see used to help differentiate
declarations from fields. The example below shows a declaration
bound to the Patterns Object Type instance itself and used with
@@ -1530,7 +1530,7 @@
<para>The <emphasis role="bold">collect</emphasis> CE result pattern can
be any concrete class that implements tha java.util.Collection interface
and provides a default no-arg public constructor. I.e., you can use
- default java collections like ArrayList, LinkedList, HashSet, etc, or
+ default Java collections like ArrayList, LinkedList, HashSet, etc, or
your own class, as long as it implements the java.util.Collection
interface and provide a default no-arg public constructor.</para>
@@ -1675,7 +1675,7 @@
result with the Number() pattern and if the double value is greater than
100, the rule will fire.</para>
- <para>The example used java as the semantic dialect, and as such, note
+ <para>The example used Java as the semantic dialect, and as such, note
that the usage of ';' is mandatory in the init, action and reverse code
blocks. The result is an expression and as such, it does not admit ';'.
If the user uses any other dialect, he must comply to that dialect
@@ -1775,7 +1775,7 @@
needed, custom, domain specific functions can easily be added to the
engine and rules can start to use them without any restrictions. To
implement a new Accumulate Functions all one needs to do is to create
- a java class that implements the
+ a Java class that implements the
org.drools.base.acumulators.AccumulateFunction interface and add a
line to the configuration file or set a system property to let the
engine know about the new function. As an example of an Accumulate
@@ -1919,7 +1919,7 @@
cuts to the KnowldgeHelper instance (refer to the KnowledgeHelper
interface for more advanced operations). The KnowledgeHelper interface is
made available to the RHS code block as a variable called "drools". If you
- provide "Property Change Listeners" to your java beans that you are
+ provide "Property Change Listeners" to your Java beans that you are
inserting into the engine, you can avoid the need to call "update" when
the object changes.</para>
</section>
Modified: labs/jbossrules/branches/irooskov_docs/drools-docs/drools-docs-referenceguide/en/Chapter-Rule_Language/Section-RuleFlow.xml
===================================================================
--- labs/jbossrules/branches/irooskov_docs/drools-docs/drools-docs-referenceguide/en/Chapter-Rule_Language/Section-RuleFlow.xml 2008-03-13 00:25:01 UTC (rev 18906)
+++ labs/jbossrules/branches/irooskov_docs/drools-docs/drools-docs-referenceguide/en/Chapter-Rule_Language/Section-RuleFlow.xml 2008-03-13 00:48:17 UTC (rev 18907)
@@ -80,7 +80,7 @@
<title>How to build a rule flow</title>
<para>Ruleflows can only be created by using the graphical ruleflow editor which is
- part of the Drools plugin for Eclipse. Once you have set up a Drools project (check
+ part of the Drools plug-in for Eclipse. Once you have set up a Drools project (check
the IDE chapter if you do not know how to do this), you can start adding ruleflows.
When in a project, use "control+N" to launch the new wizard, or right-click the directory
you would like to put your ruleflow in and select "New ... Other ...":</para>
@@ -102,7 +102,7 @@
<para>Next you will see the graphical ruleflow editor. Now would be a good time to
switch to the "Drools perspective" (if you haven't done so already) - this will tweak the UI so
it is optimal for rules. Then ensure that you can see the "properties"
- panel down the bottom of the eclipse window, as it will be necessary to fill in the different
+ panel down the bottom of the Eclipse window, as it will be necessary to fill in the different
properties of the elements in your ruleflow. If you cannot see the properties view, open it using
the Menu Window - Show View - Other ..., and under the General folder select the Properties view.</para>
Modified: labs/jbossrules/branches/irooskov_docs/drools-docs/drools-docs-referenceguide/en/Chapter-Rule_Language/Section-XML.xml
===================================================================
--- labs/jbossrules/branches/irooskov_docs/drools-docs/drools-docs-referenceguide/en/Chapter-Rule_Language/Section-XML.xml 2008-03-13 00:25:01 UTC (rev 18906)
+++ labs/jbossrules/branches/irooskov_docs/drools-docs/drools-docs-referenceguide/en/Chapter-Rule_Language/Section-XML.xml 2008-03-13 00:48:17 UTC (rev 18907)
@@ -33,7 +33,7 @@
between XML formats). Note you can always generate normal DRL as
well.</para>
- <para>Alternatively you may be embedding drools in a product that already
+ <para>Alternatively you may be embedding Drools in a product that already
uses XML for configuration, so you would like the rules to be in an XML
format. You may be creating your own rule language on XML - note that you
can always use the AST objects directly to create your own rule language
@@ -283,7 +283,7 @@
specify a type (class) and perhaps bind a variable to an instance of that
class. Nested under the pattern object are constraints and conditional
elements that have to be met. The Predicate and Return Value constraints
- allow java expressions to be embedded.</para>
+ allow Java expressions to be embedded.</para>
<para>That leaves the conditional elements, not, exists, and, or etc. They
work like their DRL counterparts. Elements that are nested under and an
@@ -292,7 +292,7 @@
for the existence or non existence of a fact meeting its
constraints.</para>
- <para>The Eval element allows the execution of a valid snippet of java
+ <para>The Eval element allows the execution of a valid snippet of Java
code - as long as it evaluates to a boolean (do not end it with a
semi-colon, as it is just a fragment) - this can include calling a
function. The Eval is less efficient then then columns, as the rule engine
Modified: labs/jbossrules/branches/irooskov_docs/drools-docs/drools-docs-release_notes/en/Chapter-Release_Notes/Section-Upgrade_tips.xml
===================================================================
--- labs/jbossrules/branches/irooskov_docs/drools-docs/drools-docs-release_notes/en/Chapter-Release_Notes/Section-Upgrade_tips.xml 2008-03-13 00:25:01 UTC (rev 18906)
+++ labs/jbossrules/branches/irooskov_docs/drools-docs/drools-docs-release_notes/en/Chapter-Release_Notes/Section-Upgrade_tips.xml 2008-03-13 00:48:17 UTC (rev 18907)
@@ -178,7 +178,7 @@
substantiating it as a safe tool to use for upgrading large sets of rule
files.</para>
- <para>The drools update tool can be found as a maven project in the
+ <para>The Drools update tool can be found as a maven project in the
following source repository
http://anonsvn.labs.jboss.com/labs/jbossrules/trunk/experimental/drools-update/ .
To check it out use the command <command>svn co /repository/location/</command>, and execute <command> mvn clean install</command> ihn the same directory as
@@ -241,7 +241,7 @@
<title>Rule flow Update for 4.0.2</title>
<para>
- The Rule flow feature has been updated for 4.0.2, and now all ruleflows must decalre a package name.
+ The Rule flow feature has been updated for 4.0.2, and now all ruleflows must declare a package name.
</para>
<figure>
@@ -256,4 +256,5 @@
</figure>
</section>
+
</section>
\ No newline at end of file
Modified: labs/jbossrules/branches/irooskov_docs/drools-docs/drools-docs-userguide/en/Chapter-Deployment/Section-Deployment.xml
===================================================================
--- labs/jbossrules/branches/irooskov_docs/drools-docs/drools-docs-userguide/en/Chapter-Deployment/Section-Deployment.xml 2008-03-13 00:25:01 UTC (rev 18906)
+++ labs/jbossrules/branches/irooskov_docs/drools-docs/drools-docs-userguide/en/Chapter-Deployment/Section-Deployment.xml 2008-03-13 00:48:17 UTC (rev 18907)
@@ -201,7 +201,7 @@
<para>Use the <classname>PackageBuilder</classname> class out of process, and then use
<methodname>getPackage()</methodname> to get the Package object. You can then (for example)
- serialize the Package object to a file (using standard java
+ serialize the Package object to a file (using standard Java
serialization). The runtime system, which only needs drools-core, can
then load the file using
<command>RuleBaseFactory.newRuleBase().addPackage(deserialized package
@@ -275,4 +275,5 @@
<para>A future release of Drools will contain a rule repository (server)
component that will directly support the above patterns, and more.</para>
</section>
+
</section>
\ No newline at end of file
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-13 00:25:01 UTC (rev 18906)
+++ labs/jbossrules/branches/irooskov_docs/drools-docs/drools-docs-userguide/en/Chapter-IDE/Section-QuickStart.xml 2008-03-13 00:48:17 UTC (rev 18907)
@@ -7,7 +7,7 @@
<para>
The IDE provides developers (and very technical users) with an environment to edit and test rules in various formats, and integrate it deeply with their applications. Where business rules and web tooling is prefered, the BRMS would be better suited over the IDE(but using the BRMS and the IDE together is not uncommon).</para>
- <para>The Drools IDE is delivered as an eclipse plugin, which
+ <para>The Drools IDE is delivered as an Eclipse plug-in, which
allows the authoring and management of rules from within Eclipse, as well as
integrating rules with the application. This is an optional tool, and only those components relevant to the application need be in use. The Drools IDE is also a part of the Red Hat Developer Studio (formerly known as JBoss IDE).</para>
@@ -17,7 +17,7 @@
</note>
<!--
- <para>Note you can get the plugin either as a zip to download, or from an
+ <para>Note you can get the plug-in either as a zip to download, or from an
update site (refer to the chapter on installation).</para>
-->
<figure>
@@ -122,7 +122,7 @@
</mediaobject>
</figure>
- <para>When choosing to create a new <emphasis>rule project</emphasis>, there will be a choice to add a selection of default artifacts to the projet (rules, decision tables, ruleflows etc). These can serve as a starting point (which can then be modified and moulded to specific needs). The simplest case (a hello world rule) is shown below. Feel free to experiment with the plugin at this point.</para>
+ <para>When choosing to create a new <emphasis>rule project</emphasis>, there will be a choice to add a selection of default artifacts to the projet (rules, decision tables, ruleflows etc). These can serve as a starting point (which can then be modified and moulded to specific needs). The simplest case (a hello world rule) is shown below. Feel free to experiment with the plug-in at this point.</para>
<figure>
<title>New rule project result</title>
@@ -135,17 +135,17 @@
</figure>
<para>The newly created project contains an example rule file (Sample.drl)
- in the src/rules dir and an example java file (DroolsTest.java) that can
- be used to execute the rules in a Drools engine in the folder src/java, in
+ in the src/rules dir and an example Java file (DroolsTest.Java) that can
+ be used to execute the rules in a Drools engine in the folder src/Java, in
the com.sample package. All the other jars that are necessary during
execution are also added to the classpath in a custom classpath container
- called Drools Library. Rules do not have to be kept in java
+ called Drools Library. 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>
+ using Eclipse as their Java IDE.</para>
<note>
-<para>The Drools plugin adds a <emphasis>Drools Builder</emphasis>
- capability to your eclipse instance. This means a builder can be enabled
+<para>The Drools plug-in adds a <emphasis>Drools Builder</emphasis>
+ capability to your Eclipse instance. This means a builder can be enabled
on any project that will build and validate the rules when resources
change. This happens automatically with the Rule Project Wizard, but
can also be manually enabled on any project. One downside of this is if there are a large number of rule files (>500 rules per file), as this would mean that the background builder may be doing a lot of work to
@@ -178,7 +178,7 @@
of location, typically a top level /rules directory would be created to
store the rules when creating a rule project with
suitably named subdirectorys. The package name is mandatory, and is similar
- to a package name in java (ie. its a namespace that groups similar rules
+ to a package name in Java (ie. its a namespace that groups similar rules
together).</para>
<figure>
@@ -526,7 +526,7 @@
loaded for editing). The Rule language mapping is the <emphasis>code</emphasis> for the
rules, which the language expression will be compiled to by the rule
engine compiler. The form of this Rule language depends if it is for a
- condition or action part of a rule (it may be a snippet of java, for
+ condition or action part of a rule (it may be a snippet of Java, for
instance). The <emphasis>scope</emphasis> item indicates where the expression is targeted:
is it for the <emphasis>when</emphasis> part of the rule (LHS), the <emphasis>then</emphasis> part (RHS) or
anywhere?</para>
@@ -555,7 +555,7 @@
to 2 constraints on a fact of type Person (the person object has the
age field as less than {age}, and the location value is the string of
{value}, where {age} and {value} are pulled out of the original rule
- source. The Rule mapping may be a java expression (such as if the scope
+ source. The Rule mapping may be a Java expression (such as if the scope
was <emphasis>then</emphasis>). If a language mapping is not wished to be used for a
particular rule in a drl, prefix the expression with > and the
compiler will not try to translate it according to the language
@@ -576,7 +576,7 @@
there are hundreds of nodes, select some of them with a frame, grouping the nodes. In some cases, not all nodes will be viewable in the current view, use the buttons "+" and "-" to zoom in and out respectively.</para>
<para>In the current release there is no export function, which to export an image of the Please use ctrl + alt + print to create a copy of
- your current eclipse window and cut it off.</para>
+ your current Eclipse window and cut it off.</para>
<mediaobject>
<imageobject>
@@ -605,10 +605,10 @@
permanent generation max size. Both SUN and IBM JDK have a permanent
generation, whereas BEA JRockit does not.</para>
-<para>To increase the permanent generation, start eclipse with:</para>
+<para>To increase the permanent generation, start Eclipse with:</para>
<screen>-XX:MaxPermSize=###m</screen>
- <example>Example: c:\eclipse\eclipse.exe -XX:MaxPermSize=128m</example>
+ <example>Example: c:\Eclipse\Eclipse.exe -XX:MaxPermSize=128m</example>
<para>Rulesets of 4,000 rules or greater should set the permanent
generation to at least 128Mb.</para>
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-13 00:25:01 UTC (rev 18906)
+++ labs/jbossrules/branches/irooskov_docs/drools-docs/drools-docs-userguide/en/Chapter-Install/Section-Checkout.xml 2008-03-13 00:48:17 UTC (rev 18907)
@@ -20,7 +20,7 @@
</listitem>
</itemizedlist>
-To checkout drools source code just execute the following command.
+To checkout Drools source code just execute the following command.
<programlisting>fmeyer:~/jboss $ svn checkout http://anonsvn.labs.jboss.com/labs/jbossrules/trunk/ jbossrules</programlisting>
@@ -93,7 +93,7 @@
- <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>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
@@ -128,4 +128,5 @@
</imageobject>
</mediaobject>
</screenshot>
+
</section>
\ No newline at end of file
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-13 00:25:01 UTC (rev 18906)
+++ labs/jbossrules/branches/irooskov_docs/drools-docs/drools-docs-userguide/en/Chapter-Install/Section-Eclipse.xml 2008-03-13 00:48:17 UTC (rev 18907)
@@ -5,20 +5,20 @@
<section>
<title>Generating Eclipse Projects</title>
- <para>The drools project has eclipse projects checked in for convenience.
+ <para>The Drools project has Eclipse projects checked in for convenience.
However, these were originally generated by Maven 2. If you have Maven 2
- installed, you can also regenerate the eclipse projects automatically, or
+ 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>
<para><indexterm>
<primary>maven</primary>
</indexterm>Maven is able to generate standard <indexterm>
- <primary>eclipse</primary>
+ <primary>Eclipse</primary>
</indexterm>Eclipse projects, but it is not able to generate Eclipse
- plugin projects. To generate the Eclipse projects for drools-core,
+ plug-in projects. To generate the Eclipse projects for drools-core,
drools-compiler and drools-jsr94 type <command>'mvn
- eclipse:eclipse'</command>.</para>
+ Eclipse:Eclipse'</command>.</para>
<screenshot>
<screeninfo>Start Maven Eclipse project generation</screeninfo>
@@ -45,9 +45,9 @@
<title>Importing Eclipse Projects</title>
<para>With the <indexterm>
- <primary>eclipse</primary>
+ <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>
@@ -173,7 +173,7 @@
</screenshot>
<screenshot>
- <screeninfo>Wait while the plugin is built and exported</screeninfo>
+ <screeninfo>Wait while the plug-in is built and exported</screeninfo>
<mediaobject>
<imageobject>
@@ -182,8 +182,8 @@
</mediaobject>
</screenshot>
- <para>Once the plugin has been built, open the output directory and copy
- the jar to the Eclipse plugin directory.</para>
+ <para>Once the plug-in has been built, open the output directory and copy
+ the jar to the Eclipse plug-in directory.</para>
<screenshot>
<screeninfo>Open the directory with the build jar</screeninfo>
@@ -196,7 +196,7 @@
</screenshot>
<screenshot>
- <screeninfo>Copy the jar to the Eclipse plugin directory</screeninfo>
+ <screeninfo>Copy the jar to the Eclipse plug-in directory</screeninfo>
<mediaobject>
<imageobject>
@@ -234,20 +234,20 @@
<section>
<title>Building the update site</title>
- <para>There is also an update site for the plug in. For developers who
+ <para>There is also an update site for the plug-in. For developers who
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
+ /jbossrules/update instead of /trunk. They are plain vanilla Eclipse
feature and site projects.</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).
+ are alternative ways ot getting the same plug-in).
</para>
</note>
- <para>Eclipse refreshing plugins in features and sites can be temperamental,
+ <para>Eclipse refreshing plug-ins 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"?>
@@ -293,7 +293,7 @@
limitations under the License.
</license>
- <plugin
+ <plug-in
id="org.drools.ide"
download-size="0"
install-size="0"
@@ -302,14 +302,15 @@
</feature>
</programlisting> Change the version number in the FEATURE tag to be the same
as what you referred to in the site.xml. If you changed the version number
- of the main plug in, you will need to put the version number in the plug
- in tag (which refers to org.drools.ide plugin). Then zip up the
+ of the main plug-in, you will need to put the version number in the plug
+ in tag (which refers to org.drools.ide plug-in). Then zip up the
feature.xml into a jar with the same name as you referred to in the
site.xml.</para>
- <para>Finally, drop the plugin jar into the /plugins jar directory of the
- update site (get the actual plug in from the exported plugin in the
+ <para>Finally, drop the plug-in jar into the /plugins jar directory of the
+ update site (get the actual plug-in from the exported plug-in in the
previous step). Now you can upload the site as is, and it will show up as
a new version for Eclipse clients.</para>
</section>
+
</section>
\ No newline at end of file
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-13 00:25:01 UTC (rev 18906)
+++ labs/jbossrules/branches/irooskov_docs/drools-docs/drools-docs-userguide/en/Chapter-Install/Section-Install.xml 2008-03-13 00:48:17 UTC (rev 18907)
@@ -2,16 +2,16 @@
<section>
<title>Installing and using</title>
- <para>Drools provides an eclipse based IDE (which is optional), but at its
+ <para>Drools provides an Eclipse-based IDE (which is optional), but at its
core only Java 1.4 (J2SE) is required.</para>
- <para>A simple way to get started is to download and install the eclipse
- plugin - this will also require the Eclipse GEF framework to be installed
+ <para>A simple way to get started is to download and install the Eclipse
+ plug-in - this will also require the Eclipse GEF framework to be installed
(see <link linkend="Installing_IDE">Installing IDE (Rule Workbench)</link>, if you don't have it installed already). This will provide all the dependencies necessary in order to automate rule project creation. Installing the
- eclipse plugin consists of unzipping a file into your eclipse
- plugin directory.</para>
+ Eclipse plug-in consists of unzipping a file into your Eclipse
+ plug-in directory.</para>
- <para>Use of the eclipse plugin however, is not required. Rule files are just
+ <para>Use of the Eclipse plug-in however, 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. The rule engine can be integrated in many ways, allowing for considerable flexability.</para>
@@ -50,7 +50,7 @@
<para>drools-jsr94.jar - this is the JSR-94 compliant implementation,
essentially a layer over the drools-compiler component. Due to the nature of the JSR-94 specification, not all features
are easily exposed via this interface. In some cases, it will be
- easier to go direct to the drools API, but in some environments the
+ easier to go direct to the Drools API, but in some environments the
JSR-94 is mandated.
</para>
</listitem>
@@ -104,28 +104,28 @@
<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 the Eclipse GEF (Graphical Editing Framework)
- by either downloading the plugin or using the update site.</para>
+ by either downloading the plug-in or using the update site.</para>
<para>Another option is to use the JBoss IDE, which comes with all the
- plugin requirements pre-packaged, as well as a choice of other tools
+ plug-in requirements pre-packaged, as well as a choice of other tools
separate to rules. You can choose to only install rules from the selection of programs
that JBoss IDE ships with if that is all that is required.</para>
<section>
<title>Installing GEF (a required dependency)</title>
- <para>GEF is the eclipse Graphical Editing Framework, which is used for
- graph viewing components in the plugin.</para>
+ <para>GEF is the Eclipse Graphical Editing Framework, which is used for
+ graph viewing components in the plug-in.</para>
<para>The JBoss IDE comes with GEF pre-installed, however if you don't have GEF installed, you can do so using the
- built in update mechanism (or downloading GEF from the eclipse.org
+ built in update mechanism (or downloading GEF from the Eclipse.org
website, though this is not recommended).</para>
<para>First open the Help->Software updates->Find and install
from the help menu. Then choose the Calisto update site:</para>
<para>If Calisto is not in use, the following update site can be used to download GEF</para>
- <programlisting>http://europa-mirror1.eclipse.org/tools/gef/update-site/releases/</programlisting>
+ <programlisting>http://europa-mirror1.Eclipse.org/tools/gef/update-site/releases/</programlisting>
<screenshot>
<mediaobject>
@@ -135,7 +135,7 @@
</mediaobject>
</screenshot>
- <para>Next choose the GEF plugin:</para>
+ <para>Next choose the GEF plug-in:</para>
<screenshot>
<mediaobject>
@@ -145,31 +145,31 @@
</mediaobject>
</screenshot>
- <para>Click next, and agree to install the plugin (an Eclipse restart
- may be required). Once this is completed, the installation of the rules plugin can be continued.</para>
+ <para>Click next, and agree to install the plug-in (an Eclipse restart
+ may be required). Once this is completed, the installation of the rules plug-in can be continued.</para>
</section>
<section>
<title>Installing from the zip file</title>
<para>To install from the zip file, download and unzip the file. Inside
- the zip you will see a plugin directory, and the plugin jar itself.Place the plugin into your Eclipse application plugin directory,
+ the zip you will see a plug-in directory, and the plug-in jar itself.Place the plug-in into your Eclipse application plug-in directory,
and restart Eclipse.</para>
</section>
<section>
<!-- <title>Installing from the update site</title> -->
- <para>Using the update site is an effective way to install the plugin, and
+ <para>Using the update site is an effective way to install the plug-in, and
keep it up to date (the Eclipse platform will check for updates as
needed).</para>
<para>Some firewalls may cause trouble when using update sites in
- Eclipse; if you have issues, then install it manually from the plugin.
- Further, if the plugin has previously been manually installed, it will
- need to be manually removed from the plugin directory.</para>
+ Eclipse; if you have issues, then install it manually from the plug-in.
+ Further, if the plug-in has previously been manually installed, it will
+ need to be manually removed from the plug-in directory.</para>
- <para>Step 1. Use the eclipse help menu to find the feature installer.
+ <para>Step 1. Use the Eclipse help menu to find the feature installer.
<screenshot>
<screeninfo>Access the software updates menu</screeninfo>
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-13 00:25:01 UTC (rev 18906)
+++ labs/jbossrules/branches/irooskov_docs/drools-docs/drools-docs-userguide/en/Chapter-Install/Section-Maven_build.xml 2008-03-13 00:48:17 UTC (rev 18907)
@@ -8,24 +8,24 @@
<para>Now that we have the source the next step is to build and install
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. 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
+ "Eclipse"; this enables quicker building of the core modules for
+ developers. The Eclipse profile will download Eclipse into the
+ 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>
+ -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>
<screen>
-mvn -Declipse -Ddocumentation clean install -DlocalEclipseDrop=/folder/jboss-rules/local-eclipse-drop-mirror
+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:</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
+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
</screen>
<para>Note that install must be done first as javadoc:javadoc won't work
@@ -85,9 +85,9 @@
</listitem>
<listitem>
- <para>eclipse</para>
+ <para>Eclipse</para>
- <para>Documentation suitable for including in an eclipse plugin</para>
+ <para>Documentation suitable for including in an Eclipse plug-in</para>
</listitem>
</itemizedlist>
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-13 00:25:01 UTC (rev 18906)
+++ labs/jbossrules/branches/irooskov_docs/drools-docs/drools-docs-userguide/en/Chapter-Rule_Engine/Section-The_Drools_Rule_Engine.xml 2008-03-13 00:48:17 UTC (rev 18907)
@@ -533,7 +533,7 @@
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. After the change
- call modifyAssert().
+ call modifyInsert().
</para>
</important>
</section>
@@ -546,7 +546,7 @@
means that the engine will automatically know when a fact has changed,
and behave accordingly (it does not need to be notified that the fact has been modified).
There are proxy libraries that can help automate this (a future version
- of drools will come with some libraries bundled to assist with this). To use the Object in
+ of Drools will come with some libraries bundled to assist with this). To use the Object in
dynamic mode, specify true for the second assertObject parameter.</para>
<screen>Cheese stilton = new Cheese("stilton");
@@ -656,14 +656,14 @@
need access to any results information they can use the <methodname>executeWithResults()</methodname>
method, which returns a StatelessSessionResult. The reason for this is in
remote situations you do not always want the return payload, so this way
- its optional.</para>
+ it's optional.</para>
<para><methodname>setAgendaFilter</methodname>, <methodname>setGlobal</methodname> and <methodname>setGlobalResolver</methodname> share their state
across sessions; so each call to <methodname>execute()</methodname> will use the set <methodname>AgendaFilter</methodname>,
or see any previous set globals etc.</para>
<para>StatelessSessions do not currently support
- propertyChangeLissteners.</para>
+ propertyChangeListeners.</para>
<para>Async versions of the Execute method are supported, remember to
override the ExecutorService implementation when in special managed thread
@@ -686,7 +686,7 @@
</figure>
<para><methodname>StatelessSession.executeWithResults(....)</methodname> returns a minimal API to
- examine the sessions data. The inserted Objects can be iterated over,
+ examine the session's data. The inserted Objects can be iterated over,
queries can be executed and globals retrieved. Once the
StatelessSessionResult is serialized it loses the reference to the
underlying WorkingMemory and RuleBase, so queries can no longer be
@@ -702,7 +702,7 @@
<methodname>ReferenceOriginalGlobalExporter</methodname> passes a reference to the original
GlobalResolver; the latter should be used with care as identifier
instances can be changed at any time by the StatelessSession and the
- GlobalResolver may not be serializable freindly.</para>
+ GlobalResolver may not be serializable friendly.</para>
<example>
<title>GlobalExporter with StatelessSessions</title>
@@ -739,7 +739,7 @@
<orderedlist>
<listitem>
<para>Working Memory Actions - this is where most of the work takes
- place - in either the Consequence or the main java application
+ place; in either the Consequence or the main Java application
process. Once the Consequence has finished or the main Java
application process calls <methodname>fireAllRules()</methodname> the engine switches to the
Agenda Evaluation phase.</para>
@@ -841,7 +841,7 @@
<itemizedlist>
<listitem>
- <para>RuleNameEndWithAgendaFilter</para>
+ <para>RuleNameEndsWithAgendaFilter</para>
</listitem>
<listitem>
@@ -857,9 +857,8 @@
</listitem>
</itemizedlist>
- <para>To use a filter specify it while calling <methodname>FireAllRules</methodname>. The
- following example will filter out all rules ending with the text
- "Test":</para>
+ <para>To use a filter specify it while calling FireAllRules. The
+ following example will only allow activation of rules ending with the test <emphasis>Test</emphasis>. All others will be filtered out:</para>
<screen>workingMemory.fireAllRules( new RuleNameEndsWithAgendaFilter( "Test" ) ); </screen>
</section>
@@ -1059,7 +1058,7 @@
<screen>session.addEventListener( new DebugWorkingMemoryEventListener() );</screen>
- <para>The Eclipse based Rule IDE also provides an audit logger and
+ <para>The Eclipse-based Rule IDE also provides an audit logger and
graphical viewer, so that the rule engine can log events for later
viewing, and auditing.</para>
</section>
More information about the jboss-svn-commits
mailing list