[jboss-svn-commits] JBL Code SVN: r13721 - labs/jbossrules/trunk/documentation/manual/en/Chapter-Install.
jboss-svn-commits at lists.jboss.org
jboss-svn-commits at lists.jboss.org
Mon Jul 23 01:30:26 EDT 2007
Author: fmeyer
Date: 2007-07-23 01:30:26 -0400 (Mon, 23 Jul 2007)
New Revision: 13721
Modified:
labs/jbossrules/trunk/documentation/manual/en/Chapter-Install/Section-Eclipse.xml
labs/jbossrules/trunk/documentation/manual/en/Chapter-Install/Section-Maven_build.xml
labs/jbossrules/trunk/documentation/manual/en/Chapter-Install/Section-Setup.xml
Log:
Updating docs
Modified: labs/jbossrules/trunk/documentation/manual/en/Chapter-Install/Section-Eclipse.xml
===================================================================
--- labs/jbossrules/trunk/documentation/manual/en/Chapter-Install/Section-Eclipse.xml 2007-07-23 05:20:45 UTC (rev 13720)
+++ labs/jbossrules/trunk/documentation/manual/en/Chapter-Install/Section-Eclipse.xml 2007-07-23 05:30:26 UTC (rev 13721)
@@ -92,8 +92,8 @@
<para>When calling <literal>'mvn install'</literal> all the project
dependencies were downloaded and added to the local Maven repository.
- Eclipse cannot find those depenencies unless you tell it where that
- repository is. To do this setup an M2_REPO claspath variable.</para>
+ Eclipse cannot find those dependencies unless you tell it where that
+ repository is. To do this setup an M2_REPO classpath variable.</para>
<screenshot>
<screeninfo>Open the Preferences dialogue window</screeninfo>
@@ -186,7 +186,7 @@
the jar to the Eclipse plugin directory.</para>
<screenshot>
- <screeninfo>Open the direcotry with the build jar</screeninfo>
+ <screeninfo>Open the directory with the build jar</screeninfo>
<mediaobject>
<imageobject>
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 2007-07-23 05:20:45 UTC (rev 13720)
+++ labs/jbossrules/trunk/documentation/manual/en/Chapter-Install/Section-Maven_build.xml 2007-07-23 05:30:26 UTC (rev 13721)
@@ -6,15 +6,13 @@
<title>Building the Source</title>
<para>Now that we have the source the next step is to build and install
- the source. We do this with</para>
-
- <para>Since version 3.1 Drools uses <indexterm>
- <primary>maven2</primary>
- </indexterm> as default to build the system. There are two profiles
+ the source. Since version 3.1 Drools uses <indexterm>
+ <primary>Maven 2</primary>
+ </indexterm> to build the system. There are two profiles
available which enable the associated modules "documentation" and
"eclipse"; this enables quicker building of the core modules for
developers. The eclipse profile will download eclipse into the
- drools-eclipse folder, which is over 100MB download, however this only
+ drools-eclipse folder, which is over 100MB download (It depends on your operation system), however this only
needs to be done once; if you wish you can move that eclipse download into
another location and specify it with
-DlocalEclipseDrop=/folder/jboss-rules/local-eclipse-drop-mirror. The
@@ -24,10 +22,10 @@
<para><programlisting>mvn -Declipse -Ddocumentation clean install -DlocalEclipseDrop=/folder/jboss-rules/local-eclipse-drop-mirror </programlisting></para>
<para>You can produce distribution builds, which puts everything into
- zips, as follows:<programlisting>mvn -Declipse -Ddocumentation clean install -DlocalEclipseDrop=/folder/jboss-rules/local-eclipse-drop-mirror
-
+ zips, as follows:
+<programlisting>mvn -Declipse -Ddocumentation clean install -DlocalEclipseDrop=/folder/jboss-rules/local-eclipse-drop-mirror
mvn -Ddocumentation -Declipse -Dmaven.test.skip package javadoc:javadoc assembly:assembly -DlocalEclipseDrop=/folder/jboss-rules/local-eclipse-drop-mirror
- </programlisting></para>
+</programlisting></para>
<para>Note that install must be done first as javadoc:javadoc won't work
unless the jars are in the local maven repo, but the tests can be skipped
@@ -61,10 +59,8 @@
<para>Drools uses <indexterm>
<primary>docbook</primary>
- </indexterm>Docbook for this manual. Ant is used to build the
- documentation. The documentation produces four different formats, all
- share the same images directory. PDFs will attempt to use SVG images where
- possible.</para>
+ </indexterm>Docbook for this manual. Ant is used internally in maven to build documents and this build produces three different formats,
+ all sharing the same images directory.</para>
<itemizedlist>
<listitem>
@@ -83,36 +79,30 @@
</listitem>
<listitem>
- <para><indexterm>
- <primary>pdf</primary>
- </indexterm>PDF (currently broken, due to layout issues with image
- sizes)</para>
-
- <para>A generated PDF, with nagivation.</para>
- </listitem>
-
- <listitem>
<para>eclipse</para>
<para>Documentation suitable for including in an eclipse plugin</para>
</listitem>
</itemizedlist>
- <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
+ <para>The manual can be generated from the project pom.xml by
+ calling <literal>'mvn package'</literal> in the documentation directory or adding the -Ddocumentation switch when you build the sources,
+ with the generated documentation being copied to <literal>'target/</literal>. What actually happens is that maven
+ call 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>
+ <literal>'target/'.</literal>
- <programlisting>C:\dev\jbossrules>ant manual
-Buildfile: build.xml
+ <programlisting>fmeyer:~/projects/jbossrules/documentation $ mvn clean package
+[INFO] Scanning for projects...
+[INFO] ----------------------------------------------------------------------------
+[INFO] Building Drools :: Documentation
+[INFO] task-segment: [install]
+[INFO] ----------------------------------------------------------------------------
+[INFO] [antrun:run {execution: manual}]
+[INFO] Executing tasks
+ [delete] Deleting directory /Users/fernandomeyer/projects/jbossrules/documentation/manual/build
-manual:
- [delete] Deleting directory D:\dev\jbossrules\documentation\manual\build
-
clean:
all.doc:
@@ -120,69 +110,65 @@
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
-...
+ [copy] Copying 188 files to /Users/fernandomeyer/projects/jbossrules/documentation/manual/build/en/shared/images
+ [copy] Copying 1 file to /Users/fernandomeyer/projects/jbossrules/documentation/manual/build/en/shared/css
+
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
+ [mkdir] Created dir: /Users/fernandomeyer/projects/jbossrules/documentation/manual/build/en/html
+ [copy] Copying 1 file to /Users/fernandomeyer/projects/jbossrules/documentation/manual/build/en/html
+ [java] Writing bk01-toc.html for book
+ [java] Writing pr01.html for preface(preface)
+ [java] Writing ch01s02.html for section
+ [java] Writing ch01s03.html for section
+ [java] Writing ch01s04.html for section
+ [java] Writing ch01s05.html for section
+ [java] Writing ch01s06.html for section
+ [java] Writing ch01.html for chapter
+ [java] Writing ch02s02.html for section
+ [java] Writing ch02s03.html for section
+ [java] Writing ch02s04.html for section
+ [java] Writing ch02s05.html for section
+ [java] Writing ch02.html for chapter
+ [java] Writing ch03s02.html for section
+ [java] Writing ch03s03.html for section
+ [java] Writing ch03s04.html for section
+ [java] Writing ch03s05.html for section
+ [java] Writing ch03s06.html for section
+ [java] Writing ch03s07.html for section
+ [java] Writing ch03s08.html for section
+ [java] Writing ch03s09.html for section
+ [java] Writing ch03.html for chapter
+ [java] Writing ch04.html for chapter
+ [java] Writing ch05.html for chapter
+ [java] Writing ch06s02.html for section
+ [java] Writing ch06s03.html for section
+ [java] Writing ch06s04.html for section
+ [java] Writing ch06s05.html for section
+ [java] Writing ch06.html for chapter
+ [java] Writing ch07s02.html for section
+ [java] Writing ch07s03.html for section
+ [java] Writing ch07.html for chapter
+ [java] Writing ch08.html for chapter
+ [java] Writing ch09.html for chapter
+ [java] Writing ch10s02.html for section
+ [java] Writing ch10.html for chapter
+ [java] Writing ch11.html for chapter
+ [java] Writing pt01.html for part
+ [java] Writing ix01.html for index
+ [java] Writing title.html for book
-BUILD SUCCESSFUL
-Total time: 54 seconds
-C:\dev\jbossrules></programlisting>
- </figure></para>
+...snip ...
+[INFO] ------------------------------------------------------------------------
+[INFO] BUILD SUCCESSFUL
+[INFO] ------------------------------------------------------------------------
+[INFO] Total time: 51 seconds
+[INFO] Finished at: Mon Jul 21 12:03:38 BRT 2007
+[INFO] Final Memory: 5M/10M
+[INFO] ------------------------------------------------------------------------></programlisting>
+ </para>
<para>The generated manual can be found in the
- <literal>target\docs</literal> directory, a folder per each format.</para>
+ <literal>target\drools-documentation$VERSION.jar'</literal> file, a compressed archive with all formats.</para>
<screenshot>
<screeninfo>Generated documentation</screeninfo>
Modified: labs/jbossrules/trunk/documentation/manual/en/Chapter-Install/Section-Setup.xml
===================================================================
--- labs/jbossrules/trunk/documentation/manual/en/Chapter-Install/Section-Setup.xml 2007-07-23 05:20:45 UTC (rev 13720)
+++ labs/jbossrules/trunk/documentation/manual/en/Chapter-Install/Section-Setup.xml 2007-07-23 05:30:26 UTC (rev 13721)
@@ -7,7 +7,7 @@
top with the latest features. Whilst aspects of Drools are quite
complicated, many users have found ways to become contributors.</para>
- <para>Drools works with JDK1.4 and above. you will need also need to have
+ <para>Drools works with JDK1.5 and above. you will need also need to have
the following tools installed. Minimum requirement version numbers
provided.</para>
@@ -56,17 +56,17 @@
</indexterm>path. The examples given illustrative and are for a win32
system:</para>
- <literallayout>Path=D:\java\j2sdk1.4.2_10\bin;D:\java\apache-ant-1.7\bin;D:\java\maven2.0.7\bin</literallayout>
+ <literallayout>Path=D:\java\j2sdk1.5.0_8\bin;D:\java\apache-ant-1.7\bin;D:\java\maven2.0.7\bin</literallayout>
<para>Following environment variables will also need to be set. The examples
given illustrative and are for a win32 system::</para>
- <literallayout>JAVA_HOME=D:\java\j2sdk1.4.2_10
+ <literallayout>JAVA_HOME=D:\java\j2sdk1.5.0_8
ANT_HOME=D:\java\apache-ant-1.6.5
MAVEN_HOME=D:\java\maven2.0.7
</literallayout>
<para>
- Past releases used to have an ant based build mechanism, but now maven is mandatory, although Ant is used for document building proposes
+ Past releases used to have an ant based build mechanism, but now maven is mandatory, although Ant is used internally in maven for document building proposes
</para>
</section>
\ No newline at end of file
More information about the jboss-svn-commits
mailing list