Difference between revisions of "Boilerplate"

From OpenOrg
Jump to: navigation, search
(SPARQL Endpoint)
(Corrections)
Line 53: Line 53:
  
 
<syntaxhighlight lang="xml">
 
<syntaxhighlight lang="xml">
     <rdfs:comment>Corrections to this data should be sent to semwebmaster@example.org. Corrections may take up to a month to be reflected in the live data.</rdfs:comment>
+
     <rdfs:comment>Corrections to this data should be sent to semwebmaster@example.org.  
 +
Corrections may take up to a month to be reflected in the live data.</rdfs:comment>
 
</syntaxhighlight>
 
</syntaxhighlight>

Revision as of 14:34, 11 January 2011

Namespaces

void rdfs dct

Document URI

In N3 and RDF+XML you /can/ refer to the current document as a zero-length-string-URI. eg. "" or <>. This is not recommended. If possible refer to the document it's authoritative URL. That way if it gets saved to disk and reloaded it doesn't then end up with it's URI/URL being its new filename.

<syntaxhighlight lang="xml">

 <rdf:Description rdf:about="">
 </rdf:Description>

</syntaxhighlight>

<syntaxhighlight lang="xml">

 <rdf:Description rdf:about="...URL-of-RDF-Document...">
   ...
 </rdf:Description>

</syntaxhighlight>

License & Rightsholder

At the very least you need to include a license. Without a license, your RDF is not Open Data.

Express the license using DCTerms: <syntaxhighlight lang="xml">

   <dct:license rdf:resource="...LICENCE-URI..." />

</syntaxhighlight> You may also add "dct:publisher" and "dct:rightsHolder" to link to the URIs of the publishing and rights-holding organisations (will often be the same, but not always). It is recommended that you also use an rdfs:label to give these organisation URIs a human readable label.

Not all licenses are suitable for use with data. The following are (nb. I am not a lawyer...)

More information on open licenses is available at http://www.opendefinition.org/licenses/

The following are the recommended URIs to use for RDF data.

SPARQL Endpoint

If the RDF triples in a document are also available from a SPARQL endpoint then you can add the following relation to the boilerplate. <syntaxhighlight lang="xml">

   <void:sparqlEndpoint rdf:resource="...URL-of-SPARQL-Endpoint..." />

</syntaxhighlight>

Corrections

It is recommended that you include an rdfs:comment describing the corrections policy and process. Without this people will have no way to help you correct errors.

<syntaxhighlight lang="xml">

   <rdfs:comment>Corrections to this data should be sent to semwebmaster@example.org. 
Corrections may take up to a month to be reflected in the live data.</rdfs:comment>

</syntaxhighlight>