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 2010/10/22 17:45:42 UTC
svn commit: r1026379 - in /uima/site/trunk/uima-website:
docs/building-uima.html docs/one-time-setup.html docs/svn.html
xdocs/building-uima.xml xdocs/one-time-setup.xml xdocs/svn.xml
Author: schor
Date: Fri Oct 22 15:45:41 2010
New Revision: 1026379
URL: http://svn.apache.org/viewvc?rev=1026379&view=rev
Log:
no Jira - add (back) info on creating a4-sized PDF documentation, update the building-uima info to eliminate the special 1-time setup for docbook (no longer needed) and update the one-time-setup for maven 3.0, additional info if building from trunk on setting up repository links to the Apache snapshots, and setting additional defaults for running maven builds using m2eclipse.
Modified:
uima/site/trunk/uima-website/docs/building-uima.html
uima/site/trunk/uima-website/docs/one-time-setup.html
uima/site/trunk/uima-website/docs/svn.html
uima/site/trunk/uima-website/xdocs/building-uima.xml
uima/site/trunk/uima-website/xdocs/one-time-setup.xml
uima/site/trunk/uima-website/xdocs/svn.xml
Modified: uima/site/trunk/uima-website/docs/building-uima.html
URL: http://svn.apache.org/viewvc/uima/site/trunk/uima-website/docs/building-uima.html?rev=1026379&r1=1026378&r2=1026379&view=diff
==============================================================================
--- uima/site/trunk/uima-website/docs/building-uima.html (original)
+++ uima/site/trunk/uima-website/docs/building-uima.html Fri Oct 22 15:45:41 2010
@@ -200,10 +200,6 @@
<a href="one-time-setup.html#eclipse-setup">Eclipse: Click here for the one-time Eclipse setup</a>. This includes
setting up m2eclipse plugin (including a patch), and is only needed if you are using Eclipse as your IDE.
</li>
- <li>
- <a href="one-time-setup.html#docbkx-setup">Docbkx: Click here for the one-time Docbkx setup</a>. This involves
- applying a 1-line patch (required).
- </li>
</ul>
</blockquote>
</td></tr>
Modified: uima/site/trunk/uima-website/docs/one-time-setup.html
URL: http://svn.apache.org/viewvc/uima/site/trunk/uima-website/docs/one-time-setup.html?rev=1026379&r1=1026378&r2=1026379&view=diff
==============================================================================
--- uima/site/trunk/uima-website/docs/one-time-setup.html (original)
+++ uima/site/trunk/uima-website/docs/one-time-setup.html Fri Oct 22 15:45:41 2010
@@ -206,12 +206,40 @@
</td></tr>
<tr><td>
<blockquote class="sectionBody">
- <ol><li>Download Maven 3.0 beta-1 or later from
+ <ol><li>Download Maven 3.0 or later from
<a class="external" rel="nofollow" target="_blank" href="http://maven.apache.org/download.html">http://maven.apache.org/download.html</a>.</li>
<li>Set up your path to use this version.</li>
<li>Add the following environment variable for Maven: <br />
<pre> Variable name: <code>MAVEN_OPTS</code><br />
Value: <code>-Xmx800m -XX:MaxPermSize=256m</code></pre></li>
+ <li>If you plan to build from "trunk" which contains unreleased as-of-yet artifacts, you'll need
+ to set up your Maven settings.xml file to reference the Apache snapshot repository; see <a class="external" rel="nofollow" target="_blank" href="http://maven.apache.org/settings.html">http://maven.apache.org/settings.html</a> and
+ <a class="external" rel="nofollow" target="_blank" href="http://maven.apache.org/ref/3.0/maven-settings/settings.html">
+ http://maven.apache.org/ref/3.0/maven-settings/settings.html</a>.
+ <p>To do this, create a settings.xml file in the right location (usually ~/.m2/) and
+ add a setting for the repository.apache.org NEXUS snapshot repository.
+ There's an existing settings.xml you can use as a template, in the conf/ directory of the maven install.
+ Here's an example of how that could be done:
+ <pre><code><profile>
+ <id>local-build-configuration</id>
+ <repositories>
+ <repository>
+ <id>apache-nexus-snapshot</id>
+ <url>https://repository.apache.org/content/groups/snapshots-group/</url>
+ </repository>
+ </repositories>
+ <pluginRepositories>
+ <pluginRepository>
+ <id>apache-nexus-snapshot</id>
+ <url>https://repository.apache.org/content/groups/snapshots-group/</url>
+ </pluginRepository>
+ </pluginRepositories>
+</profile>
+
+<activeProfiles>
+ <activeProfile>local-build-configuration</activeProfile>
+</activeProfiles>
+</code></pre></p></li>
</ol>
</blockquote>
</p>
@@ -266,8 +294,12 @@
</p>
</li>
- <li>Use Eclipse<code> Preferences -> Maven -> Installations </code> to add the Maven 3.0-beta-1 (or later) installation as the
+ <li>Use Eclipse<code> Preferences -> Maven -> Installations </code> to add the Maven 3.0 (or later) installation as the
default to use.</li>
+ <li>(Optional - if you are using m2eclipse plugin to run maven
+ build commands.) Use Eclipse <code>Preferences -> Java -> Installed JREs</code>
+ and select the JRE you will be using as the default, and click
+ "Edit" and add the default VM arguments from MAVEN_OPTS above.</li>
</ol>
</p>
</blockquote>
Modified: uima/site/trunk/uima-website/docs/svn.html
URL: http://svn.apache.org/viewvc/uima/site/trunk/uima-website/docs/svn.html?rev=1026379&r1=1026378&r2=1026379&view=diff
==============================================================================
--- uima/site/trunk/uima-website/docs/svn.html (original)
+++ uima/site/trunk/uima-website/docs/svn.html Fri Oct 22 15:45:41 2010
@@ -669,6 +669,30 @@ mvn install
</blockquote>
</td></tr>
</table>
+ <table class="subsectionTable" id='building.docbooks.a4'>
+ <tr><td>
+
+
+
+ <a name="Creating A4-size PDF documentation">
+ <h2>Creating A4-size PDF documentation
+ </h2>
+ </a>
+ </td></tr>
+ <tr><td>
+ <blockquote class="subsectionBody">
+ <p>The PDF docbook generation defaults to a paper type of USletter. You may override this
+ by specifying the maven property "pdfPaperType". You may specify this on the command line
+ as follows:
+ <code>mvn -DpdfPaperType=A4 package</code>
+ </p>
+ <p>The allowed values for paper type in Docbook can be seen on this page:
+ <a class="external" target="_blank" rel="nofollow" href="http://docbook.sourceforge.net/release/xsl/current/doc/fo/page.width.portrait.html">
+ http://docbook.sourceforge.net/release/xsl/current/doc/fo/page.width.portrait.html</a>.
+ </p>
+ </blockquote>
+ </td></tr>
+ </table>
</blockquote>
</p>
</td></tr>
Modified: uima/site/trunk/uima-website/xdocs/building-uima.xml
URL: http://svn.apache.org/viewvc/uima/site/trunk/uima-website/xdocs/building-uima.xml?rev=1026379&r1=1026378&r2=1026379&view=diff
==============================================================================
--- uima/site/trunk/uima-website/xdocs/building-uima.xml (original)
+++ uima/site/trunk/uima-website/xdocs/building-uima.xml Fri Oct 22 15:45:41 2010
@@ -53,10 +53,6 @@ under the License.
<a href="one-time-setup.html#eclipse-setup">Eclipse: Click here for the one-time Eclipse setup</a>. This includes
setting up m2eclipse plugin (including a patch), and is only needed if you are using Eclipse as your IDE.
</li>
- <li>
- <a href="one-time-setup.html#docbkx-setup">Docbkx: Click here for the one-time Docbkx setup</a>. This involves
- applying a 1-line patch (required).
- </li>
</ul>
</subsection>
Modified: uima/site/trunk/uima-website/xdocs/one-time-setup.xml
URL: http://svn.apache.org/viewvc/uima/site/trunk/uima-website/xdocs/one-time-setup.xml?rev=1026379&r1=1026378&r2=1026379&view=diff
==============================================================================
--- uima/site/trunk/uima-website/xdocs/one-time-setup.xml (original)
+++ uima/site/trunk/uima-website/xdocs/one-time-setup.xml Fri Oct 22 15:45:41 2010
@@ -51,13 +51,43 @@ under the License.
</section>
<section name="One time setup for Maven" id="maven-setup">
- <ol><li>Download Maven 3.0 beta-1 or later from
+ <ol><li>Download Maven 3.0 or later from
<a class="external" rel="nofollow" target="_blank"
href="http://maven.apache.org/download.html">http://maven.apache.org/download.html</a>.</li>
<li>Set up your path to use this version.</li>
<li>Add the following environment variable for Maven: <br/>
<pre> Variable name: <code>MAVEN_OPTS</code><br/>
Value: <code>-Xmx800m -XX:MaxPermSize=256m</code></pre></li>
+ <li>If you plan to build from "trunk" which contains unreleased as-of-yet artifacts, you'll need
+ to set up your Maven settings.xml file to reference the Apache snapshot repository; see <a class="external" rel="nofollow" target="_blank"
+ href="http://maven.apache.org/settings.html">http://maven.apache.org/settings.html</a> and
+ <a class="external" rel="nofollow" target="_blank"
+ href="http://maven.apache.org/ref/3.0/maven-settings/settings.html">
+ http://maven.apache.org/ref/3.0/maven-settings/settings.html</a>.
+ <p>To do this, create a settings.xml file in the right location (usually ~/.m2/) and
+ add a setting for the repository.apache.org NEXUS snapshot repository.
+ There's an existing settings.xml you can use as a template, in the conf/ directory of the maven install.
+ Here's an example of how that could be done:
+ <pre><code><profile>
+ <id>local-build-configuration</id>
+ <repositories>
+ <repository>
+ <id>apache-nexus-snapshot</id>
+ <url>https://repository.apache.org/content/groups/snapshots-group/</url>
+ </repository>
+ </repositories>
+ <pluginRepositories>
+ <pluginRepository>
+ <id>apache-nexus-snapshot</id>
+ <url>https://repository.apache.org/content/groups/snapshots-group/</url>
+ </pluginRepository>
+ </pluginRepositories>
+</profile>
+
+<activeProfiles>
+ <activeProfile>local-build-configuration</activeProfile>
+</activeProfiles>
+</code></pre></p></li>
</ol>
</section>
@@ -112,8 +142,12 @@ under the License.
</p>
</li>
- <li>Use Eclipse<code> Preferences -> Maven -> Installations </code> to add the Maven 3.0-beta-1 (or later) installation as the
- default to use.</li>
+ <li>Use Eclipse<code> Preferences -> Maven -> Installations </code> to add the Maven 3.0 (or later) installation as the
+ default to use.</li>
+ <li>(Optional - if you are using m2eclipse plugin to run maven
+ build commands.) Use Eclipse <code>Preferences -> Java -> Installed JREs</code>
+ and select the JRE you will be using as the default, and click
+ "Edit" and add the default VM arguments from MAVEN_OPTS above.</li>
</ol>
</p>
</section>
Modified: uima/site/trunk/uima-website/xdocs/svn.xml
URL: http://svn.apache.org/viewvc/uima/site/trunk/uima-website/xdocs/svn.xml?rev=1026379&r1=1026378&r2=1026379&view=diff
==============================================================================
--- uima/site/trunk/uima-website/xdocs/svn.xml (original)
+++ uima/site/trunk/uima-website/xdocs/svn.xml Fri Oct 22 15:45:41 2010
@@ -386,6 +386,19 @@ mvn install
Docbooks are built by the normal maven lifecycle, in the prepare-package phase.</p>
</subsection>
+ <subsection name="Creating A4-size PDF documentation" id="building.docbooks.a4">
+ <p>The PDF docbook generation defaults to a paper type of USletter. You may override this
+ by specifying the maven property "pdfPaperType". You may specify this on the command line
+ as follows:
+ <code>mvn -DpdfPaperType=A4 package</code>
+ </p>
+ <p>The allowed values for paper type in Docbook can be seen on this page:
+ <a class="external" target="_blank" rel="nofollow"
+ href="http://docbook.sourceforge.net/release/xsl/current/doc/fo/page.width.portrait.html">
+ http://docbook.sourceforge.net/release/xsl/current/doc/fo/page.width.portrait.html</a>.
+ </p>
+
+ </subsection>
<!-- This next section needs rewriting to work with the new docbook system
<subsection name="Creating A4-size PDF documentation" id="building.docbooks.a4">
<p>If you don't live in the US, you may wish to create your PDF documentation in a different