You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@uima.apache.org by sc...@apache.org on 2007/02/13 14:25:06 UTC
svn commit: r506996 - in /incubator/uima/site/trunk/uima-website:
docs/svn.html xdocs/svn.xml
Author: schor
Date: Tue Feb 13 05:25:06 2007
New Revision: 506996
URL: http://svn.apache.org/viewvc?view=rev&rev=506996
Log:
No Jira - Clarify building docbooks from src distr.
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=506996&r1=506995&r2=506996
==============================================================================
--- incubator/uima/site/trunk/uima-website/docs/svn.html (original)
+++ incubator/uima/site/trunk/uima-website/docs/svn.html Tue Feb 13 05:25:06 2007
@@ -439,6 +439,12 @@
Apache UIMA uses Maven 2 to do builds. Download Maven from <a class="external" rel="nofollow" href="http://maven.apache.org">
http://maven.apache.org</a> and add <maven-home>/bin to your path.
</p>
+ <p>
+ If you are
+ building from a source distribution, and want to build the DocBooks from the Docbook sources,
+ you need to set up your DocBook tooling by obtaining the needed parts, either from the UIMA SVN
+ or from other places on the web (see below).
+</p>
<table border="0" cellspacing="0" cellpadding="2" width="100%">
@@ -585,21 +591,25 @@
</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
+ <p>
+ You will need to setup the DocBook tooling before building the DocBooks from the
+ DocBook sources. <b>This tooling is not
+ distributed with the UIMA Source distribution</b>, but is available in the UIMA SVN and
+ other places on the Internet. If you are trying to build
+ directly from a source distribution, please get the necessary files by extracting the
+ <code>uima-docbooks/lib</code> and <code>uima-docbooks/docbook</code> directories from the UIMA SVN.
+ Please read the README.FIRST and README files in the uima-docbook directory
+ for important information about setting up the tooling. In particular, in order
+ to get the images to be rendered in the PDF output, you must obtain the
+ "Java Advanced Imaging" library from Sun.
+ </p>
+ <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=506996&r1=506995&r2=506996
==============================================================================
--- incubator/uima/site/trunk/uima-website/xdocs/svn.xml (original)
+++ incubator/uima/site/trunk/uima-website/xdocs/svn.xml Tue Feb 13 05:25:06 2007
@@ -212,6 +212,13 @@
Apache UIMA uses Maven 2 to do builds. Download Maven from <a class="external" rel="nofollow" href="http://maven.apache.org">
http://maven.apache.org</a> and add <maven-home>/bin to your path.
</p>
+
+<p>
+ If you are
+ building from a source distribution, and want to build the DocBooks from the Docbook sources,
+ you need to set up your DocBook tooling by obtaining the needed parts, either from the UIMA SVN
+ or from other places on the web (see below).
+</p>
<subsection name="Building from the command line">
<p>
<pre>
@@ -308,7 +315,19 @@
</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
+ <p>
+ You will need to setup the DocBook tooling before building the DocBooks from the
+ DocBook sources. <b>This tooling is not
+ distributed with the UIMA Source distribution</b>, but is available in the UIMA SVN and
+ other places on the Internet. If you are trying to build
+ directly from a source distribution, please get the necessary files by extracting the
+ <code>uima-docbooks/lib</code> and <code>uima-docbooks/docbook</code> directories from the UIMA SVN.
+ Please read the README.FIRST and README files in the uima-docbook directory
+ for important information about setting up the tooling. In particular, in order
+ to get the images to be rendered in the PDF output, you must obtain the
+ "Java Advanced Imaging" library from Sun.
+ </p>
+ <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>
@@ -317,15 +336,6 @@
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>