[jboss-svn-commits] JBL Code SVN: r18711 - in labs/jbossrules/branches/irooskov_docs/drools-docs/drools-docs-userguide/en: Chapter-Deployment and 4 other directories.

jboss-svn-commits at lists.jboss.org jboss-svn-commits at lists.jboss.org
Thu Mar 6 01:10:27 EST 2008


Author: irooskov at redhat.com
Date: 2008-03-06 01:10:25 -0500 (Thu, 06 Mar 2008)
New Revision: 18711

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-Testing.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-JSR94/Section-How_To_Use.xml
   labs/jbossrules/branches/irooskov_docs/drools-docs/drools-docs-userguide/en/Chapter-JSR94/Section-Introduction.xml
   labs/jbossrules/branches/irooskov_docs/drools-docs/drools-docs-userguide/en/Chapter-Release_Notes/Section-Upgrade_tips.xml
   labs/jbossrules/branches/irooskov_docs/drools-docs/drools-docs-userguide/en/Chapter-Release_Notes/Section-What_is_new.xml
   labs/jbossrules/branches/irooskov_docs/drools-docs/drools-docs-userguide/en/Chapter-Rule_Language/Section-Comments.xml
   labs/jbossrules/branches/irooskov_docs/drools-docs/drools-docs-userguide/en/Chapter-Rule_Language/Section-Function.xml
   labs/jbossrules/branches/irooskov_docs/drools-docs/drools-docs-userguide/en/Chapter-Rule_Language/Section-Overview.xml
   labs/jbossrules/branches/irooskov_docs/drools-docs/drools-docs-userguide/en/Chapter-Rule_Language/Section-Package.xml
   labs/jbossrules/branches/irooskov_docs/drools-docs/drools-docs-userguide/en/master.xml
Log:
Updated master.xml with new layout and began the re-write of the book for a consistant language. 


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-06 00:58:39 UTC (rev 18710)
+++ labs/jbossrules/branches/irooskov_docs/drools-docs/drools-docs-userguide/en/Chapter-Deployment/Section-Deployment.xml	2008-03-06 06:10:25 UTC (rev 18711)
@@ -162,7 +162,7 @@
     <section>
       <title>RuleBase</title>
 
-      <para>Compiled Packages are added to rulebases. RuleBases are
+      <para>Compiled Packages are added to the rulebases. RuleBases are
       serializable, so they can be a binary deployment unit themselves. This
       can be a useful option for when rulebases are updated as a whole - for
       short lived working memories. If existing working memories need to have
@@ -203,7 +203,7 @@
     <section>
       <title>Out of process rule building</title>
 
-      <para>In this case, rules are build into their binary process outside of
+      <para>In this case, rules are built into their binary process outside of
       the runtime system (for example in a deployment server). The chief
       advantage of deploying from an outside process is that the runtime
       system can have minimal dependencies (just one jar). It also means that

Modified: labs/jbossrules/branches/irooskov_docs/drools-docs/drools-docs-userguide/en/Chapter-Deployment/Section-Testing.xml
===================================================================
--- labs/jbossrules/branches/irooskov_docs/drools-docs/drools-docs-userguide/en/Chapter-Deployment/Section-Testing.xml	2008-03-06 00:58:39 UTC (rev 18710)
+++ labs/jbossrules/branches/irooskov_docs/drools-docs/drools-docs-userguide/en/Chapter-Deployment/Section-Testing.xml	2008-03-06 06:10:25 UTC (rev 18711)
@@ -38,7 +38,7 @@
 
     <para>As a separate add-on, there is a testing framework available that is
     built on FIT (Framework for Integrated Testing). This allows rule test
-    suites (functional) to be capture in Word documents, or Excel spreadsheets
+    suites (functional) to be captured in Word documents, or Excel spreadsheets
     (in fact any tool that can save as HTML). It utilizes a tabular layout to
     capture input data, and make assertions over the rules of a rulesets
     execution for the given facts. As the tests are stored in documents, the

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-06 00:58:39 UTC (rev 18710)
+++ labs/jbossrules/branches/irooskov_docs/drools-docs/drools-docs-userguide/en/Chapter-Install/Section-Install.xml	2008-03-06 06:10:25 UTC (rev 18711)
@@ -6,18 +6,14 @@
   core only Java 1.4 (J2SE) is required.</para>
 
   <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 below, if you don't have it installed already). This will provide you
