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

[pk...@apache.org]

Author: pkluegl
Date: Tue Aug 13 11:39:51 2013
New Revision: 1513443

URL: http://svn.apache.org/r1513443
Log:
UIMA-3184
- mentioning the view parameter in the EXEC action documentation
- fixed some typos

Modified:
    uima/sandbox/ruta/trunk/ruta-docbook/src/docbook/tools.ruta.language.actions.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=1513443&r1=1513442&r2=1513443&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 Tue Aug 13 11:39:51 2013
@@ -373,17 +373,18 @@ 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 first argument
-      refers to another script file, a new view on the document is created:
+      the matched text and the current filtering settings. If the imported component (DifferentFile)
+      refers to another script file, it is applied on a new representation of the document:
       the complete text of the original CAS with the default filtering
-      settings of the UIMA Ruta analysis engine. If the first argument refers to an 
+      settings of the UIMA Ruta analysis engine. If it 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).
+      The optional, first argument is is a string expression, which specifies the view the component should be applied on.
+      The optional, third 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.
+      The types of these annotations need to be provided in the second argument in order to be visible to the Ruta rules.
     </para>
     </note>
     <section>
@@ -391,7 +392,7 @@ Document{->CONFIGURE(HtmlAnnotator, "onl
         <emphasis role="bold">Definition:</emphasis>
       </title>
       <para>
-        <programlisting><![CDATA[EXEC(DifferentFile(, TypeListExpression)?)]]></programlisting>
+        <programlisting><![CDATA[EXEC((StringExpression,)? DifferentFile(, TypeListExpression)?)]]></programlisting>
       </para>
     </section>
     <section>
@@ -405,7 +406,7 @@ Document{->EXEC(NamedEntities, {Person, 
       <para>
         Here, an analysis engine for named entity recognition is
         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.
+        are reindexed in UIMA Ruta. Without this list of types, the annotations are added to the CAS, but cannot be accessed by Ruta rules.
       </para>
     </section>
   </section>