[jboss-svn-commits] JBL Code SVN: r33648 - in labs/jbossrules/trunk/drools-docs/drools-docs-integration/src/main/docbook/en-US/Chapter-Commands: Section-Commands and 1 other directory.

jboss-svn-commits at lists.jboss.org jboss-svn-commits at lists.jboss.org
Fri Jun 25 14:51:35 EDT 2010


Author: lucazamador
Date: 2010-06-25 14:51:35 -0400 (Fri, 25 Jun 2010)
New Revision: 33648

Modified:
   labs/jbossrules/trunk/drools-docs/drools-docs-integration/src/main/docbook/en-US/Chapter-Commands/Section-API/Section-API.xml
   labs/jbossrules/trunk/drools-docs/drools-docs-integration/src/main/docbook/en-US/Chapter-Commands/Section-Commands/Section-AbortWorkItemCommand.xml
   labs/jbossrules/trunk/drools-docs/drools-docs-integration/src/main/docbook/en-US/Chapter-Commands/Section-Commands/Section-BatchExecutionCommand.xml
   labs/jbossrules/trunk/drools-docs/drools-docs-integration/src/main/docbook/en-US/Chapter-Commands/Section-Commands/Section-Commands.xml
   labs/jbossrules/trunk/drools-docs/drools-docs-integration/src/main/docbook/en-US/Chapter-Commands/Section-Commands/Section-CompleteWorkItemCommand.xml
   labs/jbossrules/trunk/drools-docs/drools-docs-integration/src/main/docbook/en-US/Chapter-Commands/Section-Commands/Section-GetGlobalCommand.xml
   labs/jbossrules/trunk/drools-docs/drools-docs-integration/src/main/docbook/en-US/Chapter-Commands/Section-Commands/Section-ModifyCommand.xml
   labs/jbossrules/trunk/drools-docs/drools-docs-integration/src/main/docbook/en-US/Chapter-Commands/Section-Commands/Section-RetractCommand.xml
   labs/jbossrules/trunk/drools-docs/drools-docs-integration/src/main/docbook/en-US/Chapter-Commands/Section-Commands/Section-SetGlobalCommand.xml
   labs/jbossrules/trunk/drools-docs/drools-docs-integration/src/main/docbook/en-US/Chapter-Commands/Section-Commands/Section-StartProcessCommand.xml
Log:
JBRULES-2542: Drools Commands documentation
- syntax errors

Modified: labs/jbossrules/trunk/drools-docs/drools-docs-integration/src/main/docbook/en-US/Chapter-Commands/Section-API/Section-API.xml
===================================================================
--- labs/jbossrules/trunk/drools-docs/drools-docs-integration/src/main/docbook/en-US/Chapter-Commands/Section-API/Section-API.xml	2010-06-25 18:29:55 UTC (rev 33647)
+++ labs/jbossrules/trunk/drools-docs/drools-docs-integration/src/main/docbook/en-US/Chapter-Commands/Section-API/Section-API.xml	2010-06-25 18:51:35 UTC (rev 33648)
@@ -8,15 +8,16 @@
          xmlns:db="http://docbook.org/ns/docbook">
   <title>API</title>
 
-  <para>XML marshalling/unmarshalling of the Drools Commands have to use
-  special classes that are going to be described in the next sections.</para>
+  <para>XML marshalling/unmarshalling of the Drools Commands requires the use
+  of special classes, which are going to be described in the following
+  sections.</para>
 
   <section>
     <title>XStream</title>
 
     <para>To use the XStream commands marshaller you need to use the
-    DroolsHelperProvider to obtain a XStream instance. We need to use this
-    because has the commands converters registered.</para>
+    DroolsHelperProvider to obtain an XStream instance. We need to use this
+    because it has the commands converters registered.</para>
 
     <itemizedlist>
       <listitem>
@@ -61,23 +62,23 @@
   <section>
     <title>JAXB</title>
 
-    <para>Using JAXB there are two options, you can define your model in a XSD
-    file or you can have a POJO model. In both cases you need to get a
-    JAXBContext that have your classes recognized, and it's why you need to
+    <para>There are two options for using JAXB, you can define your model in
+    an XSD file or you can have a POJO model. In both cases you have to
+    declare your model inside JAXBContext, and in order to do that you need to
     use Drools Helper classes. Once you have the JAXBContext you need to
-    create the Unmarshaller/Marshaller as you needs.</para>
+    create the Unmarshaller/Marshaller as needed.</para>
 
     <para></para>
 
     <section>
-      <title>Using a XSD file to define the model</title>
+      <title>Using an XSD file to define the model</title>
 
       <para>With your model defined in a XSD file you need to have a
       KnowledgeBase that has your XSD model added as a resource.</para>
 
       <para>To do this, the XSD file must be added as a XSD ResourceType into
       the KnowledgeBuilder. Finally you can create the JAXBContext using the
-      KnowledgeBase created with the KnowledgeBuilder</para>
+      KnowledgeBase created with the KnowledgeBuilder

