You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@uima.apache.org by re...@apache.org on 2022/05/20 07:24:49 UTC
[uima-ruta] branch release/UIMA-6449-Ruta-3.2.0-release updated: [UIMA-6449] Ruta 3.2.0 release
This is an automated email from the ASF dual-hosted git repository.
rec pushed a commit to branch release/UIMA-6449-Ruta-3.2.0-release
in repository https://gitbox.apache.org/repos/asf/uima-ruta.git
The following commit(s) were added to refs/heads/release/UIMA-6449-Ruta-3.2.0-release by this push:
new 98a663e0 [UIMA-6449] Ruta 3.2.0 release
98a663e0 is described below
commit 98a663e019cd7c200dd416a459f1b2070bba0c8f
Author: Richard Eckart de Castilho <re...@apache.org>
AuthorDate: Fri May 20 09:24:43 2022 +0200
[UIMA-6449] Ruta 3.2.0 release
- Convert release notes file from html to md
- Conflate both readme files into one (md)
---
README | 54 ----------------------------
README.md | 47 ++++++++++++++++++++++++
RELEASE_NOTES.html | 104 -----------------------------------------------------
RELEASE_NOTES.md | 62 ++++++++++++++++++++++++++++++++
4 files changed, 109 insertions(+), 158 deletions(-)
diff --git a/README b/README
deleted file mode 100644
index c673e7eb..00000000
--- a/README
+++ /dev/null
@@ -1,54 +0,0 @@
-
-Apache UIMA Ruta (TM) v3.1.0
--------------------------------------------------------------------------
-
-This release is compatible with UIMA v3, but not compatible with UIMA v2.
-For compatibility to UIMA v2, please refer to the latest UIMA Ruta v2 release, e.g., 2.8.0.
-
-Building from the Source Distribution
--------------------------------------
-
-We use Maven 3.0 and Java 8 or later for building; download this if needed,
-and set the environment variable MAVEN_OPTS to -Xmx800m.
-
-Then do the build by going into the UIMA Ruta directory, and issuing the command
-
- mvn clean install
-
-This builds everything except the ...source-release.zip file. If you want that,
-change the command to
-
- mvn clean install -Papache-release
-
-For more details, please see https://uima.apache.org/building-uima.html
-
-
--------------------------------------
-
-This product was originally released as Apache UIMA TextMarker. The UIMA Ruta Workbench provides
-a command for updating old projects. Please right-click on a project and select "UIMA Ruta -> Update Project".
-
--------------------------------------
-
-The UIMA Ruta analysis engine requires type priorities for the correct execution of rules.
-If a CAS is created using the CasCreationUtils, please provide the type priorities, e.g., by:
-
- URL tpUrl = this.getClass().getResource("/org/apache/uima/ruta/engine/TypePriorities.xml");
- TypePriorities typePriorities = UIMAFramework.getXMLParser().parseTypePriorities(
- new XMLInputSource(tpUrl));
- CAS cas = CasCreationUtils.createCas(descriptor, typePriorities, new FsIndexDescription[0]);
-
--------------------------------------
-
-Using the jcasgen-maven-plugin may cause problems if it creates duplicate classes for the
-internal UIMA Ruta types (overwriting the implementation of RutaBasic). Depending on the location
-of the type system descriptors, the plugin should be configured to be limited on the project,
-or the UIMA Ruta type system descriptors should explicitly be excluded:
-
-<configuration>
- <typeSystemExcludes>
- <typeSystemExclude>/**/BasicTypeSystem.xml</typeSystemExclude>
- <typeSystemExclude>/**/InternalTypeSystem.xml</typeSystemExclude>
- </typeSystemExcludes>
-</configuration>
-
diff --git a/README.md b/README.md
index 47a33a9f..b1ae5488 100644
--- a/README.md
+++ b/README.md
@@ -73,6 +73,24 @@ The UIMA Ruta Workbench can be installed via Eclipse update sites:
* for UIMA 3: <a href="https://downloads.apache.org/uima/eclipse-update-site-v3/">https://downloads.apache.org/uima/eclipse-update-site-v3/</a>
+Building from the Source Distribution
+-------------------------------------
+
+We use Maven 3.0 and Java 8 or later for building; download this if needed,
+and set the environment variable MAVEN_OPTS to -Xmx800m.
+
+Then do the build by going into the UIMA Ruta directory, and issuing the command
+
+ mvn clean install
+
+This builds everything except the ...source-release.zip file. If you want that,
+change the command to
+
+ mvn clean install -Papache-release
+
+For more details, please see https://uima.apache.org/building-uima.html
+
+
Reference
---------
@@ -95,6 +113,35 @@ If you use UIMA Ruta to support academic research, then please consider citing t
}
~~~~
+
+Useful tips
+-----------
+
+This product was originally released as Apache UIMA TextMarker. The UIMA Ruta Workbench provides
+a command for updating old projects. Please right-click on a project and select "UIMA Ruta -> Update Project".
+
+The UIMA Ruta analysis engine requires type priorities for the correct execution of rules.
+If a CAS is created using the CasCreationUtils, please provide the type priorities, e.g., by:
+
+ URL tpUrl = this.getClass().getResource("/org/apache/uima/ruta/engine/TypePriorities.xml");
+ TypePriorities typePriorities = UIMAFramework.getXMLParser().parseTypePriorities(
+ new XMLInputSource(tpUrl));
+ CAS cas = CasCreationUtils.createCas(descriptor, typePriorities, new FsIndexDescription[0]);
+
+Using the `jcasgen-maven-plugin` may cause problems if it creates duplicate classes for the
+internal UIMA Ruta types (overwriting the implementation of RutaBasic). Depending on the location
+of the type system descriptors, the plugin should be configured to be limited on the project,
+or the UIMA Ruta type system descriptors should explicitly be excluded:
+
+ <configuration>
+ <typeSystemExcludes>
+ <typeSystemExclude>/**/BasicTypeSystem.xml</typeSystemExclude>
+ <typeSystemExclude>/**/InternalTypeSystem.xml</typeSystemExclude>
+ </typeSystemExcludes>
+ </configuration>
+
+
+
Useful links
------------
diff --git a/RELEASE_NOTES.html b/RELEASE_NOTES.html
deleted file mode 100644
index 7ce943c4..00000000
--- a/RELEASE_NOTES.html
+++ /dev/null
@@ -1,104 +0,0 @@
-<html>
- <!--
- ***************************************************************
- * 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.
- ***************************************************************
- -->
-
-<head>
- <title>Apache UIMA Ruta v3.1.0 Release Notes</title>
-</head>
-<body>
-<h1>Apache UIMA Ruta™ v3.1.0 Release Notes</h1>
-
-<h2>Contents</h2>
-<p>
-<a href="#what.is.uima-ruta">1. What is UIMA Ruta</a><br/>
-<a href="#major.changes">2. Major Changes in this Release</a><br/>
-<a href="#get.involved">3. How to Get Involved</a><br/>
-<a href="#report.issues">4. How to Report Issues</a><br/>
-<a href="#list.issues">5. List of JIRA Issues Fixed in this Release</a>
-</p>
-
-<h2><a name="what.is.uima-ruta">1. What is UIMA Ruta?</a></h2>
-
-<p>
- Apache UIMA Ruta™ is a rule-based script language supported by Eclipse-based tooling.
- The language is designed to enable rapid development of text processing applications within Apache UIMA™.
- A special focus lies on the intuitive and flexible domain specific language for defining
- patterns of annotations. The Eclipse-based tooling for Ruta, called the Ruta Workbench,
- was created to support the user and to facilitate every step when writing Ruta rules. Both the
- Ruta rule language and the Ruta Workbench integrate smoothly with Apache UIMA.
-</p>
-
-<h2><a name="major.changes">2. Major Changes in this Release</a></h2>
-
-<p>
- This release provides compatibility to UIMA v3. An upgrade from UIMA Ruta v2 to this version requires
- also an update to UIMA v3 of the overall application or Eclipse installation. Please refer to the
- UIMA v3 user's guide for detailed information: https://uima.apache.org/d/uimaj-3.0.0/version_3_users_guide.html
-</p>
-<p>
- <p>UIMA Ruta Language and Analysis Engine:</p>
- <ul>
- <li>New config parameter for internal indexing strategy.</li>
- <li>New config parameter for indexing all debug information.</li>
- <li>New config parameter for type disambiguation.</li>
- <li>TextSeeder is the new default seeder (faster, no MARKUP annotations).</li>
- <li>Improved null check using label expression.</li>
- <li>Improved conjunctive and disjunctive rule elements.</li>
- <li>Improved conjunct rules.</li>
- <li>Improved implementation of SPLIT, FILL, ADD, REMOVE, AFTER.</li>
- <li>Improved documentation.</li>
- </ul>
- <p>UIMA Ruta Workbench:</p>
- <ul>
- <li>Fixed problems launching script using newer Java versions (LayerInstantiationException).</li>
- <li>Fixed console logging when launching scripts.</li>
- <li>Improved compatibility with dark mode.</li>
- </ul>
- <p>UIMA Ruta Maven Plugin:</p>
- <ul>
- <li>Fail on error by default.</li>
- </ul>
-</p>
-
-
-<h2><a name="get.involved">3. How to Get Involved</a></h2>
-<p>
-The Apache UIMA Ruta project really needs and appreciates any contributions,
-including documentation help, source code and feedback. If you are interested
-in contributing, please visit
-<a href="https://uima.apache.org/get-involved.html">
- https://uima.apache.org/get-involved.html</a>.
-</p>
-
-<h2><a name="report.issues">4. How to Report Issues</a></h2>
-<p>
-The Apache UIMA project uses JIRA for issue tracking. Please report any
-issues you find at
-<a href="https://issues.apache.org/jira/browse/uima">https://issues.apache.org/jira/browse/uima</a>
-</p>
-
-<h2><a name="list.issues">5. List of JIRA Issues Fixed in this Release</a></h2>
-
-Click <a href="issuesFixed/jira-report.html">issuesFixed/jira-report.html</a> for the list of
-issues fixed in this release.
-
-</body>
-</html>
\ No newline at end of file
diff --git a/RELEASE_NOTES.md b/RELEASE_NOTES.md
new file mode 100644
index 00000000..b3e96296
--- /dev/null
+++ b/RELEASE_NOTES.md
@@ -0,0 +1,62 @@
+<!--
+***************************************************************
+* 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 Ruta v3.2.0 Release Notes
+
+## Contents
+
+[What is UIMA Ruta?](#what.is.uima-ruta)
+[Major Changes in this Release](#major.changes)
+[List of JIRA Issues Fixed in this Release](#list.issues)
+[How to Get Involved](#get.involved)
+[How to Report Issues](#report.issues)
+
+## <a id="what.is.uima-ruta">What is UIMA Ruta?</a>
+
+ Apache UIMA Ruta™ is a rule-based script language supported by Eclipse-based tooling.
+ The language is designed to enable rapid development of text processing applications within Apache UIMA™.
+ A special focus lies on the intuitive and flexible domain specific language for defining
+ patterns of annotations. The Eclipse-based tooling for Ruta, called the Ruta Workbench,
+ was created to support the user and to facilitate every step when writing Ruta rules. Both the
+ Ruta rule language and the Ruta Workbench integrate smoothly with Apache UIMA.
+
+
+## <a id="major.changes">Notable changes in this release</a>
+
+* ...
+
+## <a id="list.issues">Full list of JIRA Issues affecting this Release</a>
+
+Click [issuesFixed/jira-report.hmtl](issuesFixed/jira-report.html) for the list of issues affecting
+this release.
+
+Please use the mailing lists ( http://uima.apache.org/mail-lists.html ) for feedback.
+
+## <a id="get.involved">How to Get Involved</a>
+
+The Apache UIMA project really needs and appreciates any contributions, including documentation
+help, source code and feedback. If you are interested in contributing, please visit
+[http://uima.apache.org/get-involved.html](http://uima.apache.org/get-involved.html).
+
+## <a id="report.issues">How to Report Issues</a>
+
+The Apache UIMA project uses JIRA for issue tracking. Please report any issues you find at
+[http://issues.apache.org/jira/browse/uima](http://issues.apache.org/jira/browse/uima).
\ No newline at end of file