-  with all the dependencies you need to get going: you can simply create a new
-  rule project and everything will be done for you. Refer to the chapter on
-  the Rule Workbench and IDE for detailed instructions on this. Installing the
-  eclipse plugin is generally as simple as unzipping a file into your eclipse
+  plugin - 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>
 
-  <para>Use of the eclipse plugin is not required. Rule files are just
+  <para>Use of the eclipse plugin 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. People have integrated the
-  rule engine in many ways, there is no "one size fits all".</para>
+  as the Rule Workbench) is just a convenience. The rule engine can be integrated in many ways, allowing for considerable flexability.</para>
 
   <para>Alternatively, you can download the binary distribution, and include
   the relevant jars in your projects classpath.</para>
@@ -28,73 +24,71 @@
     <title>Dependencies and jars</title>
 
     <para>Drools is broken down into a few modules, some are required during
-    rule development/compiling, and some are required at runtime. In many
-    cases, people will simply want to include all the dependencies at runtime,
-    and this is fine. It allows you to have the most flexibility. However,
-    some may prefer to have their "runtime" stripped down to the bare minimum,
-    as they will be deploying rules in binary form - this is also possible.
+    rule development/compiling, and some are required at runtime. All the dependencies can be included at runtime, which would allow for the most flexibility. However, the runtime can consist of only the basics if, for instance, rules are to be deployed in binary form.
     The core runtime engine can be quite compact, and only require a few 100
     kilobytes across 2 jar files.</para>
 
     <para>The following is a description of the important libraries that make
-    up JBoss Rules</para>
+    up Drools</para>
 
     <itemizedlist>
       <listitem>
         <para>drools-core.jar - this is the core engine, runtime component.
-        Contains both the RETE engine and the LEAPS engine. This is the only
+        The .jar contains both the RETE engine and the LEAPS engine. This is the only
         runtime dependency if you are pre-compiling rules (and deploying via
         Package or RuleBase objects).</para>
       </listitem>
 
       <listitem>
         <para>drools-compiler.jar - this contains the compiler/builder
-        components to take rule source, and build executable rule bases. This
-        is often a runtime dependency of your application, but it need not be
-        if you are pre-compiling your rules. This depends on
+        components to take rule source, and build executable rule bases. Often a runtime dependency of your application,
+        if you are pre-compiling your rules it would not be necessary. This compiler depends on the
         drools-core</para>
       </listitem>
 
       <listitem>
         <para>drools-jsr94.jar - this is the JSR-94 compliant implementation,
-        this is essentially a layer over the drools-compiler component. Note
-        that due to the nature of the JSR-94 specification, not all features
+        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
-        JSR-94 is mandated.</para>
+        JSR-94 is mandated.
+	</para>
       </listitem>
 
       <listitem>
         <para>drools-decisiontables.jar - this is the decision tables
-        'compiler' component, which uses the drools-compiler component. This
-        supports both excel and CSV input formats.</para>
+        'compiler' component, which uses the drools-compiler. This
+        supports both spreadsheet and CSV input formats.</para>
       </listitem>
     </itemizedlist>
 
     <para>There are quite a few other dependencies which the above components
     require, most of which are for the drools-compiler, drools-jsr94 or
-    drools-decisiontables module. Some of these (such as the XML libraries)
+    drools-decisiontables modules. Some of these (such as the XML libraries)
     may not be required if you run in a Java 1.5 environment. Some key ones to
     note are "JCI" - which is the apache Java Compiler Interface utility which
     provides runtime compiling capability, "POI" which provides the
     spreadsheet parsing ability, and "antlr" which provides the parsing for
     the rule language itself.</para>
 
-    <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:
-    <example>-Ddrools.compiler=JANINO</example>.</note>
+    <note>
+	    <para>
+		    If you are using Drools in J2EE or servlet containers and you come across classpath issues with JDT (Java Development Tools), then you can switch to the janino compiler. The <parameter>drools.compiler</parameter> parameter will need to be set to do use janino: <command>-Ddrools.compiler=JANINO</command>.
+	   </para>
+   </note>
 
-    <para>For up to date info on dependencies in a release, consult the
+    <para>For up to date information on dependencies in a release, consult the
     <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>
 
+<!-- This section has been commented out because it repeats what has already been outlined above
+     
   <section>
     <title>Runtime</title>
 
