[Jboss-svn-commits] JBL Code SVN: r4303 - labs/jbossrules/trunk/documentation/manual/en/Chapter-Install

[<jbo...@li...>]

Author: mar...@jb...
Date: 2006-05-17 20:09:54 -0400 (Wed, 17 May 2006)
New Revision: 4303

Added:
   labs/jbossrules/trunk/documentation/manual/en/Chapter-Install/manual4.jpg
Removed:
   labs/jbossrules/trunk/documentation/manual/en/Chapter-Install/manual1.jpg
   labs/jbossrules/trunk/documentation/manual/en/Chapter-Install/manual2.jpg
Modified:
   labs/jbossrules/trunk/documentation/manual/en/Chapter-Install/Section-Maven_build.xml
Log:
-fixed the manual build docs for using ant

Modified: labs/jbossrules/trunk/documentation/manual/en/Chapter-Install/Section-Maven_build.xml
===================================================================
--- labs/jbossrules/trunk/documentation/manual/en/Chapter-Install/Section-Maven_build.xml	2006-05-18 00:04:13 UTC (rev 4302)
+++ labs/jbossrules/trunk/documentation/manual/en/Chapter-Install/Section-Maven_build.xml	2006-05-18 00:09:54 UTC (rev 4303)
@@ -10,7 +10,7 @@
         <primary>Ant</primary>
       </indexterm>Ant, which uses maven 2 under the covers to get the needed
     dependencies (you don't need to have maven 2 installed to build). Note
-    that the plug in is build seperatly, but the build process will update the
+    that the plug in is built seperatly, but the build process will update the
     plug ins dependencies (refer to the section on building the plug in if you
     need to build a new version of the plug in).</para>
 
@@ -31,12 +31,11 @@
      [echo] drools-jsr94
      [echo]
      [echo] Further to this there are two Eclipse project:
-     [echo] drools-examples - To use open eclipse and import.
-     [echo]                   Requires the Drools eclipse plugin.
+     [echo] drools-examples - To use open Eclipse and import.
+     [echo]                   Requires the Drools Eclipse plugin.
      [echo]                   Either build the plugin from drools-ide
      [echo]                   or install from the Eclipse update site
-     [echo]                   http://anonsvn.labs.jboss.com/labs/jbossrules/upda
-tes
+     [echo]                   http://anonsvn.labs.jboss.com/labs/jbossrules/updates
      [echo] drools-ide      - To use open Eclipse and import.
      [echo]                   Select export and plugin fragements to
      [echo]                   generate the Drools Eclipse plugin
@@ -141,7 +140,8 @@
       <listitem>
         <para><indexterm>
             <primary>pdf</primary>
-          </indexterm>PDF</para>
+          </indexterm>PDF (currently broken, due to layout issues with image
+        sizes)</para>
 
         <para>A generated PDF, with nagivation.</para>
       </listitem>
@@ -153,31 +153,105 @@
       </listitem>
     </itemizedlist>
 
-    <para>The documentation is generated by using the <literal>'ant'</literal>
-    commandin the <literal>documentation\manual</literal> directory.</para>
+    <para>The manual can be generated from the project root's build.xml by
+    calling <literal>'ant manual'</literal>, with the generated documentation
+    being copied to <literal>'target/docs'</literal>. What actually happens is
+    a call to a separate ant build.xml for the manual, located at
+    <literal>documentation/manual</literal>; the documentation is generated
+    into <literal>documentation/manual/build</literal> before being copied to
+    <literal>'target/docs'.</literal><figure>
+        <title>Generating the Manual with Ant</title>
 
-    <screenshot>
-      <screeninfo>Start documentation building</screeninfo>
+        <programlisting>C:\dev\jbossrules&gt;ant manual
+Buildfile: build.xml
 
-      <mediaobject>
-        <imageobject>
-          <imagedata fileref="manual1.jpg" />
-        </imageobject>
-      </mediaobject>
-    </screenshot>
+manual:
+   [delete] Deleting directory D:\dev\jbossrules\documentation\manual\build
 
+clean:
+
+all.doc:
+
+lang.all:
+
+lang.misc:
+     [copy] Copying 102 files to C:\dev\jbossrules\documentation\manual\build\en\shared\images
+     [copy] Copying 1 file to C:\dev\jbossrules\documentation\manual\build\en\shared\css
+    [style] Transforming into C:\dev\jbossrules\documentation\manual\build\en\shared\images
+    [style] Processing C:\dev\jbossrules\documentation\manual\en\Chapter-Papers\guests_at_table.svg to C:\dev\jbossrules
+\documentation\manual\build\en\shared\images\Chapter-Papers\guests_at_table.svg
+    [style] Loading stylesheet C:\dev\jbossrules\documentation\manual\en\styles\visio_svg.xsl
+    [style] Processing C:\dev\jbossrules\documentation\manual\en\Chapter-Papers\make_path.svg to C:\dev\jbossrules\docum
+entation\manual\build\en\shared\images\Chapter-Papers\make_path.svg
+    [style] Processing C:\dev\jbossrules\documentation\manual\en\Chapter-Papers\manners_activity_diagram.svg to C:\dev\j
+bossrules\documentation\manual\build\en\shared\images\Chapter-Papers\manners_activity_diagram.svg
+    [style] Processing C:\dev\jbossrules\documentation\manual\en\Chapter-Performance_Tuning\beta_node.svg to C:\dev\jbos
+...
+snip
+...
+lang.dochtml:
+    [mkdir] Created dir: C:\dev\jbossrules\documentation\manual\build\en\html
+     [copy] Copying 1 file to C:\dev\jbossrules\documentation\manual\build\en\html
+     [java] Writing bk01-toc.html for book
+     [java] Writing pr01.html for preface(preface)
+     [java] ID recommended on part: Reference Manual
+     [java] ID recommended on chapter: The Rule Engine
+     [java] ID recommended on section: What is a Rule Engine
+     [java] ID recommended on section: Background
+     [java] ID recommended on figure: Inference Engine
+     [java] ID recommended on figure: SQL as a simplistic Inference Engine
+     [java] ID recommended on figure: Additional Reading
+     [java] ID recommended on section: Rules
+     [java] ID recommended on figure: A Basic Rete network
+     [java] ID recommended on figure: A Basic Rete network
+...
+snip
+...
+lang.dochtmlsingle:
+    [mkdir] Created dir: C:\dev\jbossrules\documentation\manual\build\en\html_single
+     [java] ID recommended on part: Reference Manual
+     [java] ID recommended on chapter: The Rule Engine
+     [java] ID recommended on section: What is a Rule Engine
+     [java] ID recommended on section: Background
+     [java] ID recommended on figure: Inference Engine
+     [java] ID recommended on figure: SQL as a simplistic Inference Engine
+     [java] ID recommended on figure: Additional Reading
+     [java] ID recommended on section: Rules
+     [java] ID recommended on figure: A Basic Rete network
+     [java] ID recommended on figure: A Basic Rete network
+     [java] ID recommended on section: Why use a Rule Engine
+...
+snip
+...
+     [java] ID recommended on section: Make Path and Path Done
+     [java] ID recommended on figure: Rete Diagram
+     [java] ID recommended on section: Continue and Are We Done
+     [java] ID recommended on section: Conclusion
+     [java] ID recommended on section: Output Summary
+     [java] ID recommended on index
+     [copy] Copying 142 files to C:\dev\jbossrules\target\docs
+
+BUILD SUCCESSFUL
+Total time: 54 seconds
+C:\dev\jbossrules&gt;</programlisting>
+      </figure></para>
+
+    <para>The generated manual can be found in the
+    <literal>target\docs</literal> directory, a folder per each format.</para>
+
     <screenshot>
-      <screeninfo>Finished documentation building</screeninfo>
+      <screeninfo>Generated documentation</screeninfo>
 
       <mediaobject>
         <imageobject>
-          <imagedata fileref="manual2.jpg" />
+          <imagedata fileref="manual4.jpg" />
         </imageobject>
       </mediaobject>
     </screenshot>
 
-    <para>The generated docuementation can be found in the
-    <literal>build</literal> directory, a folder per each format.</para>
+    <para>The manual was first generated into the manual's
+    <literal>build</literal> directory, as shown below, before being copied
+    across.</para>
 
     <screenshot>
       <screeninfo>Generated documentation</screeninfo>

Deleted: labs/jbossrules/trunk/documentation/manual/en/Chapter-Install/manual1.jpg
===================================================================
(Binary files differ)

Deleted: labs/jbossrules/trunk/documentation/manual/en/Chapter-Install/manual2.jpg
===================================================================
(Binary files differ)

Added: labs/jbossrules/trunk/documentation/manual/en/Chapter-Install/manual4.jpg
===================================================================
(Binary files differ)


Property changes on: labs/jbossrules/trunk/documentation/manual/en/Chapter-Install/manual4.jpg
___________________________________________________________________
Name: svn:mime-type
   + application/octet-stream