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/05/06 14:35:08 UTC
svn commit: r941696 - in /uima/site/trunk/uima-website: docs/downloads.html
docs/maven-design.html docs/stylesheets/base.css xdocs/downloads.xml
xdocs/maven-design.xml
Author: schor
Date: Thu May 6 12:35:08 2010
New Revision: 941696
URL: http://svn.apache.org/viewvc?rev=941696&view=rev
Log:
no Jira - have the eclipse-update-site link point to incubator spot until we make our first official top-level release
Modified:
uima/site/trunk/uima-website/docs/downloads.html
uima/site/trunk/uima-website/docs/maven-design.html
uima/site/trunk/uima-website/docs/stylesheets/base.css
uima/site/trunk/uima-website/xdocs/downloads.xml
uima/site/trunk/uima-website/xdocs/maven-design.xml
Modified: uima/site/trunk/uima-website/docs/downloads.html
URL: http://svn.apache.org/viewvc/uima/site/trunk/uima-website/docs/downloads.html?rev=941696&r1=941695&r2=941696&view=diff
==============================================================================
--- uima/site/trunk/uima-website/docs/downloads.html (original)
+++ uima/site/trunk/uima-website/docs/downloads.html Thu May 6 12:35:08 2010
@@ -197,7 +197,9 @@ Thus they must be untarred with a GNU co
<tr><td>
<blockquote class="subsectionBody">
<p>You can install the UIMA Eclipse tooling via our Eclipse update site:
-<a href="http://www.apache.org/dist/uima/eclipse-update-site/">http://www.apache.org/dist/uima/eclipse-update-site/</a>.
+<a href="http://www.apache.org/dist/incubator/uima/eclipse-update-site/">http://www.apache.org/dist/incubator/uima/eclipse-update-site/</a>.
+This still points to the incubator distribution site, and will be updated after our
+first release as a top level apache project.
Don't forget to install EMF before/with the UIMA tooling. If you're doing this for the first time,
you may wish to consult the much more verbose instructions in the <a href="documentation.html">SDK
documentation</a>.
Modified: uima/site/trunk/uima-website/docs/maven-design.html
URL: http://svn.apache.org/viewvc/uima/site/trunk/uima-website/docs/maven-design.html?rev=941696&r1=941695&r2=941696&view=diff
==============================================================================
--- uima/site/trunk/uima-website/docs/maven-design.html (original)
+++ uima/site/trunk/uima-website/docs/maven-design.html Thu May 6 12:35:08 2010
@@ -187,6 +187,8 @@ and aggregation POMs do not do common fa
<p>Our parent poms are kept in a folder, under a top level SCM node called "build", which holds things
needed for building, but which are not part of normal aggregate distributions.
Aggregation POMs are kept with the SCM node focused on those modules being aggregated.</p>
+ <p class="note">A recent change in Maven 3 now requires that POMs whose parent poms are not in the
+ parent directory, have an empty <relativePath/> element.</p>
</blockquote>
</p>
</td></tr>
@@ -232,51 +234,25 @@ and aggregation POMs do not do common fa
</td></tr>
<tr><td>
<blockquote class="sectionBody">
- <p>For each Java source artifact, the Apache standard parent POM builds and attaches a source zip and a Javadocs zip
+ <p>Kinds of documentation:</p>
+ <ul>
+ <li>Javadoc</li>
+ <li>The source itself</li>
+ <li>Docbook</li>
+ <li>UIMA Website (Anakia)</li>
+ </ul>
+ <p>For each Java source artifact, the Apache standard parent POM builds and attaches
+ a <ul><li>source zip, and a</li><li>Javadocs zip</li></ul>
to the main Jar artifact. It doesn't do any standard actions for other documentation (e.g., docbook style).</p>
- <p>We use Docbook style for much of our other documentation, the main exception being our website, which uses Anakia.
- Documentation is typically built using a different lifecycle in maven, called the "site" lifecycle.
- Maven supports site deployment via additional <site> element in the <distributionManagement> POM element;
- this is used to direct deployment to the website staging area.</p>
+ <p>We use Docbook style for much of our other documentation,
+ the main exception being our website, which uses Anakia.
+ See <a href="dev-docbook.html">the development docbook page</a> for details.</p>
<p>Normally, all website content is kept in SVN in the uima/site/trunk/uima-website/docs directory; this directory is
- checked out into the right spot on people.apache.org. For large generated documents, we have the option to
- generate them from sources in svn, and deploy them directly to the right spot on people.apache.org. This avoids
+ checked out into the right spot on people.apache.org. For large generated documents,
+ we have the option to generate them from sources in svn, and deploy them directly to the right spot on people.apache.org. This avoids
using SVN for large generated files. This satisfies the
- <a href="http://apache.org/dev/project-site.html" target="_blank">requirements</a> for Apache websites.</p>
- <h2>Docbook Support</h2>
- <p>Most user-level documentation guides are written using
- <a href="http://www.docbook.org/" target="_blank">Docbook</a>.
- All docbooks are drafted using a one-docbook-per-project approach. If you need more than one, just create
- multiple projects. This is required because of the way maven supports inheritance. The
- main UIMA documentation is contained in several projects, because it consists of multiple "books".
- </p>
- <p style="padding-left: 2em">Docbooks are usually included in projects that produce other artifacts, e.g., Jars. Or,
- they can be in projects which only produce a docbook (in which case, the maven packaging type
- should be set to "pom").</p>
- <p>Docbooks can hyperlink to each other. This linking includes the ability to reference details
- about the other link, for instance, what "page" (for PDF rendering formats) the link is on.
- To make this work, the docbook tool pipeline needs to keep a central database for all docbooks
- that want to provide this information. When a docbook is processed, this information is updated,
- and is then available when other docbooks are processed.
- </p>
- <p>In our implementation, projects make their olink information available by having that file
- (which is produced or updated as a side effect of running the docbkx maven plugin) "attached"
- to the results produced by maven for this project.
- Other docbooks which have links to resolve copy those artifacts into a specific place in their
- build directory, using the maven dependency plugin using the dependency:unpack goal.
- </p>
- <p>Given that docbooks are often a part of other projects, which have normal Maven install
- phases, and that docbook processing can take a long time, the docbook processing is not normally
- done with the install phase; it is normally bound to the pre-site phase.
- It can be forced to be done when using the install phase by using "docbook" profile (
- specify -Pdocbook as a parameter on the "mvn" command line; multiple profiles are allowed
- using the syntax -Pdocbook,otherProfile).
- </p>
- <p>Docbook processing is normally done in the pre-site phase; this processing includes
- attaching the zipped up results (html, pdf, and olink database)
- to the set of artifacts so they can be installed or deployed. Future assembly runs
- use these artifacts as components within the assemblies.
- </p>
+ <a href="http://apache.org/dev/project-site.html" target="_blank">requirements</a>
+ for Apache websites.</p>
</blockquote>
</p>
</td></tr>
@@ -292,17 +268,41 @@ and aggregation POMs do not do common fa
when built produces maven artifacts in repositories (your local repository, or perhaps uploaded
to a snapshot or staging repository).</p>
<p>When releases are done, additional artifacts are constructed using the distribution assemblies.
- The input to these are the already built artifacts in the local repository.</p>
+ </p>
<h2>Distribution Pom - Clean phase</h2>
<p>The clean phase
- of the distribution POMs includes running the dependency plugin to purge the local repository of
- dependencies, and then the aggregation pom so they will be rebuilt, with current checked-out levels.
- This is done with the "docbook" profile, so any docbooks will be rebuilt.
+ of the distribution POMs includes running the dependency:purge-local-repository plugin
+ to purge the local repository of dependencies.
</p>
</blockquote>
</p>
</td></tr>
</table>
+ <div class="sectionTable">
+ <table class="sectionTable">
+ <tr><td>
+ <a name="Parent Pom Hierarchy"><h1><img src="images/UIMA_4sq50tightCropSolid.png"/> Parent Pom Hierarchy</h1></a>
+ </td></tr>
+ <tr><td>
+ <blockquote class="sectionBody">
+ <p>Parent pom names start with parent-pom-:</p>
+ <pre>
+ top
+
+ docbook
+
+ uimaj
+
+ uimaj-eclipse-plugins
+
+ uimaj-eclipse-plugins-ibm-notice
+
+ uimaj-ibm-notice
+ </pre>
+ </blockquote>
+ </p>
+ </td></tr>
+ </table>
</td>
</tr>
<!-- FOOTER -->
Modified: uima/site/trunk/uima-website/docs/stylesheets/base.css
URL: http://svn.apache.org/viewvc/uima/site/trunk/uima-website/docs/stylesheets/base.css?rev=941696&r1=941695&r2=941696&view=diff
==============================================================================
--- uima/site/trunk/uima-website/docs/stylesheets/base.css (original)
+++ uima/site/trunk/uima-website/docs/stylesheets/base.css Thu May 6 12:35:08 2010
@@ -114,7 +114,7 @@ pre, code {
}
pre {
border-width: 1px 0;
- padding: 1.5em;
+ padding: 0.5em;
background-color: #f0f0ef;
border: 1px solid #ccc;
}
@@ -122,7 +122,14 @@ pre {
pre.source {
border-width: 1px;
border-color: black;
- padding: 1.5em;
+ padding: 0.5em;
+}
+
+p.note {
+ border-width: 1px 0;
+ padding: 0.5em;
+ background-color: #fef5ef;
+ border: 1px solid #ccc;
}
.pageFooter {
Modified: uima/site/trunk/uima-website/xdocs/downloads.xml
URL: http://svn.apache.org/viewvc/uima/site/trunk/uima-website/xdocs/downloads.xml?rev=941696&r1=941695&r2=941696&view=diff
==============================================================================
--- uima/site/trunk/uima-website/xdocs/downloads.xml (original)
+++ uima/site/trunk/uima-website/xdocs/downloads.xml Thu May 6 12:35:08 2010
@@ -54,7 +54,9 @@ Thus they must be untarred with a GNU co
<subsection name="Eclipse Update Site">
<p>You can install the UIMA Eclipse tooling via our Eclipse update site:
-<a href="http://www.apache.org/dist/uima/eclipse-update-site/">http://www.apache.org/dist/uima/eclipse-update-site/</a>.
+<a href="http://www.apache.org/dist/incubator/uima/eclipse-update-site/">http://www.apache.org/dist/incubator/uima/eclipse-update-site/</a>.
+This still points to the incubator distribution site, and will be updated after our
+first release as a top level apache project.
Don't forget to install EMF before/with the UIMA tooling. If you're doing this for the first time,
you may wish to consult the much more verbose instructions in the <a href="documentation.html">SDK
documentation</a>.
Modified: uima/site/trunk/uima-website/xdocs/maven-design.xml
URL: http://svn.apache.org/viewvc/uima/site/trunk/uima-website/xdocs/maven-design.xml?rev=941696&r1=941695&r2=941696&view=diff
==============================================================================
--- uima/site/trunk/uima-website/xdocs/maven-design.xml (original)
+++ uima/site/trunk/uima-website/xdocs/maven-design.xml Thu May 6 12:35:08 2010
@@ -54,6 +54,9 @@ and aggregation POMs do not do common fa
<p>Our parent poms are kept in a folder, under a top level SCM node called "build", which holds things
needed for building, but which are not part of normal aggregate distributions.
Aggregation POMs are kept with the SCM node focused on those modules being aggregated.</p>
+
+ <p class="note">A recent change in Maven 3 now requires that POMs whose parent poms are not in the
+ parent directory, have an empty <relativePath/> element.</p>
</section>
<section name="POM style">
@@ -83,56 +86,28 @@ and aggregation POMs do not do common fa
</section>
<section name="Handling Documentation">
- <p>For each Java source artifact, the Apache standard parent POM builds and attaches a source zip and a Javadocs zip
+ <p>Kinds of documentation:</p>
+ <ul>
+ <li>Javadoc</li>
+ <li>The source itself</li>
+ <li>Docbook</li>
+ <li>UIMA Website (Anakia)</li>
+ </ul>
+
+ <p>For each Java source artifact, the Apache standard parent POM builds and attaches
+ a <ul><li>source zip, and a</li><li>Javadocs zip</li></ul>
to the main Jar artifact. It doesn't do any standard actions for other documentation (e.g., docbook style).</p>
- <p>We use Docbook style for much of our other documentation, the main exception being our website, which uses Anakia.
- Documentation is typically built using a different lifecycle in maven, called the "site" lifecycle.
- Maven supports site deployment via additional <site> element in the <distributionManagement> POM element;
- this is used to direct deployment to the website staging area.</p>
+ <p>We use Docbook style for much of our other documentation,
+ the main exception being our website, which uses Anakia.
+ See <a href="dev-docbook.html">the development docbook page</a> for details.</p>
<p>Normally, all website content is kept in SVN in the uima/site/trunk/uima-website/docs directory; this directory is
- checked out into the right spot on people.apache.org. For large generated documents, we have the option to
- generate them from sources in svn, and deploy them directly to the right spot on people.apache.org. This avoids
+ checked out into the right spot on people.apache.org. For large generated documents,
+ we have the option to generate them from sources in svn, and deploy them directly to the right spot on people.apache.org. This avoids
using SVN for large generated files. This satisfies the
- <a href="http://apache.org/dev/project-site.html" target="_blank">requirements</a> for Apache websites.</p>
-
- <h2>Docbook Support</h2>
- <p>Most user-level documentation guides are written using
- <a href="http://www.docbook.org/" target="_blank">Docbook</a>.
- All docbooks are drafted using a one-docbook-per-project approach. If you need more than one, just create
- multiple projects. This is required because of the way maven supports inheritance. The
- main UIMA documentation is contained in several projects, because it consists of multiple "books".
- </p>
-
- <p style="padding-left: 2em">Docbooks are usually included in projects that produce other artifacts, e.g., Jars. Or,
- they can be in projects which only produce a docbook (in which case, the maven packaging type
- should be set to "pom").</p>
-
- <p>Docbooks can hyperlink to each other. This linking includes the ability to reference details
- about the other link, for instance, what "page" (for PDF rendering formats) the link is on.
- To make this work, the docbook tool pipeline needs to keep a central database for all docbooks
- that want to provide this information. When a docbook is processed, this information is updated,
- and is then available when other docbooks are processed.
- </p>
- <p>In our implementation, projects make their olink information available by having that file
- (which is produced or updated as a side effect of running the docbkx maven plugin) "attached"
- to the results produced by maven for this project.
- Other docbooks which have links to resolve copy those artifacts into a specific place in their
- build directory, using the maven dependency plugin using the dependency:unpack goal.
- </p>
- <p>Given that docbooks are often a part of other projects, which have normal Maven install
- phases, and that docbook processing can take a long time, the docbook processing is not normally
- done with the install phase; it is normally bound to the pre-site phase.
- It can be forced to be done when using the install phase by using "docbook" profile (
- specify -Pdocbook as a parameter on the "mvn" command line; multiple profiles are allowed
- using the syntax -Pdocbook,otherProfile).
- </p>
- <p>Docbook processing is normally done in the pre-site phase; this processing includes
- attaching the zipped up results (html, pdf, and olink database)
- to the set of artifacts so they can be installed or deployed. Future assembly runs
- use these artifacts as components within the assemblies.
- </p>
+ <a href="http://apache.org/dev/project-site.html" target="_blank">requirements</a>
+ for Apache websites.</p>
</section>
<section name="Building Assemblies for Distribution">
@@ -140,14 +115,31 @@ and aggregation POMs do not do common fa
when built produces maven artifacts in repositories (your local repository, or perhaps uploaded
to a snapshot or staging repository).</p>
<p>When releases are done, additional artifacts are constructed using the distribution assemblies.
- The input to these are the already built artifacts in the local repository.</p>
+ </p>
+
<h2>Distribution Pom - Clean phase</h2>
<p>The clean phase
- of the distribution POMs includes running the dependency plugin to purge the local repository of
- dependencies, and then the aggregation pom so they will be rebuilt, with current checked-out levels.
- This is done with the "docbook" profile, so any docbooks will be rebuilt.
+ of the distribution POMs includes running the dependency:purge-local-repository plugin
+ to purge the local repository of dependencies.
</p>
</section>
+
+<section name="Parent Pom Hierarchy">
+ <p>Parent pom names start with parent-pom-:</p>
+<pre>
+ top
+
+ docbook
+
+ uimaj
+
+ uimaj-eclipse-plugins
+
+ uimaj-eclipse-plugins-ibm-notice
+
+ uimaj-ibm-notice
+ </pre>
+</section>
</body>
</document>
\ No newline at end of file