-    <para>The "runtime" requirements mentioned here are if you are deploying
-    rules as their binary form (either as Package objects, or RuleBase objects
+    <para>The runtime requirements that have been mentioned relate only to deploying
+    rules in their binary form (either as Package objects, or RuleBase objects
     etc). This is an optional feature that allows you to keep your runtime
     very light. You may use drools-compiler to produce rule packages "out of
     process", and then deploy them to a runtime system. This runtime system
@@ -103,18 +97,19 @@
     application this much, but it is an ideal option for certain
     environments.</para>
   </section>
-
-  <section>
+-->
+  
+  <section id="Installing_IDE">
     <title>Installing IDE (Rule Workbench)</title>
 
-    <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 using the update site.</para>
+    <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>
 
     <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
-    separate to rules. You can choose just to install rules from the "bundle"
-    that JBoss IDE ships with.</para>
+    plugin 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>
@@ -122,15 +117,14 @@
       <para>GEF is the eclipse Graphical Editing Framework, which is used for
       graph viewing components in the plugin.</para>
 
-      <para>If you don't have GEF installed, you can install it using the
+<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
-      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>
+      website, though this is not recommended).</para>
 
-      <para>First you open the Help-&gt;Software updates-&gt;Find and install
-      from the help menu. Then you choose the Calisto update site:</para>
+      <para>First open the Help-&gt;Software updates-&gt;Find and install
+      from the help menu. Then choose the Calisto update site:</para>
 
-	  <para>If you aren't using Calisto you can use the following update site do download GEF</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>
 	
       <screenshot>
@@ -141,7 +135,7 @@
         </mediaobject>
       </screenshot>
 
-      <para>Next you choose the GEF plugin:</para>
+      <para>Next choose the GEF plugin:</para>
 
       <screenshot>
         <mediaobject>
@@ -151,32 +145,29 @@
         </mediaobject>
       </screenshot>
 
-      <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 plugin.</para>
+      <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>
     </section>
 
     <section>
-      <title>Installing from zip file</title>
+      <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. You
-      place the plugin jar into your eclipse applications plugin directory,
-      and restart eclipse.</para>
+      the zip you will see a plugin directory, and the plugin jar itself.Place the plugin into your Eclipse application plugin directory,
+      and restart Eclipse.</para>
     </section>
 
     <section>
-      <title>Installing from the update site</title>
+<!--       <title>Installing from the update site</title> -->
 
-      <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>Using the update site is an effective way to install the plugin, 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.
-      Also, if you have previously installed the plugin manually, you will
-      need to manually remove it from your plugin directory.</para>
+      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>
 
       <para>Step 1. Use the eclipse help menu to find the feature installer.
       <screenshot>
@@ -189,8 +180,7 @@
           </mediaobject>
         </screenshot></para>
 
-      <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>
+      <para>Step 2: Choose the option for installing a new feature (in the future to check for updates, the "Search for updates of the currently installed features" option can be utilized). <screenshot>
           <screeninfo>Search for new features</screeninfo>
 
           <mediaobject>
@@ -212,7 +202,7 @@
         </screenshot></para>
 
       <para>Step 4: This screen is where you enter in the remote site details.
-      You give it a name eg "JBoss Drools" and the url. <programlisting>URL: http://downloads.jboss.com/drools/updatesite/</programlisting>
+      Give it a name, for example: "JBoss Drools", and the url. <screen>URL: http://downloads.jboss.com/drools/updatesite/</screen>
       <screenshot>
           <screeninfo>New remote site</screeninfo>
 
@@ -223,8 +213,8 @@
           </mediaobject>
         </screenshot></para>
 
-      <para>Step 5: Select the new update site you just added. Eclipse will
-      remember this for when it checks for updates automatically in the
+      <para>Step 5: Select the new update site that has just been added. Eclipse will
+      remember the site for when it checks for updates automatically in the
       future. <screenshot>
           <screeninfo>Choose the newly added update site</screeninfo>
 
@@ -235,8 +225,8 @@
           </mediaobject>
         </screenshot></para>
 
-      <para>Step 6: You should see the available features (Drools IDE)
-      retrieved from the update site. <screenshot>
+      <para>Step 6: The available features (such as the Drools IDE)
+      retrieved from the update site should now be visible. <screenshot>
           <screeninfo>Available features</screeninfo>
 
           <mediaobject>
