| <?xml version="1.0" encoding="UTF-8"?> |
| <!--
|
| 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>Frequently Asked Questions</title> |
| <author email="dev@uima.apache.org"> |
| Apache UIMA Documentation Team |
| </author> |
| </properties> |
| |
| <body> |
| |
| <section name="Questions"> |
| <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> |
| </section> |
| |
| <section name="General" id="GeneralSection"> |
| |
| <!--
|
| <p>
|
| <strong>What is UIMA?</strong>
|
| <blockquote>
|
| UIMA is an open source implementation.
|
| </blockquote>
|
| </p>
|
| --> |
| |
| <subsection id="general01"
|
| name="Where is the mailing list, and how can I subscribe?"> |
| <p> |
| Please see |
| <a href="mail-lists.html">mail-lists</a> |
| for details. |
| </p> |
| </subsection> |
| |
| <subsection id="general02"
|
| name="Does this project use a wiki?"> |
| <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> |
| </subsection> |
| </section> |
| |
| <section id="Contributors"
|
| name="Code and other Contributions"> |
| <subsection id="contrib01"
|
| name="Contributing a new file: what do I need to consider?"> |
| <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> |
| </subsection> |
| </section>
|
|
|
| <section id="KnownIssues" name="Known Issues">
|
|
|
| <subsection id="ugr.issues.cr_to_xml"
|
| name="Sun Java 1.4.2_12 doesn't serialize CR characters to XML">
|
| <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>
|
| </subsection>
|
|
|
| <subsection id="ugr.issues.jcasgen_java_1.4"
|
| name="JCasGen merge facility supports Java levels 1.4 or earlier">
|
| <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>
|
| </subsection>
|
|
|
| <subsection id="ugr.issues.libgcj.4.1.2"
|
| name="Descriptor editor in Eclipse tooling does not work with libgcj 4.1.2">
|
| <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>
|
| </subsection>
|
|
|
| </section> |
| |
| </body> |
| </document> |
| |
