Author: pkluegl
Date: Fri Jun 10 13:01:44 2016
New Revision: 1747704
URL: http://svn.apache.org/viewvc?rev=1747704&view=rev
Log:
UIMA-4962
- added archetype with script, wordlist and junit test
- added some documentation
Added:
uima/ruta/trunk/ruta-maven-archetype/
uima/ruta/trunk/ruta-maven-archetype/pom.xml (with props)
uima/ruta/trunk/ruta-maven-archetype/src/
Modified:
uima/ruta/trunk/ruta-docbook/src/docbook/tools.ruta.howtos.xml
Modified: uima/ruta/trunk/ruta-docbook/src/docbook/tools.ruta.howtos.xml
URL:
http://svn.apache.org/viewvc/uima/ruta/trunk/ruta-docbook/src/docbook/tools.ruta.howtos.xml?rev=1747704&r1=1747703&r2=1747704&view=diff
==============================================================================
--- uima/ruta/trunk/ruta-docbook/src/docbook/tools.ruta.howtos.xml (original)
+++ uima/ruta/trunk/ruta-docbook/src/docbook/tools.ruta.howtos.xml Fri Jun 10
13:01:44 2016
@@ -500,6 +500,46 @@ The|DT rabbit|NN made|VBD up|RP this|DT
</section>
</section>
+
+ <section id="ugr.tools.ruta.archetype">
+ <title>UIMA Ruta Maven Archetype</title>
+ <para>
+ UIMA Ruta provides a maven archetype for creating maven projects that
preconfigured for
+ building UIMA Ruta scripts with maven and contain already a minimal
example with a unit test,
+ which can be utilized as a starting point.
+ </para>
+
+
+ <para>
+ A UIMA Ruta project are created with following command using the the
archetype (in one line):
+ </para>
+
+ <programlisting><![CDATA[mvn archetype:generate
-DarchetypeGroupId=org.apache.uima
+ -DarchetypeArtifactId=ruta-maven-archetype
-DarchetypeVersion=<ruta-version>
+ -DgroupId=<package> -DartifactId=<project-name>]]></programlisting>
+
+ <para>
+ The placeholders need to be replaced with the corresponding values. This
could look like:
+ </para>
+
+ <programlisting><![CDATA[mvn archetype:generate
-DarchetypeGroupId=org.apache.uima
+ -DarchetypeArtifactId=ruta-maven-archetype -DarchetypeVersion=2.4.1
+ -DgroupId=my.domain -DartifactId=my-ruta-project]]></programlisting>
+
+ <para>
+ Using the archetype in Eclipse to create a project may result in some
missing replacements
+ of variables and thus to broken projects. Using the archetype on command
line is recommended.
+ </para>
+
+ <para>
+ In the creation process, several properties need to be defined.
+ Their default values can be accepted by simply pressing the return key.
+ After the project was created successfully, switch to the new folder and
enter 'mvn install'.
+ Now, the UIMA Ruta project is built: the descriptors for the UIMA Ruta
script are created,
+ the wordlist is compiled to a MTWL file, and the unit test verifies the
overall functionality.
+ </para>
+
+ </section>
<section id="section.tools.ruta.workbench.textruler.example">
<title>Induce rules with the TextRuler framework</title>
Added: uima/ruta/trunk/ruta-maven-archetype/pom.xml
URL:
http://svn.apache.org/viewvc/uima/ruta/trunk/ruta-maven-archetype/pom.xml?rev=1747704&view=auto
==============================================================================
--- uima/ruta/trunk/ruta-maven-archetype/pom.xml (added)
+++ uima/ruta/trunk/ruta-maven-archetype/pom.xml Fri Jun 10 13:01:44 2016
@@ -0,0 +1,65 @@
+<!-- Licensed to the Apache Software Foundation (ASF) under one or more
contributor license agreements.
+ See the NOTICE file distributed with this work for additional information
regarding copyright ownership.
+ The ASF licenses this file to you under the Apache License, Version 2.0 (the
"License"); you may not
+ use this file except in compliance with the License. You may obtain a copy
of the License at http://www.apache.org/licenses/LICENSE-2.0
+ Unless required by applicable law or agreed to in writing, software
distributed under the License is
+ distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
KIND, either express or implied.
+ See the License for the specific language governing permissions and
limitations under the License. -->
+<project xmlns="http://maven.apache.org/POM/4.0.0";
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance";
+ xsi:schemaLocation="http://maven.apache.org/POM/4.0.0
http://maven.apache.org/xsd/maven-4.0.0.xsd";>
+ <modelVersion>4.0.0</modelVersion>
+ <artifactId>ruta-maven-archetype</artifactId>
+ <name>Apache UIMA Maven: ${project.artifactId}</name>
+ <description>A Maven archetype for creating maven-built Ruta
projects</description>
+ <packaging>maven-archetype</packaging>
+ <parent>
+ <groupId>org.apache.uima</groupId>
+ <artifactId>ruta-parent</artifactId>
+ <version>2.4.1-SNAPSHOT</version>
+ <relativePath>../ruta-parent/pom.xml</relativePath>
+ </parent>
+ <properties>
+ <postNoticeText />
+ </properties>
+ <url>${uimaWebsiteUrl}</url>
+ <scm>
+
<url>http://svn.apache.org/viewvc/uima/ruta/trunk/ruta-maven-archetype</url>
+
<connection>scm:svn:http://svn.apache.org/repos/asf/uima/ruta/trunk/ruta-maven-archetype</connection>
+
<developerConnection>scm:svn:https://svn.apache.org/repos/asf/uima/ruta/trunk/ruta-maven-archetype</developerConnection>
+ </scm>
+ <build>
+ <extensions>
+ <extension>
+ <groupId>org.apache.maven.archetype</groupId>
+ <artifactId>archetype-packaging</artifactId>
+ <version>2.3</version>
+ </extension>
+ </extensions>
+ <pluginManagement>
+ <plugins>
+ <plugin>
+ <groupId>org.apache.maven.plugins</groupId>
+ <artifactId>maven-archetype-plugin</artifactId>
+ <version>2.4</version>
+ </plugin>
+ <plugin>
+ <groupId>org.apache.rat</groupId>
+ <artifactId>apache-rat-plugin</artifactId>
+ <executions>
+ <execution>
+ <id>default-cli</id>
+ <configuration>
+ <excludes>
+
<exclude>src/main/resources/archetype-resources/src/main/resources/META-INF/org.apache.uima.fit/*.txt</exclude>
<!-- uimafit -->
+
<exclude>src/main/resources/archetype-resources/src/main/resources/**/*.txt</exclude>
<!-- dictionary -->
+ <exclude>issuesFixed/**</exclude> <!-- generated -->
+ <exclude>marker-file-identifying-*</exclude>
+ </excludes>
+ </configuration>
+ </execution>
+ </executions>
+ </plugin>
+ </plugins>
+ </pluginManagement>
+ </build>
+</project>
Propchange: uima/ruta/trunk/ruta-maven-archetype/pom.xml
------------------------------------------------------------------------------
svn:eol-style = native