@@ -246,7 +236,7 @@
           </mediaobject>
         </screenshot></para>
 
-      <para>Step 7: The license agreement. Choose the option to accept the
+      <para>Step 7: Choose the option to accept the
       license agreement. Once this happens, the workbench will start
       downloading. This may take several minutes. <screenshot>
           <screeninfo>License</screeninfo>
@@ -258,7 +248,7 @@
           </mediaobject>
         </screenshot></para>
 
-      <para>Step 8: Confirm that this is the feature you want. <screenshot>
+      <para>Step 8: Confirm that this is the feature you wish to install. <screenshot>
           <screeninfo>Confirmation</screeninfo>
 
           <mediaobject>
@@ -268,9 +258,8 @@
           </mediaobject>
         </screenshot></para>
 
-      <para>Step 9: Press Accept to accept the fact that the feature is not
-      digitally signed. No one signs their features, its a silly default
-      screen in Eclipse. <screenshot>
+      <para>Step 9: Click Accept to accept the fact that the feature is not
+      digitally signed. There is no need to worry about this as it is common practice not to sign features.<screenshot>
           <screeninfo>Verify</screeninfo>
 
           <mediaobject>
@@ -292,7 +281,7 @@
         </screenshot></para>
 
       <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>
+      the Rule Workbench for more information on what can be achieved with it.</para>
     </section>
   </section>
 </section>
\ No newline at end of file

Modified: labs/jbossrules/branches/irooskov_docs/drools-docs/drools-docs-userguide/en/Chapter-JSR94/Section-How_To_Use.xml
===================================================================
--- labs/jbossrules/branches/irooskov_docs/drools-docs/drools-docs-userguide/en/Chapter-JSR94/Section-How_To_Use.xml	2008-03-06 00:58:39 UTC (rev 18710)
+++ labs/jbossrules/branches/irooskov_docs/drools-docs/drools-docs-userguide/en/Chapter-JSR94/Section-How_To_Use.xml	2008-03-06 06:10:25 UTC (rev 18711)
@@ -13,7 +13,7 @@
     <para>The RuleServiceProviderManager manages the registration and
     retrieval of RuleServiceProviders. The Drools RuleServiceProvider
     implementation is automatically registered via a static block when the
-    class is loaded using Class.forName; in much the same way as JDBC
+    class is loaded using Class.forName; in much the same way as JDBC (Java DataBase Connectivity)
     drivers.</para>
 
     <para><example>
@@ -156,12 +156,12 @@
     <section>
       <title>Globals</title>
 
-      <para>It is possible to support globals with JSR94, in a none portable
+      <para>It is possible to support globals with JSR94, in a non-portable
       manner, by using the properties map passed to the RuleSession factory
       method. Globals must be defined in the drl or xml file first, otherwise
       an Exception will be thrown. the key represents the identifier declared
       in the drl or xml and the value is the instance you wish to be used in
-      the execution. In the following example the results are collected in an
+      the execution. In the following example the results are collected in a
       java.util.List which is used as global:</para>
 
       <programlisting>java.util.List globalList = new java.util.ArrayList( );

Modified: labs/jbossrules/branches/irooskov_docs/drools-docs/drools-docs-userguide/en/Chapter-JSR94/Section-Introduction.xml
===================================================================
--- labs/jbossrules/branches/irooskov_docs/drools-docs/drools-docs-userguide/en/Chapter-JSR94/Section-Introduction.xml	2008-03-06 00:58:39 UTC (rev 18710)
+++ labs/jbossrules/branches/irooskov_docs/drools-docs/drools-docs-userguide/en/Chapter-JSR94/Section-Introduction.xml	2008-03-06 06:10:25 UTC (rev 18711)
@@ -4,10 +4,10 @@
 
   <para>Drools provides an implementation of the Java Rule Engine API (known
   as JSR94), which allows for support of multiple rule engines from a single
-  API. JSR94 does not deal in anyway with the rule language itself. W3C is
+  API. JSR94 does not deal in anyway with the rule language itself. W3C (World Wide Web Consortium) is
   working on the <ulink
   url="http://www.w3.org/TR/2006/WD-rif-ucr-20060323/">Rule Interchange Format
-  (RIF)</ulink> and the OMG has started to work on a standard based on <ulink
+  (RIF)</ulink> and the OMG (Object Management Group) has started to work on a standard based on <ulink
   url="http://ruleml.org/">RuleML</ulink>, recently Haley Systems has also
   proposed a rule language standard called RML.</para>
 