</para>
 
       <para></para>
 
@@ -97,15 +98,14 @@
       <title>Using a POJO model</title>
 
       <para>In this case you need to use DroolsJaxbContextHelper to create the
-      JAXBContext, this class has two parameters:</para>
+      JAXBContext. This class has two parameters:</para>
 
       <para></para>
 
       <orderedlist>
         <listitem>
-          <para>classNames: A List with the cannonical name of the classes
-          that you want to use in the marshalling/unmarshalling
-          process.</para>
+          <para>classNames: A List with the canonical name of the classes that
+          you want to use in the marshalling/unmarshalling process.</para>
         </listitem>
 
         <listitem>

Modified: labs/jbossrules/trunk/drools-docs/drools-docs-integration/src/main/docbook/en-US/Chapter-Commands/Section-Commands/Section-AbortWorkItemCommand.xml
===================================================================
--- labs/jbossrules/trunk/drools-docs/drools-docs-integration/src/main/docbook/en-US/Chapter-Commands/Section-Commands/Section-AbortWorkItemCommand.xml	2010-06-25 18:29:55 UTC (rev 33647)
+++ labs/jbossrules/trunk/drools-docs/drools-docs-integration/src/main/docbook/en-US/Chapter-Commands/Section-Commands/Section-AbortWorkItemCommand.xml	2010-06-25 18:51:35 UTC (rev 33648)
@@ -12,7 +12,7 @@
 
   <itemizedlist>
     <listitem>
-      <para>Description: Allow abort an WorkItem. The same as
+      <para>Description: Allows you abort an WorkItem. The same as
       session.getWorkItemManager().abortWorkItem(workItemId)</para>
     </listitem>
 

Modified: labs/jbossrules/trunk/drools-docs/drools-docs-integration/src/main/docbook/en-US/Chapter-Commands/Section-Commands/Section-BatchExecutionCommand.xml
===================================================================
--- labs/jbossrules/trunk/drools-docs/drools-docs-integration/src/main/docbook/en-US/Chapter-Commands/Section-Commands/Section-BatchExecutionCommand.xml	2010-06-25 18:29:55 UTC (rev 33647)
+++ labs/jbossrules/trunk/drools-docs/drools-docs-integration/src/main/docbook/en-US/Chapter-Commands/Section-Commands/Section-BatchExecutionCommand.xml	2010-06-25 18:51:35 UTC (rev 33648)
@@ -12,8 +12,8 @@
 
   <itemizedlist>
     <listitem>
-      <para>Description: The main command, used to group a set of commands to
-      are going to be executed.</para>
+      <para>Description: The command that contains a list of commands, which
+      will be sent and executed.</para>
     </listitem>
 
     <listitem>

Modified: labs/jbossrules/trunk/drools-docs/drools-docs-integration/src/main/docbook/en-US/Chapter-Commands/Section-Commands/Section-Commands.xml
===================================================================
--- labs/jbossrules/trunk/drools-docs/drools-docs-integration/src/main/docbook/en-US/Chapter-Commands/Section-Commands/Section-Commands.xml	2010-06-25 18:29:55 UTC (rev 33647)
+++ labs/jbossrules/trunk/drools-docs/drools-docs-integration/src/main/docbook/en-US/Chapter-Commands/Section-Commands/Section-Commands.xml	2010-06-25 18:51:35 UTC (rev 33648)
@@ -8,7 +8,7 @@
          xmlns:db="http://docbook.org/ns/docbook">
   <title>Commands supported</title>
 
-  <para>At this moment the next commands are supported</para>
+  <para>Currently, the following commands are supported:</para>
 
   <itemizedlist>
     <listitem>
@@ -73,7 +73,7 @@
   </itemizedlist>
 
   <para><note>
-       In the next snippets code we are going to use a POJO org.drools.test.Person that have two fields 
+       In the next snippets code we are going to use a POJO org.drools.test.Person that has two fields 
 
       <itemizedlist>
         <listitem>

Modified: labs/jbossrules/trunk/drools-docs/drools-docs-integration/src/main/docbook/en-US/Chapter-Commands/Section-Commands/Section-CompleteWorkItemCommand.xml
===================================================================
--- labs/jbossrules/trunk/drools-docs/drools-docs-integration/src/main/docbook/en-US/Chapter-Commands/Section-Commands/Section-CompleteWorkItemCommand.xml	2010-06-25 18:29:55 UTC (rev 33647)
+++ labs/jbossrules/trunk/drools-docs/drools-docs-integration/src/main/docbook/en-US/Chapter-Commands/Section-Commands/Section-CompleteWorkItemCommand.xml	2010-06-25 18:51:35 UTC (rev 33648)
@@ -12,7 +12,7 @@
 
   <itemizedlist>
     <listitem>
-      <para>Description: Allow to complete a WorkItem.</para>
+      <para>Description: Allows you to complete a WorkItem.</para>
     </listitem>
 
     <listitem>

