Import drools docs (2/10)

drools-docs/doc-authoring-guideline-and-cheatsheet.txt

@@ -0,0 +1,181 @@
+Drools Documentation Authoring Guideline and Cheat Sheet
+========================================================
+
+Guideline
+=========
+* please markup all package names, class names, method names, etc. with 
+  <code></code>.
+
+  example:
+    <para>The <code>JavaDialectConfiguration</code> allows the compiler
+     and language levels to be supported. You can override by setting the
+    <code>drools.dialect.java.compiler</code> property in a 
+    <code>packagebuilder.conf</code> file that the 
+    <code>ChainedProperties</code> instance will find, or you can do it 
+    at runtime as shown below.</para>
+
+* please link svg image files instead of png bitmaps in the text whenever
+  possible.
+
+* Please avoid using .bmp bitmaps, since it will bloat size of the end 
+  doc. Use any image processing program such as GIMP to convert your bmp 
+  images to png images first. Better yet, use any vector graphic program
+  such as InkScape to scan your bmp image and make a true svg image out
+  of it. But this approach may take time and effort, recommanded for 
+  processing diagrams but not screenshots.
+
+
+Cheat Sheet
+===========
+
+Text boxes implemented in the jboss docbook styles:
+---------------------------------------------------
+* <caution><para></para></caution>
+* <important><para></para></important>
+* <note><para></para></note>
+* <tip><para></para></tip>
+* <warning><para></para></warning>
+
+Linking syntax in DocBook 5.0+:
+-------------------------------
+http://www.sagehill.net/docbookxsl/Db5Tools.html#Db5UnivLinking
+
+Note: The jboss docbook xsl does not support docbook 5.0 syntax yet,
+so please use the docbook 4.5 linking syntax for the links. 
+
+Markup program list or console output:
+--------------------------------------
+
+* as Example:
+
+    <example>
+      <title>Configuring the <code>JavaDialectConfiguration</code> 
+      to use JANINO via a setter</title>
+
+      <programlisting><![CDATA[PackageBuilderConfiguration cfg = new PackageBuilderConfiguration( );
+JavaDialectConfiguration javaConf = (JavaDialectConfiguration) cfg.getDialectConfiguration( "java" );
+javaConf.setCompiler( JavaDialectConfiguration.JANINO );]]></programlisting>
+    </example>
+
+* Simple (not as Example):
+
+  <programlisting ><![CDATA[ your code here...  ]]></programlisting>
+
+
+Link image files:
+-----------------
+
+* suitable for diagrams:
+
+  <figure>
+    <title>High-level View of a Rule Engine</title>
+    <mediaobject>
+      <imageobject>
+        <imagedata align="center" 
+        fileref="images/Chapter-Rule_Engine/rule-engine-inkscape.svg" 
+        format="SVG" contentwidth="540px" contentdepth="300px" />
+      </imageobject>
+    </mediaobject>
+  </figure>
+
+* suitable for screenshots:
+
+  TODO
+
+
+Lists
+-----
+
+* unnumbered list (bullets):
+
+    <itemizedlist>
+      <listitem> <para>Linear</para> </listitem>
+      ...
+    </itemizedlist>
+
+* numbered list:
+    <orderedlist>
+      <listitem> <para> Initialize the .... </para> </listitem>
+      ...
+    </orderedlist>
+
+
+Indexed terms:
+-------------
+
+  <para>Drools implements and extends the 
+  <indexterm><primary>Rete</primary></indexterm> Rete algorithm, 
+  <indexterm><primary>Leaps</primary></indexterm> ...</para>
+
+
+Citations:
+---------
+<para>To quote a Drools mailing list regular: 
+<blockquote>
+  <attribution>Dave Hamu</attribution>
+  <para>It seems to me
+    that in the excitement of working with rules engines, that people forget
+    that a rules engine is only one piece of a complex application or
+    solution. Rules engines are not really intended to handle workflow or
+    process executions nor are workflow engines or process management tools
+    designed to do rules. Use the right tool for the job. Sure, a pair of
+    pliers can be used as a hammering tool in a pinch, but that's not what
+    it's designed for.</para>
+  </blockquote>
+</para>
+
+You can see the effect of the above example code here:
+https://hudson.jboss.org/hudson/job/drools/lastSuccessfulBuild/artifact/trunk/target/docs/drools-expert/html/ch01.html#d0e231
+
+
+Show source of reference:
+-------------------------
+<para>The term "Production Rule" originates from formal grammar - where it
+    is described as "an abstract structure that describes a formal language
+    precisely, i.e., a set of rules that mathematically delineates a (usually
+    infinite) set of finite-length strings over a (usually finite) alphabet"
+    (<ulink url="http://en.wikipedia.org/wiki/Formal_grammar">
+    <citetitle>wikipedia</citetitle>
+    </ulink>).
+</para>
+
+You can see the the effect of the above example code here:
+https://hudson.jboss.org/hudson/job/drools/lastSuccessfulBuild/artifact/trunk/target/docs/drools-expert/html/ch01.html#d0e41
+
+You can of course combine the <blockquote>, <ulink> and <citetitle> together.
+
+
+Footnotes:
+----------
+TODO
+
+
+Callouts:
+---------
+TODO
+
+  ======================================
+
+I guess the "reference section" would be somehow like a bibliography
+section in a book or paper. Here is the information I found for
+bibliography markup:
+
+http://www.docbook.org/tdg5/en/html/bibliography.html
+
+But I'm not sure whether it is working with the JBoss customized XSLT
+and CSS. If it looks too complex for you, just don't waste your time
+and I'll try it out later and add the relevant information to the
+cheatsheet.
+
+For the "Definition/Concept", I found the <termdef> tag that might be
+what you want:
+
+http://www.docbook.org/tdg5/en/html/termdef.html
+
+The example in the page looks not that complex. You can give it a try.
+Be warned I've not tested it yet (have much to do in the office for
+now), if this markup breaks the build, please let me know. (If it does
+not break the build, but you do not see any obvious visual effect,
+that means this tag is not defined the css. This is small problem and
+you can keep using the markup. I'm into CSS these days and will sooner
+or later update the Drools css for documentation.)

