You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@uima.apache.org by tw...@apache.org on 2008/01/28 17:01:14 UTC
svn commit: r615921 [2/7] - in /incubator/uima/site/trunk/uima-website:
docs/ docs/ip-clearances/ xdocs/ xdocs/stylesheets/
Modified: incubator/uima/site/trunk/uima-website/docs/decisions.html
URL: http://svn.apache.org/viewvc/incubator/uima/site/trunk/uima-website/docs/decisions.html?rev=615921&r1=615920&r2=615921&view=diff
==============================================================================
--- incubator/uima/site/trunk/uima-website/docs/decisions.html (original)
+++ incubator/uima/site/trunk/uima-website/docs/decisions.html Mon Jan 28 08:01:08 2008
@@ -1,43 +1,402 @@
-<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
- "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-<!--
-Licensed to the Apache Software Foundation (ASF) under one or more
-contributor license agreements. See the NOTICE file distributed with
-this work for additional information regarding copyright ownership.
-The ASF licenses this file to You under the Apache License, Version 2.0
-(the "License"); you may not use this file except in compliance with
-the License. You may obtain a copy of the License at
-
-http://www.apache.org/licenses/LICENSE-2.0
-
-Unless required by applicable law or agreed to in writing, software
-distributed under the License is distributed on an "AS IS" BASIS,
-WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-See the License for the specific language governing permissions and
-limitations under the License.
--->
-<html>
- <head>
- <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
- <link rel="stylesheet" href="/style/style.css" type="text/css" />
- <meta name="author" content=" UIMA Documentation
- Team" /><meta name="email" content="uima-dev@incubator.apache.org" />
- <title>Apache UIMA Project Guidelines - Apache UIMA</title>
- </head>
- <body>
- <table border="0" width="100%" cellspacing="0">
- <tr><!-- SITE BANNER AND PROJECT IMAGE -->
- <td align="left" valign="top">
-<a href="http://www.apache.org/"><img src="/images/asf_logo_wide.gif" alt="The Apache Software Foundation" border="0"/></a>
-</td>
-<td align="right">
-<a href="http://incubator.apache.org/uima/"><img src="./images/apache-incubator-logo.png" alt="Apache UIMA" border="0"/></a>
-</td>
- </tr>
- </table>
- <table border="0" width="100%" cellspacing="4">
- <tr><td colspan="3"><hr noshade="noshade" size="1"/></td></tr>
- <tr>
- <!-- LEFT SIDE NAVIGATION -->
- <td valign="top" nowrap="nowrap" class="navleft">
-
\ No newline at end of file
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
+
+<!--
+Licensed to the Apache Software Foundation (ASF) under one
+or more contributor license agreements. See the NOTICE file
+distributed with this work for additional information
+regarding copyright ownership. The ASF licenses this file
+to you under the Apache License, Version 2.0 (the
+"License"); you may not use this file except in compliance
+with the License. You may obtain a copy of the License at
+
+http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing,
+software distributed under the License is distributed on an
+"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+KIND, either express or implied. See the License for the
+specific language governing permissions and limitations
+under the License.
+-->
+
+
+<!-- Content Stylesheet for Site -->
+
+
+<!-- start the processing -->
+ <!-- ====================================================================== -->
+ <!-- GENERATED FILE, DO NOT EDIT, EDIT THE XML FILE IN xdocs INSTEAD! -->
+ <!-- Main Page Section -->
+ <!-- ====================================================================== -->
+ <html>
+ <head>
+ <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"/>
+
+ <meta name="author" value=" UIMA Documentation
+ Team">
+ <meta name="email" value="uima-dev@incubator.apache.org">
+
+
+
+
+
+
+
+ <title>Apache UIMA - Apache UIMA Project Guidelines</title>
+ </head>
+
+ <body bgcolor="#ffffff" text="#000000" link="#525D76">
+ <table border="0" width="100%" cellspacing="0">
+ <!-- TOP IMAGE -->
+ <tr>
+ <td align='LEFT'>
+ <td align="left">
+<a href="http://incubator.apache.org/"><img src="./images/apache-incubator-logo.png" alt="Apache UIMA" border="0"/></a>
+</td>
+ </td>
+ <td align='CENTER'>
+ <td width="80%" align="center" valign="bottom" bgcolor="#ffffff">
+ <font color="#625972" size="+3" face="arial,helvetica,sanserif">
+ <b>Apache UIMA Project Guidelines</b>
+</font>
+</td>
+ </td>
+ <td align='RIGHT'>
+ <td align="left">
+<img src="./images/UIMA_banner.png" alt="UIMA project logo" border="0"/>
+</td>
+ </td>
+ </tr>
+ </table>
+ <table border="0" width="100%" cellspacing="4">
+ <tr><td colspan="2">
+ <hr noshade="" size="1"/>
+ </td></tr>
+
+ <tr>
+ <!-- LEFT SIDE NAVIGATION -->
+ <td width="20%" valign="top" nowrap="true">
+
+ <!-- special ACon Logo - leave here for next time
+ <a href="http://apachecon.com/2005/US/">
+ <img src="http://apache.org/images/ac2005us_blue_125x125.jpg" height="125"
+ width="125" border="0" alt="ApacheCon US 2005" />
+ </a> -->
+
+ <!-- regular menu -->
+
+
+ <!-- ============================================================ -->
+
+ <p><strong>General</strong></p>
+ <ul>
+ <li> <a href="./index.html">Home</a>
+</li>
+ <li> <a href="./news.html">News</a>
+</li>
+ <li> <a href="./documentation.html">Documentation</a>
+</li>
+ <li> <a href="./downloads.cgi">Downloads</a>
+</li>
+ <li> <a href="./license.html">License</a>
+</li>
+ <li> <a href="http://www.apache.org/">ASF</a>
+</li>
+ <li> <a href="http://apache.org/foundation/thanks.html">Thanks</a>
+</li>
+ <li> <a href="http://www.apache.org/foundation/sponsorship.html">Sponsorship</a>
+</li>
+ </ul>
+ <p><strong>Community</strong></p>
+ <ul>
+ <li> <a href="./project-guidelines.html">Project Guidelines</a>
+</li>
+ <li> <a href="./contribution-policy.html">Contribution Policies</a>
+</li>
+ <li> <a href="./get-involved.html">Get Involved</a>
+</li>
+ <li> <a href="./team-list.html">Project Team</a>
+</li>
+ <li> <a href="./mail-lists.html">Mailing Lists</a>
+</li>
+ <li> <a href="./faq.html">FAQ</a>
+</li>
+ <li> <a href="http://cwiki.apache.org/UIMA/">Wiki</a>
+</li>
+ <li> <a href="./external-resources.html">External UIMA Resources</a>
+</li>
+ </ul>
+ <p><strong>Development</strong></p>
+ <ul>
+ <li> <a href="./svn.html">Source Code</a>
+</li>
+ <li> <a href="./distribution.html">Creating a Distribution</a>
+</li>
+ <li> <a href="./codeConventions.html">Code Conventions</a>
+</li>
+ <li> <a href="http://issues.apache.org/jira/browse/uima ">JIRA</a>
+</li>
+ <li> <a href="./uima-specification.html">UIMA Specification</a>
+</li>
+ <li> <a href="./sandbox.html">Sandbox</a>
+</li>
+ </ul>
+ <p><strong>Conferences</strong></p>
+ <ul>
+ <li> <a href="./gldv07.html">GLDV 2007</a>
+</li>
+ <li> <a href="./lrec08.html">LREC 2008</a>
+</li>
+ </ul>
+ </td>
+ <td width="80%" align="left" valign="top">
+ <table border="0" cellspacing="0" cellpadding="2" width="100%">
+ <tr><td bgcolor="#726982">
+ <font color="#ffffff" face="arial,helvetica,sanserif">
+ <a name="Decision Making"><strong>Decision Making</strong></a>
+ </font>
+ </td></tr>
+ <tr><td>
+ <blockquote>
+ <h3 align="center"><font color="#FF0000"><b>Note: This is a working draft
+ document.</b>
+ </font></h3>
+ <p align="center">Discussion of this document is occuring on the uima-dev mailing list.</p>
+ <br />
+ <p> All
+ <a href="roles.html">Contributors</a> are encouraged to participate in
+ decisions, but the decision itself is made by those that have
+ <a href="roles.html">Committer</a> status in the Project. In other words, the
+ Project is a
+ "
+ <em>Minimum Threshold Meritocracy</em>".
+ </p>
+ <h2>Voting</h2>
+ <p> The act of voting carries certain obligations. Voting members are not only stating
+ their opinion, they are also agreeing to help do the work.
+ </p>
+ <p> Any subscriber to the list may vote on any issue or action item. However, the only
+ binding votes are those cast by a Committer. <!--If the vote is about a change to the source code or
+ documentation and the primary author is a Contributor and not a
+ Committer, the primary author of what is being changed may also
+ cast a binding vote on that issue. -->
+ </p>
+ <p> Any Contributor or Committer ("member") may call for an action-item vote on the
+ uima-dev mailing list. It is preferred that a vote be preceded by a formal proposal
+ offered for discussion purposes. The message announcing a vote should contain a
+ Subject beginning with "[VOTE]", and a distinctive one-line summary corresponding
+ to the action item for the vote.
+ </p>
+ <p>Each vote can be made in one of three flavors:</p>
+ <table>
+ <tr>
+ <td bgcolor="#a0ddf0" colspan="" rowspan="" valign="top" align="left">
+ <font color="#000000" size="-1" face="arial,helvetica,sanserif">
+
+ <strong>+1</strong>
+
+ </font>
+</td>
+ <td bgcolor="#a0ddf0" colspan="" rowspan="" valign="top" align="left">
+ <font color="#000000" size="-1" face="arial,helvetica,sanserif">
+
+ "Yes," "Agree," or "the action should be
+ performed." On some issues this is only binding if the voter has tested the
+ action on their own system(s).
+
+ </font>
+</td>
+ </tr>
+ <tr>
+ <td bgcolor="#a0ddf0" colspan="" rowspan="" valign="top" align="left">
+ <font color="#000000" size="-1" face="arial,helvetica,sanserif">
+
+ <strong>+/-0</strong>
+
+ </font>
+</td>
+ <td bgcolor="#a0ddf0" colspan="" rowspan="" valign="top" align="left">
+ <font color="#000000" size="-1" face="arial,helvetica,sanserif">
+
+ "Abstain," "no opinion". An abstention may have
+ detrimental effects if too many people abstain. -0 can indicate lack of support,
+ but without any alternative being proposed.
+
+ </font>
+</td>
+ </tr>
+ <tr>
+ <td bgcolor="#a0ddf0" colspan="" rowspan="" valign="top" align="left">
+ <font color="#000000" size="-1" face="arial,helvetica,sanserif">
+
+ <strong>-1</strong>
+
+ </font>
+</td>
+ <td bgcolor="#a0ddf0" colspan="" rowspan="" valign="top" align="left">
+ <font color="#000000" size="-1" face="arial,helvetica,sanserif">
+
+ "No" On issues where consensus is required, this vote counts as a
+ <strong>veto</strong>. All vetos must contain an explanation of why the veto is
+ appropriate, and possibly, an alternative. Vetos with no explanation are void.
+ No veto can be overruled. If you disagree with the veto, you should lobby the
+ person who cast the veto. Voters intending to veto an action item should make
+ their opinions known to the group immediately so that the problem can be remedied
+ as early as possible.
+
+ </font>
+</td>
+ </tr>
+ </table>
+ <p>An action item may need one of two types of approval.</p>
+ <blockquote>
+
+ <p> An action requiring consensus approval must receive at least
+ <strong>3 binding +1</strong> votes and
+ <strong>no binding vetos</strong>.
+ </p>
+ <p> An action requiring majority approval must receive at least
+ <strong>3 binding +1</strong> votes and more
+ <strong>+1</strong> votes than
+ <strong>-1</strong> votes.
+ </p>
+
+ </blockquote>
+ <p> Except for a public release, All other action items are considered to have lazy
+ approval until somebody votes
+ <strong>-1</strong>, at which point the action item is converted to a formal
+ consensus or majority vote, depending on the type of action item.</p>
+ <blockquote><p>Note: "Lazy" means the action item has immediate tacit approval, and
+ it is not necessary to tally the vote until a -1 reply is posted. Once a -1 reply is
+ posted, the vote must be tallied and reported before the action item is considered
+ approved. All action-item votes are lazy except for a public release vote.
+ </p></blockquote>
+ <h3>Voting Caveats</h3>
+ <ul>
+ <!--
+ <li>A +1 vote regarding product code is only can only be made binding
+ if the voter has tested the action on their own system(s) equipment.</li>
+
+ <li>A binding +1 vote on a public release means the (sub)project's Committer
+ agrees to provide ongoing support for that release while it is current.</li>
+ Members who wish to discuss a vote before replying, may open another thread to help avoid premature vetos. Any +/-1's or +/-0's posted to an alternate thread, or any other thread not labeled "[VOTE]", are considered conversational, and do not qualify as an valid action-item vote. A "lazy item" remains subject to lazy approval until a valid -1 reply is posted to the "[VOTE]" thread.
+ -->
+ <li>An abstention may have detrimental effects if too many people abstain.</li>
+ <li>Vetos with no explanation are void. No veto can be overruled. If you disagree with
+ the veto, you should lobby the person who cast the veto. Voters intending to veto an
+ action item should make their opinions known to the group immediately so that the
+ problem can be remedied as early as possible.</li>
+ <!--
+ <li>If a Committer believes the explanation for a veto is invalid,
+ an affirmation of the veto can be requested. If some other
+ Committer does not affirm that the explanation for the veto is
+ valid, the veto shall be void.</li>
+ <li>If a dispute over a veto becomes intractable, the PMC may consent to arbitrate
+ the matter, and, if appropriate, rescind the veto with a 3/4
+ majority vote of the PMC members.</li>
+ -->
+ <li>Members who wish to discuss a vote before replying, may open another thread to
+ help avoid premature vetos. Any +/-1's or +/-0's posted to an alternate thread, or
+ any other thread not labeled "[VOTE]", are considered conversational, and do not
+ qualify as an valid action-item vote. A "lazy item" remains subject to lazy
+ approval until a valid -1 reply is posted to the "[VOTE]" thread.</li>
+ </ul>
+ <h2>Action Items</h2>
+ <p> All decisions revolve around "
+ <em>Action Items.</em>" Action Items consist of the following:
+ </p>
+ <ul>
+ <li><a href="#long_term_plans">Long Term Plans</a></li>
+ <li><a href="#short_term_plans">Short Term Plans</a></li>
+ <li><a href="#release_plan">Release Plan</a></li>
+ <li><a href="#release_testing">Release Testing</a></li>
+ <li><a href="#public_testing">Public Release</a></li>
+ <li><a href="#showstoppers">Showstoppers</a></li>
+ <li><a href="#software_changes">Software Changes</a></li>
+ </ul>
+ <h3><a id="long_term_plans">Long Term Plans</a></h3>
+ <p> Long term plans are simply announcements that group members are working on
+ particular issues related to the Project. These are not voted on, but Committers who
+ do not agree with a particular plan, or think that an alternative plan would be better,
+ are obligated to inform the group of their feelings.
+ </p>
+ <h3><a id="short_term_plans">Short Term Plans</a></h3>
+ <p> Short term plans are announcements that a volunteer is working on a particular set of
+ documentation or code files with the implication that other volunteers should avoid
+ them or try to coordinate their changes.
+ </p>
+ <h3><a id="release_plan">Release Plan</a></h3>
+ <p> A release plan is used to keep all volunteers aware of when a release is desired, who
+ will be the release manager, when the repository will be frozen to create a release,
+ and other assorted information to keep volunteers from tripping over each other.
+ Lazy majority decides each issue in a release plan.
+ </p>
+ <h3><a id="release_testing">Release Testing</a></h3>
+ <p> After a new release is built, it must be tested before being released to the public.
+ The Release Manager will announce that a release is ready for testing.
+ </p>
+ <h3><a id="public_release">Public Release</a></h3>
+ <p>Once the Release Manager determines that testing is complete, and all showstoppers
+ for the release have been resolved, the Release Manager shall call for a vote on the
+ public release. Majority approval is required before the public release can be made.
+ The Committers who approve a public release (vote +1) are expected to provide ongoing
+ support for that release while it is current. The Release Manager must summarize the
+ outcome of the vote before the public release becomes final.
+ </p>
+ <h3><a id="showstoppers">Showstoppers</a></h3>
+ <p> Showstoppers are issues that require a fix be in place before the next public
+ release. They are listed in the project's JIRA tracking system, categorized as
+ "blockers" in order to focus special attention on
+ these problems. An issue becomes a showstopper when it is listed as such in the project's
+ JIRA tracking system and remains so by lazy consensus.
+ </p>
+ <h3><a id="software_changes">Software Changes</a></h3>
+ <p> Changes to the software of the Project, including code and documentation, will
+ appear as action items in the project's JIRA tracking system. All software changes to the currently active
+ repository are subject to lazy consensus.
+ </p>
+ </blockquote>
+ </p>
+ </td></tr>
+ <tr><td><br/></td></tr>
+ </table>
+
+ </td>
+ </tr>
+
+ <!-- FOOTER -->
+ <tr><td colspan="2">
+ <hr noshade="" size="1"/>
+ </td></tr>
+ <tr><td colspan="2">
+ <div align="center"><font color="#525D76" size="-1"><em>
+ Copyright © 2006-2008, The Apache Software Foundation
+ </em></font></div>
+ </td></tr>
+ </table>
+ </body>
+ </html>
+<!-- end the processing -->
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Modified: incubator/uima/site/trunk/uima-website/docs/dependencies.html
URL: http://svn.apache.org/viewvc/incubator/uima/site/trunk/uima-website/docs/dependencies.html?rev=615921&r1=615920&r2=615921&view=diff
==============================================================================
--- incubator/uima/site/trunk/uima-website/docs/dependencies.html (original)
+++ incubator/uima/site/trunk/uima-website/docs/dependencies.html Mon Jan 28 08:01:08 2008
@@ -1,43 +1,206 @@
-<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
- "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-<!--
-Licensed to the Apache Software Foundation (ASF) under one or more
-contributor license agreements. See the NOTICE file distributed with
-this work for additional information regarding copyright ownership.
-The ASF licenses this file to You under the Apache License, Version 2.0
-(the "License"); you may not use this file except in compliance with
-the License. You may obtain a copy of the License at
-
-http://www.apache.org/licenses/LICENSE-2.0
-
-Unless required by applicable law or agreed to in writing, software
-distributed under the License is distributed on an "AS IS" BASIS,
-WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-See the License for the specific language governing permissions and
-limitations under the License.
--->
-<html>
- <head>
- <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
- <link rel="stylesheet" href="/style/style.css" type="text/css" />
- <meta name="author" content="
- UIMA Documentation Team" /><meta name="email" content="uima-dev@incubator.apache.org" />
- <title>Project Dependencies - Apache UIMA</title>
- </head>
- <body>
- <table border="0" width="100%" cellspacing="0">
- <tr><!-- SITE BANNER AND PROJECT IMAGE -->
- <td align="left" valign="top">
-<a href="http://www.apache.org/"><img src="/images/asf_logo_wide.gif" alt="The Apache Software Foundation" border="0"/></a>
-</td>
-<td align="right">
-<a href="http://incubator.apache.org/uima/"><img src="./images/apache-incubator-logo.png" alt="Apache UIMA" border="0"/></a>
-</td>
- </tr>
- </table>
- <table border="0" width="100%" cellspacing="4">
- <tr><td colspan="3"><hr noshade="noshade" size="1"/></td></tr>
- <tr>
- <!-- LEFT SIDE NAVIGATION -->
- <td valign="top" nowrap="nowrap" class="navleft">
-
\ No newline at end of file
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
+
+<!--
+Licensed to the Apache Software Foundation (ASF) under one
+or more contributor license agreements. See the NOTICE file
+distributed with this work for additional information
+regarding copyright ownership. The ASF licenses this file
+to you under the Apache License, Version 2.0 (the
+"License"); you may not use this file except in compliance
+with the License. You may obtain a copy of the License at
+
+http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing,
+software distributed under the License is distributed on an
+"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+KIND, either express or implied. See the License for the
+specific language governing permissions and limitations
+under the License.
+-->
+
+
+<!-- Content Stylesheet for Site -->
+
+
+<!-- start the processing -->
+ <!-- ====================================================================== -->
+ <!-- GENERATED FILE, DO NOT EDIT, EDIT THE XML FILE IN xdocs INSTEAD! -->
+ <!-- Main Page Section -->
+ <!-- ====================================================================== -->
+ <html>
+ <head>
+ <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"/>
+
+ <meta name="author" value="
+ UIMA Documentation Team">
+ <meta name="email" value="uima-dev@incubator.apache.org">
+
+
+
+
+
+
+
+ <title>Apache UIMA - Project Dependencies</title>
+ </head>
+
+ <body bgcolor="#ffffff" text="#000000" link="#525D76">
+ <table border="0" width="100%" cellspacing="0">
+ <!-- TOP IMAGE -->
+ <tr>
+ <td align='LEFT'>
+ <td align="left">
+<a href="http://incubator.apache.org/"><img src="./images/apache-incubator-logo.png" alt="Apache UIMA" border="0"/></a>
+</td>
+ </td>
+ <td align='CENTER'>
+ <td width="80%" align="center" valign="bottom" bgcolor="#ffffff">
+ <font color="#625972" size="+3" face="arial,helvetica,sanserif">
+ <b>Project Dependencies</b>
+</font>
+</td>
+ </td>
+ <td align='RIGHT'>
+ <td align="left">
+<img src="./images/UIMA_banner.png" alt="UIMA project logo" border="0"/>
+</td>
+ </td>
+ </tr>
+ </table>
+ <table border="0" width="100%" cellspacing="4">
+ <tr><td colspan="2">
+ <hr noshade="" size="1"/>
+ </td></tr>
+
+ <tr>
+ <!-- LEFT SIDE NAVIGATION -->
+ <td width="20%" valign="top" nowrap="true">
+
+ <!-- special ACon Logo - leave here for next time
+ <a href="http://apachecon.com/2005/US/">
+ <img src="http://apache.org/images/ac2005us_blue_125x125.jpg" height="125"
+ width="125" border="0" alt="ApacheCon US 2005" />
+ </a> -->
+
+ <!-- regular menu -->
+
+
+ <!-- ============================================================ -->
+
+ <p><strong>General</strong></p>
+ <ul>
+ <li> <a href="./index.html">Home</a>
+</li>
+ <li> <a href="./news.html">News</a>
+</li>
+ <li> <a href="./documentation.html">Documentation</a>
+</li>
+ <li> <a href="./downloads.cgi">Downloads</a>
+</li>
+ <li> <a href="./license.html">License</a>
+</li>
+ <li> <a href="http://www.apache.org/">ASF</a>
+</li>
+ <li> <a href="http://apache.org/foundation/thanks.html">Thanks</a>
+</li>
+ <li> <a href="http://www.apache.org/foundation/sponsorship.html">Sponsorship</a>
+</li>
+ </ul>
+ <p><strong>Community</strong></p>
+ <ul>
+ <li> <a href="./project-guidelines.html">Project Guidelines</a>
+</li>
+ <li> <a href="./contribution-policy.html">Contribution Policies</a>
+</li>
+ <li> <a href="./get-involved.html">Get Involved</a>
+</li>
+ <li> <a href="./team-list.html">Project Team</a>
+</li>
+ <li> <a href="./mail-lists.html">Mailing Lists</a>
+</li>
+ <li> <a href="./faq.html">FAQ</a>
+</li>
+ <li> <a href="http://cwiki.apache.org/UIMA/">Wiki</a>
+</li>
+ <li> <a href="./external-resources.html">External UIMA Resources</a>
+</li>
+ </ul>
+ <p><strong>Development</strong></p>
+ <ul>
+ <li> <a href="./svn.html">Source Code</a>
+</li>
+ <li> <a href="./distribution.html">Creating a Distribution</a>
+</li>
+ <li> <a href="./codeConventions.html">Code Conventions</a>
+</li>
+ <li> <a href="http://issues.apache.org/jira/browse/uima ">JIRA</a>
+</li>
+ <li> <a href="./uima-specification.html">UIMA Specification</a>
+</li>
+ <li> <a href="./sandbox.html">Sandbox</a>
+</li>
+ </ul>
+ <p><strong>Conferences</strong></p>
+ <ul>
+ <li> <a href="./gldv07.html">GLDV 2007</a>
+</li>
+ <li> <a href="./lrec08.html">LREC 2008</a>
+</li>
+ </ul>
+ </td>
+ <td width="80%" align="left" valign="top">
+ <table border="0" cellspacing="0" cellpadding="2" width="100%">
+ <tr><td bgcolor="#726982">
+ <font color="#ffffff" face="arial,helvetica,sanserif">
+ <a name="The Apache UIMA Project"><strong>The Apache UIMA Project</strong></a>
+ </font>
+ </td></tr>
+ <tr><td>
+ <blockquote>
+ <p>Under construction</p>
+ </blockquote>
+ </p>
+ </td></tr>
+ <tr><td><br/></td></tr>
+ </table>
+
+ </td>
+ </tr>
+
+ <!-- FOOTER -->
+ <tr><td colspan="2">
+ <hr noshade="" size="1"/>
+ </td></tr>
+ <tr><td colspan="2">
+ <div align="center"><font color="#525D76" size="-1"><em>
+ Copyright © 2006-2008, The Apache Software Foundation
+ </em></font></div>
+ </td></tr>
+ </table>
+ </body>
+ </html>
+<!-- end the processing -->
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Modified: incubator/uima/site/trunk/uima-website/docs/distribution.html
URL: http://svn.apache.org/viewvc/incubator/uima/site/trunk/uima-website/docs/distribution.html?rev=615921&r1=615920&r2=615921&view=diff
==============================================================================
--- incubator/uima/site/trunk/uima-website/docs/distribution.html (original)
+++ incubator/uima/site/trunk/uima-website/docs/distribution.html Mon Jan 28 08:01:08 2008
@@ -1,42 +1,338 @@
-<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
- "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-<!--
-Licensed to the Apache Software Foundation (ASF) under one or more
-contributor license agreements. See the NOTICE file distributed with
-this work for additional information regarding copyright ownership.
-The ASF licenses this file to You under the Apache License, Version 2.0
-(the "License"); you may not use this file except in compliance with
-the License. You may obtain a copy of the License at
-
-http://www.apache.org/licenses/LICENSE-2.0
-
-Unless required by applicable law or agreed to in writing, software
-distributed under the License is distributed on an "AS IS" BASIS,
-WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-See the License for the specific language governing permissions and
-limitations under the License.
--->
-<html>
- <head>
- <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
- <link rel="stylesheet" href="/style/style.css" type="text/css" />
- <meta name="author" content="UIMA Documentation Team" /><meta name="email" content="uima-dev@incubator.apache.org" />
- <title>Creating Distributions - Apache UIMA</title>
- </head>
- <body>
- <table border="0" width="100%" cellspacing="0">
- <tr><!-- SITE BANNER AND PROJECT IMAGE -->
- <td align="left" valign="top">
-<a href="http://www.apache.org/"><img src="/images/asf_logo_wide.gif" alt="The Apache Software Foundation" border="0"/></a>
-</td>
-<td align="right">
-<a href="http://incubator.apache.org/uima/"><img src="./images/apache-incubator-logo.png" alt="Apache UIMA" border="0"/></a>
-</td>
- </tr>
- </table>
- <table border="0" width="100%" cellspacing="4">
- <tr><td colspan="3"><hr noshade="noshade" size="1"/></td></tr>
- <tr>
- <!-- LEFT SIDE NAVIGATION -->
- <td valign="top" nowrap="nowrap" class="navleft">
-
\ No newline at end of file
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
+
+<!--
+Licensed to the Apache Software Foundation (ASF) under one
+or more contributor license agreements. See the NOTICE file
+distributed with this work for additional information
+regarding copyright ownership. The ASF licenses this file
+to you under the Apache License, Version 2.0 (the
+"License"); you may not use this file except in compliance
+with the License. You may obtain a copy of the License at
+
+http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing,
+software distributed under the License is distributed on an
+"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+KIND, either express or implied. See the License for the
+specific language governing permissions and limitations
+under the License.
+-->
+
+
+<!-- Content Stylesheet for Site -->
+
+
+<!-- start the processing -->
+ <!-- ====================================================================== -->
+ <!-- GENERATED FILE, DO NOT EDIT, EDIT THE XML FILE IN xdocs INSTEAD! -->
+ <!-- Main Page Section -->
+ <!-- ====================================================================== -->
+ <html>
+ <head>
+ <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"/>
+
+ <meta name="author" value="UIMA Documentation Team">
+ <meta name="email" value="uima-dev@incubator.apache.org">
+
+
+
+
+
+
+
+ <title>Apache UIMA - Creating Distributions</title>
+ </head>
+
+ <body bgcolor="#ffffff" text="#000000" link="#525D76">
+ <table border="0" width="100%" cellspacing="0">
+ <!-- TOP IMAGE -->
+ <tr>
+ <td align='LEFT'>
+ <td align="left">
+<a href="http://incubator.apache.org/"><img src="./images/apache-incubator-logo.png" alt="Apache UIMA" border="0"/></a>
+</td>
+ </td>
+ <td align='CENTER'>
+ <td width="80%" align="center" valign="bottom" bgcolor="#ffffff">
+ <font color="#625972" size="+3" face="arial,helvetica,sanserif">
+ <b>Creating Distributions</b>
+</font>
+</td>
+ </td>
+ <td align='RIGHT'>
+ <td align="left">
+<img src="./images/UIMA_banner.png" alt="UIMA project logo" border="0"/>
+</td>
+ </td>
+ </tr>
+ </table>
+ <table border="0" width="100%" cellspacing="4">
+ <tr><td colspan="2">
+ <hr noshade="" size="1"/>
+ </td></tr>
+
+ <tr>
+ <!-- LEFT SIDE NAVIGATION -->
+ <td width="20%" valign="top" nowrap="true">
+
+ <!-- special ACon Logo - leave here for next time
+ <a href="http://apachecon.com/2005/US/">
+ <img src="http://apache.org/images/ac2005us_blue_125x125.jpg" height="125"
+ width="125" border="0" alt="ApacheCon US 2005" />
+ </a> -->
+
+ <!-- regular menu -->
+
+
+ <!-- ============================================================ -->
+
+ <p><strong>General</strong></p>
+ <ul>
+ <li> <a href="./index.html">Home</a>
+</li>
+ <li> <a href="./news.html">News</a>
+</li>
+ <li> <a href="./documentation.html">Documentation</a>
+</li>
+ <li> <a href="./downloads.cgi">Downloads</a>
+</li>
+ <li> <a href="./license.html">License</a>
+</li>
+ <li> <a href="http://www.apache.org/">ASF</a>
+</li>
+ <li> <a href="http://apache.org/foundation/thanks.html">Thanks</a>
+</li>
+ <li> <a href="http://www.apache.org/foundation/sponsorship.html">Sponsorship</a>
+</li>
+ </ul>
+ <p><strong>Community</strong></p>
+ <ul>
+ <li> <a href="./project-guidelines.html">Project Guidelines</a>
+</li>
+ <li> <a href="./contribution-policy.html">Contribution Policies</a>
+</li>
+ <li> <a href="./get-involved.html">Get Involved</a>
+</li>
+ <li> <a href="./team-list.html">Project Team</a>
+</li>
+ <li> <a href="./mail-lists.html">Mailing Lists</a>
+</li>
+ <li> <a href="./faq.html">FAQ</a>
+</li>
+ <li> <a href="http://cwiki.apache.org/UIMA/">Wiki</a>
+</li>
+ <li> <a href="./external-resources.html">External UIMA Resources</a>
+</li>
+ </ul>
+ <p><strong>Development</strong></p>
+ <ul>
+ <li> <a href="./svn.html">Source Code</a>
+</li>
+ <li> <a href="./distribution.html">Creating a Distribution</a>
+</li>
+ <li> <a href="./codeConventions.html">Code Conventions</a>
+</li>
+ <li> <a href="http://issues.apache.org/jira/browse/uima ">JIRA</a>
+</li>
+ <li> <a href="./uima-specification.html">UIMA Specification</a>
+</li>
+ <li> <a href="./sandbox.html">Sandbox</a>
+</li>
+ </ul>
+ <p><strong>Conferences</strong></p>
+ <ul>
+ <li> <a href="./gldv07.html">GLDV 2007</a>
+</li>
+ <li> <a href="./lrec08.html">LREC 2008</a>
+</li>
+ </ul>
+ </td>
+ <td width="80%" align="left" valign="top">
+ <table border="0" cellspacing="0" cellpadding="2" width="100%">
+ <tr><td bgcolor="#726982">
+ <font color="#ffffff" face="arial,helvetica,sanserif">
+ <a name="Building a distribution"><strong>Building a distribution</strong></a>
+ </font>
+ </td></tr>
+ <tr><td>
+ <blockquote>
+ <p>
+ To build a distribution, you will need to set up your Maven development environment as described
+ on the <a href="./svn.html">source code page</a>. Try extracting and building the code manually
+ as described there. Once you have all that working, you can build a distribution with the help
+ of the scripts in <code>uimaj-distr/src/main/build</code>. Start out in an empty directory and
+ run: <blockquote> <code>extractAndBuild.sh</code> </blockquote>
+ This will extract the source code from SVN, compile and run the tests, and finally build the
+ distribution artifacts. The final artifacts will end up in <code>trunk/uimaj-distr/target</code>.
+ </p>
+ </blockquote>
+ </p>
+ </td></tr>
+ <tr><td><br/></td></tr>
+ </table>
+
+ <table border="0" cellspacing="0" cellpadding="2" width="100%">
+ <tr><td bgcolor="#726982">
+ <font color="#ffffff" face="arial,helvetica,sanserif">
+ <a name="Signing a distribution"><strong>Signing a distribution</strong></a>
+ </font>
+ </td></tr>
+ <tr><td>
+ <blockquote>
+ <p>
+ If you're not set up for creating PGP signatures, the first section tells you where to get the
+ necessary software, how to create a personal key and how to upload it to a key server. If you're
+ already set up with GnuPG or equivalent software, you can skip right to the next section.
+ </p>
+ <table border="0" cellspacing="0" cellpadding="2" width="100%">
+
+
+ <tr><td bgcolor="#9289A2">
+ <font color="#ffffff" face="arial,helvetica,sanserif">
+ <a name="Getting started with release signing"><strong>Getting started with release signing</strong></a>
+ </font>
+ </td></tr>
+ <tr><td>
+ <blockquote>
+ <p>
+ Although you can follow the steps described here mechanically, it is preferable to have at least
+ a basic understanding of what it actually is you are doing. Here is a <a href="http://www.pgpi.org/doc/pgpintro/">
+ good introduction to PGP</a> and digital certificates. We recommend reading this document front-to-back.
+ There is also more general information on <a href="http://www.apache.org/dev/release-signing.html">
+ signing Apache releases</a>. More information is also available <a href="http://wiki.apache.org/incubator/SigningReleases">
+ on the wiki</a>. Some of that information is outdated, though, so take with a grain of salt.
+ The UIMA release signing script is based on the code from the wiki page.
+ </p>
+ <p>
+ Start by <a href="http://www.gnupg.org/download/">downloading GnuPG</a>. For the purposes of
+ release signing, it is sufficient to install the command line tools. After installing GnuPG,
+ create a public/private key pair with <blockquote><code>gpg --gen-key</code></blockquote>
+ This is pretty self-explanatory,
+ some more information is <a href="http://www.apache.org/dev/release-signing.html#generate">in the
+ release signing FAQ</a>. Make sure to remember the passphrase you choose when creating the key,
+ you will need it later for using your private key to sign the release.
+ </p>
+ <p>
+ You can now list your public key with the following command:
+ <blockquote><code>gpg --armor --export</code></blockquote>
+ The output will look like this:<blockquote>
+ <code>
+-----BEGIN PGP PUBLIC KEY BLOCK-----<br />
+Version: GnuPG v1.4.6 (MingW32)<br />
+<br />
+mQGiBEWszKIRBACRscWnk1F408lWIZEgqx6OffiMtgApEVdl9UXXF2+DeS5WrHj0<br />
+1KDm9Q5Ir/o3f1qw7Il16Z496nDqmZHFKcrIgZvXcp5oCRE8sPMwdoy6X9kqVKug<br />
+...<br />
+-----END PGP PUBLIC KEY BLOCK-----
+ </code>
+ </blockquote>
+ There are two places this output needs to go: the UIMA KEYS file, and a public key server.
+ <ol>
+ <li>
+ Append your key (delimiting lines and all) to <code>uimaj-distr/src/main/readme/KEYS</code>.
+ You can optionally place your name above the key, but that is for documentation purposes only.
+ Don't forget to commit the KEYS file to SVN.
+ </li>
+ <li>
+ Upload your public key to <a href="http://pgp.mit.edu/">the MIT public key server</a> and any
+ other key server you think is appropriate (follow instructions on website).
+ </li>
+ </ol>
+ Your public key can later be used by our users to verify releases that you signed.
+ </p>
+ <p>
+ You're now set up to do the actual release signing, and we'll tell you how in the next section.
+ </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="Signing a Apache UIMA Release"><strong>Signing a Apache UIMA Release</strong></a>
+ </font>
+ </td></tr>
+ <tr><td>
+ <blockquote>
+ <p>
+ You can use the script <code>uimaj-distr/src/main/build/signRelease.sh</code> to do the actual
+ release signing. The script generates three different kinds of signatures for each release
+ artifact. It is expected that any given user will use only one of those methods to verify the
+ integrity of a release artifact.
+ <ol>
+ <li>
+ A PGP ASCII-armored detached signature file. This is a hash/message digest encrypted by your
+ private key. The user can later use your public key to decrypt the message digest, which in
+ turn is used to verify that the corresponding release artifact has not been altered. Sounds
+ complicated, but is simple in practice. The command line for generating the signature file is
+ <blockquote><code>gpg --passphrase "Your passphrase" --output <artifact>.asc --detach-sig --armored <artifact></code></blockquote>
+ </li>
+ <li>
+ A MD5 message digest. This is a checksum a user can use to check the integrity of the
+ download. There are various tools to create MD5 checksums. Since we're using gpg anyway, here's
+ the gpg way: <blockquote><code>gpg --print-md MD5 <artifact>.md5</code></blockquote>
+ </li>
+ <li>
+ A SHA1 message digest. This is a checksum a user can use to check the integrity of the
+ download. Here's how to create a SHA1 checksum with gpg: <blockquote><code>gpg --print-md SHA1 <artifact>.sha1</code></blockquote>
+ </li>
+ </ol>
+ </p>
+ <p>
+ To use the signing script mentioned above, <code>cd</code> to the directory with your release
+ artifacts and run: <blockquote> <code>signRelease.sh <release> <passphrase></code> </blockquote>
+ So for example: <blockquote> <code>signRelease.sh uimaj-2.1.0 "Your passphrase in quotes"</code> </blockquote>
+ </p>
+ </blockquote>
+ </td></tr>
+ <tr><td><br/></td></tr>
+ </table>
+ </blockquote>
+ </p>
+ </td></tr>
+ <tr><td><br/></td></tr>
+ </table>
+
+ </td>
+ </tr>
+
+ <!-- FOOTER -->
+ <tr><td colspan="2">
+ <hr noshade="" size="1"/>
+ </td></tr>
+ <tr><td colspan="2">
+ <div align="center"><font color="#525D76" size="-1"><em>
+ Copyright © 2006-2008, The Apache Software Foundation
+ </em></font></div>
+ </td></tr>
+ </table>
+ </body>
+ </html>
+<!-- end the processing -->
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Modified: incubator/uima/site/trunk/uima-website/docs/doc-uima-examples.html
URL: http://svn.apache.org/viewvc/incubator/uima/site/trunk/uima-website/docs/doc-uima-examples.html?rev=615921&r1=615920&r2=615921&view=diff
==============================================================================
--- incubator/uima/site/trunk/uima-website/docs/doc-uima-examples.html (original)
+++ incubator/uima/site/trunk/uima-website/docs/doc-uima-examples.html Mon Jan 28 08:01:08 2008
@@ -1,44 +1,435 @@
-<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
- "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-<!--
-Licensed to the Apache Software Foundation (ASF) under one or more
-contributor license agreements. See the NOTICE file distributed with
-this work for additional information regarding copyright ownership.
-The ASF licenses this file to You under the Apache License, Version 2.0
-(the "License"); you may not use this file except in compliance with
-the License. You may obtain a copy of the License at
-
-http://www.apache.org/licenses/LICENSE-2.0
-
-Unless required by applicable law or agreed to in writing, software
-distributed under the License is distributed on an "AS IS" BASIS,
-WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-See the License for the specific language governing permissions and
-limitations under the License.
--->
-<html>
- <head>
- <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
- <link rel="stylesheet" href="/style/style.css" type="text/css" />
- <meta name="author" content="
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
+
+<!--
+Licensed to the Apache Software Foundation (ASF) under one
+or more contributor license agreements. See the NOTICE file
+distributed with this work for additional information
+regarding copyright ownership. The ASF licenses this file
+to you under the Apache License, Version 2.0 (the
+"License"); you may not use this file except in compliance
+with the License. You may obtain a copy of the License at
+
+http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing,
+software distributed under the License is distributed on an
+"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+KIND, either express or implied. See the License for the
+specific language governing permissions and limitations
+under the License.
+-->
+
+
+<!-- Content Stylesheet for Site -->
+
+
+<!-- start the processing -->
+ <!-- ====================================================================== -->
+ <!-- GENERATED FILE, DO NOT EDIT, EDIT THE XML FILE IN xdocs INSTEAD! -->
+ <!-- Main Page Section -->
+ <!-- ====================================================================== -->
+ <html>
+ <head>
+ <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"/>
+
+ <meta name="author" value="
UIMA Documentation Team
- " /><meta name="email" content="uima-dev@incubator.apache.org" />
- <title>Getting Started: Install UIMA And Run Examples - Apache UIMA</title>
- </head>
- <body>
- <table border="0" width="100%" cellspacing="0">
- <tr><!-- SITE BANNER AND PROJECT IMAGE -->
- <td align="left" valign="top">
-<a href="http://www.apache.org/"><img src="/images/asf_logo_wide.gif" alt="The Apache Software Foundation" border="0"/></a>
-</td>
-<td align="right">
-<a href="http://incubator.apache.org/uima/"><img src="./images/apache-incubator-logo.png" alt="Apache UIMA" border="0"/></a>
-</td>
- </tr>
- </table>
- <table border="0" width="100%" cellspacing="4">
- <tr><td colspan="3"><hr noshade="noshade" size="1"/></td></tr>
- <tr>
- <!-- LEFT SIDE NAVIGATION -->
- <td valign="top" nowrap="nowrap" class="navleft">
-
\ No newline at end of file
+ ">
+ <meta name="email" value="uima-dev@incubator.apache.org">
+
+
+
+
+
+
+
+ <title>Apache UIMA - Getting Started: Install UIMA And Run Examples</title>
+ </head>
+
+ <body bgcolor="#ffffff" text="#000000" link="#525D76">
+ <table border="0" width="100%" cellspacing="0">
+ <!-- TOP IMAGE -->
+ <tr>
+ <td align='LEFT'>
+ <td align="left">
+<a href="http://incubator.apache.org/"><img src="./images/apache-incubator-logo.png" alt="Apache UIMA" border="0"/></a>
+</td>
+ </td>
+ <td align='CENTER'>
+ <td width="80%" align="center" valign="bottom" bgcolor="#ffffff">
+ <font color="#625972" size="+3" face="arial,helvetica,sanserif">
+ <b>Getting Started: Install UIMA And Run Examples</b>
+</font>
+</td>
+ </td>
+ <td align='RIGHT'>
+ <td align="left">
+<img src="./images/UIMA_banner.png" alt="UIMA project logo" border="0"/>
+</td>
+ </td>
+ </tr>
+ </table>
+ <table border="0" width="100%" cellspacing="4">
+ <tr><td colspan="2">
+ <hr noshade="" size="1"/>
+ </td></tr>
+
+ <tr>
+ <!-- LEFT SIDE NAVIGATION -->
+ <td width="20%" valign="top" nowrap="true">
+
+ <!-- special ACon Logo - leave here for next time
+ <a href="http://apachecon.com/2005/US/">
+ <img src="http://apache.org/images/ac2005us_blue_125x125.jpg" height="125"
+ width="125" border="0" alt="ApacheCon US 2005" />
+ </a> -->
+
+ <!-- regular menu -->
+
+
+ <!-- ============================================================ -->
+
+ <p><strong>General</strong></p>
+ <ul>
+ <li> <a href="./index.html">Home</a>
+</li>
+ <li> <a href="./news.html">News</a>
+</li>
+ <li> <a href="./documentation.html">Documentation</a>
+</li>
+ <li> <a href="./downloads.cgi">Downloads</a>
+</li>
+ <li> <a href="./license.html">License</a>
+</li>
+ <li> <a href="http://www.apache.org/">ASF</a>
+</li>
+ <li> <a href="http://apache.org/foundation/thanks.html">Thanks</a>
+</li>
+ <li> <a href="http://www.apache.org/foundation/sponsorship.html">Sponsorship</a>
+</li>
+ </ul>
+ <p><strong>Community</strong></p>
+ <ul>
+ <li> <a href="./project-guidelines.html">Project Guidelines</a>
+</li>
+ <li> <a href="./contribution-policy.html">Contribution Policies</a>
+</li>
+ <li> <a href="./get-involved.html">Get Involved</a>
+</li>
+ <li> <a href="./team-list.html">Project Team</a>
+</li>
+ <li> <a href="./mail-lists.html">Mailing Lists</a>
+</li>
+ <li> <a href="./faq.html">FAQ</a>
+</li>
+ <li> <a href="http://cwiki.apache.org/UIMA/">Wiki</a>
+</li>
+ <li> <a href="./external-resources.html">External UIMA Resources</a>
+</li>
+ </ul>
+ <p><strong>Development</strong></p>
+ <ul>
+ <li> <a href="./svn.html">Source Code</a>
+</li>
+ <li> <a href="./distribution.html">Creating a Distribution</a>
+</li>
+ <li> <a href="./codeConventions.html">Code Conventions</a>
+</li>
+ <li> <a href="http://issues.apache.org/jira/browse/uima ">JIRA</a>
+</li>
+ <li> <a href="./uima-specification.html">UIMA Specification</a>
+</li>
+ <li> <a href="./sandbox.html">Sandbox</a>
+</li>
+ </ul>
+ <p><strong>Conferences</strong></p>
+ <ul>
+ <li> <a href="./gldv07.html">GLDV 2007</a>
+</li>
+ <li> <a href="./lrec08.html">LREC 2008</a>
+</li>
+ </ul>
+ </td>
+ <td width="80%" align="left" valign="top">
+ <table border="0" cellspacing="0" cellpadding="2" width="100%">
+ <tr><td bgcolor="#726982">
+ <font color="#ffffff" face="arial,helvetica,sanserif">
+ <a name="Getting Started: Install UIMA And Run Examples"><strong>Getting Started: Install UIMA And Run Examples</strong></a>
+ </font>
+ </td></tr>
+ <tr><td>
+ <blockquote>
+ <p>
+ The "Getting Started: Install UIMA And Run Examples"
+ guide should help you to install the UIMA release
+ package shows you how run the UIMA analysis example
+ using some of the UIMA tooling.
+ </p>
+ <table border="0" cellspacing="0" cellpadding="2" width="100%">
+
+
+ <tr><td bgcolor="#9289A2">
+ <font color="#ffffff" face="arial,helvetica,sanserif">
+ <a name="Install UIMA"><strong>Install UIMA</strong></a>
+ </font>
+ </td></tr>
+ <tr><td>
+ <blockquote>
+ <p>
+ To get started with UIMA, you first have to install
+ the Apache UIMA release package. The packages are
+ available at the UIMA
+ <a href="downloads.cgi">download page</a>
+ in different data formats for different platforms.
+ Choose for example the .zip packages when you work
+ on Windows or the .tar.gz packages when you work on
+ Linux. Further we have two different package types,
+ the binary distribution that contains the complied
+ sources with script files to run the tooling and the
+ source distribution that only contains the sources
+ of the release.
+ </p>
+ <p>
+ To install UIMA you have to:
+ <ol>
+
+ <li>
+ Download the perferred binary distribution
+ package. To verify the download you can use the
+ signature files provided for each file. For details on
+ how to verify the download please refer to
+ "<a href="downloads.cgi#VerifyDownload">Verifying a Release Download</a>"
+ </li>
+ <li>
+ Unzip the downloaded release package to a target directory of your
+ choice.
+ </li>
+ <li>
+ Create an UIMA_HOME environment variable
+ that points to the target directory where
+ you have unzipped the downloaded release package.
+ </li>
+ <li>
+ If you haven't already set a JAVA_HOME
+ variable, create a JAVA_HOME environment
+ variable that points to a JDK (Java
+ Development Kit) of your choice. UIMA
+ requires at least a Java level 1.4 to run.
+ For more details about the supported Java
+ versions, please refer to the README
+ document of the release package.
+ </li>
+ <br />
+ <li>
+ Optional: If you want to have the UIMA
+ script files in the PATH environment
+ variable of your system you additionally
+ have to add $UIMA_HOME/bin (or for Windows
+ %UIMA_HOME%\bin) to your PATH settings.
+ </li>
+ <li>
+ Optional: To use the provided examples you
+ have to adjust the examples to your UIMA
+ installation directory. To do that, just run
+ the
+ <code>adjustExamplePaths.sh</code>
+ (or for Windows .bat) script in the
+ <code>bin</code>
+ subdirectory of your UIMA installation.
+ </li>
+ </ol>
+ </p>
+ <p>
+ Now the installation of UIMA is finished and all the
+ tooling and the examples should work properly.
+ </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="Running The UIMA Analysis Example"><strong>Running The UIMA Analysis Example</strong></a>
+ </font>
+ </td></tr>
+ <tr><td>
+ <blockquote>
+ <p>
+ UIMA comes with many examples for the different UIMA
+ components and artifacts that can be created. All
+ these examples are explained and used in the UIMA
+ documentation when the specific components or
+ artifacts are introduced. The UIMA analysis example
+ that we want to use now is a combination of some of
+ these example components that shows a basic document
+ analysis using UIMA.
+ </p>
+ <p>
+ To run the UIMA analysis example, we use the UIMA
+ DocumentAnalyzer tooling that comes with the UIMA
+ SDK. The tool can run UIMA analysis components (also
+ know as annotators) on a given set of text documents
+ and shows the result of the analysis run at the end.
+ </p>
+ <p>
+ To start the UIMA DocumentAnalyzer, start the
+ <code>documentAnalyzer.sh</code>
+ (or for Windows .bat) file located in the
+ <code>bin</code>
+ subdirectory of your UIMA installation. The
+ DocumentAnalyzer window pops up where the following
+ values must be set to run the UIMA analysis example:
+ </p>
+ <p>
+ Input Directory:
+ <code><UIMA_HOME>/examples/data</code>
+ <br />
+ Output Directory:
+ <code><UIMA_HOME>/examples/data/processed</code>
+ <br />
+ AE XML Descriptor:
+ <code>
+ <UIMA_HOME>/examples/descriptors/analysis_engine/UIMA_Analysis_Example.xml
+ </code>
+ <br />
+ </p>
+ <p>
+ Replace <UIMA_HOME> above with the path of your
+ Apache UIMA installation directory. In the sample
+ screenshot below, the Apache UIMA installation
+ directory was "C:\programme\apache-uima".
+ </p>
+ <p>
+ <table width="100%">
+ <tr>
+ <td align="center" valign="middle">
+ <img src="./images/getting-started/run_config.jpg" alt="DocumentAnalyzer run configuration" border="0" />
+ </td>
+ </tr>
+ </table>
+ </p>
+ <p>
+ To analyze the doccuments, click the "Run" button,
+ which should, after a brief pause, pop up an
+ "Analyzed Results" window.
+ </p>
+ <p>
+ <table width="100%">
+ <tr>
+ <td align="center" valign="middle">
+ <img src="./images/getting-started/analyzed_docs.jpg" alt="Analyzed Documents view" border="0" />
+ </td>
+ </tr>
+ </table>
+ </p>
+ <p>
+ To display the analysis results for one of the
+ documents, just double-click the desired document.
+ The important one for the UIMA analysis example is
+ the Apache_UIMA.xmi file. When you open this
+ document from the result list, you will see
+ different kind of annotations such as:
+ </p>
+ <p>
+ <ul>
+ <li>EmailAddress annotations</li>
+ <li>Name annotations</li>
+ <li>PersonTitle annotations</li>
+ <li>Sentence annotations</li>
+ <li>Token annotations</li>
+ </ul>
+ </p>
+ <p>
+ When selecting the check-box for those annotations
+ the highlighting in the text for those annotations
+ can be turned on or off.
+ </p>
+ <p>
+ <table width="100%">
+ <tr>
+ <td align="center" valign="middle">
+ <img src="./images/getting-started/annotations.jpg" alt="DocumentAnalyzer annotation view" border="0" />
+ </td>
+ </tr>
+ </table>
+ </p>
+ <p>
+ This concludes the exercise. You may wish to
+ experiment by submitting text of your own for
+ analysis. To do that you can use the
+ DocumentAnalyzer in the interactive mode. Just click
+ the "Interactive" button instead of the "Run" button
+ when you have entered the settings for the analysis
+ example as seen in the screenshot above.
+ </p>
+ <p>
+ After clicking the "Interactive" button to following
+ screen is displayed where you can enter your text.
+ </p>
+ <p>
+ <table width="100%">
+ <tr>
+ <td align="center" valign="middle">
+ <img src="./images/getting-started/interactive.jpg" alt="DocumentAnalyzer interactive mode" border="0" />
+ </td>
+ </tr>
+ </table>
+ </p>
+ <p>
+ When clicking the "Analyze" button your text will be
+ analyzed and you will see the analysis results in
+ the annotation view in the same way as for the
+ example above.
+ </p>
+ </blockquote>
+ </td></tr>
+ <tr><td><br/></td></tr>
+ </table>
+ </blockquote>
+ </p>
+ </td></tr>
+ <tr><td><br/></td></tr>
+ </table>
+
+ </td>
+ </tr>
+
+ <!-- FOOTER -->
+ <tr><td colspan="2">
+ <hr noshade="" size="1"/>
+ </td></tr>
+ <tr><td colspan="2">
+ <div align="center"><font color="#525D76" size="-1"><em>
+ Copyright © 2006-2008, The Apache Software Foundation
+ </em></font></div>
+ </td></tr>
+ </table>
+ </body>
+ </html>
+<!-- end the processing -->
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Modified: incubator/uima/site/trunk/uima-website/docs/doc-uima-why.html
URL: http://svn.apache.org/viewvc/incubator/uima/site/trunk/uima-website/docs/doc-uima-why.html?rev=615921&r1=615920&r2=615921&view=diff
==============================================================================
--- incubator/uima/site/trunk/uima-website/docs/doc-uima-why.html (original)
+++ incubator/uima/site/trunk/uima-website/docs/doc-uima-why.html Mon Jan 28 08:01:08 2008
@@ -1,44 +1,298 @@
-<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
- "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-<!--
-Licensed to the Apache Software Foundation (ASF) under one or more
-contributor license agreements. See the NOTICE file distributed with
-this work for additional information regarding copyright ownership.
-The ASF licenses this file to You under the Apache License, Version 2.0
-(the "License"); you may not use this file except in compliance with
-the License. You may obtain a copy of the License at
-
-http://www.apache.org/licenses/LICENSE-2.0
-
-Unless required by applicable law or agreed to in writing, software
-distributed under the License is distributed on an "AS IS" BASIS,
-WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-See the License for the specific language governing permissions and
-limitations under the License.
--->
-<html>
- <head>
- <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
- <link rel="stylesheet" href="/style/style.css" type="text/css" />
- <meta name="author" content="
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
+
+<!--
+Licensed to the Apache Software Foundation (ASF) under one
+or more contributor license agreements. See the NOTICE file
+distributed with this work for additional information
+regarding copyright ownership. The ASF licenses this file
+to you under the Apache License, Version 2.0 (the
+"License"); you may not use this file except in compliance
+with the License. You may obtain a copy of the License at
+
+http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing,
+software distributed under the License is distributed on an
+"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+KIND, either express or implied. See the License for the
+specific language governing permissions and limitations
+under the License.
+-->
+
+
+<!-- Content Stylesheet for Site -->
+
+
+<!-- start the processing -->
+ <!-- ====================================================================== -->
+ <!-- GENERATED FILE, DO NOT EDIT, EDIT THE XML FILE IN xdocs INSTEAD! -->
+ <!-- Main Page Section -->
+ <!-- ====================================================================== -->
+ <html>
+ <head>
+ <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"/>
+
+ <meta name="author" value="
UIMA Documentation Team
- " /><meta name="email" content="uima-dev@incubator.apache.org" />
- <title>Getting Started: Why UIMA - Apache UIMA</title>
- </head>
- <body>
- <table border="0" width="100%" cellspacing="0">
- <tr><!-- SITE BANNER AND PROJECT IMAGE -->
- <td align="left" valign="top">
-<a href="http://www.apache.org/"><img src="/images/asf_logo_wide.gif" alt="The Apache Software Foundation" border="0"/></a>
-</td>
-<td align="right">
-<a href="http://incubator.apache.org/uima/"><img src="./images/apache-incubator-logo.png" alt="Apache UIMA" border="0"/></a>
-</td>
- </tr>
- </table>
- <table border="0" width="100%" cellspacing="4">
- <tr><td colspan="3"><hr noshade="noshade" size="1"/></td></tr>
- <tr>
- <!-- LEFT SIDE NAVIGATION -->
- <td valign="top" nowrap="nowrap" class="navleft">
-
\ No newline at end of file
+ ">
+ <meta name="email" value="uima-dev@incubator.apache.org">
+
+
+
+
+
+
+
+ <title>Apache UIMA - Getting Started: Why UIMA</title>
+ </head>
+
+ <body bgcolor="#ffffff" text="#000000" link="#525D76">
+ <table border="0" width="100%" cellspacing="0">
+ <!-- TOP IMAGE -->
+ <tr>
+ <td align='LEFT'>
+ <td align="left">
+<a href="http://incubator.apache.org/"><img src="./images/apache-incubator-logo.png" alt="Apache UIMA" border="0"/></a>
+</td>
+ </td>
+ <td align='CENTER'>
+ <td width="80%" align="center" valign="bottom" bgcolor="#ffffff">
+ <font color="#625972" size="+3" face="arial,helvetica,sanserif">
+ <b>Getting Started: Why UIMA</b>
+</font>
+</td>
+ </td>
+ <td align='RIGHT'>
+ <td align="left">
+<img src="./images/UIMA_banner.png" alt="UIMA project logo" border="0"/>
+</td>
+ </td>
+ </tr>
+ </table>
+ <table border="0" width="100%" cellspacing="4">
+ <tr><td colspan="2">
+ <hr noshade="" size="1"/>
+ </td></tr>
+
+ <tr>
+ <!-- LEFT SIDE NAVIGATION -->
+ <td width="20%" valign="top" nowrap="true">
+
+ <!-- special ACon Logo - leave here for next time
+ <a href="http://apachecon.com/2005/US/">
+ <img src="http://apache.org/images/ac2005us_blue_125x125.jpg" height="125"
+ width="125" border="0" alt="ApacheCon US 2005" />
+ </a> -->
+
+ <!-- regular menu -->
+
+
+ <!-- ============================================================ -->
+
+ <p><strong>General</strong></p>
+ <ul>
+ <li> <a href="./index.html">Home</a>
+</li>
+ <li> <a href="./news.html">News</a>
+</li>
+ <li> <a href="./documentation.html">Documentation</a>
+</li>
+ <li> <a href="./downloads.cgi">Downloads</a>
+</li>
+ <li> <a href="./license.html">License</a>
+</li>
+ <li> <a href="http://www.apache.org/">ASF</a>
+</li>
+ <li> <a href="http://apache.org/foundation/thanks.html">Thanks</a>
+</li>
+ <li> <a href="http://www.apache.org/foundation/sponsorship.html">Sponsorship</a>
+</li>
+ </ul>
+ <p><strong>Community</strong></p>
+ <ul>
+ <li> <a href="./project-guidelines.html">Project Guidelines</a>
+</li>
+ <li> <a href="./contribution-policy.html">Contribution Policies</a>
+</li>
+ <li> <a href="./get-involved.html">Get Involved</a>
+</li>
+ <li> <a href="./team-list.html">Project Team</a>
+</li>
+ <li> <a href="./mail-lists.html">Mailing Lists</a>
+</li>
+ <li> <a href="./faq.html">FAQ</a>
+</li>
+ <li> <a href="http://cwiki.apache.org/UIMA/">Wiki</a>
+</li>
+ <li> <a href="./external-resources.html">External UIMA Resources</a>
+</li>
+ </ul>
+ <p><strong>Development</strong></p>
+ <ul>
+ <li> <a href="./svn.html">Source Code</a>
+</li>
+ <li> <a href="./distribution.html">Creating a Distribution</a>
+</li>
+ <li> <a href="./codeConventions.html">Code Conventions</a>
+</li>
+ <li> <a href="http://issues.apache.org/jira/browse/uima ">JIRA</a>
+</li>
+ <li> <a href="./uima-specification.html">UIMA Specification</a>
+</li>
+ <li> <a href="./sandbox.html">Sandbox</a>
+</li>
+ </ul>
+ <p><strong>Conferences</strong></p>
+ <ul>
+ <li> <a href="./gldv07.html">GLDV 2007</a>
+</li>
+ <li> <a href="./lrec08.html">LREC 2008</a>
+</li>
+ </ul>
+ </td>
+ <td width="80%" align="left" valign="top">
+ <table border="0" cellspacing="0" cellpadding="2" width="100%">
+ <tr><td bgcolor="#726982">
+ <font color="#ffffff" face="arial,helvetica,sanserif">
+ <a name="Getting Started: Why UIMA"><strong>Getting Started: Why UIMA</strong></a>
+ </font>
+ </td></tr>
+ <tr><td>
+ <blockquote>
+ <p>
+ The "Getting Started: Why UIMA" guide should help you to understand what UIMA is,
+ what it can be used for, and how you can use it.
+ </p>
+ <table border="0" cellspacing="0" cellpadding="2" width="100%">
+
+
+ <tr><td bgcolor="#9289A2">
+ <font color="#ffffff" face="arial,helvetica,sanserif">
+ <a name="What Is UIMA"><strong>What Is UIMA</strong></a>
+ </font>
+ </td></tr>
+ <tr><td>
+ <blockquote>
+ <p>
+ UIMA stands for Unstructured Information Management Architecture and is a component
+ architecture and software framework implementation for the analysis of unstructured
+ content like text, video and audio data. Unstructured information represents the largest,
+ most current and fastest growing source of information available to businesses and governments.
+ </p>
+ <p>
+ The motivation to develop such a framework was to build a common platform for unstructured analytics,
+ to foster reuse of analysis components and to reduce duplication of analysis development.
+ The pluggable architecture of UIMA allows to easily plug-in your own analysis components and
+ combine them together with others. A full analysis task of a solution using unstructured analytics
+ like search or government intelligence applications is often not a
+ monolithic thing but a multi-stage process where different modules need to build on each other
+ to get a powerful analysis chain. In some cases also annotators from different specialized vendors
+ may need to work together to produce the results needed.
+ The UIMA application interested in such analysis results does not need to know the details of how annotators
+ work together to create the results. The UIMA framework take care of the integration and orchestration
+ of multiple annotators.
+ </p>
+ <p>
+ So the major goal of UIMA is to transform unstructured information to structured
+ information by orchestrating analysis engines to detect entities or relations and thus to build the
+ bridge between the unstructured and the structured world.
+ </p>
+ <p>
+ <table width="100%"><tr><td align="center" valign="middle">
+ <img src="./images/getting-started/analytics-world.jpg" alt="analytics world" border="0" />
+ </td></tr></table>
+ </p>
+ <p>
+ The Apache UIMA incubator project provides two Apache licensed UIMA framework implementations,
+ one for Java and one for C++.
+ </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="What Can UIMA Be Used For"><strong>What Can UIMA Be Used For</strong></a>
+ </font>
+ </td></tr>
+ <tr><td>
+ <blockquote>
+ <p>
+ UIMA is, by itself, an empty framework. Its purpose is to enable a world-wide, diverse community to develop
+ inter-operable, often complex analytic components, and allow them to be combined and run together, with
+ framework supplied scaled-out and remoting as needed. Some of the major external UIMA resources are linked
+ on the Apache UIMA website "<a href="external-resources.html">UIMA Resources on the Web</a>".
+ You can also check the <a href="sandbox.html">UIMA Sandbox</a> for components that can be used and combined
+ to build your own application.
+ </p>
+ <p>
+ There are lots of use cases where UIMA may be applicable. One of the major ones are search applications.
+ Within search applications, the unstructured content that is available mainly as text in various kinds
+ must be processed and analyzed to be searchable. To obtain a powerful search application, the text
+ content must be analyzed to get the document language followed by language dependent linguistic
+ processing such as tokenization, lemmatization and part of speech detection. After these steps a
+ more sophisticated analysis like entity detection and relation detection between entities can be done.
+ For all these analysis steps UIMA and UIMA components can be used.
+ </p>
+ <p>
+ Another important use case is business or government intelligence. For example, UIMA analysis is used
+ to extract structured information from car repair reports. This data is then used for quality feed-back
+ and problem early warning systems.
+ </p>
+ <p>
+ Other possible solutions where UIMA can be used for are the analsyis of call center notes to detect product
+ problems and customer issues or a public image monitoring solution to find out how others for example in internet
+ forums or press releases think about my product or company.
+ </p>
+ </blockquote>
+ </td></tr>
+ <tr><td><br/></td></tr>
+ </table>
+ </blockquote>
+ </p>
+ </td></tr>
+ <tr><td><br/></td></tr>
+ </table>
+
+ </td>
+ </tr>
+
+ <!-- FOOTER -->
+ <tr><td colspan="2">
+ <hr noshade="" size="1"/>
+ </td></tr>
+ <tr><td colspan="2">
+ <div align="center"><font color="#525D76" size="-1"><em>
+ Copyright © 2006-2008, The Apache Software Foundation
+ </em></font></div>
+ </td></tr>
+ </table>
+ </body>
+ </html>
+<!-- end the processing -->
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+