Modified: labs/jbossrules/trunk/drools-docs/drools-docs-integration/src/main/docbook/en-US/Chapter-Commands/Section-Commands/Section-GetGlobalCommand.xml
===================================================================
--- labs/jbossrules/trunk/drools-docs/drools-docs-integration/src/main/docbook/en-US/Chapter-Commands/Section-Commands/Section-GetGlobalCommand.xml	2010-06-25 18:29:55 UTC (rev 33647)
+++ labs/jbossrules/trunk/drools-docs/drools-docs-integration/src/main/docbook/en-US/Chapter-Commands/Section-Commands/Section-GetGlobalCommand.xml	2010-06-25 18:51:35 UTC (rev 33648)
@@ -12,7 +12,7 @@
 
   <itemizedlist>
     <listitem>
-      <para>Description: Allow to get a global previously defined.</para>
+      <para>Description: Allows you to get a global previously defined.</para>
     </listitem>
 
     <listitem>

Modified: labs/jbossrules/trunk/drools-docs/drools-docs-integration/src/main/docbook/en-US/Chapter-Commands/Section-Commands/Section-ModifyCommand.xml
===================================================================
--- labs/jbossrules/trunk/drools-docs/drools-docs-integration/src/main/docbook/en-US/Chapter-Commands/Section-Commands/Section-ModifyCommand.xml	2010-06-25 18:29:55 UTC (rev 33647)
+++ labs/jbossrules/trunk/drools-docs/drools-docs-integration/src/main/docbook/en-US/Chapter-Commands/Section-Commands/Section-ModifyCommand.xml	2010-06-25 18:51:35 UTC (rev 33648)
@@ -12,8 +12,8 @@
 
   <itemizedlist>
     <listitem>
-      <para>Description: Allow to modify a previously inserted object in the
-      knowledge session.</para>
+      <para>Description: Allows you to modify a previously inserted object in
+      the knowledge session.</para>
     </listitem>
 
     <listitem>

Modified: labs/jbossrules/trunk/drools-docs/drools-docs-integration/src/main/docbook/en-US/Chapter-Commands/Section-Commands/Section-RetractCommand.xml
===================================================================
--- labs/jbossrules/trunk/drools-docs/drools-docs-integration/src/main/docbook/en-US/Chapter-Commands/Section-Commands/Section-RetractCommand.xml	2010-06-25 18:29:55 UTC (rev 33647)
+++ labs/jbossrules/trunk/drools-docs/drools-docs-integration/src/main/docbook/en-US/Chapter-Commands/Section-Commands/Section-RetractCommand.xml	2010-06-25 18:51:35 UTC (rev 33648)
@@ -64,7 +64,7 @@
         </listitem>
 
         <listitem>
-          <para>Set the Fact Handle that you got when the object was
+          <para>Set the Fact Handle that you received when the object was
           inserted</para>
 
           <para><programlisting>BatchExecutionCommand command = new BatchExecutionCommand();

Modified: labs/jbossrules/trunk/drools-docs/drools-docs-integration/src/main/docbook/en-US/Chapter-Commands/Section-Commands/Section-SetGlobalCommand.xml
===================================================================
--- labs/jbossrules/trunk/drools-docs/drools-docs-integration/src/main/docbook/en-US/Chapter-Commands/Section-Commands/Section-SetGlobalCommand.xml	2010-06-25 18:29:55 UTC (rev 33647)
+++ labs/jbossrules/trunk/drools-docs/drools-docs-integration/src/main/docbook/en-US/Chapter-Commands/Section-Commands/Section-SetGlobalCommand.xml	2010-06-25 18:51:35 UTC (rev 33648)
@@ -12,7 +12,7 @@
 
   <itemizedlist>
     <listitem>
-      <para>Description: Allow to set a global.</para>
+      <para>Description: Allows you to set a global.</para>
     </listitem>
 
     <listitem>

Modified: labs/jbossrules/trunk/drools-docs/drools-docs-integration/src/main/docbook/en-US/Chapter-Commands/Section-Commands/Section-StartProcessCommand.xml
===================================================================
--- labs/jbossrules/trunk/drools-docs/drools-docs-integration/src/main/docbook/en-US/Chapter-Commands/Section-Commands/Section-StartProcessCommand.xml	2010-06-25 18:29:55 UTC (rev 33647)
+++ labs/jbossrules/trunk/drools-docs/drools-docs-integration/src/main/docbook/en-US/Chapter-Commands/Section-Commands/Section-StartProcessCommand.xml	2010-06-25 18:51:35 UTC (rev 33648)
@@ -12,8 +12,8 @@
 
   <itemizedlist>
     <listitem>
-      <para>Description: Allow to start a process using the ID. Also you can
-      pass parameters and initial data to be inserted.</para>
+      <para>Description: Allows you to start a process using the ID. Also you
+      can pass parameters and initial data to be inserted.</para>
     </listitem>
 
     <listitem>



More information about the jboss-svn-commits mailing list