You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@jena.apache.org by ch...@apache.org on 2012/10/16 17:54:48 UTC
svn commit: r1398857 - in /jena/Scratch/Eyeball/trunk/doc:
eyeball-2.4-brief.html eyeball-2.4-full-template.html eyeball-2.4-index.html
Author: chrisdollin
Date: Tue Oct 16 15:54:48 2012
New Revision: 1398857
URL: http://svn.apache.org/viewvc?rev=1398857&view=rev
Log:
Started updating the documentation.
Modified:
jena/Scratch/Eyeball/trunk/doc/eyeball-2.4-brief.html
jena/Scratch/Eyeball/trunk/doc/eyeball-2.4-full-template.html
jena/Scratch/Eyeball/trunk/doc/eyeball-2.4-index.html
Modified: jena/Scratch/Eyeball/trunk/doc/eyeball-2.4-brief.html
URL: http://svn.apache.org/viewvc/jena/Scratch/Eyeball/trunk/doc/eyeball-2.4-brief.html?rev=1398857&r1=1398856&r2=1398857&view=diff
==============================================================================
--- jena/Scratch/Eyeball/trunk/doc/eyeball-2.4-brief.html (original)
+++ jena/Scratch/Eyeball/trunk/doc/eyeball-2.4-brief.html Tue Oct 16 15:54:48 2012
@@ -8,7 +8,7 @@
<h1>caveat</h1>
This document is a work-in-progress; refer to the
-<a href="full.html">manual</a> for details when this page
+<a href="eyeball-2.4-full.html">manual</a> for details when this page
doesn't help.
<h1>brief guide</h1>
@@ -25,7 +25,7 @@ and any models your model imports: you c
from the command line or configuration file.
Eyeball uses those schemas to work out what URIs count as "declared"
in advance. It also checks URIs and literals for syntactic
-correctness and name space prefixes for being "sensible".
+correctness and name space prefixes for being "sensible".
Let's look at some of the messages you can get.
<h2>unknown predicate reports</h2>
@@ -55,22 +55,22 @@ the option:
Eyeball will read the OWL schema (it has a copy stashed away in the
<i>mirror</i> directory) and add the declared properties to
its known list. This works for any filename or URL you like, so long as
-there's RDF there and it has a suitable file suffix - <i>.n3</i> for
-N3 or <i>.rdf</i> or <i>.owl</i> for RDF/XML - and for the built-in
-names <i>dc</i> (basic Dublin Core), <i>dcterms</i> (Dublin Core terms)
-and <i>dc-all</i> (both). So you
+there's RDF there and it has a suitable file suffix - <i>.ttl</i> for
+Turtle, <i>.n3</i> for N3, <i>.rdf</i> or <i>.owl</i> for RDF/XML -
+and for the built-in names <i>dc</i> (basic Dublin Core),
+<i>dcterms</i> (Dublin Core terms) and <i>dc-all</i> (both). So you
can construct your own schemas, which declare your own domain-specific
property declarations, and invoke Eyeball with
<blockquote>
--assume owl <i>mySchemaFile.n3</i> <i>otherSchemaFile.rdf</i>
+-assume owl <i>mySchemaFile.ttl</i> <i>otherSchemaFile.rdf</i>
</blockquote>
<p>
You can give short names (like <b>dc</b> and <b>rdfs</b>) to
your own schemas, or collections of schemas, using an Eyeball
<i>config file</i>, but you'll have to see the
-<a href="full.html">manual</a> to find out how.
+<a href="eyeball-2.4-full.html">manual</a> to find out how.
<h2>unknown class reports</h2>
@@ -112,7 +112,7 @@ Eyeball's different checks are carried o
classes. These classes are given short names by entries in
Eyeball config files (which are RDF files written using N3; you
can see the default config file by looking in Eyeball's
-<code>etc</code> directory for <code>eyeball2-config.n3</code>).
+<code>etc</code> directory for <code>eyeball-config.ttl</code>).
By adding eg:
<blockquote>
Modified: jena/Scratch/Eyeball/trunk/doc/eyeball-2.4-full-template.html
URL: http://svn.apache.org/viewvc/jena/Scratch/Eyeball/trunk/doc/eyeball-2.4-full-template.html?rev=1398857&r1=1398856&r2=1398857&view=diff
==============================================================================
--- jena/Scratch/Eyeball/trunk/doc/eyeball-2.4-full-template.html (original)
+++ jena/Scratch/Eyeball/trunk/doc/eyeball-2.4-full-template.html Tue Oct 16 15:54:48 2012
@@ -12,6 +12,7 @@
</script>
</head>
<body>
+
<h1>summary</h1>
<p>This document describes Eyeball 2.4, an
@@ -77,58 +78,26 @@
<h2>installation</h2>
- <p>Fetch the Eyeball distribution zipfile and unpack it somewhere
- convenient. Read the documention in the <i>doc</i> directory: the
- one-minute guide <i>index.html</i>, the brief introduction
- <i>brief.html</i>, and when necessary the manual <i>full.html</i>
- (that's what this is).</p>
-
- <p>Eyeball 2.4 comes with its own copy of Jena 2.5 with CVS
- updates. Do <i>not</i> attempt to use other versions of Jena with
- Eyeball.</p>
-
- <p>In the Eyeball distribution directory, run the Eyeball
- tests:
- </p>
-
- <blockquote>
- ant test
- </blockquote>
-
<p>
- If these tests fail, something is wrong.
-
- (The message <i>(Note:
- statistician test disabled; don't worry about this.)</i> is not a
- failure.)
-
- Sometimes
- it's no more than a classpath problem, which you can fix. If not,
- use the <i>jena-dev</i> mailing list to request assistance. Note that,
- just as with Jena itself, any support is provided on a voluntary
- basis, as and when the effort is available.
+ There are two ways you can download and use Eyeball. The
+ usual, initial way is to download the Eyeball jar from
+ <i>locationtobedetermined</i>. This jar is an executable
+ (using <code>java -jar</code>) file containing all the
+ necessary dependences. Or you can build your own Maven
+ project that depends on the Eyeball artifact and build
+ customised versions of Eyeball.
</p>
<p>
- If the tests have passed, you can use Eyeball from the installation
- directory, or copy <i>lib</i>, <i>etc</i> and <i>mirror</i> to
- somewhere convenient.
+ See <i>later</i> for using Maven.
</p>
<h2>command line operation</h2>
- <p>
- You must ensure that <i>all</i> the Eyeball jars from <i>lib</i>
- are on your classpath. (Note that Eyeball comes with its own Jena
- jar files and <i>may not work</i> with other Jena jars.) The
- directories <i>etc</i> and <i>mirror</i> should be in the
- current directory or also on your classpath.
- </p>
-
<p>Run the Eyeball command:</p>
<pre>
-java [java options eg classpath and proxy] jena.eyeball
+java [java options eg classpath and proxy] -jar eyeball-2.4-exec.jar
(-check | -sign | -accept) specialURL+
[-assume Reference*]
[-config fileOrURL*]
@@ -1389,9 +1358,5 @@ eye:eyeball a eye:Eyeball
...
</pre>
- <p>
- </p>
-
-
</body>
</html>
Modified: jena/Scratch/Eyeball/trunk/doc/eyeball-2.4-index.html
URL: http://svn.apache.org/viewvc/jena/Scratch/Eyeball/trunk/doc/eyeball-2.4-index.html?rev=1398857&r1=1398856&r2=1398857&view=diff
==============================================================================
--- jena/Scratch/Eyeball/trunk/doc/eyeball-2.4-index.html (original)
+++ jena/Scratch/Eyeball/trunk/doc/eyeball-2.4-index.html Tue Oct 16 15:54:48 2012
@@ -7,21 +7,22 @@
<h1>Eyeball: checking RDF/OWL for common problems</h1>
-Eyeball is a Jena contrib for checking RDF models (including OWL) for
+Eyeball is a Jena component for checking RDF and OWL models for
common problems. It is user-extensible using plugins. The available
documentation for this Eyeball, E2.4, is:
<ul>
<li>This index and one-minute introduction.
-<li>The <a href="brief.html">brief guide</a>.
+<li>The <a href="eyeball-2.4-brief.html">brief guide</a>.
<li>The <i>experimental</i> <a href="gui.html">Eyeball GUI</a>.
-<li>The full <a href="full.html">manual</a>.
+<li>The full <a href="eyeball-2.4-full.html">manual</a>.
<li>The <a href="javadoc/index.html">javadoc</a>.
</ul>
You can download Eyeball from the
-<a href="http://sourceforge.net/project/showfiles.php?group_id=40417&package_id=148927">
-Eyeball package page</a>. Eyeball needs Java 5 or later to run.
+<a href="locationtobedetermined">
+Eyeball package page
+</a>. Eyeball needs Java 5 or later to run.
<h1>one-minute introduction</h1>
@@ -29,24 +30,9 @@ Eyeball package page</a>. Eyeball needs
<p>
If you haven't already, download Eyeball from the
-<a href="http://sourceforge.net/project/showfiles.php?group_id=40417&package_id=148927">Eyeball package page</a>
-and unzip it into a directory of your choice.
-The download is rather large, because Eyeball 2.4 includes the Jena
-jars so that it runs stand-alone.
-
-<p>If you have Ant installed, run the Eyeball test suite:
-
-<blockquote>
-ant test
-</blockquote>
-
-<p>
-If it doesn't say that the tests passed, let us know via the jena-dev
-mailing list <i>jena-dev@groups.yahoo.com</i> (registration required)
-and we'll see what we can do to fix the problem.
-
-<p>Ensure all the jars in the Eyeball lib directory are on your classpath.
-(You might find <a href="classpath.text">this list</a> helpful.)
+<a href="locationtobedetermined">Eyeball package page</a>.
+This jar file is self-contained (it includes all the Jena jars
+it needs so that it can run standalone).
<h2>trying it out</h2>
@@ -55,22 +41,20 @@ Pick one of your RDF files; we'll call i
command:
<blockquote>
-java jena.eyeball -check FOO
+java -jar eyeball-2.4.0-exec.jar -check FOO
</blockquote>
<p>
You will likely get a whole bunch
of messages about your RDF. The messages are supposed to be self-explanatory,
-so you may be able to go ahead and fix some problems straight away. If you
-get a Java error about <b>NoClassDefFoundError</b>, you've forgotten to
-set the classpath up or use the <i>-cp myClassPath</i> option to Java.
+so you may be able to go ahead and fix some problems straight away.
<p>(You may also want to try the experimental <a href="gui.html">Eyeball GUI</a>,
but you'll still need to start it from the command line.)
<p>
If the messages aren't self-explanatory, or you want more details,
-you'll want to move on to the <a href="brief.html">brief guide</a>.
+you'll want to move on to the <a href="eyeball-2.4-brief.html">brief guide</a>.
</body>
</html>