Documentation: Basic Structure

This page describes the core of an OPD document. An OPD Document describes an organisation as machine-readable information. It consists of RDF data and is usually encoded as a Turtle Document. It is simple to get started and there's a checker tool on this site to check it is valid and show you what it understood you to mean.

Basic Structure

  1. Organisation URI
  2. Prefixes
  3. Document Description
  4. Organisation Description
  5. OPD example

1. Organisation URI

You will need to assign a URI for your organisation. This looks like a web address but instead of indicating a document it indicates your organisation. DO NOT USE YOUR HOMEPAGE URL. If in doubt you can use the URI from learning-provider.data.ac.uk.

2. Prefixes

The prefixes at the top help keep the document more readable by defining short aliases for the "namespaces" of terms used in the documents. prefix.cc is a great resource and can even provide the exact syntax you need for turtle documents.

@prefix owl: <http://www.w3.org/2002/07/owl#>. @prefix foaf: <http://xmlns.com/foaf/0.1/>. @prefix oo: <http://purl.org/openorg/>. @prefix dcterms: <http://purl.org/dc/terms/>. @prefix geo: <http://www.w3.org/2003/01/geo/wgs84_pos#>. @prefix skos: <http://www.w3.org/2004/02/skos/core#>. @prefix org: <http://www.w3.org/ns/org#>. @prefix xtypes: <http://purl.org/xtypes/>. @prefix lyou: <http://purl.org/linkingyou/>. @prefix vcard: <http://www.w3.org/2006/vcard/ns#>.

3. Document Description

This block just describes the document itself, stating what it is and what license it is provided under. We strongly recommend CC0 as this allows it to be freely used by third parties with no obligations placed on them.

<> a oo:OrganizationProfileDocument ; dcterms:license <http://creativecommons.org/publicdomain/zero/1.0/> ; foaf:primaryTopic <ORG-URI> .

4. Organisation Description

<http://id.example.ac.uk/> a org:FormalOrganization ; skos:prefLabel "The University of Example" ; skos:hiddenLabel "Example" ; skos:hiddenLabel "Example U" ; vcard:sortLabel "Example, University of" ; foaf:phone <tel:+441234567890> ; foaf:mbox <mailto:info@example.ac.uk> ; foaf:logo <http://www.example.ac.uk/example-logo.png> ; foaf:homepage <http://www.example.ac.uk/> ; owl:sameAs <http://id.learning-provider.data.ac.uk/ukprn/12345678> ; owl:sameAs <http://dbpedia.org/resource/University_of_Example> .

5. OPD Example

# Defining prefixes makes your document easier to read and maintain @prefix owl: <http://www.w3.org/2002/07/owl#>. @prefix foaf: <http://xmlns.com/foaf/0.1/>. @prefix oo: <http://purl.org/openorg/>. @prefix dcterms: <http://purl.org/dc/terms/>. @prefix geo: <http://www.w3.org/2003/01/geo/wgs84_pos#>. @prefix skos: <http://www.w3.org/2004/02/skos/core#>. @prefix org: <http://www.w3.org/ns/org#>. @prefix xtypes: <http://purl.org/xtypes/>. @prefix lyou: <http://purl.org/linkingyou/>. @prefix vcard: <http://www.w3.org/2006/vcard/ns#>. # Describe this document and state a license <> a oo:OrganizationProfileDocument ; dcterms:license <http://creativecommons.org/publicdomain/zero/1.0/> ; foaf:primaryTopic <http://id.example.ac.uk/> . # Some information about the organisation, most of this is optional but the prefLabel, logo and # sameAs to the learning-provider URI is strongly encouraged. <http://id.example.ac.uk/> a org:FormalOrganization ; skos:prefLabel "The University of Example" ; skos:hiddenLabel "Example" ; skos:hiddenLabel "Example U" ; vcard:sortLabel "Example, University of" ; vcard:tel <tel:+441234567890> ; foaf:logo <http://www.example.ac.uk/example-logo.png> ; foaf:homepage <http://www.example.ac.uk/> ; owl:sameAs <http://id.learning-provider.data.ac.uk/ukprn/12345678> ; owl:sameAs <http://dbpedia.org/resource/University_of_Example> .

Notes

Please Note: It is assumed that logos will be displayed on a white background, so if your logo is white supply a background for it.

© 2015 data.ac.uk - This site uses cookies for Google Analytics.