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/07/11 15:19:20 UTC

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

Author: pkluegl
Date: Thu Jul 11 13:19:20 2013
New Revision: 1502218

URL: http://svn.apache.org/r1502218
Log:
UIMA-3069
- adapted documentation

Modified:
    uima/sandbox/ruta/trunk/ruta-docbook/src/docbook/tools.ruta.language.syntax.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.syntax.xml
URL: http://svn.apache.org/viewvc/uima/sandbox/ruta/trunk/ruta-docbook/src/docbook/tools.ruta.language.syntax.xml?rev=1502218&r1=1502217&r2=1502218&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 Jul 11 13:19:20 2013
@@ -26,7 +26,7 @@
     Structure: The overall structure of a UIMA Ruta
     script is defined by
     the following syntax.
-    <programlisting><![CDATA[Script              -> PackageDeclaration GlobalStatements Statements
+    <programlisting><![CDATA[Script              -> PackageDeclaration? GlobalStatements Statements
 PackageDeclaration  -> "PACKAGE" DottedIdentifier ";"
 GlobalStatments     -> GlobalStatement*   
 GlobalStatment      -> ("TYPESYSTEM" | "SCRIPT" | "ENGINE" | "UIMAFIT") 

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=1502218&r1=1502217&r2=1502218&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:19:20 2013
@@ -151,14 +151,10 @@ under the License.
       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 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. 
-      In order to obtain a valid script file, please ensure that all used types are imported or declared and 
-      that a package declaration like <quote>PACKAGE uima.ruta.example;</quote> is added in the first line of the script.
-    </para></note>
     <para>
       The first example consists of a declaration of a type followed by a simple rule. Type declarations always start with the keyword 
       <quote>DECLARE</quote> followed by the short name of the new type. The namespace of the type is equal to the package declaration of the script file.
+      If there is no package declaration, then the types declared in the script file have no namespace.
       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.