Modified: labs/jbossrules/branches/irooskov_docs/drools-docs/drools-docs-userguide/en/Chapter-Release_Notes/Section-Upgrade_tips.xml
===================================================================
--- labs/jbossrules/branches/irooskov_docs/drools-docs/drools-docs-userguide/en/Chapter-Release_Notes/Section-Upgrade_tips.xml	2008-03-06 00:58:39 UTC (rev 18710)
+++ labs/jbossrules/branches/irooskov_docs/drools-docs/drools-docs-userguide/en/Chapter-Release_Notes/Section-Upgrade_tips.xml	2008-03-06 06:10:25 UTC (rev 18711)
@@ -2,14 +2,8 @@
 <section>
   <title>Upgrade tips from Drools 3.0.x to Drools 4.0.x</title>
 
-  <para>As mentioned before Drools 4.0 is a major update over the previous
-  Drools 3.0.x series. Unfortunately, in order to achieve the goals set for
-  this release, some backward compatibility issues were introduced, as
-  discussed in the mail list and blogs.</para>
+  <para>The advancement to Drools 4.0 has meant that certain backward compatibility issues have been introduced, however this section docuemnts a simple how-to on upgrading from Drools 3.0.x with minimal side effects.</para>
 
-  <para>This section of the manual is a work in progress and will document a
-  simple how-to on upgrading from Drools 3.0.x to Drools 4.0.x.</para>
-
   <section>
     <title>API changes</title>
 
@@ -19,7 +13,7 @@
     <section>
       <title>Working Memory creation</title>
 
-      <para>Drools 3.0.x had only one working memory type that worked like a
+      <para>Drools 3.0.x comprised of only one working memory type that worked similar to a
       stateful working memory. Drools 4.0.x introduces separate APIs for
       Stateful and Stateless working memories that are now called Rule
       Sessions. In Drools 3.0.x, the code to create a working memory
@@ -45,7 +39,7 @@
 
       <para>Drools 4.0.x now supports pluggable dialects and has built-in
       support for Java and MVEL scripting language. In order to avoid keyword
-      conflicts, the working memory actions were renamed as showed
+      conflicts, the working memory actions were renamed as shown
       bellow:</para>
 
       <para></para>
@@ -94,8 +88,8 @@
       <title>Working Memory Actions</title>
 
       <para>The Working Memory actions in rule consequences were also changed
-      in a similar way to the change made in the API. The following table
-      summarizes the change:</para>
+      in a similar way to the changes made in the API. The following table
+      summarizes the changes:</para>
 
       <table>
         <title>Working Memory Actions equivalent DRL commands</title>
@@ -135,11 +129,11 @@
 
       <para>Drools 3.0.x did not have native support for primitive types and
       consequently, it auto-boxed all primitives in it's respective wrapper
-      classes. That way, any use of a boxed variable binding required a manual
+      classes. This meant that any use of a boxed variable binding required a manual
       unbox.</para>
 
-      <para>Drools 4.0.x has full support for primitive types and does not
-      wrap values anymore. So, all previous unwrap method calls must be
+      <para>Added functionality for full primitave type support has been included in Drools 4.0.x, meaning that values no longer need to be 
+      wraped and that all previous unwrap method calls must be
       removed from the DRL.</para>
 
       <example>
@@ -178,25 +172,23 @@
 
     <para>At this point, its main objective is to upgrade the memory action
     calls from 3.0.x to 4.0.x, but expect it to grow to covering additional
-scenarios. It is important to note that it does not
-    make a dumb text search and replace in the rules file, but it actually
+scenarios. It is important to note that it actually
 parses
-    the rules file and tries to make sure it is not doing anything
-unexpected,
-    and as so, it is a safe tool to use for upgrading large sets of rule
+    the rules file and attempts to ensure nothing unexpected is occurring,
+    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
     following source repository
-    http://anonsvn.labs.jboss.com/labs/jbossrules/trunk/experimental/drools-update/
-    you just need to check it out, and execute the maven clean install action
-    with the project's pom.xml file. After, resolve all the class path
-    dependencies you are able to and run the tool with the following
+    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
+    the project's pom.xml file. After, resolve all the class path
+    dependencies and run the tool with the following
     command:</para>
 
     <programlisting>java -cp $CLASSPATH org.drools.tools.update.UpdateTool -f &lt;filemask&gt; [-d &lt;basedir&gt;] [-s &lt;sufix&gt;]</programlisting>
 
