Google Git
Sign in
apache/uima-site/refs/heads/main/./docs/faq.html
blob: 1ec653f56d67a9cfd7896c3579e99f7ed7877492 [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 - Frequently Asked Questions</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">Frequently Asked Questions</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="Questions"><h1><img src="images/UIMA_4sq50tightCropSolid.png"/>&nbsp;Questions</h1></a>
</td></tr>
<tr><td>
<blockquote class="sectionBody">
<ul>
<li>
<a href="#GeneralSection">General</a>
</li>
<ul>
<li>
<a href="#general01">
Where is the mailing list, and how can I
subscribe?
</a>
</li>
<li>
<a href="#general02">
Does this project use a wiki?
</a>
</li>
</ul>
<li>
<a href="#Contributors">
Code and other Contributions
</a>
</li>
<ul>
<li>
<a href="#contrib01">
Contributing a new file: what do I need to
consider?
</a>
</li>
</ul>
<li>
<a href="#KnownIssues">Known Issues</a>
</li>
<ul>
<li>
<a href="#ugr.issues.cr_to_xml">
Sun Java 1.4.2_12 doesn't serialize CR
characters to XML
</a>
</li>
<li>
<a href="#ugr.issues.jcasgen_java_1.4">
JCasGen merge facility supports Java levels
1.4 or earlier"
</a>
</li>
<li>
<a href="#ugr.issues.libgcj.4.1.2">
Descriptor editor in Eclipse tooling does not work with libgcj 4.1.2
</a>
</li>
</ul>
</ul>
</blockquote>
</p>
</td></tr>
</table>
<div class="sectionTable">
<table class="sectionTable" id='GeneralSection'>
<tr><td>
<a name="General"><h1><img src="images/UIMA_4sq50tightCropSolid.png"/>&nbsp;General</h1></a>
</td></tr>
<tr><td>
<blockquote class="sectionBody">
<table class="subsectionTable" id='general01'>
<tr><td>
<a name="Where is the mailing list, and how can I subscribe?">
<h2>Where is the mailing list, and how can I subscribe?
</h2>
</a>
</td></tr>
<tr><td>
<blockquote class="subsectionBody">
<p>
Please see
<a href="mail-lists.html">mail-lists</a>
for details.
</p>
</blockquote>
</td></tr>
</table>
<table class="subsectionTable" id='general02'>
<tr><td>
<a name="Does this project use a wiki?">
<h2>Does this project use a wiki?
</h2>
</a>
</td></tr>
<tr><td>
<blockquote class="subsectionBody">
<p>
It does; see:
<a href="https://cwiki.apache.org/confluence/display/UIMA/">
UIMA wiki
</a>
. It will complement the work taking place on the
mailing list and provide additional information on
the project.
</p>
</blockquote>
</td></tr>
</table>
</blockquote>
</p>
</td></tr>
</table>
<div class="sectionTable">
<table class="sectionTable" id='Contributors'>
<tr><td>
<a name="Code and other Contributions"><h1><img src="images/UIMA_4sq50tightCropSolid.png"/>&nbsp;Code and other Contributions</h1></a>
</td></tr>
<tr><td>
<blockquote class="sectionBody">
<table class="subsectionTable" id='contrib01'>
<tr><td>
<a name="Contributing a new file: what do I need to consider?">
<h2>Contributing a new file: what do I need to consider?
</h2>
</a>
</td></tr>
<tr><td>
<blockquote class="subsectionBody">
<p>
Any new file should contain the
<a href="https://www.apache.org/legal/src-headers.html">
Apache license header
</a>
. This is true of source code, but also XML files
and many other source type files. License headers
are not necessary for automatically generated files
(such as javadoc) and binary files. Binary files may
have licenses of their own, please be sure you know
what you are doing when checking them in. When in
doubt, please ask on uima-dev.
</p>
<p>
For source code, please also follow the
<a href="https://uima.apache.org/codeConventions.html">
coding conventions
</a>
of the UIMA team.
</p>
</blockquote>
</td></tr>
</table>
</blockquote>
</p>
</td></tr>
</table>
<div class="sectionTable">
<table class="sectionTable" id='KnownIssues'>
<tr><td>
<a name="Known Issues"><h1><img src="images/UIMA_4sq50tightCropSolid.png"/>&nbsp;Known Issues</h1></a>
</td></tr>
<tr><td>
<blockquote class="sectionBody">
<table class="subsectionTable" id='ugr.issues.cr_to_xml'>
<tr><td>
<a name="Sun Java 1.4.2_12 doesn't serialize CR characters to XML">
<h2>Sun Java 1.4.2_12 doesn't serialize CR characters to XML
</h2>
</a>
</td></tr>
<tr><td>
<blockquote class="subsectionBody">
<p>
(Note: Apache UIMA now requires Java 1.5 support -
so this issue is moot.)
The XML serialization support in Sun Java 1.4.2_12
doesn't serialize CR characters to XML. As a result,
if the document text contains CR characters, XCAS or
XMI serialization will cause them to be lost,
resulting in incorrect annotation offsets. This is
exposed in the DocumentAnalyzer, with the
highlighting being incorrect if the input document
contains CR characters.
</p>
</blockquote>
</td></tr>
</table>
<table class="subsectionTable" id='ugr.issues.jcasgen_java_1.4'>
<tr><td>
<a name="JCasGen merge facility supports Java levels 1.4 or earlier">
<h2>JCasGen merge facility supports Java levels 1.4 or earlier
</h2>
</a>
</td></tr>
<tr><td>
<blockquote class="subsectionBody">
<p>
JCasGen has a facility to merge in user (hand-coded)
changes with the code generated by JCasGen. This
merging supports Java 1.4 constructs only. JCasGen
generates Java 1.4 code, so as long as any code you
change here also onlu uses Java 1.4 constructs, the
merge will work. If you use Java 5 or later specific
syntax or constructs, the merge operation will
likely fail to merge properly.
</p>
</blockquote>
</td></tr>
</table>
<table class="subsectionTable" id='ugr.issues.libgcj.4.1.2'>
<tr><td>
<a name="Descriptor editor in Eclipse tooling does not work with libgcj 4.1.2">
<h2>Descriptor editor in Eclipse tooling does not work with libgcj 4.1.2
</h2>
</a>
</td></tr>
<tr><td>
<blockquote class="subsectionBody">
<p>
The descriptor editor in the Eclipse tooling does
not work with libgcj 4.1.2, and possibly other
versions of libgcj. This is apparently due to a bug
in the implementation of their XML library, which
results in a class cast error. libgcj is used as the
default JVM for Eclipse in Ubuntu (and other Linux
distributions?). The workaround is to use a
different JVM to start Eclipse.
</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>