You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@uima.apache.org by al...@apache.org on 2007/02/13 00:12:43 UTC
svn commit: r506740 - in /incubator/uima/site/trunk/uima-website:
docs/svn.html xdocs/svn.xml
Author: alally
Date: Mon Feb 12 15:12:42 2007
New Revision: 506740
URL: http://svn.apache.org/viewvc?view=rev&rev=506740
Log:
Added that to build docbooks from a source distribution, you
need to get the docbooks libraries and stylesheets from SVN.
Also restructured to indicate that running ant in the docbooks
dir is not required before running mvn assembly:assembly.
UIMA-306: https://issues.apache.org/jira/browse/UIMA-306
Modified:
incubator/uima/site/trunk/uima-website/docs/svn.html
incubator/uima/site/trunk/uima-website/xdocs/svn.xml
Modified: incubator/uima/site/trunk/uima-website/docs/svn.html
URL: http://svn.apache.org/viewvc/incubator/uima/site/trunk/uima-website/docs/svn.html?view=diff&rev=506740&r1=506739&r2=506740
==============================================================================
--- incubator/uima/site/trunk/uima-website/docs/svn.html (original)
+++ incubator/uima/site/trunk/uima-website/docs/svn.html Mon Feb 12 15:12:42 2007
@@ -475,17 +475,6 @@
</p>
<p>If you want to build just one of the "projects", and not the whole thing, cd to the project you want to build, and run
mvn install there.</p>
- <h3>Building uima-docbooks</h3>
- <p>Note that the uima-docbooks project is not built using Maven; it is built by an ant script. To do this,
-cd to the uima-docbooks directory, and run <code>ant</code>. This will build all 4 books into the uima-docbooks target
-directory.
- An Assembly step (see following) will copy the results into the output package.</p>
- <p>Note that each book is actually built twice - the first build only runs the transforms to get the
- links established and setup of cross reference database table. The second outputs the html and pdf files,
- using the cross reference database table just created.</p>
- <p>However, in order to get the images to be rendered in the PDF output, you must obtain the
- "Java Advanced Imaging" library from Sun. See <code>uima-docbooks/README.FIRST</code> for
- more information.</p>
</blockquote>
</td></tr>
<tr><td><br/></td></tr>
@@ -577,8 +566,40 @@
$>mvn assembly:assembly
</pre>
-This will create .zip, .tar.gz, and .tar.bz2 archives in the <code>uimaj-distr/target</code> directory.
+This will build the javadocs and the manual (using docbooks, as described below), and will create
+.zip, .tar.gz, and .tar.bz2 archives of the full UIMA distribution in the <code>uimaj-distr/target</code>
+directory.
+
</p>
+ </blockquote>
+ </td></tr>
+ <tr><td><br/></td></tr>
+ </table>
+ <table border="0" cellspacing="0" cellpadding="2" width="100%">
+
+
+ <tr><td bgcolor="#9289A2">
+ <font color="#ffffff" face="arial,helvetica,sanserif">
+ <a name="Building uima-docbooks"><strong>Building uima-docbooks</strong></a>
+ </font>
+ </td></tr>
+ <tr><td>
+ <blockquote>
+ <p>Note that the uima-docbooks project is not built using Maven; it is built by an ant script. If you
+want to build the documentation without building the entire UIMA distribution,
+cd to the uima-docbooks directory, and run <code>ant</code>. This will build all 4 books into the
+uima-docbooks/target directory.</p>
+ <p>Note that each book is actually built twice - the first build only runs the transforms to get the
+ links established and setup of cross reference database table. The second outputs the html and pdf files,
+ using the cross reference database table just created.</p>
+ <p>However, in order to get the images to be rendered in the PDF output, you must obtain the
+ "Java Advanced Imaging" library from Sun. See <code>uima-docbooks/README.FIRST</code> for
+ more information.</p>
+ <p>Note that the necessary libraries and stylesheets needed to build the docbook are included in an
+ SVN extract, but they are not included in a UIMA source distribution. If you are trying to build
+ directly from a source distribution, you need to get the necessary files by extracting the
+ <code>uima-docbooks/lib</code> and <code>uima-docbooks/docbook</code> directories from the UIMA SVN.
+ </p>
</blockquote>
</td></tr>
<tr><td><br/></td></tr>
Modified: incubator/uima/site/trunk/uima-website/xdocs/svn.xml
URL: http://svn.apache.org/viewvc/incubator/uima/site/trunk/uima-website/xdocs/svn.xml?view=diff&rev=506740&r1=506739&r2=506740
==============================================================================
--- incubator/uima/site/trunk/uima-website/xdocs/svn.xml (original)
+++ incubator/uima/site/trunk/uima-website/xdocs/svn.xml Mon Feb 12 15:12:42 2007
@@ -241,19 +241,6 @@
<p>If you want to build just one of the "projects", and not the whole thing, cd to the project you want to build, and run
mvn install there.</p>
- <h3>Building uima-docbooks</h3>
-<p>Note that the uima-docbooks project is not built using Maven; it is built by an ant script. To do this,
-cd to the uima-docbooks directory, and run <code>ant</code>. This will build all 4 books into the uima-docbooks target
-directory.
- An Assembly step (see following) will copy the results into the output package.</p>
-
- <p>Note that each book is actually built twice - the first build only runs the transforms to get the
- links established and setup of cross reference database table. The second outputs the html and pdf files,
- using the cross reference database table just created.</p>
-
- <p>However, in order to get the images to be rendered in the PDF output, you must obtain the
- "Java Advanced Imaging" library from Sun. See <code>uima-docbooks/README.FIRST</code> for
- more information.</p>
</subsection>
<subsection name="Building from Eclipse">
@@ -313,11 +300,33 @@
$>mvn assembly:assembly
</pre>
-This will create .zip, .tar.gz, and .tar.bz2 archives in the <code>uimaj-distr/target</code> directory.
+This will build the javadocs and the manual (using docbooks, as described below), and will create
+.zip, .tar.gz, and .tar.bz2 archives of the full UIMA distribution in the <code>uimaj-distr/target</code>
+directory.
+
</p>
</subsection>
-
+<subsection name="Building uima-docbooks">
+<p>Note that the uima-docbooks project is not built using Maven; it is built by an ant script. If you
+want to build the documentation without building the entire UIMA distribution,
+cd to the uima-docbooks directory, and run <code>ant</code>. This will build all 4 books into the
+uima-docbooks/target directory.</p>
+
+ <p>Note that each book is actually built twice - the first build only runs the transforms to get the
+ links established and setup of cross reference database table. The second outputs the html and pdf files,
+ using the cross reference database table just created.</p>
+
+ <p>However, in order to get the images to be rendered in the PDF output, you must obtain the
+ "Java Advanced Imaging" library from Sun. See <code>uima-docbooks/README.FIRST</code> for
+ more information.</p>
+
+ <p>Note that the necessary libraries and stylesheets needed to build the docbook are included in an
+ SVN extract, but they are not included in a UIMA source distribution. If you are trying to build
+ directly from a source distribution, you need to get the necessary files by extracting the
+ <code>uima-docbooks/lib</code> and <code>uima-docbooks/docbook</code> directories from the UIMA SVN.
+ </p>
+</subsection>
</section>