-    <para>The program parameters are very easy to understand as following.
+    <para>The program parameters are as follows:
     <itemizedlist>
         <listitem>
           <para>-h,--help, Shows a very simple list the usage help</para>
@@ -222,12 +214,12 @@
   <section>
     <title>DSL Grammars in Drools 4.0</title>
 
-    <para>It is important to note that the DSL template engine was rewritten
+    <para>It is important to note that the DSL template engine has been rewritten
     from scratch to improve flexibility. One of the new features of DSL
-    grammars is the support to Regular Expressions. This way, you can now
-    write your mappings using regexp to have additional flexibility, as
-    explained in the DSL chapter. Although, now you have to escape characters
-    with regexp meaning. Example: if previously you had a matching
+    grammars is the support of Regular Expressions. This way, you can now
+    write your mappings using <productname>regexp</productname> to have additional flexibility, as
+    explained in the DSL chapter. Some characters will now need to be escaped
+    because they hold meaning within <productname>regexp</productname>. For example: if previously you had a mapping
     like:</para>
 
     <example>
@@ -236,8 +228,7 @@
       <programlisting>[when][]- the {attr} is in [ {values} ]={attr} in ( {values} )</programlisting>
     </example>
 
-    <para>Now, you need to escape '[' and ']' characters, as they have special
-    meaning in regexps. So, the same mapping in Drools 4.0 would be:</para>
+    <para>Now, you need to escape the '[' and ']' characters. In Drools 4.0, the same mapping would be written as:</para>
 
     <example>
       <title>Drools 4.0.x mapping with escaped characters</title>
@@ -250,7 +241,7 @@
     <title>Rule flow Update for 4.0.2</title>
 
     <para>
-    	The Rule flow feature was updated for 4.0.2, and now all your ruleflows must decalre a package name.
+    	The Rule flow feature has been updated for 4.0.2, and now all ruleflows must decalre a package name.
     </para>
 
   <figure>

Modified: labs/jbossrules/branches/irooskov_docs/drools-docs/drools-docs-userguide/en/Chapter-Release_Notes/Section-What_is_new.xml
===================================================================
--- labs/jbossrules/branches/irooskov_docs/drools-docs/drools-docs-userguide/en/Chapter-Release_Notes/Section-What_is_new.xml	2008-03-06 00:58:39 UTC (rev 18710)
+++ labs/jbossrules/branches/irooskov_docs/drools-docs/drools-docs-userguide/en/Chapter-Release_Notes/Section-What_is_new.xml	2008-03-06 06:10:25 UTC (rev 18711)
@@ -3,9 +3,9 @@
   <title>What is new in Drools 4.0</title>
 
   <para>Drools 4.0 is a major update over the previous Drools 3.0.x series. A
-  whole new set of features were developed with special focus on language
+  whole new set of features have been developed with special focus on language
   expressiveness, engine performance and tools availability. The following is
-  a list of the most interesting changes.</para>
+  a list of the most important changes.</para>
 
   <section>
     <title>Language Expressiveness Enhancements</title>

Modified: labs/jbossrules/branches/irooskov_docs/drools-docs/drools-docs-userguide/en/Chapter-Rule_Language/Section-Comments.xml
===================================================================
--- labs/jbossrules/branches/irooskov_docs/drools-docs/drools-docs-userguide/en/Chapter-Rule_Language/Section-Comments.xml	2008-03-06 00:58:39 UTC (rev 18710)
+++ labs/jbossrules/branches/irooskov_docs/drools-docs/drools-docs-userguide/en/Chapter-Rule_Language/Section-Comments.xml	2008-03-06 06:10:25 UTC (rev 18711)
@@ -4,10 +4,6 @@
 <section>
   <title>Comments</title>
 
-  <note>
-    <para><replaceable>(updated to Drools 4.0)</replaceable></para>
-  </note>
-
   <para>Comments are sections of text that are ignored by the rule engine.
   They are stripped out when they are encountered, except inside semantic code
   blocks, like the RHS of a rule.</para>

