You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@jena.apache.org by bu...@apache.org on 2013/05/17 17:45:31 UTC

svn commit: r862270 - in /websites/staging/jena/trunk/content: ./ documentation/io/rdf-output.html

Author: buildbot
Date: Fri May 17 15:45:31 2013
New Revision: 862270

Log:
Staging update by buildbot for jena

Modified:
    websites/staging/jena/trunk/content/   (props changed)
    websites/staging/jena/trunk/content/documentation/io/rdf-output.html

Propchange: websites/staging/jena/trunk/content/
------------------------------------------------------------------------------
--- cms:source-revision (original)
+++ cms:source-revision Fri May 17 15:45:31 2013
@@ -1 +1 @@
-1483873
+1483876

Modified: websites/staging/jena/trunk/content/documentation/io/rdf-output.html
==============================================================================
--- websites/staging/jena/trunk/content/documentation/io/rdf-output.html (original)
+++ websites/staging/jena/trunk/content/documentation/io/rdf-output.html Fri May 17 15:45:31 2013
@@ -506,91 +506,113 @@ needing any writer state.</p>
 
 <p>The main N-Triples and N-Quads writers follow RDF 1.1 and output using UTF-8.  
 For compatibility with old software, writers are provided that output
-in ASCII (using `\u` escape sequences for non-ASCI charcaters where necessary).
+in ASCII (using `\u` escape sequences for non-ASCI characters where necessary).
+</p>
 
 <p>&nbsp;</p>
 
