You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@uima.apache.org by to...@apache.org on 2011/01/07 23:15:36 UTC

svn commit: r1056535 - in /uima/sandbox/trunk/RDFCASConsumer: build_documentation.xml pom.xml src/docbook/ src/docbook/RDFCASConsumerUserGuide.xml

Author: tommaso
Date: Fri Jan  7 22:15:36 2011
New Revision: 1056535

URL: http://svn.apache.org/viewvc?rev=1056535&view=rev
Log:
[UIMA-1993] - added documentation to RDFCASConsumer

Added:
    uima/sandbox/trunk/RDFCASConsumer/build_documentation.xml
    uima/sandbox/trunk/RDFCASConsumer/src/docbook/
    uima/sandbox/trunk/RDFCASConsumer/src/docbook/RDFCASConsumerUserGuide.xml
Modified:
    uima/sandbox/trunk/RDFCASConsumer/pom.xml

Added: uima/sandbox/trunk/RDFCASConsumer/build_documentation.xml
URL: http://svn.apache.org/viewvc/uima/sandbox/trunk/RDFCASConsumer/build_documentation.xml?rev=1056535&view=auto
==============================================================================
--- uima/sandbox/trunk/RDFCASConsumer/build_documentation.xml (added)
+++ uima/sandbox/trunk/RDFCASConsumer/build_documentation.xml Fri Jan  7 22:15:36 2011
@@ -0,0 +1,31 @@
+<?xml version="1.0" encoding="UTF-8"?>
+
+<!--
+   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.    
+-->
+
+<!-- set the basedir value to point to the top level of the project -->
+
+<project name="Apache UIMA RDF CAS Consumer Documentation" default="all" basedir=".">
+  
+  <property name="book_name" value="RDFCASConsumerUserGuide"/>
+  <property name="artifactId" value="RDFCASConsumer"/>
+  
+  <import file="${basedir}/../SandboxDocs/sandbox_build.xml"/>  
+  
+</project>

Modified: uima/sandbox/trunk/RDFCASConsumer/pom.xml
URL: http://svn.apache.org/viewvc/uima/sandbox/trunk/RDFCASConsumer/pom.xml?rev=1056535&r1=1056534&r2=1056535&view=diff
==============================================================================
--- uima/sandbox/trunk/RDFCASConsumer/pom.xml (original)
+++ uima/sandbox/trunk/RDFCASConsumer/pom.xml Fri Jan  7 22:15:36 2011
@@ -114,6 +114,85 @@
 
   <build>
     <finalName>uima-rdfcasconsumer</finalName>