Modified: labs/jbossrules/branches/irooskov_docs/drools-docs/drools-docs-userguide/en/Chapter-Rule_Language/Section-Function.xml
===================================================================
--- labs/jbossrules/branches/irooskov_docs/drools-docs/drools-docs-userguide/en/Chapter-Rule_Language/Section-Function.xml	2008-03-06 00:58:39 UTC (rev 18710)
+++ labs/jbossrules/branches/irooskov_docs/drools-docs/drools-docs-userguide/en/Chapter-Rule_Language/Section-Function.xml	2008-03-06 06:10:25 UTC (rev 18711)
@@ -4,10 +4,6 @@
 <section>
   <title>Function</title>
 
-  <note>
-    <para><replaceable>(updated to Drools 4.0)</replaceable></para>
-  </note>
-
   <figure>
     <title>function</title>
 

Modified: labs/jbossrules/branches/irooskov_docs/drools-docs/drools-docs-userguide/en/Chapter-Rule_Language/Section-Overview.xml
===================================================================
--- labs/jbossrules/branches/irooskov_docs/drools-docs/drools-docs-userguide/en/Chapter-Rule_Language/Section-Overview.xml	2008-03-06 00:58:39 UTC (rev 18710)
+++ labs/jbossrules/branches/irooskov_docs/drools-docs/drools-docs-userguide/en/Chapter-Rule_Language/Section-Overview.xml	2008-03-06 06:10:25 UTC (rev 18711)
@@ -4,10 +4,6 @@
 <section>
   <title>Overview</title>
 
-  <note>
-    <para><replaceable>(updated to Drools 4.0)</replaceable></para>
-  </note>
-
   <para>Drools 4.0 has a "native" rule language that is non XML textual
   format. This format is very light in terms of punctuation, and supports
   natural and domain specific languages via "expanders" that allow the

Modified: labs/jbossrules/branches/irooskov_docs/drools-docs/drools-docs-userguide/en/Chapter-Rule_Language/Section-Package.xml
===================================================================
--- labs/jbossrules/branches/irooskov_docs/drools-docs/drools-docs-userguide/en/Chapter-Rule_Language/Section-Package.xml	2008-03-06 00:58:39 UTC (rev 18710)
+++ labs/jbossrules/branches/irooskov_docs/drools-docs/drools-docs-userguide/en/Chapter-Rule_Language/Section-Package.xml	2008-03-06 06:10:25 UTC (rev 18711)
@@ -4,10 +4,6 @@
 <section>
   <title>Package</title>
 
-  <note>
-    <para><replaceable>(updated to Drools 4.0)</replaceable></para>
-  </note>
-
   <para>A package is a collection of rules and other related constructs, such
   as imports and globals. The package members are typically related to each
   other - perhaps HR rules, for instance. A package represents a namespace,

Modified: labs/jbossrules/branches/irooskov_docs/drools-docs/drools-docs-userguide/en/master.xml
===================================================================
--- labs/jbossrules/branches/irooskov_docs/drools-docs/drools-docs-userguide/en/master.xml	2008-03-06 00:58:39 UTC (rev 18710)
+++ labs/jbossrules/branches/irooskov_docs/drools-docs/drools-docs-userguide/en/master.xml	2008-03-06 06:10:25 UTC (rev 18711)
@@ -4,21 +4,27 @@
     <title>Drools User Guide</title>
 
     <releaseinfo>5.0.0.SNAPSHOT</releaseinfo>
-
+    
     <author>
       <firstname>Mark</firstname>
-      <surname>Proctor</surname>
+      <surname>Proctor - Author</surname>
     </author>
 
     <author>
       <firstname>Michael</firstname>
-      <surname>Neale</surname>
+      <surname>Neale - Author</surname>
     </author>
 
     <author>
       <firstname>Edson</firstname>
-      <surname>Tirelli</surname>
+      <surname>Tirelli - Author</surname>
     </author>
+
+    <author>
+    <firstname>Isaac</firstname>
+    <surname>Rooskov - Editor</surname>
+    <email>irooskov at redhat.com</email>
+    </author>
   </bookinfo>
 
 <!--
@@ -45,16 +51,31 @@
     </chapter>
 
     <chapter>
