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/05/02 23:31:29 UTC
svn commit: r1478565 [1/2] -
/uima/sandbox/ruta/trunk/ruta-docbook/src/docbook/
Author: pkluegl
Date: Thu May 2 21:31:28 2013
New Revision: 1478565
URL: http://svn.apache.org/r1478565
Log:
UIMA-2850
- renaming: "UIMA Ruta" instead of "Ruta"
Modified:
uima/sandbox/ruta/trunk/ruta-docbook/src/docbook/tools.ruta.language.actions.xml
uima/sandbox/ruta/trunk/ruta-docbook/src/docbook/tools.ruta.language.basic_annotations.xml
uima/sandbox/ruta/trunk/ruta-docbook/src/docbook/tools.ruta.language.declarations.xml
uima/sandbox/ruta/trunk/ruta-docbook/src/docbook/tools.ruta.language.expressions.xml
uima/sandbox/ruta/trunk/ruta-docbook/src/docbook/tools.ruta.language.syntax.xml
uima/sandbox/ruta/trunk/ruta-docbook/src/docbook/tools.ruta.language.xml
uima/sandbox/ruta/trunk/ruta-docbook/src/docbook/tools.ruta.overview.xml
uima/sandbox/ruta/trunk/ruta-docbook/src/docbook/tools.ruta.workbench.create_dictionaries.xml
uima/sandbox/ruta/trunk/ruta-docbook/src/docbook/tools.ruta.workbench.explain_perspective.xml
uima/sandbox/ruta/trunk/ruta-docbook/src/docbook/tools.ruta.workbench.install.xml
uima/sandbox/ruta/trunk/ruta-docbook/src/docbook/tools.ruta.workbench.overview.xml
uima/sandbox/ruta/trunk/ruta-docbook/src/docbook/tools.ruta.workbench.projects.xml
uima/sandbox/ruta/trunk/ruta-docbook/src/docbook/tools.ruta.workbench.query.xml
uima/sandbox/ruta/trunk/ruta-docbook/src/docbook/tools.ruta.workbench.ruta_perspective.xml
uima/sandbox/ruta/trunk/ruta-docbook/src/docbook/tools.ruta.workbench.testing.xml
uima/sandbox/ruta/trunk/ruta-docbook/src/docbook/tools.ruta.workbench.xml
Modified: uima/sandbox/ruta/trunk/ruta-docbook/src/docbook/tools.ruta.language.actions.xml
URL: http://svn.apache.org/viewvc/uima/sandbox/ruta/trunk/ruta-docbook/src/docbook/tools.ruta.language.actions.xml?rev=1478565&r1=1478564&r2=1478565&view=diff
==============================================================================
--- uima/sandbox/ruta/trunk/ruta-docbook/src/docbook/tools.ruta.language.actions.xml (original)
+++ uima/sandbox/ruta/trunk/ruta-docbook/src/docbook/tools.ruta.language.actions.xml Thu May 2 21:31:28 2013
@@ -33,7 +33,7 @@ under the License.
The ADD action adds all the elements of the passed
RutaExpressions to a given list. For example, this expressions
could be a string, an integer variable or a list. For a
- complete overview on Ruta expressions see
+ complete overview on UIMA Ruta expressions see
<xref linkend='ugr.tools.ruta.language.expressions' />.
</para>
<section>
@@ -376,7 +376,7 @@ Document{->CONFIGURE(HtmlAnnotator, "onl
the matched text and the current filtering settings. If the argument
refers to another script file, a new view on the document is created:
the complete text of the original CAS with the default filtering
- settings of the Ruta analysis engine.
+ settings of the UIMA Ruta analysis engine.
</para>
<section>
<title>
@@ -679,7 +679,7 @@ A B{-> GATHER(C, 1, 2, "a" = 1, "b" = 2)
<section id="ugr.tools.ruta.language.actions.mark">
<title>MARK</title>
<para>
- The MARK action is the most important action in the Ruta
+ The MARK action is the most important action in the UIMA Ruta
system. It creates a new annotation of the given type. The optionally
passed indexes (NumberExpressions after the TypeExpression) can be
used to create an annotation that spanns the matched information of
Modified: uima/sandbox/ruta/trunk/ruta-docbook/src/docbook/tools.ruta.language.basic_annotations.xml
URL: http://svn.apache.org/viewvc/uima/sandbox/ruta/trunk/ruta-docbook/src/docbook/tools.ruta.language.basic_annotations.xml?rev=1478565&r1=1478564&r2=1478565&view=diff
==============================================================================
--- uima/sandbox/ruta/trunk/ruta-docbook/src/docbook/tools.ruta.language.basic_annotations.xml (original)
+++ uima/sandbox/ruta/trunk/ruta-docbook/src/docbook/tools.ruta.language.basic_annotations.xml Thu May 2 21:31:28 2013
@@ -19,7 +19,7 @@
<section id="ugr.tools.ruta.language.seeding">
<title>Basic annotations and tokens</title>
<para>
- The Ruta system uses a JFlex lexer to initially create a
+ The UIMA Ruta system uses a JFlex lexer to initially create a
seed of basic token annotations. These tokens build a hierarchy shown in <xref linkend='figure.ugr.tools.ruta.language.seeding.basic_token' />. The
<quote>ALL</quote> (green) annotation is the root of the hierarchy. ALL and the red
marked annotation types are abstract. This means that they are actually not
Modified: uima/sandbox/ruta/trunk/ruta-docbook/src/docbook/tools.ruta.language.declarations.xml
URL: http://svn.apache.org/viewvc/uima/sandbox/ruta/trunk/ruta-docbook/src/docbook/tools.ruta.language.declarations.xml?rev=1478565&r1=1478564&r2=1478565&view=diff
==============================================================================
--- uima/sandbox/ruta/trunk/ruta-docbook/src/docbook/tools.ruta.language.declarations.xml (original)
+++ uima/sandbox/ruta/trunk/ruta-docbook/src/docbook/tools.ruta.language.declarations.xml Thu May 2 21:31:28 2013
@@ -19,10 +19,10 @@
<section id="ugr.tools.ruta.language.declarations">
<title>Declarations</title>
<para>
- There are three different kinds of declarations in the Ruta system:
+ There are three different kinds of declarations in the UIMA Ruta system:
Declarations of types with optional feature definitions,
declarations of variables and declarations for importing
- external resources, further Ruta scripts and UIMA components
+ external resources, further UIMA Ruta scripts and UIMA components
such as type systems and analysis engines.
</para>
<section id="ugr.tools.ruta.language.declarations.type">
@@ -154,7 +154,7 @@ BOOLEANLIST newBooleanList;]]></programl
<title>Resources</title>
<para>
There are two kinds of resource declarations that make external
- resources available in the Ruta system:
+ resources available in the UIMA Ruta system:
<itemizedlist mark='opencircle'>
<listitem>
<para>
@@ -206,7 +206,7 @@ Document{->CALL(AnotherScript)}; // <- r
<title>Components</title>
<para>
There are two kinds of UIMA components that can be imported in a
- Ruta script:
+ UIMA Ruta script:
<itemizedlist mark='opencircle'>
<listitem>
<para>
Modified: uima/sandbox/ruta/trunk/ruta-docbook/src/docbook/tools.ruta.language.expressions.xml
URL: http://svn.apache.org/viewvc/uima/sandbox/ruta/trunk/ruta-docbook/src/docbook/tools.ruta.language.expressions.xml?rev=1478565&r1=1478564&r2=1478565&view=diff
==============================================================================
--- uima/sandbox/ruta/trunk/ruta-docbook/src/docbook/tools.ruta.language.expressions.xml (original)
+++ uima/sandbox/ruta/trunk/ruta-docbook/src/docbook/tools.ruta.language.expressions.xml Thu May 2 21:31:28 2013
@@ -19,7 +19,7 @@
<section id="ugr.tools.ruta.language.expressions">
<title>Expressions</title>
<para>
- Ruta provides five different kinds of expressions. These are
+ UIMA Ruta provides five different kinds of expressions. These are
type expressions, number expressions, string expressions,
boolean expressions and list expressions.
</para>
@@ -32,7 +32,7 @@
<section id="ugr.tools.ruta.language.expressions.type">
<title>Type Expressions</title>
<para>
- Ruta provides two kinds of type expressions.
+ UIMA Ruta provides two kinds of type expressions.
<orderedlist numeration="arabic">
<listitem>
Declared annotation types (see
@@ -71,9 +71,9 @@ Document{->ASSIGN(typeVar, Author)};]]><
<section id="ugr.tools.ruta.language.expressions.number">
<title>Number Expressions</title>
<para>
- Ruta provides several possibilities to define number
+ UIMA Ruta provides several possibilities to define number
expressions. As expected, every number expression evaluates to a
- number. Ruta supports integer and floating-point numbers. A
+ number. UIMA Ruta supports integer and floating-point numbers. A
floating-point number can be in single or in double precision. To get
a complete overview, have a look at the following syntax definition
of number expressions.
@@ -130,7 +130,7 @@ Document{->ASSIGN(intVar1, 12 * intVar1
<section id="ugr.tools.ruta.language.expressions.string">
<title>String Expressions</title>
<para>
- There are two kinds of string expressions in Ruta.
+ There are two kinds of string expressions in UIMA Ruta.
<orderedlist numeration="arabic">
<listitem>
@@ -173,7 +173,7 @@ Document{->ASSIGN(strVar, "strLiteral" +
<section id="ugr.tools.ruta.language.expressions.boolean">
<title>Boolean Expressions</title>
<para>
- Ruta provides several possibilities to define boolean
+ UIMA Ruta provides several possibilities to define boolean
expressions. As expected, every boolean expression evaluates to
either
true or false. To get a complete overview, have a look at the
Modified: uima/sandbox/ruta/trunk/ruta-docbook/src/docbook/tools.ruta.language.syntax.xml
URL: http://svn.apache.org/viewvc/uima/sandbox/ruta/trunk/ruta-docbook/src/docbook/tools.ruta.language.syntax.xml?rev=1478565&r1=1478564&r2=1478565&view=diff
==============================================================================
--- uima/sandbox/ruta/trunk/ruta-docbook/src/docbook/tools.ruta.language.syntax.xml (original)
+++ uima/sandbox/ruta/trunk/ruta-docbook/src/docbook/tools.ruta.language.syntax.xml Thu May 2 21:31:28 2013
@@ -19,11 +19,11 @@
<section id="ugr.tools.ruta.language.syntax">
<title>Syntax</title>
<para>
- Ruta defines its own language for writing rules and rule
+ UIMA Ruta defines its own language for writing rules and rule
scripts. This section gives a formal overview of its syntax.
</para>
<para>
- Structure: The overall structure of a Ruta
+ Structure: The overall structure of a UIMA Ruta
script is defined by
the following syntax.
<programlisting><![CDATA[Script -> PackageDeclaration GlobalStatements Statements
@@ -38,7 +38,7 @@ Statement -> Declaration | Var
"//" and always go to the end of the line.
</para>
<para>
- Example beginning of a Ruta file:
+ Example beginning of a UIMA Ruta file:
<programlisting><![CDATA[PACKAGE uima.ruta.example;
// import the types of this type system
Modified: uima/sandbox/ruta/trunk/ruta-docbook/src/docbook/tools.ruta.language.xml
URL: http://svn.apache.org/viewvc/uima/sandbox/ruta/trunk/ruta-docbook/src/docbook/tools.ruta.language.xml?rev=1478565&r1=1478564&r2=1478565&view=diff
==============================================================================
--- uima/sandbox/ruta/trunk/ruta-docbook/src/docbook/tools.ruta.language.xml (original)
+++ uima/sandbox/ruta/trunk/ruta-docbook/src/docbook/tools.ruta.language.xml Thu May 2 21:31:28 2013
@@ -53,13 +53,13 @@ under the License.
<para>
Rule based or pattern based information extraction systems often
suffer from unimportant fill words, additional whitespace and
- unexpected markup. The Ruta System enables the knowledge
+ unexpected markup. The UIMA Ruta System enables the knowledge
engineer to filter and to hide all possible combinations of
predefined and new types of annotations. The
visibility of tokens and annotations is modified by the actions of
rule elements and can be conditioned using the complete
expressiveness of the language.
- Therefore the Ruta system
+ Therefore the UIMA Ruta system
supports a robust approach to
information extraction and simplifies
the creation of new rules since
@@ -133,7 +133,7 @@ Dr.JoachimBaumeister
<title>Blocks</title>
<para>
Blocks combine some more complex control structures in the
- Ruta
+ UIMA Ruta
language:
<orderedlist numeration="arabic">
<listitem>
@@ -163,7 +163,7 @@ RuleElementWithCA -> TypeExpressio
A block declaration always starts with the keyword
<quote>BLOCK</quote>, followed by the identifier of the block within parentheses. The
<quote>RuleElementType</quote>-element
- is a Ruta rule that consists of exactly one rule
+ is a UIMA Ruta rule that consists of exactly one rule
element. The rule element has to be a declared annotation type.
<note>
<para>
@@ -187,7 +187,7 @@ RuleElementWithCA -> TypeExpressio
]]></programlisting>
</para>
<para>
- A block is always executed when the Ruta interpreter
+ A block is always executed when the UIMA Ruta interpreter
reaches its
declaration. But a block may also be called from another
position of
@@ -197,7 +197,7 @@ RuleElementWithCA -> TypeExpressio
<section id="ugr.tools.ruta.language.blocks.condition">
<title>Conditioned statements</title>
<para>
- A block can use common Ruta conditions to condition the
+ A block can use common UIMA Ruta conditions to condition the
execution of its containing rules.
</para>
<para>
@@ -293,7 +293,7 @@ BLOCK(IsBig) Paragraph{} {
<section id="ugr.tools.ruta.language.blocks.procedure">
<title>Procedures</title>
<para>
- Blocks can be used to introduce procedures to the Ruta
+ Blocks can be used to introduce procedures to the UIMA Ruta
scripts.
To do this, declare a block as before. Let us assume, you want to
simulate a procedure
@@ -359,7 +359,7 @@ Document{->CALL(MyScript.countNumberOfTy
number of
findings is used to derive a solution.
- The Ruta system tries to
+ The UIMA Ruta system tries to
transfer this diagnostic problem
solution strategy to the
information
@@ -457,14 +457,14 @@ Document{-> EXEC(Modifier)};
would reduce the effort.
</para>
<para>
- Ruta provides, therefore, two kinds of external resources to
+ UIMA Ruta provides, therefore, two kinds of external resources to
solve such tasks more easily: WORDLISTs and WORDTABLEs.
</para>
<section>
<title>WORDLISTs</title>
<para>
A WORDLIST is a list of text items. There are three
- different possibilities of how to provide a WORDLIST to the Ruta system.
+ different possibilities of how to provide a WORDLIST to the UIMA Ruta system.
</para>
<para>
The first possibility is the use of simple text files, which
@@ -510,13 +510,13 @@ Document{->MARKFAST(FistName, FirstNameL
several ordinary WORDLISTs given as simple text files. It contains special
nodes that provide additional information about the original file. These
kind of WORDLIST is useful, if several fifferent WORDLISTs are used within
- a Ruta script. Using five different lists results in five rules using
+ a UIMA Ruta script. Using five different lists results in five rules using
the MARKFAST action. The documents to annotate are thus searched five
times resulting in a complexity of 5*O(m*log(n)) With a multi tree
word list this can be reduced to about O(m*log(5*n)). To
generate a multi tree word list, see
<xref linkend='section.ugr.tools.ruta.workbench.create_dictionaries' />
- To use a multi tree word list Ruta provides the action
+ To use a multi tree word list UIMA Ruta provides the action
TRIE. If for example two word lists
<quote>FirstNames.txt</quote>
and
@@ -564,7 +564,7 @@ Document{->MARKTABLE(PresidentOfUSA, 1,
<section id="ugr.tools.ruta.language.regexprule">
<title>Simple Rules based on Regular Expressions</title>
<para>
- The Ruta language includes, additionally to the normal rules, a simplified rule syntax for processing regular expressions.
+ The UIMA Ruta language includes, additionally to the normal rules, a simplified rule syntax for processing regular expressions.
These simple rules consist of two parts separated by <quote>-></quote>: The left part is the regular expression
(flags: DOTALL and MULTILINE), which may contain capturing groups. The right part defines, which kind of annotations
should be created for each match of the regular expression. If a type is given without a group index, then an annotation of that type is
Modified: uima/sandbox/ruta/trunk/ruta-docbook/src/docbook/tools.ruta.overview.xml
URL: http://svn.apache.org/viewvc/uima/sandbox/ruta/trunk/ruta-docbook/src/docbook/tools.ruta.overview.xml?rev=1478565&r1=1478564&r2=1478565&view=diff
==============================================================================
--- uima/sandbox/ruta/trunk/ruta-docbook/src/docbook/tools.ruta.overview.xml (original)
+++ uima/sandbox/ruta/trunk/ruta-docbook/src/docbook/tools.ruta.overview.xml Thu May 2 21:31:28 2013
@@ -35,9 +35,9 @@ under the License.
The language is designed to enable rapid development of text processing applications within UIMA.
A special focus lies on the intuitive and flexible domain specific language for defining
patterns of annotations. Writing rules for information extraction or other text processing
- applications is a tedious process. The Eclipse-based tooling for Ruta, called the Apache UIMA 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.
+ applications is a tedious process. The Eclipse-based tooling for UIMA Ruta, called the Apache UIMA Ruta Workbench,
+ was created to support the user and to facilitate every step when writing UIMA Ruta rules. Both the
+ Ruta rule language and the UIMA Ruta Workbench integrate smoothly with Apache UIMA.
</para>
</section>
@@ -45,44 +45,44 @@ under the License.
<title>Getting started</title>
<para>
This section gives a short roadmap how to read the documentation and gives some recommendations how to
- start developing Ruta-based applications. This documentation assumes that the reader knows about
+ start developing UIMA Ruta-based applications. This documentation assumes that the reader knows about
the core concepts of Apache UIMA. Knowledge of the meaning and usage of the terms <quote>CAS</quote>,
<quote>Feature Structure</quote>, <quote>Annotation</quote>, <quote>Type</quote>, <quote>Type System</quote>
and <quote>Analysis Engine</quote> is required. Please refer to the documentation of Apache UIMA for an introduction.
</para>
<para>
- Unexperienced users that want to learn about Ruta can start with the next two sections:
+ Unexperienced users that want to learn about UIMA Ruta can start with the next two sections:
<xref linkend="ugr.tools.ruta.overview.coreconcepts"/>
- gives a short overview of the core ideas and features of the Ruta language and Workbench.
- This section introduces the main concepts of the Ruta language. It explains how Ruta rules
- are composed and applied, and discusses the advantages of the Ruta system.
- The following <xref linkend="ugr.tools.ruta.overview.examples"/> approaches the Ruta language using a different
+ gives a short overview of the core ideas and features of the UIMA Ruta language and Workbench.
+ This section introduces the main concepts of the UIMA Ruta language. It explains how UIMA Ruta rules
+ are composed and applied, and discusses the advantages of the UIMA Ruta system.
+ The following <xref linkend="ugr.tools.ruta.overview.examples"/> approaches the UIMA Ruta language using a different
perspective. Here, the language is introduced by examples. The first example starts with explaining how a simple rule
- looks like, and each following example extends the syntax or semantics of the Ruta language.
+ looks like, and each following example extends the syntax or semantics of the UIMA Ruta language.
After the consultation of these two sections, the reader is expected to have gained enough
- knowledge to start writing her first Ruta-based application.
+ knowledge to start writing her first UIMA Ruta-based application.
</para>
<para>
- The Ruta Workbench was created to support the user and to facilitate the development process. It is strongly recommended to
+ The UIMA Ruta Workbench was created to support the user and to facilitate the development process. It is strongly recommended to
use this Eclipse-based IDE since it, for example, automatically configures the component descriptors and provides editing support like
- syntax checking. <xref linkend="section.ugr.tools.ruta.workbench.install"/> describes how the Ruta Workbench is installed.
- Ruta rules can also be applied on CAS without using the Ruta Workbench.
- <xref linkend="ugr.tools.ruta.ae.basic.apply"/> contains examples how to execute Ruta rules in plain java.
- A good way to get started with Ruta is to play around with an exemplary Ruta project, e.g.,
- <uri>https://svn.apache.org/repos/asf/uima/sandbox/ruta/trunk/example-projects/ExampleProject</uri>. This Ruta project
+ syntax checking. <xref linkend="section.ugr.tools.ruta.workbench.install"/> describes how the UIMA Ruta Workbench is installed.
+ UIMA Ruta rules can also be applied on CAS without using the UIMA Ruta Workbench.
+ <xref linkend="ugr.tools.ruta.ae.basic.apply"/> contains examples how to execute UIMA Ruta rules in plain java.
+ A good way to get started with UIMA Ruta is to play around with an exemplary UIMA Ruta project, e.g.,
+ <uri>https://svn.apache.org/repos/asf/uima/sandbox/ruta/trunk/example-projects/ExampleProject</uri>. This UIMA Ruta project
contains some simple rules for processing citation metadata.
</para>
<para>
<xref linkend="ugr.tools.ruta.language.language"/> and <xref linkend="ugr.tools.ruta.workbench"/> provide
more detailed descriptions and can be referred to in order to gain knowledge of specific parts
- of the Ruta language or the Ruta Workbench.
+ of the UIMA Ruta language or the UIMA Ruta Workbench.
</para>
</section>
<section id="ugr.tools.ruta.overview.coreconcepts">
<title>Core Concepts</title>
<para>
- The Ruta language is an imperative rule language extended with scripting elements. A Ruta rule defines a
+ The UIMA Ruta language is an imperative rule language extended with scripting elements. A UIMA Ruta 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 consist of four parts:
A matching condition, an optional quantifier, a list of conditions and a list of actions.
@@ -90,66 +90,66 @@ under the License.
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.
- They are only applied if all rule elements of the rule have successfully matched. Examples for Ruta rules can be found in
+ They are only applied if all rule elements of the rule have successfully matched. Examples for UIMA Ruta rules can be found in
<xref linkend="ugr.tools.ruta.overview.examples"/>.
</para>
<para>
- When Ruta rules are applied on a document, respectively on a CAS, then they are always grouped in a script file. However, a Ruta
+ When UIMA Ruta rules are applied on a document, respectively on a CAS, then they are always grouped in a script file. However, a UIMA Ruta
script file does not only contain rules, but also other statements. First of all, each script file starts with a package declaration followed by
a list of optional imports. Then, common statements like rules, type declarations or blocks build the body and functionality of a script.
- <xref linkend="ugr.tools.ruta.ae.basic.apply"/> gives an example, how Ruta scripts can be applied in plain Java.
- Ruta script files are naturally organized in Ruta projects, which is a concept of the Ruta Workbench.
- The structure of a Ruta project is described in <xref linkend="section.ugr.tools.ruta.workbench.projects"/>
+ <xref linkend="ugr.tools.ruta.ae.basic.apply"/> gives an example, how UIMA Ruta scripts can be applied in plain Java.
+ UIMA Ruta script files are naturally organized in UIMA Ruta projects, which is a concept of the UIMA Ruta Workbench.
+ The structure of a UIMA Ruta project is described in <xref linkend="section.ugr.tools.ruta.workbench.projects"/>
</para>
<para>
- The inference of Ruta rules, that is the approach how the rules are applied, can be described as imperative depth-first matching.
- In contrast to similar rule-based systems, Ruta rules are applied in the order they are defined in the script.
+ The inference of UIMA Ruta rules, that is the approach how the rules are applied, can be described as imperative depth-first matching.
+ In contrast to similar rule-based systems, UIMA Ruta rules are applied in the order they are defined in the script.
The imperative execution of the matching rules may have disadvantages, but also many advantages like an increased rate of development or
- an easier explanation. The second main property of the Ruta inference is the depth-first matching. When a rule matches on a pattern of annotations, then
+ an easier explanation. The second main property of the UIMA Ruta inference is the depth-first matching. When a rule matches on a pattern of annotations, then
an alternative is always tracked until it has matched or failed before the next alternative is considered. The behavior of a rule may change, if
it has already matched on an early alternative and thus has performed an action, which influences some constraints of the rule.
- Examples, how Ruta rules are applied, are given in <xref linkend="ugr.tools.ruta.overview.examples"/>.
+ Examples, how UIMA Ruta rules are applied, are given in <xref linkend="ugr.tools.ruta.overview.examples"/>.
</para>
<para>
- The Ruta language provides the possibility to approach an annotation problem in different ways. Let us distinguish
+ The UIMA Ruta language provides the possibility to approach an annotation problem in different ways. Let us distinguish
some approaches as an example.
- It is common in the Ruta language to create many annotations of different types. These annotations are probably not the targeted annotation of the domain,
+ It is common in the UIMA Ruta language to create many annotations of different types. These annotations are probably not the targeted annotation of the domain,
but can be helpful to incrementally approximate the annotation of interest. This enables the user to work <quote>bottom-up</quote> and <quote>top-down</quote>.
In the former approach, the rules add incrementally more complex annotations using simple ones until the target annotation can be created.
In the latter approach, the rules get more specific while partitioning the document in smaller segments, which result in the targeted annotation, eventually.
By using many <quote>helper</quote>-annotations, the engineering task becomes easier and more comprehensive.
- The Ruta language provides distinctive language elements for different tasks. There are, for example, actions
+ The UIMA Ruta language provides distinctive language elements for different tasks. There are, for example, actions
that are able to create new annotations, actions that are able to remove annotations and actions that are able to modify the
offsets of annotations. This enables, amongst other things, a transformation-based approach. The user starts by creating general rules that are able to
annotate most of the text fragments of interest. Then, instead of making these rules more complex by adding more conditions for situations where they fail,
additional rules are defined that correct the mistakes of the general rules, e.g., by deleting false positive annotations.
- <xref linkend="ugr.tools.ruta.overview.examples"/> provides some examples how Ruta rules can be engineered.
+ <xref linkend="ugr.tools.ruta.overview.examples"/> provides some examples how UIMA Ruta rules can be engineered.
</para>
<para>
- To write rules manually is a tedious and error-prone process. The <link linkend="ugr.tools.ruta.workbench">Ruta Workbench</link>
+ To write rules manually is a tedious and error-prone process. The <link linkend="ugr.tools.ruta.workbench">UIMA Ruta Workbench</link>
was developed to facilitate writing rules by providing as much tooling support as possible. This includes, for example, syntax checking and auto completion, which
make the development less error-prone. The user can annotate documents and use these documents as unit tests for test-driven development or
quality maintenance. Sometimes, it is necessary to debug the rules because they do not match as expected. In this case, the explanation perspective provides views
- that explain every detail of the matching process. Finally, the Ruta language can also be used by the tooling, for example, by the <quote>Query</quote> view.
- Here, Ruta rules can be used as query statements in order to investigate annotated documents.
+ that explain every detail of the matching process. Finally, the UIMA Ruta language can also be used by the tooling, for example, by the <quote>Query</quote> view.
+ Here, UIMA Ruta rules can be used as query statements in order to investigate annotated documents.
</para>
<para>
- Ruta smoothly integrates with Apache UIMA. First of all, the Ruta rules are applied using a generic Analysis Engine and thus Ruta scripts can
- easily be added to Apache UIMA pipelines. Ruta also provides the functionality to import and use other UIMA components like Analysis Engines and Type Systems.
- Ruta rules can refer to every type defined in an imported type system, and the Ruta Workbench generates a type system descriptor file containing all
+ UIMA Ruta smoothly integrates with Apache UIMA. First of all, the UIMA Ruta rules are applied using a generic Analysis Engine and thus UIMA Ruta scripts can
+ easily be added to Apache UIMA pipelines. UIMA Ruta also provides the functionality to import and use other UIMA components like Analysis Engines and Type Systems.
+ UIMA Ruta rules can refer to every type defined in an imported type system, and the UIMA Ruta Workbench generates a type system descriptor file containing all
types that were defined in a script file. Any Analysis Engine can be executed by rules as long as their implementation is available in the classpath. Therefore,
- functionality outsourced in an arbitrary Analysis Engine can be added and used within Ruta.
+ functionality outsourced in an arbitrary Analysis Engine can be added and used within UIMA Ruta.
</para>
</section>
<section id="ugr.tools.ruta.overview.examples">
<title>Learning by Example</title>
<para>
- This section gives an introduction to the Ruta language by explaining the rule syntax
- and inference with some simplified examples. It is recommended to use the Ruta Workbench to write Ruta rules
- in order to gain advantages like syntax checking. A short description how to install the Ruta Workbench
+ This section gives an introduction to the UIMA Ruta language by explaining the rule syntax
+ and inference with some simplified examples. It is recommended to use the UIMA Ruta Workbench to write UIMA Ruta rules
+ in order to gain advantages like syntax checking. A short description how to install the UIMA Ruta Workbench
is given <link linkend="section.ugr.tools.ruta.workbench.install">here</link>. The following examples make use of the
- annotations added by the default seeding of the Ruta Analysis Engine. Their meaning is explained along with the examples.
+ annotations added by the default seeding of the UIMA Ruta Analysis Engine. Their meaning is explained along with the examples.
</para>
<note><para>
The examples in this section are not valid script files as they are missing at least a package declaration.
@@ -162,7 +162,7 @@ under the License.
There is also the possibility to create more complex types with features or specific parent types, but this will be neglected for now.
In the example, a simple annotation type with the short name <quote>Animal</quote> is defined.
After the declaration of the type, a rule with one rule element is given.
- Ruta rules in general can consist of a sequence of rule elements. Simple rule elements themselves consist of four parts: A matching condition,
+ UIMA Ruta rules in general can consist of a sequence of rule elements. Simple rule elements themselves consist of four parts: A matching condition,
an optional quantifier, an optional list of conditions and an optional list of actions. The rule element in the
following example has a matching condition <quote>W</quote>, an annotation type standing for normal words.
Statements like declarations and rules always end with a semicolon.
@@ -268,7 +268,7 @@ Paragraph{CONTAINS(Bold, 90, 100, true),
<para>
The readability and maintenance of rules does not increase, if more conditions are added.
- One of the strengths of the Ruta language is that it provides different approaches to solve an annotation task. The next two examples
+ One of the strengths of the UIMA Ruta language is that it provides different approaches to solve an annotation task. The next two examples
introduce actions for transformation-based rules.
</para>
@@ -292,7 +292,7 @@ Paragraph{CONTAINS(Bold, 90, 100, true),
</para>
<para>
- Ruta rules can contain arbitrary conditions and actions, which is illustrated by the next example.
+ UIMA Ruta rules can contain arbitrary conditions and actions, which is illustrated by the next example.
</para>
<programlisting><![CDATA[DECLARE Month, Year, Date;
@@ -337,7 +337,7 @@ ANY+{-PARTOF(Text2) -> MARK(Text2)};]]><
</para>
<para>
- Ruta rules can not only be used to create or modify annotations, but also to create features for annotations. The next example defines
+ UIMA Ruta rules can not only be used to create or modify annotations, but also to create features for annotations. The next example defines
and assigns a relation of employment, by storing the given annotations as feature values.
</para>
@@ -372,14 +372,14 @@ NUM{PARSE(moneyAmount)} SPECIAL{REGEXP("
<para>
First, a new annotation with the name <quote>MoneyAmount</quote> and two features are defined, one string feature and one integer feature.
- Then, two Ruta variables are declared, one integer variable and one string variable. The rule matches on a number, whose value is stored
+ Then, two UIMA Ruta variables are declared, one integer variable and one string variable. The rule matches on a number, whose value is stored
in the variable <quote>moneyAmount</quote>, followed by a special token that needs to be equal to the string <quote>â¬</quote>. Then,
the covered text of the special annotation is stored in the string variable <quote>moneyCurrency</quote> and annotation of the
type <quote>MoneyAmount</quote> spanning over both rule elements is created. Additionally, the variables are assigned as feature values.
</para>
<para>
- Ruta script files with many rules can quickly confuse the reader. The Ruta language, therefore, allows to import other script files in order to increase
+ UIMA Ruta script files with many rules can quickly confuse the reader. The UIMA Ruta language, therefore, allows to import other script files in order to increase
the modularity of a project or to create rule libraries. The next example imports the rules together with all known types of another script file
and executes that script file.
</para>
@@ -390,9 +390,9 @@ Document{-> CALL(SecondaryScript)};]]></
<para>
The script file with the name <quote>SecondaryScript.ruta</quote>, which is located in the package <quote>uima/ruta/example</quote>, is imported and executed
by the CALL action on the complete document. The script needs to be located in the folder specified by the parameter
- <link linkend="ugr.tools.ruta.ae.basic.parameter.scriptPaths">scriptPaths</link>. It is also possible to import script files of other Ruta projects, e.g.,
- by adapting the configuration parameters of the Ruta Analysis Engine or
- by setting a project reference in the project properties of a Ruta project.
+ <link linkend="ugr.tools.ruta.ae.basic.parameter.scriptPaths">scriptPaths</link>. It is also possible to import script files of other UIMA Ruta projects, e.g.,
+ by adapting the configuration parameters of the UIMA Ruta Analysis Engine or
+ by setting a project reference in the project properties of a UIMA Ruta project.
</para>
<para>
@@ -412,10 +412,10 @@ Person{PARTOF(Organization) -> UNMARK(Pe
<para>
It is sometimes easier to express functionality with control structures known by programming languages rather than to engineer all functionality
- only with matching rules. The Ruta language provides the BLOCK element for some of these use cases.
- The Ruta BLOCK element starts with the keyword <quote>BLOCK</quote> followed by its name in parentheses. The name of a block has two purposes:
+ only with matching rules. The UIMA Ruta language provides the BLOCK element for some of these use cases.
+ The UIMA Ruta BLOCK element starts with the keyword <quote>BLOCK</quote> followed by its name in parentheses. The name of a block has two purposes:
On the one hand, it is easier to distinguish the block, if they have different names, e.g., in the
- <link linkend="section.ugr.tools.ruta.workbench.explain_perspective">explain perspective</link> of the Ruta Workbench. On the other hand,
+ <link linkend="section.ugr.tools.ruta.workbench.explain_perspective">explain perspective</link> of the UIMA Ruta Workbench. On the other hand,
the name can be used to execute this block using the CALL action. Hereby, it is possible to access only specific sets of rules of other script files,
or to implement a recursive call of rules. After the name of the block, a single rule element is given, which has curly parentheses,
even if no conditions or actions are specified. Then, the body of the block is framed by curly brackets.
@@ -453,7 +453,7 @@ BLOCK(ForEach) Sentence{} {
</para>
<para>
- Let us take a closer look on what exactly the Ruta rules match. The following rule matches on a word followed by another word:
+ Let us take a closer look on what exactly the UIMA Ruta rules match. The following rule matches on a word followed by another word:
</para>
<programlisting><![CDATA[W W;]]></programlisting>
@@ -462,7 +462,7 @@ BLOCK(ForEach) Sentence{} {
<quote><![CDATA[Apache <b>UIMA</b>]]></quote>. There are two main reasons for this: First of all, it depends on how the available annotations are defined. The default seeder
for the inital annotations creates an annotation for all characters until an upper case character occurs. Thus, the string <quote>ApacheUIMA</quote> consists of
two tokens.
- However, more important, the Ruta language provides a concept of visibility of the annotations. By default, all annotations of the types
+ However, more important, the UIMA Ruta language provides a concept of visibility of the annotations. By default, all annotations of the types
<quote>SPACE</quote>, <quote>NBSP</quote>, <quote>BREAK</quote> and <quote>MARKUP</quote> (whitespace and XML elements) are filtered and not visible. This holds of course for
their covered text, too. The rule elements skip all positions of the
document where those annotations occur. The rule in the last example matches on all examples. Without the default filtering settings,
@@ -471,7 +471,7 @@ BLOCK(ForEach) Sentence{} {
</para>
<para>
- The filtering setting can also be modified by the Ruta rules themselves. The next example provides rules that extend and limit
+ The filtering setting can also be modified by the UIMA Ruta rules themselves. The next example provides rules that extend and limit
the amount of visible text of the document.
</para>
@@ -489,14 +489,14 @@ Document{-> RETAINTYPE, FILTERTYPE};]]><
that the rule elements are now sensible to whitespaces. The following rule will, therefore, match on sentences that start with whitespaces.
The third rule now filters the type <quote>CW</quote> with the consequence that all capitalized words are invisible.
If the following rule now wants to match on sentences, then this is only possible for Sentence annotations that do not start with a capitalized word.
- The last rule finally resets the filtering setting to the default configuration in the Ruta Analysis Engine.
+ The last rule finally resets the filtering setting to the default configuration in the UIMA Ruta Analysis Engine.
</para>
<para>
The next example gives a showcase for importing external Analysis Engines and for modifying the documents by creating a new view called <quote>modified</quote>.
Additional Analysis Engines can be imported with the keyword <quote>ENGINE</quote> followed by the name of the descriptor. These imported Analysis Engines can be
executed with the actions <quote>CALL</quote> or <quote>EXEC</quote>. If the executed Analysis Engine adds, removes or modifies annotations, then their types need
- to be mentioned when calling the descriptor, or else these annotations will not be correctly processed by the following Ruta rules.
+ to be mentioned when calling the descriptor, or else these annotations will not be correctly processed by the following UIMA Ruta rules.
</para>
<programlisting><![CDATA[ENGINE utils.Modifier;
@@ -519,7 +519,7 @@ Document{-> EXEC(Modifier)};
<section id="ugr.tools.ruta.ae">
<title>UIMA Analysis Engines</title>
- <para>This section gives an overview of the UIMA Analysis Engines shipped with Ruta. The most
+ <para>This section gives an overview of the UIMA Analysis Engines shipped with UIMA Ruta. The most
important one is <quote>RutaEngine</quote>, a generic analysis engine, which is able to interpret
and execute script files. The other analysis engines provide support for some additional functionality or
add certain types of annotations.
@@ -527,18 +527,18 @@ Document{-> EXEC(Modifier)};
<section id="ugr.tools.ruta.ae.basic">
<title>Ruta Engine</title>
<para>
- This generic Analysis Engine is the most important one for the Ruta language since it is
- responsible for applying the Ruta rules on a CAS. Its functionality is configured by the configuration parameters,
- which, for example, specify the rule file that should be executed. In the Ruta IDE, a basic template named <quote>BasicEngine.xml</quote>
- is given in the descriptor folder of a Ruta project and correctly configured descriptors typically named <quote>MyScriptEngine.xml</quote>
+ This generic Analysis Engine is the most important one for the UIMA Ruta language since it is
+ responsible for applying the UIMA Ruta rules on a CAS. Its functionality is configured by the configuration parameters,
+ which, for example, specify the rule file that should be executed. In the UIMA Ruta Workbench, a basic template named <quote>BasicEngine.xml</quote>
+ is given in the descriptor folder of a UIMA Ruta project and correctly configured descriptors typically named <quote>MyScriptEngine.xml</quote>
are generated in the descriptor folder corresponding to the package namespace of the script file.
- The available configuration parameters of the Ruta Analysis Engine are described in the following.
+ The available configuration parameters of the UIMA Ruta Analysis Engine are described in the following.
</para>
<section id="ugr.tools.ruta.ae.basic.apply">
- <title>Apply Ruta Analysis Engine in plain Java</title>
+ <title>Apply UIMA Ruta Analysis Engine in plain Java</title>
<para>
- Let us assume that the reader wrote the Ruta rules using the Ruta Workbench, which already creates correctly configured descriptors.
- In this case, the following java code can be used to apply the Ruta script.
+ Let us assume that the reader wrote the UIMA Ruta rules using the UIMA Ruta Workbench, which already creates correctly configured descriptors.
+ In this case, the following java code can be used to apply the UIMA Ruta script.
</para>
<programlisting><![CDATA[File specFile = new File("pathToMyWorkspace/MyProject/descriptor/"+
"my/package/MyScriptEngine.xml");
@@ -551,12 +551,12 @@ CAS cas = ae.newCAS();
cas.setDocumentText("This is my document.");
ae.process(cas);]]></programlisting>
<note><para>
- The Ruta Analysis Engine utilizes type priorities. If the CAS object is
- not created using the Ruta Analysis Engine descriptor by other means, then please
- provide the necessary type priorities for a valid execution of the Ruta rules.
+ The UIMA Ruta Analysis Engine utilizes type priorities. If the CAS object is
+ not created using the UIMA Ruta Analysis Engine descriptor by other means, then please
+ provide the necessary type priorities for a valid execution of the UIMA Ruta rules.
</para></note>
<para>
- If the Ruta script was written, for example, with a common text editor and no configured descriptors are yet available,
+ If the UIMA Ruta script was written, for example, with a common text editor and no configured descriptors are yet available,
then the following java code can be used, which, however, is only applicable for executing single script files that do not import
additional components or scripts. In this case the other parameters, e.g., <quote>additionalScripts</quote>, need to be configured correctly.
</para>
@@ -600,7 +600,7 @@ ae.process(cas);]]></programlisting>
<section id="ugr.tools.ruta.ae.basic.parameter">
<title>Configuration Parameters</title>
<para>
- The configuration parameters of the Ruta Analysis Engine can be subdivided into three
+ The configuration parameters of the UIMA Ruta Analysis Engine can be subdivided into three
different groups: parameters for the setup of the environment (<link linkend='ugr.tools.ruta.ae.basic.parameter.mainScript'>mainScript</link>
to <link linkend='ugr.tools.ruta.ae.basic.parameter.additionalExtensions'>additionalExtensions</link>),
parameters that change the behavior of the analysis engine (<link linkend='ugr.tools.ruta.ae.basic.parameter.reloadScript'>reloadScript</link>
@@ -611,13 +611,13 @@ ae.process(cas);]]></programlisting>
<xref linkend='table.ugr.tools.ruta.ae.parameter' />. Afterwards, all parameters are described in detail with examples.
</para>
<para>
- To change the value of any configuration parameter within a Ruta script, the CONFIGURE action (see <xref linkend='ugr.tools.ruta.language.actions.configure' />)
+ To change the value of any configuration parameter within a UIMA Ruta script, the CONFIGURE action (see <xref linkend='ugr.tools.ruta.language.actions.configure' />)
can be used. For changing behaviour of <link linkend='ugr.tools.ruta.ae.basic.parameter.dynamicAnchoring'>dynamicAnchoring</link> the DYNAMICANCHORING action
(see <xref linkend='ugr.tools.ruta.language.actions.dynamicanchoring' />) is recommended.
</para>
<para>
<table id="table.ugr.tools.ruta.ae.parameter" frame="all">
- <title>Configuration parameters of the Ruta Analysis Engine </title>
+ <title>Configuration parameters of the UIMA Ruta Analysis Engine </title>
<tgroup cols="3" colsep="1" rowsep="1">
<colspec colname="c1" colwidth="1.2*" />
<colspec colname="c2" colwidth="2*" />
@@ -643,7 +643,7 @@ ae.process(cas);]]></programlisting>
<entry>
<link linkend='ugr.tools.ruta.ae.basic.parameter.scriptEncoding'>scriptEncoding</link>
</entry>
- <entry>Encoding of all Ruta script files.</entry>
+ <entry>Encoding of all UIMA Ruta script files.</entry>
<entry>Single String</entry>
</row>
<row>
@@ -687,7 +687,7 @@ ae.process(cas);]]></programlisting>
<link linkend='ugr.tools.ruta.ae.basic.parameter.additionalEngines'>additionalEngines</link>
</entry>
<entry>List of names with complete namespace of additional analysis engines, which
- can be called by Ruta rules.
+ can be called by UIMA Ruta rules.
</entry>
<entry>Multi String</entry>
</row>
@@ -704,7 +704,7 @@ ae.process(cas);]]></programlisting>
<entry>
<link linkend='ugr.tools.ruta.ae.basic.parameter.additionalExtensions'>additionalExtensions</link>
</entry>
- <entry>List of factory classes for additional extensions of the Ruta language
+ <entry>List of factory classes for additional extensions of the UIMA Ruta language
like proprietary conditions.
</entry>
<entry>Multi String</entry>
@@ -872,7 +872,7 @@ ae.process(cas);]]></programlisting>
<section id="ugr.tools.ruta.ae.basic.parameter.additionalEngines">
<title>additionalEngines</title>
<para>
- This parameter contains a list of additional analysis engines, which can be executed by the Ruta rules. The single values
+ This parameter contains a list of additional analysis engines, which can be executed by the UIMA Ruta rules. The single values
are given by the name of the analysis engine with their complete namespace and have to be located relative to one value of the parameter
<link linkend='ugr.tools.ruta.ae.basic.parameter.descriptorPaths'>descriptorPaths</link>, the location where the analysis engine searches for the descriptor file.
An example for one value of the parameter is "utils.HtmlAnnotator", which points to the descriptor "HtmlAnnotator.xml" in the folder "utils".
@@ -889,7 +889,7 @@ ae.process(cas);]]></programlisting>
<section id="ugr.tools.ruta.ae.basic.parameter.additionalExtensions">
<title>additionalExtensions</title>
<para>
- This parameter specifies optional extensions of the Ruta language. The elements of the string list have to implement the interface
+ This parameter specifies optional extensions of the UIMA Ruta language. The elements of the string list have to implement the interface
"org.apache.uima.ruta.extensions.IRutaExtension". With these extensions, application-specific conditions and actions can be
added to the set of provided ones.
</para>
@@ -908,7 +908,7 @@ ae.process(cas);]]></programlisting>
This list of string values refers to implementations of the interface "org.apache.uima.ruta.seed.RutaAnnotationSeeder",
which can be used to automatically add annotations to the CAS. The default value of the parameter is a single seeder, namely "org.apache.uima.ruta.seed.DefaultSeeder"
that adds annotations for token classes like CW, MARKUP or SEMICOLON. Remember that additional annotations can also be added with
- an additional engine that is executed by a Ruta rule.
+ an additional engine that is executed by a UIMA Ruta rule.
</para>
</section>
<section id="ugr.tools.ruta.ae.basic.parameter.defaultFilteredTypes">
@@ -983,7 +983,7 @@ ae.process(cas);]]></programlisting>
<section id="ugr.tools.ruta.ae.basic.parameter.statistics">
<title>statistics</title>
<para>
- If this parameter is set to true, then additional information about the runtime of Ruta language elements like conditions and actions
+ If this parameter is set to true, then additional information about the runtime of UIMA Ruta language elements like conditions and actions
is added to the CAS.
The default value of this parameter is set to false.
</para>
@@ -1003,7 +1003,7 @@ ae.process(cas);]]></programlisting>
This Analysis Engine can be utilized to write the covered text of annotations in a text file, whereas each covered text is put into a new line.
If the Analyis engine, for example, is configured for the type <quote>uima.example.Person</quote>, then all covered texts of all Person annotations are stored
in a text file, one person in each line.
- A descriptor file for this Analysis Engine is located in the folder <quote>descriptor/utils</quote> of a Ruta project.
+ A descriptor file for this Analysis Engine is located in the folder <quote>descriptor/utils</quote> of a UIMA Ruta project.
</para>
<section id="ugr.tools.ruta.ae.annotationwriter.parameter">
<title>Configuration Parameters</title>
@@ -1014,7 +1014,7 @@ ae.process(cas);]]></programlisting>
<para>
This string parameter specifies the absolute path of the resulting file named <quote>output.txt</quote>. However, if an annotation of the
type <quote>org.apache.uima.examples.SourceDocumentInformation</quote> is given, then the value of this parameter is interpreted to be relative
- to the URI stored in the annotation and the name of the file will be adapted to the name of the source file. The Ruta IDE automatically adds
+ to the URI stored in the annotation and the name of the file will be adapted to the name of the source file. The UIMA Ruta Workbench automatically adds
the SourceDocumentInformation annotation when the user launches a script file. The default value of this parameter is <quote>/../output/</quote>.
</para>
</section>
@@ -1037,7 +1037,7 @@ ae.process(cas);]]></programlisting>
<title>Plain Text Annotator</title>
<para>
This Analysis Engines adds annotations for lines and paragraphs.
- A descriptor file for this Analysis Engine is located in the folder <quote>descriptor/utils</quote> of a Ruta project. There are no configuration parameters.
+ A descriptor file for this Analysis Engine is located in the folder <quote>descriptor/utils</quote> of a UIMA Ruta project. There are no configuration parameters.
</para>
</section>
<section id="ugr.tools.ruta.ae.modifier">
@@ -1047,7 +1047,7 @@ ae.process(cas);]]></programlisting>
were specified by the executed rules. This Analysis Engine can be applied, e.g.,
for anonymization where all annotations of persons are replaced by the string <quote>Person</quote>.
Furthermore, the content of the new view can optionally be stored in a new HTML file.
- A descriptor file for this Analysis Engine is located in the folder <quote>descriptor/utils</quote> of a Ruta project.
+ A descriptor file for this Analysis Engine is located in the folder <quote>descriptor/utils</quote> of a UIMA Ruta project.
</para>
<section id="ugr.tools.ruta.ae.modifier.parameter">
<title>Configuration Parameters</title>
@@ -1071,7 +1071,7 @@ ae.process(cas);]]></programlisting>
<para>
This optional string parameter specifies the absolute path of the resulting file named <quote>output.modified.html</quote>. However, if an annotation of the
type <quote>org.apache.uima.examples.SourceDocumentInformation</quote> is given, then the value of this parameter is interpreted to be relative
- to the URI stored in the annotation and the name of the file will be adapted to the name of the source file. The Ruta IDE automatically adds
+ to the URI stored in the annotation and the name of the file will be adapted to the name of the source file. The UIMA Ruta Workbench automatically adds
the SourceDocumentInformation annotation when the user launches a script file. The default value of this parameter is empty.
In this case no additional html file will be created.
</para>
@@ -1093,7 +1093,7 @@ ae.process(cas);]]></programlisting>
The document <quote><![CDATA[This text is <b>bold</b>.]]></quote>, for example, would be annotated with an annotation of the type
<quote>org.apache.uima.ruta.type.html.B</quote> for the word <quote>bold</quote>. The HTML annotator can be configured
in order to include the start and end elements in the created annotations.
- A descriptor file for this Analysis Engine is located in the folder <quote>descriptor/utils</quote> of a Ruta project.
+ A descriptor file for this Analysis Engine is located in the folder <quote>descriptor/utils</quote> of a UIMA Ruta project.
</para>
<section id="ugr.tools.ruta.ae.html.parameter">
<title>Configuration Parameters</title>
@@ -1122,7 +1122,7 @@ ae.process(cas);]]></programlisting>
Note that in general it is suggested to run an html cleaner before any further processing to avoid problems with malformed html.
- A descriptor file for this Analysis Engine is located in the folder <quote>descriptor/utils</quote> of a Ruta project.
+ A descriptor file for this Analysis Engine is located in the folder <quote>descriptor/utils</quote> of a UIMA Ruta project.
</para>
<section id="ugr.tools.ruta.ae.htmlconverter.parameter">
<title>Configuration Parameters</title>
@@ -1191,7 +1191,7 @@ ae.process(cas);]]></programlisting>
This Analysis Engine can be utilized to create style map information, which is needed by the Modifier Analysis Engine in order to create
highlightings for some annotations.
Style map information can be created using the <link linkend='ugr.tools.ruta.language.actions.color'>COLOR</link> action.
- A descriptor file for this Analysis Engine is located in the folder <quote>descriptor/utils</quote> of a Ruta project.
+ A descriptor file for this Analysis Engine is located in the folder <quote>descriptor/utils</quote> of a UIMA Ruta project.
</para>
<section id="ugr.tools.ruta.ae.stylemap.parameter">
<title>Configuration Parameters</title>
@@ -1217,7 +1217,7 @@ ae.process(cas);]]></programlisting>
<para>
This Analysis Engine is able to serialize the processed CAS to an XMI file. One use case for the XMI Writer is, for example, a rule-based sort,
which stores the processed XMI files in different folder, dependent on the execution of the rules, e.g., whether a pattern of annotations occurs or not.
- A descriptor file for this Analysis Engine is located in the folder <quote>descriptor/utils</quote> of a Ruta project.
+ A descriptor file for this Analysis Engine is located in the folder <quote>descriptor/utils</quote> of a UIMA Ruta project.
</para>
<section id="ugr.tools.ruta.ae.xmi.parameter">
<title>Configuration Parameters</title>
@@ -1228,7 +1228,7 @@ ae.process(cas);]]></programlisting>
<para>
This string parameter specifies the absolute path of the resulting file named <quote>output.xmi</quote>. However, if an annotation of the
type <quote>org.apache.uima.examples.SourceDocumentInformation</quote> is given, then the value of this parameter is interpreted to be relative
- to the URI stored in the annotation and the name of the file will be adapted to the name of the source file. The Ruta IDE automatically adds
+ to the URI stored in the annotation and the name of the file will be adapted to the name of the source file. The UIMA Ruta Workbench automatically adds
the SourceDocumentInformation annotation when the user launches a script file.
The default value is <quote>/../output/</quote>
</para>
Modified: uima/sandbox/ruta/trunk/ruta-docbook/src/docbook/tools.ruta.workbench.create_dictionaries.xml
URL: http://svn.apache.org/viewvc/uima/sandbox/ruta/trunk/ruta-docbook/src/docbook/tools.ruta.workbench.create_dictionaries.xml?rev=1478565&r1=1478564&r2=1478565&view=diff
==============================================================================
--- uima/sandbox/ruta/trunk/ruta-docbook/src/docbook/tools.ruta.workbench.create_dictionaries.xml (original)
+++ uima/sandbox/ruta/trunk/ruta-docbook/src/docbook/tools.ruta.workbench.create_dictionaries.xml Thu May 2 21:31:28 2013
@@ -32,7 +32,7 @@ under the License.
with a given annotation type, very fast. For more details
on their use, see <xref linkend='ugr.tools.ruta.language.external_resources' />.
Since simple tree and multi tree word lists have to be compiled
- the Ruta workbench provides an easy way to compile
+ the UIMA Ruta Workbench provides an easy way to compile
them from ordinary text files. These text files have to
containing one item per line, for example, like in the
following list of first names:
@@ -44,7 +44,7 @@ Martin
</para>
<para>
To compile a simple tree word list from a text file,
- right-click on the text file in Ruta script
+ right-click on the text file in UIMA Ruta script
explorer. The resulting menu is shown in
<xref linkend='figure.ugr.tools.ruta.workbench.create_dictionaries_1' />.
@@ -69,7 +69,7 @@ Martin
</figure>
</para>
<para>
- When hovering over Ruta item you can choose
+ When hovering over UIMA Ruta item you can choose
<quote>Convert to TWL</quote>.
Click on it and a tree word list with the same name as the original
file is generated in the same folder.
@@ -85,7 +85,7 @@ Martin
generated
into the multi tree word list. Again right-click and select
<quote>Convert to Multi TWL</quote>
- under item Ruta. A multi tree word list
+ under item UIMA Ruta. A multi tree word list
named
<quote>generated.mtwl</quote>
will be created.
Modified: uima/sandbox/ruta/trunk/ruta-docbook/src/docbook/tools.ruta.workbench.explain_perspective.xml
URL: http://svn.apache.org/viewvc/uima/sandbox/ruta/trunk/ruta-docbook/src/docbook/tools.ruta.workbench.explain_perspective.xml?rev=1478565&r1=1478564&r2=1478565&view=diff
==============================================================================
--- uima/sandbox/ruta/trunk/ruta-docbook/src/docbook/tools.ruta.workbench.explain_perspective.xml (original)
+++ uima/sandbox/ruta/trunk/ruta-docbook/src/docbook/tools.ruta.workbench.explain_perspective.xml Thu May 2 21:31:28 2013
@@ -20,15 +20,15 @@
<title>Explain Perspective</title>
<para>
Writing new rules is laborious, especially if the newly written
- rules do not behave as expected. The Ruta system is able to
+ rules do not behave as expected. The UIMA Ruta system is able to
record the application of each single rule and block in order to
provide an explanation of the rule inference and a
minimal debugging functionality. The information about the application of the rules
itself is stored in the resulting xmiCAS output file, if the parameters
of the executed engine are configured correctly. The simplest way to
generate these explanation information is to click on the common 'Debug' button (looks like a green bug)
- while having the Ruta script file you want to debug active in
- your editor. The current Ruta file will then be executed on the text files in the input
+ while having the UIMA Ruta script file you want to debug active in
+ your editor. The current UIMA Ruta file will then be executed on the text files in the input
directory and xmiCAS are created in the output directory containing the
additional UIMA feature structures describing the
rule inference. To show the newly created execution information, you can either open the
@@ -37,14 +37,14 @@
the execution of the rules: Applied Rules, Covering Rules, Created By,
Failed Rules, Matched Rules, Rule Elements, Rule List
and Statistics. All of theses views are further explained in detail, using the
- Ruta example project for examples.
+ UIMA Ruta example project for examples.
</para>
<para>
To make it possible to reproduce all of the examples used below,
- switch to the Ruta Explain perspective within your Eclipse
+ switch to the UIMA Ruta Explain perspective within your Eclipse
workbench.
- Import the Ruta example project and open the main
+ Import the UIMA Ruta example project and open the main
Ruta script file 'Main.ruta'. Now press the 'Debug' button
and wait
for the end of execution. Open the resulting xmiCAS file
@@ -64,7 +64,7 @@
represented as child node in the tree of the view. Each Ruta
file is a BLOCK construct itself and named after the file. The
root node of the view is, therefore, always a BLOCK containing the rules of the
- executed Ruta script. Additionally, if a rule calls a different
+ executed UIMA Ruta script. Additionally, if a rule calls a different
Ruta file, then the root block of that file is the child of the
calling rule.
</para>
@@ -74,7 +74,7 @@
</para>
<para>
<xref linkend='section.ugr.tools.ruta.workbench.explain_perspective' />
- shows the whole rule hierarchy resulting from the Ruta example
+ shows the whole rule hierarchy resulting from the UIMA Ruta example
project. The root of the whole hierarchy is the BLOCK associated to
the 'Main.ruta' script. On the next level, the rules called by the
'Main.ruta' script are listed. Since there is a call to each of the
@@ -83,7 +83,7 @@
into the hierarchy, each forming their own block.
</para>
<para>
- The following image shows the Ruta Applied Rules view.
+ The following image shows the UIMA Ruta Applied Rules view.
<figure
id="figure.ugr.tools.ruta.workbench.explain_perspective.applied_rules">
<title> Applied Rules view
@@ -155,7 +155,7 @@
succeeded and are shown in the Matched Rules view.
</para>
<para>
- The following image shows the Ruta Applied Rules view.
+ The following image shows the UIMA Ruta Applied Rules view.
<figure
id="figure.ugr.tools.ruta.workbench.explain_perspective.matched_and_failed_rules">
<title> The views Matched Rules and Failed Rules
@@ -214,7 +214,7 @@
in <xref linkend='figure.ugr.tools.ruta.workbench.explain_perspective.rule_elements' />.
</para>
<para>
- The following image shows the Ruta Rule Elements view.
+ The following image shows the UIMA Ruta Rule Elements view.
<figure
id="figure.ugr.tools.ruta.workbench.explain_perspective.rule_elements">
<title> The views Matched Rules and Failed Rules
@@ -294,7 +294,7 @@
document <quote>Year.ruta</quote>.
</para>
<para>
- The following image shows the Ruta Created By view.
+ The following image shows the UIMA Ruta Created By view.
<figure
id="figure.ugr.tools.ruta.workbench.explain_perspective.created_by">
<title> The Created By view
@@ -323,14 +323,14 @@
<title>Statistics</title>
<para>
The Statistics view displays profiling information for the used
- conditions and actions of the Ruta language. Three
+ conditions and actions of the UIMA Ruta language. Three
numbers are
given for each element: The total time of execution, the amount of
executions and the average time per execution.
</para>
<para>
- The following image shows the Ruta Statistics view generated
- form the Ruta example project.
+ The following image shows the UIMA Ruta Statistics view generated
+ form the UIMA Ruta example project.
<figure
id="figure.ugr.tools.ruta.workbench.explain_perspective.statistics">
<title> The Statistics view
Modified: uima/sandbox/ruta/trunk/ruta-docbook/src/docbook/tools.ruta.workbench.install.xml
URL: http://svn.apache.org/viewvc/uima/sandbox/ruta/trunk/ruta-docbook/src/docbook/tools.ruta.workbench.install.xml?rev=1478565&r1=1478564&r2=1478565&view=diff
==============================================================================
--- uima/sandbox/ruta/trunk/ruta-docbook/src/docbook/tools.ruta.workbench.install.xml (original)
+++ uima/sandbox/ruta/trunk/ruta-docbook/src/docbook/tools.ruta.workbench.install.xml Thu May 2 21:31:28 2013
@@ -27,7 +27,7 @@ under the License.
<title>Installation</title>
<para>
- Do the installation of the Ruta workbench as follows:
+ Do the installation of the UIMA Ruta Workbench as follows:
<orderedlist numeration="arabic">
<listitem>
<para>
@@ -104,9 +104,9 @@ under the License.
</figure>
</para>
<para>
- Now, Ruta is going to be installed.
+ Now, UIMA Ruta is going to be installed.
After the successful
- installation, switch to the Ruta
+ installation, switch to the UIMA Ruta
perspective. To get an overview, see
<xref linkend='section.ugr.tools.ruta.workbench.overview' />.
</para>
@@ -117,9 +117,9 @@ under the License.
</para>
</note>
<para>
- Several times within this chapter we use a Ruta example
+ Several times within this chapter we use a UIMA Ruta example
project
- to illustrate the use of the Ruta workbench.
+ to illustrate the use of the UIMA Ruta Workbench.
The example project
can be downloaded per
<emphasis>svn</emphasis>
Modified: uima/sandbox/ruta/trunk/ruta-docbook/src/docbook/tools.ruta.workbench.overview.xml
URL: http://svn.apache.org/viewvc/uima/sandbox/ruta/trunk/ruta-docbook/src/docbook/tools.ruta.workbench.overview.xml?rev=1478565&r1=1478564&r2=1478565&view=diff
==============================================================================
--- uima/sandbox/ruta/trunk/ruta-docbook/src/docbook/tools.ruta.workbench.overview.xml (original)
+++ uima/sandbox/ruta/trunk/ruta-docbook/src/docbook/tools.ruta.workbench.overview.xml Thu May 2 21:31:28 2013
@@ -14,14 +14,14 @@
See the License for the specific language governing permissions and limitations under the License. -->
<section id="section.ugr.tools.ruta.workbench.overview">
- <title>Ruta Workbench Overview</title>
+ <title>UIMA Ruta Workbench Overview</title>
<para>
- The Ruta workbench provides two main perspectives.
+ The UIMA Ruta Workbench provides two main perspectives.
<orderedlist numeration="arabic">
<listitem>
<para>
The
- <quote>Ruta perspective</quote>, which provides the main functionality for working on Ruta projects. See
+ <quote>UIMA Ruta perspective</quote>, which provides the main functionality for working on UIMA Ruta projects. See
<xref linkend='section.ugr.tools.ruta.workbench.ruta_perspective' />
for detailed information.
</para>
@@ -37,9 +37,9 @@
</orderedlist>
</para>
<para>
- The following image shows the Ruta perspective.
+ The following image shows the UIMA Ruta perspective.
<figure id="figure.ugr.tools.ruta.workbench.overview.ruta_perspective">
- <title> The Ruta perspective.
+ <title> The UIMA Ruta perspective.
</title>
<mediaobject>
<imageobject role="html">
@@ -52,21 +52,21 @@
</imageobject>
<textobject>
<phrase>
- The Ruta perspective.
+ The UIMA Ruta perspective.
</phrase>
</textobject>
</mediaobject>
</figure>
- As you can see, the Ruta perspective provides an editor for editing documents, e.g.,
- Ruta scripts, and several views for different other tasks. The Script Explorer, for
- example, helps to manage your Ruta projects.
+ As you can see, the UIMA Ruta perspective provides an editor for editing documents, e.g.,
+ UIMA Ruta scripts, and several views for different other tasks. The Script Explorer, for
+ example, helps to manage your UIMA Ruta projects.
</para>
<para>
The following
<xref linkend='table.ugr.tools.ruta.workbench.overview.views' />
- lists all available Ruta views:
+ lists all available UIMA Ruta views:
<table id="table.ugr.tools.ruta.workbench.overview.views" frame="all">
- <title>Ruta views</title>
+ <title>UIMA Ruta views</title>
<tgroup cols="2" colsep="1" rowsep="1">
<colspec colname="c1" colwidth="1*" />
<colspec colname="c2" colwidth="1*" />
@@ -189,9 +189,9 @@
<para>
The following
<xref linkend='table.ugr.tools.ruta.workbench.overview.wizards' />
- lists all Ruta wizards:
+ lists all UIMA Ruta wizards:
<table id="table.ugr.tools.ruta.workbench.overview.wizards" frame="all">
- <title>Ruta wizards</title>
+ <title>UIMA Ruta wizards</title>
<tgroup cols="2" colsep="1" rowsep="1">
<colspec colname="c1" colwidth="1*" />
<colspec colname="c2" colwidth="1*" />
@@ -203,7 +203,7 @@
</thead>
<tbody>
<row>
- <entry>Create Ruta project</entry>
+ <entry>Create UIMA Ruta project</entry>
<entry>
See
<xref linkend='section.ugr.tools.ruta.workbench.projects.create_projects' />
Modified: uima/sandbox/ruta/trunk/ruta-docbook/src/docbook/tools.ruta.workbench.projects.xml
URL: http://svn.apache.org/viewvc/uima/sandbox/ruta/trunk/ruta-docbook/src/docbook/tools.ruta.workbench.projects.xml?rev=1478565&r1=1478564&r2=1478565&view=diff
==============================================================================
--- uima/sandbox/ruta/trunk/ruta-docbook/src/docbook/tools.ruta.workbench.projects.xml (original)
+++ uima/sandbox/ruta/trunk/ruta-docbook/src/docbook/tools.ruta.workbench.projects.xml Thu May 2 21:31:28 2013
@@ -18,12 +18,12 @@
<section id="section.ugr.tools.ruta.workbench.projects">
- <title>Ruta Projects</title>
+ <title>UIMA Ruta Projects</title>
<para>
- Ruta projects used within the Ruta workbench need to have
+ UIMA Ruta projects used within the UIMA Ruta Workbench need to have
a certain folder structure. The parts of this folder structure are
explained in
- <xref linkend='table.ugr.tools.ruta.workbench.create_project.folder_strucutre' />. To create a Ruta project it is recommended to use the provided
+ <xref linkend='table.ugr.tools.ruta.workbench.create_project.folder_strucutre' />. To create a UIMA Ruta project it is recommended to use the provided
wizard, explained in
<xref linkend='section.ugr.tools.ruta.workbench.projects.create_projects' />. If this wizard is used, the required folder structure is
automatically created.
@@ -46,7 +46,7 @@
<row>
<entry>script</entry>
<entry>
- Source folder for Ruta scripts and packages.
+ Source folder for UIMA Ruta scripts and packages.
</entry>
</row>
<row>
@@ -62,7 +62,7 @@
<entry>
Folder that contains the files that will be processed when
launching a
- Ruta script. Such input files could be plain
+ UIMA Ruta script. Such input files could be plain
text,
HTML or xmiCAS files.
</entry>
@@ -96,7 +96,7 @@
shows a project, newly created with the wizard.
<figure id="figure.ugr.tools.ruta.workbench.projects.test_project">
- <title>A newly created Ruta project</title>
+ <title>A newly created UIMA Ruta project</title>
<mediaobject>
<imageobject role="html">
<imagedata width="300px" format="PNG" align="center"
@@ -108,7 +108,7 @@
</imageobject>
<textobject>
<phrase>
- A newly created Ruta project.
+ A newly created UIMA Ruta project.
</phrase>
</textobject>
</mediaobject>
@@ -116,10 +116,10 @@
</para>
<section id="section.ugr.tools.ruta.workbench.projects.create_projects">
- <title>Ruta create project wizard</title>
+ <title>UIMA Ruta create project wizard</title>
<para>
- To create a new Ruta project, switch to Ruta perspective
- and click <quote>File → New → Ruta Project</quote>. This opens the corresponding wizard.
+ To create a new UIMA Ruta project, switch to UIMA Ruta perspective
+ and click <quote>File → New → UIMA Ruta Project</quote>. This opens the corresponding wizard.
</para>
<para>
@@ -147,7 +147,7 @@
</figure>
</para>
<para>
- To create a simple Ruta project, enter a project name for
+ To create a simple UIMA Ruta project, enter a project name for
your project and click
<quote>Finish</quote>. This will create everything you need to start.
</para>
Modified: uima/sandbox/ruta/trunk/ruta-docbook/src/docbook/tools.ruta.workbench.query.xml
URL: http://svn.apache.org/viewvc/uima/sandbox/ruta/trunk/ruta-docbook/src/docbook/tools.ruta.workbench.query.xml?rev=1478565&r1=1478564&r2=1478565&view=diff
==============================================================================
--- uima/sandbox/ruta/trunk/ruta-docbook/src/docbook/tools.ruta.workbench.query.xml (original)
+++ uima/sandbox/ruta/trunk/ruta-docbook/src/docbook/tools.ruta.workbench.query.xml Thu May 2 21:31:28 2013
@@ -26,8 +26,8 @@ under the License.
<section id="section.ugr.tools.ruta.workbench.ruta_query">
<title>Query View</title>
- <para> With the Query View, the Ruta language can be used to write queries on a set of
- documents. A query is simply a set of Ruta rules. Each query returns a list of all text
+ <para> With the Query View, the UIMA Ruta language can be used to write queries on a set of
+ documents. A query is simply a set of UIMA Ruta rules. Each query returns a list of all text
passages the query applies to. For example, if you have a set of annotated documents containing
a number of Author annotations, you could use the Query View to get a list of all the author
names associated with these annotations.
@@ -71,14 +71,14 @@ under the License.
<para>
The field
<quote>Type System</quote>
- has to contain a type system or a Ruta script that specifies all types that are used
+ has to contain a type system or a UIMA Ruta script that specifies all types that are used
in the query. You can either click on the button next to the field to specify the type
system by browsing through the file system or you can drag and drop a type system
directly into the field.
</para>
</listitem>
<listitem>
- <para> The query in form of one or more Ruta rules is specified in the text field in
+ <para> The query in form of one or more UIMA Ruta rules is specified in the text field in
the middle of the view.</para>
</listitem>
<listitem>
@@ -95,11 +95,11 @@ under the License.
the related document is already open you can jump to another matched text passage within the the
same document with one click on the listed item. Of course, this text passage is selected.
By clicking on the export button, a list of all matched text passaged is showed in a
- separate window. For further usage, e.g. as a list of authors in another Ruta project,
+ separate window. For further usage, e.g. as a list of authors in another UIMA Ruta project,
copy the content of this window to another text file.
</para>
<para> The screenshot shows an example where a rule is used to find occurrences of years within
- brackets in the input file of the Ruta example. After pressing the run button the result
+ brackets in the input file of the UIMA Ruta example. After pressing the run button the result
list contains all occurrences. Recognize that the rule does not create any annotation. The list
lists all rule matches, not the created annotations.
</para>
Modified: uima/sandbox/ruta/trunk/ruta-docbook/src/docbook/tools.ruta.workbench.ruta_perspective.xml
URL: http://svn.apache.org/viewvc/uima/sandbox/ruta/trunk/ruta-docbook/src/docbook/tools.ruta.workbench.ruta_perspective.xml?rev=1478565&r1=1478564&r2=1478565&view=diff
==============================================================================
--- uima/sandbox/ruta/trunk/ruta-docbook/src/docbook/tools.ruta.workbench.ruta_perspective.xml (original)
+++ uima/sandbox/ruta/trunk/ruta-docbook/src/docbook/tools.ruta.workbench.ruta_perspective.xml Thu May 2 21:31:28 2013
@@ -17,10 +17,10 @@
language governing permissions and limitations under the License. -->
<section id="section.ugr.tools.ruta.workbench.ruta_perspective">
- <title>Ruta Perspective</title>
+ <title>UIMA Ruta Perspective</title>
<para>
- The Ruta perspective is the main view to manage Ruta
- projects. There are several views associated with the Ruta
+ The UIMA Ruta perspective is the main view to manage UIMA Ruta
+ projects. There are several views associated with the UIMA Ruta
perspective: Annotation Test, Annotation Browser, Selection,
TextRuler and Ruta Query. Since Annotation Test, TextRuler and
Ruta Query have a stand-alone functionality. They are explained
@@ -29,10 +29,10 @@
<para>
To make it possible to reproduce all of the examples used below,
- switch to the Ruta Explain perspective within your Eclipse
+ switch to the UIMA Ruta Explain perspective within your Eclipse
workbench.
- Import the Ruta example project and open the main
- Ruta script file 'Main.ruta'. Now press the 'Run' button (green
+ Import the UIMA Ruta example project and open the main
+ UIMA Ruta script file 'Main.ruta'. Now press the 'Run' button (green
arrow) and wait for the end of execution. Open the resulting xmiCAS
file 'Test1.txt.xmi', which you can find in the output folder.
</para>
@@ -42,12 +42,12 @@
<title>Annotation Browser</title>
<para>
The Annotation Browser can be used to view the annotations
- created by the execution of a Ruta project. If an xmiCAS file
+ created by the execution of a UIMA Ruta project. If an xmiCAS file
is opened and active in the editor, the related annotations are shown
in this view.
</para>
<para>
- The result of the execution of the Ruta example project is
+ The result of the execution of the UIMA Ruta example project is
shown in <xref linkend='figure.ugr.tools.ruta.workbench.ruta_perspective.annotation_browser' />.
</para>
<para>