| <?xml version="1.0" encoding="ISO-8859-1"?> | |
| <!-- | |
| 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 | |
| https://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. | |
| --> | |
| <document> | |
| <properties> | |
| <title>Apache UIMA Documentation</title> | |
| <author email="dev@uima.apache.org"> | |
| Apache UIMA Documentation Team | |
| </author> | |
| </properties> | |
| <body> | |
| <section name="Documentation"> | |
| <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></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></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> | |
| </section> | |
| <section name="Older Releases"> | |
| <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> | |
| <subsection name="Annotators, Web Servers, Tooling, and more" id="sandbox"> | |
| <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> | |
| </subsection> | |
| <subsection name="Getting Started" id="getting_started"> | |
| <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></br> | |
| For first time UIMA users who want to know what UIMA is and how it can be used for.</li> | |
| <br></br> | |
| <li><a href="doc-uima-examples.html">Getting Started: Install UIMA And Run Examples</a><br></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></br> | |
| <li><a href="doc-uima-annotator.html">Getting Started: Writing My First UIMA Annotator</a><br></br> | |
| For UIMA beginners that want to develop their first UIMA analysis component using eclipse. | |
| </li> | |
| <br></br> | |
| <li><a href="doc-uimaj-cookbook.html">Getting Started: A UIMA Java cookbook</a><br></br> | |
| Here's a cookbook of some tips and useful things, for writing UIMA annotators in Java. | |
| </li> | |
| <br></br> | |
| <li><a href="doc-uima-pears.html">Getting Started: Working With PEARs</a><br></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></br> | |
| <li><a href="https://github.com/apache/uima-uimacpp">Getting Started: UIMA C++ Framework</a><br></br> | |
| For UIMA users who want to create UIMA compliant Analysis Engines from programs written in C++, | |
| Perl, Python or Tcl.</li> | |
| </ul> | |
| </p> | |
| </subsection> | |
| </section> | |
| </body> | |
| </document> |