+    <plugins>
+      <plugin>
+        <groupId>org.apache.maven.plugins</groupId>
+        <artifactId>maven-dependency-plugin</artifactId>
+        <executions>
+          <execution>
+            <!-- use the dependency:unpack goal to get the shared resource
+          that has the docbook-shared directory
+          Unpack into spot relative to project - because
+          these are referred to in docbook sources using
+          relative references -->
+            <id>copyDocbookInfo</id>
+            <phase>prepare-package</phase>
+            <goals>
+              <goal>unpack</goal>
+            </goals>
+            <configuration>
+              <overWriteIfNewer>true</overWriteIfNewer>
+              <artifactItems>
+                <artifactItem>
+                  <groupId>org.apache.uima</groupId>
+                  <artifactId>uima-build-resources</artifactId>
+                  <version>1</version>
+                  <includes>docbook-shared/**</includes>
+                  <outputDirectory>${project.build.directory}</outputDirectory>
+                </artifactItem>
+              </artifactItems>
+            </configuration>
+          </execution>
+          <execution>
+            <!-- also unpack next to docbook-olink in
+       repository location for olink info, because
+       the site.xml files use relative location to
+       get at the uima entities -->
+            <id>copyDocbookInfoNextToOlink</id>
+            <phase>prepare-package</phase>
+            <goals>
+              <goal>unpack</goal>
+            </goals>
+            <configuration>
+              <overWriteIfNewer>true</overWriteIfNewer>
+              <markersDirectory>${dolRepo}/dependency-maven-plugin-markers</markersDirectory>
+              <artifactItems>
+                <artifactItem>
+                  <groupId>org.apache.uima</groupId>
+                  <artifactId>uima-build-resources</artifactId>
+                  <version>1</version>
+                  <includes>docbook-shared/**</includes>
+                  <outputDirectory>${dolRepo}</outputDirectory>
+                </artifactItem>
+              </artifactItems>
+            </configuration>
+          </execution>
+          <!-- use the dependency:unpack goal to get the
+       olink databases  -->
+          <execution>
+            <id>getOlink</id>
+            <phase>prepare-package</phase>
+            <goals>
+              <goal>unpack</goal>
+            </goals>
+            <configuration>
+              <overWriteIfNewer>true</overWriteIfNewer>
+              <markersDirectory>${dolRepo}/dependency-maven-plugin-markers</markersDirectory>
+              <artifactItems>
+                <artifactItem>
+                  <groupId>org.apache.uima</groupId>
+                  <artifactId>${dolArtifactId}</artifactId>
+                  <version>1-SNAPSHOT</version>
+                  <type>zip</type>
+                  <classifier>${dolClassifier}</classifier>
+                  <outputDirectory>${dolUnzipped}</outputDirectory>
+                </artifactItem>
+              </artifactItems>
+            </configuration>
+          </execution>
+        </executions>
+      </plugin>
+    </plugins>
   </build>
 
 </project>
\ No newline at end of file

Added: uima/sandbox/trunk/RDFCASConsumer/src/docbook/RDFCASConsumerUserGuide.xml
URL: http://svn.apache.org/viewvc/uima/sandbox/trunk/RDFCASConsumer/src/docbook/RDFCASConsumerUserGuide.xml?rev=1056535&view=auto
==============================================================================
--- uima/sandbox/trunk/RDFCASConsumer/src/docbook/RDFCASConsumerUserGuide.xml (added)
+++ uima/sandbox/trunk/RDFCASConsumer/src/docbook/RDFCASConsumerUserGuide.xml Fri Jan  7 22:15:36 2011
@@ -0,0 +1,69 @@
+<?xml version="1.0" encoding="UTF-8"?>
+
+<!--
+  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.
+-->
+
+<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN"
+        "http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd">
+<book lang="en">
+
+  <title>
+    Apache UIMA RDF CAS Consumer documentation
+  </title>
+
+  <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
+              href="../../target/docbook-shared/common_book_info.xml"/>
+
+  <preface>
+    <title>Introduction</title>
+    <para>
+      The RDF CAS Consumer is a component to create RDF files from
+      CAS objects.
+    </para>
+    <para>
+      RDF CAS Consumer uses Apache Clerezza RDF serializing
+      capabilities and its integration modules with UIMA to create
+      files in various RDF formats from the CAS object.
+    </para>
+  </preface>
+
+  <chapter id="sandbox.rdfcas.services">
+    <title>Configuration</title>
+    <para>
+      To configure the RDFCASConsumer there are 3 parameters that can be set.
+      The parameters 'file' and 'format' are mandatory while 'view' is optional.
+      With the 'file' parameter the output file has to be specified using the file
+      protocol (i.e.: file://pathto/file.rdf).
+    </para>
+    <para>
+      The 'format' parameter handles the output format as there are different options
+      provided by the Serializer specified. Since RDFCASConsumer takes advantage of the
+      Apache Clerezza serializing facilities it depends on which serializer is enabled;
+      by default only the org.apache.clerezza.rdf.jena.serializer artifact is used but,
+      as Clerezza offers different serializing options, it can be extended to handle more
+      file formats. With org.apache.clerezza.rdf.jena.serializer the following formats are
+      supported: application/rdf+xml, text/turtle, application/x-turtle, text/rdf+nt and
+      text/rdf+n3.
+    </para>
+    <para>
+      Finally with the 'view' parameter the particular CAS View to serialize can be specified.
+      If no view is defined then the current default CAS view is serialized as RDF.
+    </para>
+
+
+  </chapter>
+
+</book>
\ No newline at end of file