+	    <title>Installation and Setup (Core and IDE)</title>
+	    
+	    <xi:include href="Chapter-Install/Section-Install.xml" />
+<!--
+	    <xi:include href="Chapter-Install/Section-Setup.xml" />
+	    
+	    <xi:include href="Chapter-Install/Section-Checkout.xml" />
+	    
+	    <xi:include href="Chapter-Install/Section-Maven_build.xml" />
+	    
+	    <xi:include href="Chapter-Install/Section-Eclipse.xml" />
+-->
+    </chapter>
+    
+    <chapter>
       <title>The Rule Engine</title>
 
       <xi:include href="Chapter-Rule_Engine/Section-What_is_a_Rule_Engine.xml" />
-
+<!--
       <xi:include href="Chapter-Rule_Engine/Section-Why_use_a_Rule_Engine.xml" />
 
       <xi:include href="Chapter-Rule_Engine/Section-Rules.xml" />
 
       <xi:include href="Chapter-Rule_Engine/Section-Rete_Algorithm.xml" />
-
+-->
       <xi:include href="Chapter-Rule_Engine/Section-The_Drools_Rule_Engine.xml" />
 
       <!--xi:include href="Chapter-Rule_Engine/Section-Rule_Base.xml" />
@@ -65,19 +86,35 @@
 
       <xi:include href="Chapter-Rule_Engine/Section-Event_Model.xml" /-->
     </chapter>
+    
+    <chapter>
+	    <title>The Rule Language</title>
+	    
+	    <xi:include href="Chapter-Rule_Language/Section-Overview.xml" />
+	    
+	    <xi:include href="Chapter-Rule_Language/Section-Comments.xml" />
+	    
+	    <xi:include href="Chapter-Rule_Language/Section-Package.xml" />
+	    
+	    <xi:include href="Chapter-Rule_Language/Section-Function.xml" />
+	    
+	    <xi:include href="Chapter-Rule_Language/Section-Rule.xml" />
+	    
+	    <xi:include href="Chapter-Rule_Language/Section-Query.xml" />
+	    
+	    <xi:include href="Chapter-Rule_Language/Section-DSL.xml" />
+	    
+	    <xi:include href="Chapter-Rule_Language/Section-RuleFlow.xml" />
+	    
+	    <xi:include href="Chapter-Rule_Language/Section-XML.xml" />
+    </chapter>
 
     <chapter>
-      <title>Installation and Setup (Core and IDE)</title>
-
-      <xi:include href="Chapter-Install/Section-Install.xml" />
-
-      <xi:include href="Chapter-Install/Section-Setup.xml" />
-
-      <xi:include href="Chapter-Install/Section-Checkout.xml" />
-
-      <xi:include href="Chapter-Install/Section-Maven_build.xml" />
-
-      <xi:include href="Chapter-Install/Section-Eclipse.xml" />
+	    <title>Deployment and Testing</title>
+	    
+	    <xi:include href="Chapter-Deployment/Section-Deployment.xml" />
+	    
+	    <xi:include href="Chapter-Deployment/Section-Testing.xml" />
     </chapter>
 
     <chapter>
@@ -92,14 +129,6 @@
       <xi:include href="Chapter-IDE/Section-QuickStart.xml" />
     </chapter>
 
-    <chapter>
-      <title>Deployment and Testing</title>
-
-      <xi:include href="Chapter-Deployment/Section-Deployment.xml" />
-
-      <xi:include href="Chapter-Deployment/Section-Testing.xml" />
-    </chapter>
-
       <chapter>
         <title>The Java Rule Engine API</title>
 
@@ -114,27 +143,6 @@
         <xi:include href="Chapter-JSR94/Section-References.xml" />
       </chapter>
       
-    <chapter>
-      <title>The Rule Language</title>
 
-      <xi:include href="Chapter-Rule_Language/Section-Overview.xml" />
-
-      <xi:include href="Chapter-Rule_Language/Section-Comments.xml" />
-
-      <xi:include href="Chapter-Rule_Language/Section-Package.xml" />
-
-      <xi:include href="Chapter-Rule_Language/Section-Function.xml" />
-
-      <xi:include href="Chapter-Rule_Language/Section-Rule.xml" />
-
-      <xi:include href="Chapter-Rule_Language/Section-Query.xml" />
-
-      <xi:include href="Chapter-Rule_Language/Section-DSL.xml" />
-
-      <xi:include href="Chapter-Rule_Language/Section-RuleFlow.xml" />
-
-      <xi:include href="Chapter-Rule_Language/Section-XML.xml" />
-    </chapter>      
-
-  <index/>
-</book>
+<index/>
+</book>




More information about the jboss-svn-commits mailing list