[jboss-svn-commits] JBL Code SVN: r14294 - labs/jbossrules/trunk/documentation/manual/en/Chapter-BRMS.
jboss-svn-commits at lists.jboss.org
jboss-svn-commits at lists.jboss.org
Thu Aug 16 02:47:30 EDT 2007
Author: fmeyer
Date: 2007-08-16 02:47:30 -0400 (Thu, 16 Aug 2007)
New Revision: 14294
Modified:
labs/jbossrules/trunk/documentation/manual/en/Chapter-BRMS/Section-AdminGuide.xml
labs/jbossrules/trunk/documentation/manual/en/Chapter-BRMS/Section-Architecture.xml
labs/jbossrules/trunk/documentation/manual/en/Chapter-BRMS/Section-ExamplesAndTutorials.xml
labs/jbossrules/trunk/documentation/manual/en/Chapter-BRMS/Section-Introduction.xml
labs/jbossrules/trunk/documentation/manual/en/Chapter-BRMS/Section-UserGuide.xml
Log:
JBRULES-1088 - spelling check BRMS docs
Modified: labs/jbossrules/trunk/documentation/manual/en/Chapter-BRMS/Section-AdminGuide.xml
===================================================================
--- labs/jbossrules/trunk/documentation/manual/en/Chapter-BRMS/Section-AdminGuide.xml 2007-08-16 06:05:36 UTC (rev 14293)
+++ labs/jbossrules/trunk/documentation/manual/en/Chapter-BRMS/Section-AdminGuide.xml 2007-08-16 06:47:30 UTC (rev 14294)
@@ -23,7 +23,7 @@
from http://labs.jboss.com/jbossrules/downloads), you will find the
drools-jbrms.war file in the zip file. Copy the WAR file into the
deployment directory of you app server, and then start your app server. If
- you need to customise some settings, you can first "explode" (unzip) the
+ you need to customize some settings, you can first "explode" (unzip) the
war file, and change any configuration settings, and then either zip it
up, or deploy it "exploded".</para>
@@ -39,7 +39,7 @@
<title>Supported and recommended platforms</title>
<para>The BRMS is capable of running in any application server that
- sypports Java SE5 (JEE 5 is not required) - this includes servlet
+ supports Java SE5 (JEE 5 is not required) - this includes servlet
containers like tomcat.</para>
<para>It is actively tested on JBoss platforms, and these are
@@ -107,11 +107,11 @@
<para>To change the location, unzip the WAR file, and locate the
components.xml file in the WEB-INF directory. This is a JBoss Seam
configuration file (Seam is the framework used) which allows various
- parts of the system to be customised. When you have located the
+ parts of the system to be customized. When you have located the
components.xml file, you should see something like the following:</para>
<programlisting><component name="repositoryConfiguration">
<!--
- *** This is for configuring the "home" directory for the repo storage. the directory must exist. ***
+ *** This is for configuring the "home" directory for the repository storage. the directory must exist. ***
<property name="homeDirectory">/home/michael/RulesRepository_001</property>
-->
@@ -169,7 +169,7 @@
<section>
<title>Searching and indexing, Version storage</title>
- <para>Jackrabbit has a seperate storage area for version storage (as
+ <para>Jackrabbit has a separate storage area for version storage (as
over time, the number of old versions will increase, yet it should not
slow down the performance of the main data store). The version storage
also has its own persistence manage configuration in the repository.xml,
@@ -190,7 +190,7 @@
<title>Security</title>
<para>Security is configured by using the components.xml file in the war
- file. To customise this, you will need to unzip the war file, and locate
+ file. To customize this, you will need to unzip the war file, and locate
the components.xml file which is in the WEB-INF directory.</para>
<para>The JAAS standard is used as the underlying authentication and
@@ -277,7 +277,7 @@
<para>LDAP isn't the final word, you can use JDBC against a database of
user name, or you can write your own login module to use any sort of
- wierd and wonderful authentication and authorisation systems that you
+ weird and wonderful authentication and authorization systems that you
may have to deal with (that would be an extreme case, but its possible).
Refer to JBoss AS documentation (or documentation for your existing
application server).</para>
@@ -308,10 +308,10 @@
</section>
<section>
- <title>Asset list customisation</title>
+ <title>Asset list customization</title>
<para>In a few places in the BRMS there is an asset list: this list can
- be customised by looking for the AssetListTable.properties file. You can
+ be customized by looking for the AssetListTable.properties file. You can
then set the header names and the "getter" methods that are used to
populate the columns. eg you could add in getCreator, or
getExternalSource as extra fields if you were using them.</para>
@@ -342,7 +342,7 @@
<iframe id='__gwt_historyFrame' style='width:0;height:0;border:0'></iframe>
</body>
</html></programlisting><para> The above is the contents of the JBRMS.html
- file - it is faily empty (as most of the work is done by the GWT - the
+ file - it is fairly empty (as most of the work is done by the GWT - the
GUI is built dynamically in the browser). The parts you can customise
are the style sheet - you can either edit the JBRMS.css (or better yet,
take a copy, and change the style to be what you need), the "shortcut
@@ -352,7 +352,7 @@
loaded and attached to the page. This html page is loaded only once by
the browser when the user accesses the BRMS web GUI.</para>
- <para>The best way to customise is to take a copy of the JBRMS.html -
+ <para>The best way to customize is to take a copy of the JBRMS.html -
and then edit. You can also change the URL by editing the web.xml via
the normal means. </para>
</section>
Modified: labs/jbossrules/trunk/documentation/manual/en/Chapter-BRMS/Section-Architecture.xml
===================================================================
--- labs/jbossrules/trunk/documentation/manual/en/Chapter-BRMS/Section-Architecture.xml 2007-08-16 06:05:36 UTC (rev 14293)
+++ labs/jbossrules/trunk/documentation/manual/en/Chapter-BRMS/Section-Architecture.xml 2007-08-16 06:47:30 UTC (rev 14294)
@@ -4,7 +4,7 @@
<section>
<title>Architecture</title>
- <para>This section covers the innards of the BRMS - it is not neccesary to
+ <para>This section covers the innards of the BRMS - it is not necessary to
use this if you are integrating or an end user of the BRMS application.
However, JBoss Rules is open source, so build instructions form part of the
manual.</para>
@@ -28,7 +28,7 @@
parts that are highly configurable (eg database).</para>
<para>The BRMS is deployed as a war, which provides user interfaces over the
- web, and provides binary packages via URLs (or files). It utilised the
+ web, and provides binary packages via URLs (or files). It utilized the
JSR-170 standard for data storage (JCR). JBoss Seam is used as the component
framework, and GWT is used as the widget toolkit for constructing the ajax
based web user interface.</para>
@@ -61,11 +61,11 @@
<para>Initially, you should go into the root of the jboss-rules checked
out source tree, and run mvn install to install all the components for
- the inter project depedencies. If the build is broken (no ! say it isn't
+ the inter project dependencies. If the build is broken (no ! say it isn't
so !) you can use the flag -Dmaven.test.skip=true to prevent failing
unit tests from preventing the build.</para>
- <para>When you wan't to build the BRMS - you can go into the
+ <para>When you want to build the BRMS - you can go into the
drools-jbrms directory, and run "mvn package" - this will run the tests,
and then build a deployable war. The only thing this won't do is rebuild
the GWT front end (see the next section for details on that). Once you
@@ -78,7 +78,7 @@
<para>The GUI widgets for the web front end are developed with GWT
(google web toolkit). If you need to make changes to or build the GUI,
- you will need to download GWT seperately. Once GWT is downloaded, you
+ you will need to download GWT separately. Once GWT is downloaded, you
can modify the build.properties file in the drools-jbrms directory to
point to where you installed GWT. Once you have this, you can use the
ant tasks to build the GWT components, as well as launch GWT in
@@ -126,14 +126,14 @@
<section>
<title>Re-usable components</title>
- <para>The BRMS uses a service interface to seperate the GUI from the "back
+ <para>The BRMS uses a service interface to separate the GUI from the "back
end" functionality - in this case the back end both includes the asset
repository (drools-repository and JCR) as well as the compiler specifics
to deal with rules. </para>
<para>The main interface is RepositoryService, which is implemented in
ServiceImplementation. The GWT ajax front end talks to this interface (via
- the async callback mechanism that GWT uses). The seam configuration file
+ the asynchrony callback mechanism that GWT uses). The seam configuration file
is components.xml (consult Seam documentation, and the components.xml file
for details).</para>
@@ -142,16 +142,16 @@
<para>The GWT user interface may be re-used - as it is GWT there is only
one html page: JBRMS.html. For those familiar with GWT, each of the
- "features" can be used seperate (eg in a portal) - look at the
+ "features" can be used separate (eg in a portal) - look at the
JBRMSFeature class and the classes that implement it (they can in theory
be stand alone).</para>
<para>Normally the BRMS is intended to be deployed as its own war, however
you could in theory combine it with your own application (with some care)
- - but it is easier to keep it as a seperate war, and will make it easier
+ - but it is easier to keep it as a separate war, and will make it easier
to upgrade to newer releases as they come out.</para>
- <para>The JBRMS.html file can be customised - for example to change logos or embed
+ <para>The JBRMS.html file can be customized - for example to change logos or embed
the BRMS in another page. Take a look at the JBRMS.html file for details (its
very simple).
</para>
@@ -167,7 +167,7 @@
</para>
<para>When "snapshots" are created, copies are made of the entire package
- into a seperate location in the JCR database. </para>
+ into a separate location in the JCR database. </para>
<para>For those familiar with jcr and jackrabbit, you can look at the
*.cnd files in the source for the node type definitions. In a nutshell, a
@@ -178,7 +178,7 @@
<section>
<title>Contributing</title>
- <para>Consult the wiki and project homepages if you are interested in
+ <para>Consult the wiki and project home-pages if you are interested in
contributing. A useful way to contribute is via logging issues or feature
requests in JIRA. However, if you are creating an issue in JIRA for the
BRMS, it is important that you choose "drools-brms" as the component in
Modified: labs/jbossrules/trunk/documentation/manual/en/Chapter-BRMS/Section-ExamplesAndTutorials.xml
===================================================================
--- labs/jbossrules/trunk/documentation/manual/en/Chapter-BRMS/Section-ExamplesAndTutorials.xml 2007-08-16 06:05:36 UTC (rev 14293)
+++ labs/jbossrules/trunk/documentation/manual/en/Chapter-BRMS/Section-ExamplesAndTutorials.xml 2007-08-16 06:47:30 UTC (rev 14294)
@@ -15,7 +15,7 @@
(I wouldn't).</para>
<para>This example takes you through the key steps in using the BRMS
- with an example respository, and using rules in a very very simple
+ with an example repository, and using rules in a very very simple
application (which you can use as a basis for your applications).</para>
<itemizedlist>
Modified: labs/jbossrules/trunk/documentation/manual/en/Chapter-BRMS/Section-Introduction.xml
===================================================================
--- labs/jbossrules/trunk/documentation/manual/en/Chapter-BRMS/Section-Introduction.xml 2007-08-16 06:05:36 UTC (rev 14293)
+++ labs/jbossrules/trunk/documentation/manual/en/Chapter-BRMS/Section-Introduction.xml 2007-08-16 06:47:30 UTC (rev 14294)
@@ -69,11 +69,11 @@
<title>Who uses a BRMS</title>
<para>The main roles of people who would use a BRMS are: Business
- Analyst, Rule expert, Developer, Administrators (rule admins etc).
+ Analyst, Rule expert, Developer, Administrators (rule administrators etc).
</para>
<para>The BRMS is designed in such a way as these different roles can be
- accomodated, it can be controlled how much is exposed to different users in a safe fashion.</para>
+ accommodated, it can be controlled how much is exposed to different users in a safe fashion.</para>
</section>
</section>
@@ -82,13 +82,13 @@
<itemizedlist>
<listitem>
- <para>Mutliple types of rule editors (GUI, text)</para>
+ <para>Multiple types of rule editors (GUI, text)</para>
</listitem>
<listitem>
<para>Version control (historical assets)</para>
</listitem>
<listitem>
- <para>Cateogorisation</para>
+ <para>Categorization</para>
</listitem>
<listitem>
<para>Build and deploy</para>
Modified: labs/jbossrules/trunk/documentation/manual/en/Chapter-BRMS/Section-UserGuide.xml
===================================================================
--- labs/jbossrules/trunk/documentation/manual/en/Chapter-BRMS/Section-UserGuide.xml 2007-08-16 06:05:36 UTC (rev 14293)
+++ labs/jbossrules/trunk/documentation/manual/en/Chapter-BRMS/Section-UserGuide.xml 2007-08-16 06:47:30 UTC (rev 14294)
@@ -132,7 +132,7 @@
</listitem>
<listitem>
- <para>You will also have to choose one category. Cateogies provide a
+ <para>You will also have to choose one category. Categories provide a
way of viewing rules that is separate to packages (and you can make
rules appear in multiple packages) - think of it like
tagging.</para>
@@ -143,7 +143,7 @@
</listitem>
<listitem>
- <para>This will open a rule modeller, which is a guided editor. You
+ <para>This will open a rule modeler, which is a guided editor. You
can add and edit conditions and actions based on the model that is
in use in the current package. Also, any DSL sentence templates
setup for the package will be available.</para>
@@ -234,7 +234,7 @@
</mediaobject>
</figure>
- <para>Categories allow rules (assets) to be labelled (or tagged) with
+ <para>Categories allow rules (assets) to be labeled (or tagged) with
any number of categories that you define. This means that you can then
view a list of rules that match a specific category. Rules can belong to
any number of categories. In the above diagram, you can see this can in
@@ -246,7 +246,7 @@
<para>Generally categories are created with meaningful name that match
the area of the business the rule applies to (if the rule applies to
multiple areas, multiple categories can be attached). Categories can
- also be used to "tag" rules as part of their lifecycle, for example to
+ also be used to "tag" rules as part of their life-cycle, for example to
mark as "Draft" or "For Review".</para>
<figure>
@@ -295,7 +295,7 @@
<para>The above view shows the administration screen for setting up
categories (there) are no categories in the system by default. As the
- categories can be hierachical you chose the "parent" category that you
+ categories can be hierarchical you chose the "parent" category that you
want to create a sub-category for. From here categories can also be
removed (but only if they are not in use by any current versions of
assets).</para>
@@ -604,7 +604,7 @@
</mediaobject>
</figure>
- <para>A dsl rule is a single rule. Refering to the picture above, you
+ <para>A dsl rule is a single rule. Referring to the picture above, you
can a text editor. You can use the icons to the right to provide lists
of conditions and actions to choose from (or else press Control +
Space at the same time to pop up a list).</para>
@@ -753,7 +753,7 @@
by someone with some experience with rules/models. Generally speaking,
very few people will need to configure packages, and once they are
setup, they can be copied over and over if needed. Package configuration
- is most definately a technical task that requires the appropriate
+ is most definitely a technical task that requires the appropriate
expertise.</para>
<para>All assets live in "packages" in the BRMS - a package is like a
@@ -804,7 +804,7 @@
</listitem>
<listitem>
- <para>DSL: Domain Specific Lanaguages can also be stored as an
+ <para>DSL: Domain Specific Languages can also be stored as an
asset. If they exist (generally there is only one), then they will
be used in the appropriate editor GUIs.</para>
</listitem>
@@ -934,7 +934,7 @@
</figure>
<para>The above shows deployment snapshots view. On the left there is a
- list of packages. Clilcking on a specific package will show you a list
+ list of packages. Clicking on a specific package will show you a list
of snapshots for that package (if any). From there you can copy, remove
or view an asset snapshot. Each snapshot is available for download or
access via a URL for deployment.</para>
@@ -944,11 +944,11 @@
<title>Navigating and finding rules</title>
<para>The two main ways of viewing the repository are by using
- user-driven Categorisation (tagging) as outlined above, and the package
+ user-driven Categorization (tagging) as outlined above, and the package
explorer view.</para>
<para>The category view provides a way to navigate your rules in a way
- that makes sense to your organisation.</para>
+ that makes sense to your organization.</para>
<figure>
<title>Category view</title>
@@ -994,7 +994,7 @@
required to use the BRMS. In fact any software system in some sense
requires that people be "technical" even if it has a nice looking GUI.
Having said that, in the right hands the BRMS can be setup to provide a
- sutiable environment for non technical users.</para>
+ suitable environment for non technical users.</para>
<para>The most appropriate rule formats for this use are using the Guided
editor, Decision tables and DSL rules. You can use some DSL expressions
@@ -1119,7 +1119,7 @@
<para>localCacheDir</para>
<para>This is used in conjunction with the url above, so that if the
- BRMS is down (the url is not accessable) then if the runtime has to
+ BRMS is down (the url is not accessible) then if the runtime has to
start up, it can start up with the last known "good" versions of the
packages.</para>
</listitem>
More information about the jboss-svn-commits
mailing list