-| RDFFormat       |
-|-----------------|
-| NTRIPLES_ASCII  |
-| NQUADS_ASCII    |
-
-### RDF/XML
-
-RIOT supports output in RDF/XML. RIOT RDFFormats defaults to pretty printed RDF/XML,
-while the jena writer writer name defaults to a streaming plain output.
-
-| RDFFormat | Other names              | Jena writer name            |
-|-----------|--------------------------|-----------------------------|
-| RDFXML    | RDFXML_PRETTY, RDF_XML_ABBREV | "RDF/XML-ABBREV" |
-| RDFXML_PLAIN |                            | "RDF/XML"        |
-
-## Examples
-
-Example code may be found in [jena-arq/src-examples](https://svn.apache.org/repos/asf/jena/trunk/jena-arq/src-examples/arq/examples/riot/).
-
-### Ways to write a model
-
-The follow ways are different ways to write a model in Turtle:
-
-        Model model =  ... ;
-
-        // Write a model in Turtle syntax, default style (pretty printed)
-        RDFDataMgr.write(System.out, model, Lang.TURTLE) ;
-
-        // Wriet Turtle to the blocks variant
-        RDFDataMgr.write(System.out, model, RDFFormat.TURTLE_BLOCKS) ;
-
-        // Write as Turtle via model.write
-        model.write(System.out, "TTL") ;
-
-### Ways to write a dataset
-
-The prefered style is to use `RDFDataMgr`:
-
-    Dataset ds = .... ;
-    // Write as TriG
-    RDFDataMgr.write(System.out, ds, Lang.TRIG) ;
-
-    // Write as N-Quads
-    RDFDataMgr.write(System.out, dataset, Lang.NQUADS) ;
-
-Additionaly, a single model can be written in a dataset format - it becomes
-the default graph of the dataset.
-
-    Model m = 
-    RDFDataMgr.write(System.out, m, Lang.TRIG) ;
-
-might give:
-
-    @prefix :      <http://example/> .
-    @prefix dc:    <http://purl.org/dc/elements/1.1/> .
-    @prefix foaf:  <http://xmlns.com/foaf/0.1/> .
-    @prefix rdf:   <http://www.w3.org/1999/02/22-rdf-syntax-ns#> .
-
-    {
-        :book   dc:author  ( :a :b ) .
-
-        :a      a           foaf:Person ;
-                foaf:knows  [ foaf:name  "Bob" ] ;
-                foaf:name   "Alice" .
-
-        :b      foaf:knows  :a .
-    }
-
-### Adding a new output format
-
-An complete example of adding a new output format is given in the example file: 
-[RIOT Output example 3](https://svn.apache.org/repos/asf/jena/trunk/jena-arq/src-examples/arq/examples/riot/ExRIOT_out3.java)
-
-## Notes
-
-Using `OutputStream`s is strongly encouraged.  This allows the writers
-to manage the character encoding using UTF-8.  Using `java.io.Writer` 
+<table>
+<thead>
+<tr>
+<th>RDFFormat</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td>NTRIPLES_ASCII</td>
+</tr>
+<tr>
+<td>NQUADS_ASCII</td>
+</tr>
+</tbody>
+</table>
+<h3 id="rdfxml">RDF/XML</h3>
+<p>RIOT supports output in RDF/XML. RIOT RDFFormats defaults to pretty printed RDF/XML,
+while the jena writer writer name defaults to a streaming plain output.</p>
+<table>
+<thead>
+<tr>
+<th>RDFFormat</th>
+<th>Other names</th>
+<th>Jena writer name</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td>RDFXML</td>
+<td>RDFXML_PRETTY, RDF_XML_ABBREV</td>
+<td>"RDF/XML-ABBREV"</td>
+</tr>
+<tr>
+<td>RDFXML_PLAIN</td>
+<td></td>
+<td>"RDF/XML"</td>
+</tr>
+</tbody>
+</table>
+<h2 id="examples">Examples</h2>
+<p>Example code may be found in <a href="https://svn.apache.org/repos/asf/jena/trunk/jena-arq/src-examples/arq/examples/riot/">jena-arq/src-examples</a>.</p>
+<h3 id="ways-to-write-a-model">Ways to write a model</h3>
+<p>The follow ways are different ways to write a model in Turtle:</p>
+<div class="codehilite"><pre>    <span class="n">Model</span> <span class="n">model</span> <span class="o">=</span>  <span class="o">...</span> <span class="p">;</span>
+
+    <span class="sr">//</span> <span class="n">Write</span> <span class="n">a</span> <span class="n">model</span> <span class="n">in</span> <span class="n">Turtle</span> <span class="n">syntax</span><span class="p">,</span> <span class="n">default</span> <span class="n">style</span> <span class="p">(</span><span class="n">pretty</span> <span class="n">printed</span><span class="p">)</span>
+    <span class="n">RDFDataMgr</span><span class="o">.</span><span class="nb">write</span><span class="p">(</span><span class="n">System</span><span class="o">.</span><span class="n">out</span><span class="p">,</span> <span class="n">model</span><span class="p">,</span> <span class="n">Lang</span><span class="o">.</span><span class="n">TURTLE</span><span class="p">)</span> <span class="p">;</span>
+
+    <span class="sr">//</span> <span class="n">Wriet</span> <span class="n">Turtle</span> <span class="n">to</span> <span class="n">the</span> <span class="n">blocks</span> <span class="n">variant</span>
+    <span class="n">RDFDataMgr</span><span class="o">.</span><span class="nb">write</span><span class="p">(</span><span class="n">System</span><span class="o">.</span><span class="n">out</span><span class="p">,</span> <span class="n">model</span><span class="p">,</span> <span class="n">RDFFormat</span><span class="o">.</span><span class="n">TURTLE_BLOCKS</span><span class="p">)</span> <span class="p">;</span>
+
+    <span class="sr">//</span> <span class="n">Write</span> <span class="n">as</span> <span class="n">Turtle</span> <span class="n">via</span> <span class="n">model</span><span class="o">.</span><span class="nb">write</span>
+    <span class="n">model</span><span class="o">.</span><span class="nb">write</span><span class="p">(</span><span class="n">System</span><span class="o">.</span><span class="n">out</span><span class="p">,</span> <span class="s">&quot;TTL&quot;</span><span class="p">)</span> <span class="p">;</span>
+</pre></div>
+
+
+<h3 id="ways-to-write-a-dataset">Ways to write a dataset</h3>
+<p>The prefered style is to use <code>RDFDataMgr</code>:</p>
+<div class="codehilite"><pre><span class="n">Dataset</span> <span class="n">ds</span> <span class="o">=</span> <span class="o">....</span> <span class="p">;</span>
+<span class="sr">//</span> <span class="n">Write</span> <span class="n">as</span> <span class="n">TriG</span>
+<span class="n">RDFDataMgr</span><span class="o">.</span><span class="nb">write</span><span class="p">(</span><span class="n">System</span><span class="o">.</span><span class="n">out</span><span class="p">,</span> <span class="n">ds</span><span class="p">,</span> <span class="n">Lang</span><span class="o">.</span><span class="n">TRIG</span><span class="p">)</span> <span class="p">;</span>
+
+<span class="sr">//</span> <span class="n">Write</span> <span class="n">as</span> <span class="n">N</span><span class="o">-</span><span class="n">Quads</span>
+<span class="n">RDFDataMgr</span><span class="o">.</span><span class="nb">write</span><span class="p">(</span><span class="n">System</span><span class="o">.</span><span class="n">out</span><span class="p">,</span> <span class="n">dataset</span><span class="p">,</span> <span class="n">Lang</span><span class="o">.</span><span class="n">NQUADS</span><span class="p">)</span> <span class="p">;</span>
+</pre></div>
+
+
+<p>Additionaly, a single model can be written in a dataset format - it becomes
+the default graph of the dataset.</p>
+<div class="codehilite"><pre><span class="n">Model</span> <span class="n">m</span> <span class="o">=</span> 
+<span class="n">RDFDataMgr</span><span class="o">.</span><span class="nb">write</span><span class="p">(</span><span class="n">System</span><span class="o">.</span><span class="n">out</span><span class="p">,</span> <span class="n">m</span><span class="p">,</span> <span class="n">Lang</span><span class="o">.</span><span class="n">TRIG</span><span class="p">)</span> <span class="p">;</span>
+</pre></div>
+
+
+<p>might give:</p>
+<div class="codehilite"><pre><span class="nv">@prefix</span> <span class="p">:</span>      <span class="sr">&lt;http://example/&gt;</span> <span class="o">.</span>
+<span class="nv">@prefix</span> <span class="n">dc:</span>    <span class="sr">&lt;http://purl.org/dc/elements/1.1/&gt;</span> <span class="o">.</span>
+<span class="nv">@prefix</span> <span class="n">foaf:</span>  <span class="sr">&lt;http://xmlns.com/foaf/0.1/&gt;</span> <span class="o">.</span>
+<span class="nv">@prefix</span> <span class="n">rdf:</span>   <span class="sr">&lt;http://www.w3.org/1999/02/22-rdf-syntax-ns#&gt;</span> <span class="o">.</span>
+
+<span class="p">{</span>
+    <span class="p">:</span><span class="n">book</span>   <span class="n">dc:author</span>  <span class="p">(</span> <span class="p">:</span><span class="n">a</span> <span class="p">:</span><span class="n">b</span> <span class="p">)</span> <span class="o">.</span>
+
+    <span class="p">:</span><span class="n">a</span>      <span class="n">a</span>           <span class="n">foaf:Person</span> <span class="p">;</span>
+            <span class="n">foaf:knows</span>  <span class="p">[</span> <span class="n">foaf:name</span>  <span class="s">&quot;Bob&quot;</span> <span class="p">]</span> <span class="p">;</span>
+            <span class="n">foaf:name</span>   <span class="s">&quot;Alice&quot;</span> <span class="o">.</span>
+
+    <span class="p">:</span><span class="n">b</span>      <span class="n">foaf:knows</span>  <span class="p">:</span><span class="n">a</span> <span class="o">.</span>
+<span class="p">}</span>
+</pre></div>
+
+
+<h3 id="adding-a-new-output-format">Adding a new output format</h3>
+<p>An complete example of adding a new output format is given in the example file: 
+<a href="https://svn.apache.org/repos/asf/jena/trunk/jena-arq/src-examples/arq/examples/riot/ExRIOT_out3.java">RIOT Output example 3</a></p>
+<h2 id="notes">Notes</h2>
+<p>Using <code>OutputStream</code>s is strongly encouraged.  This allows the writers
+to manage the character encoding using UTF-8.  Using <code>java.io.Writer</code> 
 does not allow this; on platforms such as MS Windows, the default
-configuration of a `Writer` is not suitable for Turtle because
+configuration of a <code>Writer</code> is not suitable for Turtle because
 the characte set is the platform default, and not UTF-8.
-The only use of wirters that is useful is using `java.io.StringWriter`.
+The only use of wirters that is useful is using <code>java.io.StringWriter</code>.</p>
   </div>
 
   <div id="footer">