You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@uima.apache.org by pk...@apache.org on 2013/04/13 12:35:38 UTC
svn commit: r1467585 - /uima/site/trunk/uima-website/docs/uima-re.html
Author: pkluegl
Date: Sat Apr 13 10:35:38 2013
New Revision: 1467585
URL: http://svn.apache.org/r1467585
Log:
UIMA-2811
- missed one file in last commit: added uima-re.html
Added:
uima/site/trunk/uima-website/docs/uima-re.html
Added: uima/site/trunk/uima-website/docs/uima-re.html
URL: http://svn.apache.org/viewvc/uima/site/trunk/uima-website/docs/uima-re.html?rev=1467585&view=auto
==============================================================================
--- uima/site/trunk/uima-website/docs/uima-re.html (added)
+++ uima/site/trunk/uima-website/docs/uima-re.html Sat Apr 13 10:35:38 2013
@@ -0,0 +1,404 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://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 - Apache UIMA Rule Engine and Workbench</title>
+ </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">Apache UIMA Rule Engine and Workbench</div>
+ </td>
+ <td align='RIGHT'>
+ <a href="http://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="http://www.google.com/search">
+ Search the site
+ <input type="text" name="q" size="25" maxlength="255" value="" />
+ <input type="hidden" name="sitesearch" value="http://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>
+ <br style="line-height: .5em"/>
+ <div class="navBarItem"> <a href="./mail-lists.html">Mailing Lists</a>
+ </div>
+ <div class="navBarItem"> <a href="./mail-lists.html#Apache_UIMA_Forums">Forums</a>
+ <a href="http://news.gmane.org/gmane.comp.apache.uima.general" target="_blank"><em> Users</em> <img src="images/offsitelink.png" /></a>
+ <a href="http://news.gmane.org/gmane.comp.apache.uima.devel" target="_blank"><em>Dev</em> <img src="images/offsitelink.png" /></a>
+ </div>
+ <div class="navBarItem"> <a href="http://cwiki.apache.org/UIMA/powered-by-apache-uima.html" target="_blank">Powered By UIMA <img src="images/offsitelink.png"/></a>
+ </div>
+ <br style="line-height: .5em"/>
+ <div class="navBarItem"> <a href="http://issues.apache.org/jira/browse/uima" target="_blank">Issue tracker <img src="images/offsitelink.png"/></a>
+ </div>
+ <div class="navBarItem"> <a href="http://cwiki.apache.org/UIMA/" target="_blank">Wiki <img src="images/offsitelink.png"/></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="./uima-re.html">UIMA-RE</a>
+ </div>
+ <div class="navBarItem"> <a href="./external-resources.html">External Resources</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="./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">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="./distribution.html">Creating a Distribution</a>
+ </div>
+ <div class="navBarItem"> <a href="./release.html">Doing a UIMA release</a>
+ </div>
+ <div class="navBarItem"> <a href="./eclipse-update-site.html">Eclipse Update Sites</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="./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="http://www.apache.org/licenses/" target="_blank">License <img src="images/offsitelink.png"/></a>
+ </div>
+ <div class="navBarItem"> <a href="http://www.apache.org/foundation/thanks.html" target="_blank">ASF Sponsors <img src="images/offsitelink.png"/></a>
+ </div>
+ <div class="navBarItem"> <a href="http://www.apache.org/foundation/sponsorship.html" target="_blank">ASF Sponsorship <img src="images/offsitelink.png"/></a>
+ </div>
+ <div class="navBarItem"> <a href="http://www.apache.org/security" target="_blank">Security <img src="images/offsitelink.png"/></a>
+ </div>
+ </div>
+ </div>
+ </td>
+ <td width="80%" align="left" valign="top">
+ <div class="sectionTable">
+ <table class="sectionTable">
+ <tr><td>
+ <a name="Apache UIMA Rule Engine and Workbench"><h1><img src="images/UIMA_4sq50tightCropSolid.png"/> Apache UIMA Rule Engine and Workbench</h1></a>
+ </td></tr>
+ <tr><td>
+ <blockquote class="sectionBody">
+ <p>
+ This component was originally released as Apache UIMA TextMarker and is currently renamed.
+</p>
+ <ul>
+ <li><a href='#Overview'>
+ Overview
+
+ </a></li>
+ <li><a href='#Rule Language'>
+ Rule Language
+
+ </a></li>
+ <li><a href='#Workbench'>
+ Workbench
+
+ </a></li>
+ <li><a href='#Developer Information'>
+ Developer Information
+
+ </a></li>
+ </ul>
+ <table class="subsectionTable" id='uima.re.overview'>
+ <tr><td>
+
+
+
+ <a name="Overview">
+ <h2>Overview
+ </h2>
+ </a>
+ </td></tr>
+ <tr><td>
+ <blockquote class="subsectionBody">
+ <p>
+ This Apache UIMA™ component consists of two major parts: An Analysis Engine, which interprets
+ and executes the rule-based scripting language, and the Eclipse-based tooling (Workbench),
+ which provides various support for developing rules.
+ </p>
+ <ul>
+ <li>
+ <p>
+ This page only contains a short overview. A more detailed introduction can be found in the documentation
+ (<a href="d/textmarker-current/tools.textmarker.book.html">html</a>,
+ <a href="d/textmarker-current/tools.textmarker.book.pdf">pdf</a>).
+ </p>
+ </li>
+ <li>
+ <p>
+ UIMA Rule Engine Workbench can be installed via our Eclipse update site:
+ <a href="http://www.apache.org/dist/uima/eclipse-update-site/">http://www.apache.org/dist/uima/eclipse-update-site/</a>
+ </p>
+ </li>
+ </ul>
+ </blockquote>
+ </td></tr>
+ </table>
+ <table class="subsectionTable" id='uima.re.language'>
+ <tr><td>
+
+
+
+ <a name="Rule Language">
+ <h2>Rule Language
+ </h2>
+ </a>
+ </td></tr>
+ <tr><td>
+ <blockquote class="subsectionBody">
+ <p>
+ The Rule Engine language is an imperative rule language extended with scripting elements. A rule defines a
+ pattern of annotations with additional conditions. If this pattern applies, then the actions of the rule are performed
+ on the matched annotations. A rule is composed of a sequence of rule elements and a rule element essentially consists of four parts:
+ A matching condition, an optional quantifier, a list of conditions and a list of actions.
+ The matching condition is typically a type of an annotation by which the rule element matches on the covered text of one of those annotations.
+ The quantifier specifies, whether it is necessary that the rule element successfully matches and how often the rule element may match.
+ The list of conditions specifies additional constraints that the matched text or annotations need to fulfill. The list of actions defines
+ the consequences of the rule and often creates new annotations or modifies existing annotations.
+ </p>
+ <p>
+ The following example rule consists of three rule elements. The first one (<code>ANY...</code>) matches on every token, which has a covered text that occurs in a word lists, named <code>MonthsList</code>.
+ The second rule element (<code>PERIOD?</code>) is optional and does not need to be fulfilled, which is indicated by the quantifier <code>?</code>. The last rule element (<code>NUM...</code>) matches
+ on numbers that fulfill the regular expression <code>REGEXP(".{2,4}"</code> and are therefore at least two characters to a maximum of four characters long.
+ If this rule successfully matches on a text passage, then its three actions are executed: An annotation of the type <code>Month</code> is created for the first rule element,
+ an annotation of the type <code>Year</code> is created for the last rule element and an annotation of the type <code>Date</code>
+ is created for the span of all three rule elements. If the word list contains the correct entries, then this rule matches on strings like
+ <code>Dec. 2004</code>, <code>July 85</code> or <code>11.2008</code> and creates the corresponding annotations.
+
+ <pre>ANY{INLIST(MonthsList) -> MARK(Month), MARK(Date,1,3)}
+ PERIOD? NUM{REGEXP(".{2,4}") -> MARK(Year))};</pre>
+ </p>
+ <p>
+ Here is a short overview of additional features of the rule language:
+ </p>
+ <ul>
+ <li>Expressions and variables</li>
+ <li>Import and execution of external components</li>
+ <li>Flexible matching with filtering</li>
+ <li>Modularization in different files or blocks</li>
+ <li>Control structures, e.g., for windowing</li>
+ <li>Score-based extraction</li>
+ <li>Modification</li>
+ <li>Html support</li>
+ <li>Dictionaries</li>
+ <li>Extensible language definition</li>
+ </ul>
+ </blockquote>
+ </td></tr>
+ </table>
+ <table class="subsectionTable" id='uima.re.workbench'>
+ <tr><td>
+
+
+
+ <a name="Workbench">
+ <h2>Workbench
+ </h2>
+ </a>
+ </td></tr>
+ <tr><td>
+ <blockquote class="subsectionBody">
+ <p>
+ The Rule Engine Workbench was created to facilitate all steps in creating Analysis Engines based on the Rule Engine language.
+ Here is a short overview of included features:
+ </p>
+ <ul>
+ <li>
+ <p>
+ <b>Editing support:</b> The full-featured editor for the TextMaker language provides syntax and semantic highlighting,
+ syntax checking, context-sensitive auto-completion, template-based completion, open declaration and more.
+ </p>
+ </li>
+ <li>
+ <p>
+ <b>Rule Explanation:</b> Each step in the matching process can be explained: This includes how often a rule was applied,
+ which condition was not fulfilled, or by which rule a specific annotation was created. Additionally, profile information
+ about the runtime performance can be accessed.
+ </p>
+ </li>
+ <li>
+ <p>
+ <b>Test-driven development:</b> Rule Engine scripts can automatically tested against a set of annotated documents.
+ </p>
+ </li>
+ <li>
+ <p>
+ <b>Rule learning:</b> The supervised learning algorithms of the included TextRuler framework are able to induce rules
+ and, therefore, enable semi-automatic development of rule-based components.
+ </p>
+ </li>
+ <li>
+ <p>
+ <b>Query:</b> Rules can be used as query statements in order to investigate annotated documents.
+ </p>
+ </li>
+ </ul>
+ <img style="width: 75%; height: 75%" src="./images/textmarker/textmarker_workbench.png" alt="UIMA Rule Engine Workbench" />
+ </blockquote>
+ </td></tr>
+ </table>
+ <table class="subsectionTable" id='uima.re.developer'>
+ <tr><td>
+
+
+
+ <a name="Developer Information">
+ <h2>Developer Information
+ </h2>
+ </a>
+ </td></tr>
+ <tr><td>
+ <blockquote class="subsectionBody">
+ <p>The latest version of UIMA Rule Engine is available via <a href="http://search.maven.org/#search%7Cga%7C1%7Ctextmarker">Maven Central</a>.
+ If you use Maven as your build tool, then you can add the basic UIMA Rule Engine functionality as a dependency
+ in your pom.xml file (additionally to other UIMA dependencies):</p>
+ <pre>
+<dependency>
+ <groupId>org.apache.uima</groupId>
+ <artifactId>textmarker-core</artifactId>
+ <version>2.0.0</version>
+</dependency>
+ </pre>
+ <subsubsection>
+ For building the UIMA Rule Engine projects from sources, follow the instructions for <a href="building-uima.html">building UIMA</a>,
+ but exchange the command for SVN checkout:<br />
+ <code>svn checkout https://svn.apache.org/repos/asf/uima/sandbox/textmarker/trunk c:/myWorkingDirectory</code>
+ </subsubsection>
+ <p>
+ The sources of the current release are available at the <a href="downloads.html">download page</a>.
+ </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 © 2006-2013, 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>
+