Google Git
Sign in
apache/uima-site/refs/heads/main/./docs/documentation.html
blob: 796c2e874e7f0ed209ad0cea75cc9be0e557a398 [file]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "https://www.w3.org/TR/html4/loose.dtd">
<!-- ====================================================================== -->
<!-- GENERATED FILE, DO NOT EDIT, EDIT THE XML FILE IN xdocs INSTEAD! -->
<!-- ====================================================================== -->
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"/>
<style type="text/css">@import "stylesheets/base.css";</style>
<meta name="author" value="
Apache UIMA Documentation Team
">
<meta name="email" value="dev@uima.apache.org">
<title>Apache UIMA - Apache UIMA Documentation</title>
<!-- Begin Cookie Consent plugin by Silktide - https://silktide.com/cookieconsent -->
<!-- Commented out because implied consent is not compatible with GDPR -->
<!--
<script type="text/javascript">
window.cookieconsent_options = {"message":"This website uses cookies to ensure you get the best experience on our website","dismiss":"Got it!","learnMore":"More info","link":"https://uima.apache.org/privacy-policy.html","theme":"dark-bottom"};
</script>
<script type="text/javascript" src="/cookieconsent2/cookieconsent.min.js"></script>
-->
<!-- End Cookie Consent plugin -->
<!-- Begin Google Analytics -->
<!-- Commented out because GA requires consent according to GDPR -->
<!--
<script>
(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
(i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
})(window,document,'script','//www.google-analytics.com/analytics.js','ga');
ga('create', 'UA-70846351-1', 'auto');
ga('set', 'anonymizeIp', true);
ga('send', 'pageview');
</script>
-->
<!-- End Google Analytics -->
</head>
<body>
<div class="topLogos">
<table border="0" width="100%" cellspacing="0">
<!-- TOP IMAGE -->
<tr>
<td align='LEFT'>
<a href="index.html">
<img style="border: 1px solid black;" src="./images/UIMA_banner2tlpTm.png" alt="UIMA project logo" border="0"/>
</a>
</td>
<td align='CENTER'>
<div class="pageBanner">Apache UIMA Documentation</div>
</td>
<td align='RIGHT'>
<a href="https://www.apache.org">
<img src="./images/asf-logo-on-white-smallTm.png" alt="Apache UIMA" border="0"/>
</a>
</td>
</tr>
</table>
<hr noshade="" size="1"/>
</div>
<table border="0" width="100%" cellspacing="4">
<tr>
<td align='RIGHT' colspan="2">
<form method="get" action="https://www.google.com/search">
Search the site
<input type="text" name="q" size="25" maxlength="255" value="" />
<input type="hidden" name="sitesearch" value="https://uima.apache.org/" />
<input name="Search" value="Search Site" type="submit"/>
</form>
</td>
</tr>
<tr> <!-- LEFT SIDE NAVIGATION -->
<td width="20%" valign="top">
<!-- regular menu -->
<div class="navBar">
<br/>
<div class="navBarItem"> <div class="navPartHeading">General</div>
</div>
<div class="navBar">
<div class="navBarItem"> <a href="./index.html">Home</a>
</div>
<div class="navBarItem"> <a href="./downloads.cgi">Downloads</a>
</div>
<div class="navBarItem"> <a href="./documentation.html">Documentation</a>
</div>
<div class="navBarItem"> <a href="./news.html">News</a>
</div>
<div class="navBarItem"> <a href="./publications.html">Publications</a>
</div>
<br style="line-height: .5em"/>
<div class="navBarItem"> <a href="https://issues.apache.org/jira/browse/uima" target="_blank" rel="noopener">Issue tracker <img src="images/offsitelink.png"/></a>
</div>
<div class="navBarItem"> <a href="https://cwiki.apache.org/confluence/display/UIMA/" target="_blank" rel="noopener">Wiki <img src="images/offsitelink.png"/></a>
</div>
<br style="line-height: .5em"/>
<div class="navBarItem"> <a href="https://cwiki.apache.org/confluence/display/UIMA/Powered+by+Apache+UIMA" target="_blank" rel="noopener">Powered By UIMA <img src="images/offsitelink.png"/></a>
</div>
</div>
<br/>
<div class="navBarItem"> <div class="navPartHeading">Community</div>
</div>
<div class="navBar">
<div class="navBarItem"> <a href="./get-involved.html">Get Involved</a>
</div>
<div class="navBarItem"> <a href="./mail-lists.html">Mailing Lists</a>
</div>
<div class="navBarItem"> <a href="./contribution-policy.html">Contribution Policies</a>
</div>
<div class="navBarItem"> <a href="./faq.html">FAQ</a>
</div>
<div class="navBarItem"> <a href="./project-guidelines.html">Project Guidelines</a>
</div>
</div>
<br/>
<div class="navBarItem"> <div class="navPartHeading">Components & Tools</div>
</div>
<div class="navBar">
<div class="navBarItem"> <a href="./sandbox.html#uima-addons-annotators">Annotators</a>
</div>
<div class="navBarItem"> <a href="./toolsServers.html">Tools & Servers</a>
</div>
<div class="navBarItem"> <a href="./sandbox.html">Addons and Sandbox</a>
</div>
<div class="navBarItem"> <a href="./ruta.html">UIMA Ruta</a>
</div>
<div class="navBarItem"> <a href="https://github.com/apache/uima-uimafit" target="_blank" rel="noopener">uimaFIT <img src="images/offsitelink.png"/></a>
</div>
<div class="navBarItem"> <a href="./external-resources.html">External Resources</a>
</div>
</div>
<br/>
<div class="navBarItem"> <div class="navPartHeading">Development</div>
</div>
<div class="navBar">
<div class="navBarItem"> <a href="./dev-quick.html">Quick Start: building</a>
</div>
<div class="navBarItem"> <a href="./building-uima.html">Building from Source</a>
</div>
<div class="navBarItem"> <a href="./one-time-setup.html">One-time setups</a>
</div>
<div class="navBarItem"> <a href="./svn.html">Source Code</a>
</div>
<div class="navBarItem"> <a href="./release.html">Doing a UIMA release</a>
</div>
<div class="navBarItem"> <a href="https://www.apache.org/security/committers.html" target="_blank" rel="noopener">Doing a CVE (Apache) <img src="images/offsitelink.png"/></a>
</div>
<div class="navBarItem"> <a href="./eclipse-update-site.html">Eclipse Update Sites</a>
</div>
<div class="navBarItem"> <a href="./git.html">GIT</a>
</div>
<div class="navBarItem"> <a href="./codeConventions.html">Code Conventions</a>
</div>
<div class="navBarItem"> <a href="./uima-specification.html">UIMA Specification (OASIS)</a>
</div>
<div class="navBarItem"> <a href="./team-list.html">Project Team</a>
</div>
<div class="navBarItem"> <a href="./maven-design.html">Maven Use</a>
</div>
<div class="navBarItem"> <a href="./updating-website.html">Updating this Website</a>
</div>
</div>
<br/>
<div class="navBarItem"> <div class="navPartHeading">Events and Conferences</div>
</div>
<div class="navBar">
<div class="navBarItem"> <a href="./coling14.html">COLING 2014</a>
</div>
<div class="navBarItem"> <a href="./gscl13.html">GSCL 2013</a>
</div>
<div class="navBarItem"> <a href="./iks09.html">IKS 2009</a>
</div>
<div class="navBarItem"> <a href="./gscl09.html">GSCL 2009</a>
</div>
<div class="navBarItem"> <a href="./lsm09.html">LSM 2009</a>
</div>
<div class="navBarItem"> <a href="./lrec08.html">LREC 2008</a>
</div>
<div class="navBarItem"> <a href="./gldv07.html">GLDV 2007</a>
</div>
</div>
<br/>
<div class="navBarItem"> <div class="navPartHeading">ASF</div>
</div>
<div class="navBar">
<div class="navBarItem"> <a href="https://www.apache.org/licenses/" target="_blank" rel="noopener">License <img src="images/offsitelink.png"/></a>
</div>
<div class="navBarItem"> <a href="https://www.apache.org/foundation/thanks.html" target="_blank" rel="noopener">ASF Sponsors <img src="images/offsitelink.png"/></a>
</div>
<div class="navBarItem"> <a href="https://www.apache.org/foundation/sponsorship.html" target="_blank" rel="noopener">ASF Sponsorship <img src="images/offsitelink.png"/></a>
</div>
<div class="navBarItem"> <a href="./security_report">Security</a>
</div>
</div>
</div>
</td>
<td width="80%" align="left" valign="top">
<div class="sectionTable">
<table class="sectionTable">
<tr><td>
<a name="Documentation"><h1><img src="images/UIMA_4sq50tightCropSolid.png"/>&nbsp;Documentation</h1></a>
</td></tr>
<tr><td>
<blockquote class="sectionBody">
<p>Here you can find documentation for the different parts of Apache UIMA and a few
<a href="#getting_started">Getting Started Guides</a>.
</p>
<table class="downloads">
<tr>
<th colspan="3">Apache UIMA Java SDK</th>
</tr>
<tr>
<td>Overview and Setup</td>
<td>[<a href="d/uimaj-current/oas.html">HTML</a>]</td>
<td>[<a href="d/uimaj-current/oas.pdf">PDF</a>]</td>
</tr>
<tr>
<td>Tutorials and Users' Guides</td>
<td>[<a href="d/uimaj-current/tug.html">HTML</a>]</td>
<td>[<a href="d/uimaj-current/tug.pdf">PDF</a>]</td>
</tr>
<tr>
<td>Tools</td>
<td>[<a href="d/uimaj-current/tools.html">HTML</a>]</td>
<td>[<a href="d/uimaj-current/tools.pdf">PDF</a>]</td>
</tr>
<tr>
<td>References</td>
<td>[<a href="d/uimaj-current/ref.html">HTML</a>]</td>
<td>[<a href="d/uimaj-current/ref.pdf">PDF</a>]</td>
</tr>
<tr>
<td>User's Guide</td>
<td>[<a href="d/uimaj-current/user.html">HTML</a>]</td>
<td>[<a href="d/uimaj-current/user.pdf">PDF</a>]</td>
</tr>
<tr>
<td>API Documentation</td>
<td>[<a href="d/uimaj-current/api/index.html">HTML</a>]</td>
<td />
</tr>
<tr>
<th colspan="3">Apache UIMA uimaFIT</th>
</tr>
<tr>
<td>Guide and Reference Manual</td>
<td>[<a href="d/uimafit-current/fit.html">HTML</a>]</td>
<td>[<a href="d/uimafit-current/fit.pdf">PDF</a>]</td>
</tr>
<tr>
<td>API Documentation</td>
<td>[<a href="d/uimafit-current/api/index.html">HTML</a>]</td>
<td />
</tr>
<tr>
<th colspan="3">Apache UIMA Ruta</th>
</tr>
<tr>
<td>Guide and Reference Manual</td>
<td>[<a href="d/ruta-current/ruta.html">HTML</a>]</td>
<td>[<a href="d/ruta-current/ruta.pdf">PDF</a>]</td>
</tr>
</table>
</blockquote>
</p>
</td></tr>
</table>
<div class="sectionTable">
<table class="sectionTable">
<tr><td>
<a name="Older Releases"><h1><img src="images/UIMA_4sq50tightCropSolid.png"/>&nbsp;Older Releases</h1></a>
</td></tr>
<tr><td>
<blockquote class="sectionBody">
<p>
Archived versions may also be found at
<a href="https://svn.apache.org/repos/asf/uima/site/archive/docs/d/">
https://svn.apache.org/repos/asf/uima/site/archive/docs/d/</a>.
</p>
<table class="subsectionTable" id='sandbox'>
<tr><td>
<a name="Annotators, Web Servers, Tooling, and more">
<h2>Annotators, Web Servers, Tooling, and more
</h2>
</a>
</td></tr>
<tr><td>
<blockquote class="subsectionBody">
<p>Many of the additional components found in the Addons and Sandbox have individual documentation files, which
you can access from the <a href="sandbox.html">Addons and Sandbox</a> page</p>
<p>Note: Many of these have not (yet) been updated for UIMA V3.</p>
</blockquote>
</td></tr>
</table>
<table class="subsectionTable" id='getting_started'>
<tr><td>
<a name="Getting Started">
<h2>Getting Started
</h2>
</a>
</td></tr>
<tr><td>
<blockquote class="subsectionBody">
<p>
The UIMA "Getting Started" guides are intended to offer a quick overview of UIMA and how it works.
They are designed to address different audiences that want to work with UIMA.
</p>
<p>
The section below lists all currently available "getting started" guides with their links.
For more advanced documentation about these topics, please refer to the Apache UIMA release documentation.
<ul>
<li><a href="doc-uima-why.html">Getting Started: Why UIMA</a><br />
For first time UIMA users who want to know what UIMA is and how it can be used for.</li>
<br />
<li><a href="doc-uima-examples.html">Getting Started: Install UIMA And Run Examples</a><br />
For first time UIMA users who want to know how UIMA is installed and how they can run
the UIMA analysis examples that are provided with the release package.</li>
<br />
<li><a href="doc-uima-annotator.html">Getting Started: Writing My First UIMA Annotator</a><br />
For UIMA beginners that want to develop their first UIMA analysis component using eclipse.
</li>
<br />
<li><a href="doc-uimaj-cookbook.html">Getting Started: A UIMA Java cookbook</a><br />
Here's a cookbook of some tips and useful things, for writing UIMA annotators in Java.
</li>
<br />
<li><a href="doc-uima-pears.html">Getting Started: Working With PEARs</a><br />
For UIMA users who want to know what a UIMA PEAR package is, how to generate them
and how to use them within UIMA applications.</li>
<br />
<li><a href="https://github.com/apache/uima-uimacpp">Getting Started: UIMA C++ Framework</a><br />
For UIMA users who want to create UIMA compliant Analysis Engines from programs written in C++,
Perl, Python or Tcl.</li>
</ul>
</p>
</blockquote>
</td></tr>
</table>
</blockquote>
</p>
</td></tr>
</table>
</td>
</tr>
<!-- FOOTER -->
<tr><td colspan="2">
<hr noshade="" size="1"/>
</td></tr>
<tr><td colspan="2">
<table class="pageFooter">
<tr>
<td><a href="index.html">Home</a></td>
<td><a href="privacy-policy.html">Privacy Policy</a></td>
<td style="font-size:75%">
Copyright &#169; 2006-2024, The Apache Software Foundation.<br/>
Apache UIMA, UIMA, the Apache UIMA logo and the Apache Feather logo are trademarks of The Apache Software Foundation.<br/>
All other marks mentioned may be trademarks or registered trademarks of their respective owners.
</td>
<td><a href="mailto:dev@uima.apache.org">Contact us</a></td>
</tr>
</table>
</td></tr>
</table>
</body>
</html>