This is an automated email from the ASF dual-hosted git repository. rec pushed a commit to branch release/UIMA-6476-Apache-UIMA-Java-SDK-JSON-CAS-IO-0_4_0-release in repository https://gitbox.apache.org/repos/asf/uima-uimaj-io-jsoncas.git
commit 31bbeb1b19c3a848418d69df12c5ba0d98dd9370 Author: Richard Eckart de Castilho <[email protected]> AuthorDate: Tue Jun 28 14:56:15 2022 +0200 [UIMA-6476] Apache UIMA Java SDK JSON CAS IO 0.4.0 release - Formatting in the spec - Added RELEASE_NOTES.md --- README.adoc | 6 +++--- RELEASE_NOTES.md | 49 +++++++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 52 insertions(+), 3 deletions(-) diff --git a/README.adoc b/README.adoc index b1ff61e..733cb9c 100644 --- a/README.adoc +++ b/README.adoc @@ -103,9 +103,9 @@ The document defines several marker prefixes for JSON object keys. For the reade [width="100%",cols="11%,56%,33%",options="header",] |=== |*Marker* |*Description* |*Examples* -|`%` |Keyword marker |"%ID", "%TYPES" -|`^` |Anchor marker on feature name keys |"^begin", "^end" -|`@` |Reference marker on feature name keys |"@sofa" +|`%` |Keyword marker | `%ID`, `%TYPES` +|`^` |Anchor marker on feature name keys |`^begin`, `^end` +|`@` |Reference marker on feature name keys |`@sofa` |=== ==== UIMA JSON CAS keywords diff --git a/RELEASE_NOTES.md b/RELEASE_NOTES.md new file mode 100644 index 0000000..1db76cb --- /dev/null +++ b/RELEASE_NOTES.md @@ -0,0 +1,49 @@ +<!-- +*************************************************************** +* 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. +*************************************************************** +--> + +# Apache UIMA Java SDK JSON CAS I/O (TM) v0.4.0 + +The JSON CAS I/O implementation for use with the UIMA Java SDK allows to serialize UIMA CAS data to +JSON and to de-serialize the data back from JSON again, loading it into a CAS object. The aim of +this library is to facilitate the data interoperability of UIMA data across different platform and +programming languages. For example, the implementation contains functionality to deal with the +different character offset counting strategies used by different languages such as Java and Python. +A Python-based implementation of the UIMA JSON CAS format is available as part of the third-party +[DKPro Cassis](https://github.com/dkpro/dkpro-cassis) library. + +This is the first public release based on the JSON serialization of the Apache UIMA CAS draft +specification version 0.4.0. Please note that the implementation and the specification are not yet +final. For this reason, is not yet recommended to use this library in scenarios where data needs to +be stored or archived over an extended period of time as future versions of the implementation and +specification may introduce incompatibilities with the current version. Good usage scenarios are +for example short-term data exchange between different UIMA implementations such as for example in +network communication. + +A [full list of issues](https://issues.apache.org/jira/issues/?jql=project%20%3D%20UIMA%20AND%20fixVersion%20%3D%200.4.0jsoncas) addressed in this release can be found on issue tracker. + +Please use the [mailing lists](https://uima.apache.org/mail-lists.html) for feedback and the [issue tracker](https://issues.apache.org/jira/browse/uima) to report bugs. + +## Supported Platforms + +UIMA Java SDK JSON CAS I/O v0.4.0 should be used in combination with + +- Java 1.8 or higher +- UIMA Java SDK 3.3.0 or higher