drools-docs/docbook-style-drools/pom.xml

@@ -7,7 +7,7 @@
   <parent>
     <artifactId>drools-docs</artifactId>
     <groupId>org.drools</groupId>
-    <version>5.0.0.SNAPSHOT</version>
+    <version>5.0.0</version>
   </parent>
 
   <groupId>org.drools</groupId>

drools-docs/docbook-style-drools/src/main/css/css/documentation.css

@@ -295,7 +295,7 @@ div.note h2, div.note p, div.tip h2, div.tip p, div.caution h2, div.caution p, d
     height:89px;
     width:310px;
     float:left;
-    background:url(../images/community/drools_logo.png) top left no-repeat;
+    background:url(../images/drools_logo.png) top left no-repeat;
 }
 
 #title a.doc_href {

drools-docs/docbook-xsl-drools/pom.xml

@@ -6,7 +6,7 @@
 	<parent>
 		<artifactId>drools-docs</artifactId>
 		<groupId>org.drools</groupId>
-		<version>5.0.0.SNAPSHOT</version>
+		<version>5.0.0</version>
 	</parent>
 
 	<groupId>org.drools</groupId>

drools-docs/drools-docs-expert/pom.xml

@@ -6,7 +6,7 @@
 	<parent>
 		<artifactId>drools-docs</artifactId>
 		<groupId>org.drools</groupId>
-		<version>5.0.0.SNAPSHOT</version>
+		<version>5.0.0</version>
 	</parent>
 
 	<artifactId>drools-docs-expert</artifactId>

drools-docs/drools-docs-expert/src/main/docbook/de-DE/master.xml

@@ -0,0 +1,35 @@
+<?xml version="1.0" encoding="UTF-8"?>
+
+<book version="5.0" xmlns="http://docbook.org/ns/docbook"
+  xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude"
+  xmlns:svg="http://www.w3.org/2000/svg" xmlns:m="http://www.w3.org/1998/Math/MathML"
+  xmlns:html="http://www.w3.org/1999/xhtml" xmlns:db="http://docbook.org/ns/docbook">
+  <info>
+    <title>Drools Expert User Guide</title>
+
+    <releaseinfo>5.0.0</releaseinfo>
+
+    <author>
+      <personname>
+        <firstname>Mark</firstname>
+        <surname>Proctor</surname>
+      </personname>
+    </author>
+
+    <author>
+      <personname>
+        <firstname>Michael</firstname>
+        <surname>Neale</surname>
+      </personname>
+    </author>
+
+    <author>
+      <personname>
+        <firstname>Edson</firstname>
+        <surname>Tirelli</surname>
+      </personname>
+    </author>
+  </info>
+
+  <index />
+</book>

drools-docs/drools-docs-expert/src/main/docbook/en-US/Acknowledgements.xml

@@ -0,0 +1,29 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<chapter version="5.0" xmlns="http://docbook.org/ns/docbook"
+         xmlns:xlink="http://www.w3.org/1999/xlink"
+         xmlns:xi="http://www.w3.org/2001/XInclude"
+         xmlns:svg="http://www.w3.org/2000/svg"
+         xmlns:m="http://www.w3.org/1998/Math/MathML"
+         xmlns:html="http://www.w3.org/1999/xhtml"
+         xmlns:db="http://docbook.org/ns/docbook">
+  <title>Acknowledgements</title>
+
+  <section>
+    <title>Documentation</title>
+
+    <para>We would like to thank the following persons that contributed either
+    directly or indirectly in building the documentation that is presented
+    here. The list is presented in no particular order and the appreciation of
+    both the Drools team and the community is due.</para>
+
+    <itemizedlist>
+      <listitem>
+        <para>Peter Samouelian</para>
+      </listitem>
+    </itemizedlist>
+
+    <para>If you contributed to the project in some way and your name is not
+    listed above, please drop us a note with your name and e-mail and we will
+    gladly add it. </para>
+  </section>
+</chapter>