svn commit: r1502223 - in /uima/sandbox/ruta/trunk/ruta-docbook/src/docbook: tools.ruta.language.actions.xml tools.ruta.overview.xml

[pk...@apache.org]

Author: pkluegl
Date: Thu Jul 11 13:38:30 2013
New Revision: 1502223

URL: http://svn.apache.org/r1502223
Log:
UIMA-3025
- added mention of type list for reindexing annotations

Modified:
    uima/sandbox/ruta/trunk/ruta-docbook/src/docbook/tools.ruta.language.actions.xml
    uima/sandbox/ruta/trunk/ruta-docbook/src/docbook/tools.ruta.overview.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=1502223&r1=1502222&r2=1502223&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 Jul 11 13:38:30 2013
@@ -373,17 +373,25 @@ Document{->CONFIGURE(HtmlAnnotator, "onl
     <para>
       The EXEC action initiates the execution of a different script
       file or analysis engine on the complete input document, independent from
-      the matched text and the current filtering settings. If the argument
+      the matched text and the current filtering settings. If the first 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 UIMA Ruta analysis engine.
+      settings of the UIMA Ruta analysis engine. If the first argument refers to an 
+      external analysis engine, then it is applied on the complete document. 
+      The optinal, second argument is a list of types, which should be reindexed by Ruta (not UIMA itself).
     </para>
+    <note>
+    <para>
+      Annotations created by the external analysis engine are not accessible for UIMA Ruta rules in the same script. 
+      The types of these annoations need to be provided in the second argument in order to be visible to the Ruta rules.
+    </para>
+    </note>
     <section>
       <title>
         <emphasis role="bold">Definition:</emphasis>
       </title>
       <para>
-        <programlisting><![CDATA[EXEC(DifferentFile)]]></programlisting>
+        <programlisting><![CDATA[EXEC(DifferentFile(, TypeListExpression)?)]]></programlisting>
       </para>
     </section>
     <section>
@@ -392,11 +400,12 @@ Document{->CONFIGURE(HtmlAnnotator, "onl
       </title>
       <para>
         <programlisting><![CDATA[ENGINE NamedEntities;
-Document{->EXEC(NamedEntities)};]]></programlisting>
+Document{->EXEC(NamedEntities, {Person, Location})};]]></programlisting>
       </para>
       <para>
         Here, an analysis engine for named entity recognition is
-        executed once on the complete document.
+        executed once on the complete document and the annotations of the types Person and Location (and all subtypes) 
+        are reindexed in UIMA Ruta. Wihtout this list of types, the annoations are added to the CAS, but cannot be accessed by Ruta rules.
       </para>
     </section>
   </section>

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=1502223&r1=1502222&r2=1502223&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 Jul 11 13:38:30 2013
@@ -540,11 +540,12 @@ Document{-> EXEC(Modifier)};
     whereas the given class name has to be present in the classpath. In the UIMA Ruta Workbench, you can add a dependency to a java project, which contains the 
     implementation, to the UIMA Ruta project. If the UIMA Ruta script is applied in a UIMA Pipeline, then the configuration parameter 
     <link linkend="ugr.tools.ruta.ae.basic.parameter.additionalUimafitEngines">additionalUimafitEngines</link> has to list the class of the analysis engine. 
-    The following example loads an analysis engine without an descriptor and applies it on the document.
+    The following example loads an analysis engine without an descriptor and applies it on the document. The additional list of types states that
+    the annoations of those types created by the analysis engine should be available to the following Ruta rules.
     
   </para>
       <programlisting><![CDATA[UIMAFIT my.package.impl.MyAnalysisEngine;
-Document{-> EXEC(MyAnalysisEngine)};
+Document{-> EXEC(MyAnalysisEngine, {MyType1, MyType2})};
 ]]></programlisting>
   
   </section>