Workshop: Getting Started

Introduction

This workshop is designed to get you started by creating an OPD for you organisation.

We will be using an online tool to help validate your OPD, you can find it here: http://opd.data.ac.uk/checker

OPD's can be any RDF format, but in this workshop we will be using the Turtle format, as its simple to learn and easy to edit by hand. More info: http://en.wikipedia.org/wiki/Turtle_(syntax)

My First OPD

If you open up the checker in a web browser you should see Option 3. You can work on your OPD in the text box and click Test to test it.

To make the OPD legible we should start it with some namespaces (Aliases to shorten the URLs) The following should be all that we need for this workshop

# defining prefixes makes our document easier to read an maintain
@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#>.

One thing you'll need to do is 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! Otherwise computers will think [your-university]=[your-university-homepage] and therefore your university is in HTML format and has 19 images. If in doubt you can use the URI from learning-provider.data.ac.uk.

We now need to add some RDF describing the document, we need to descide an id for the organsation, in this example we are using http://id.example.ac.uk/, replace it for your own organsation's uri.

Add this to your OPD

# 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/> .

Now we need to add some information to the OPD about the organsation. To get started we shall say:

<http://id.example.ac.uk/>
        a org:FormalOrganization ;
        skos:prefLabel "The University of Example" .

Hopfully you should have an OPD that looks like this:

# defining prefixes makes our document easier to read an maintain
@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
<http://id.example.ac.uk/>
        a org:FormalOrganization ;
        skos:prefLabel "The University of Example" .

If you click test OPD you should should now see a results page that has OPD Loaded OK!, if not double check your OPD for any errors.

Adding more information

You can now extend your organisations information by adding more RDF, most of thease are optional but the prefLabel, logo and sameAs to the learning-provider URI are strongly encouraged, as these allow to link the data to other datasets.

# Some information about the organisation
<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> .

Note that each line except the last one ends with a ; and the last one ends with a .

Check out the Core documentation for more information: http://opd.data.ac.uk/docs/core

Social Networks

Inorder to add social networks, first find the network account on our documentation page: http://opd.data.ac.uk/docs/social

Lets start with a twitter account, @exampleuni, first we start by adding the account to the organisation block by adding the following:

foaf:account <https://twitter.com/exampleuni> .

Then we add a new block of RDF describing that accoung:

<https://twitter.com/exampleuni> a foaf:OnlineAccount ;
	foaf:accountName "exampleuni" ;
	foaf:accountServiceHomepage <https://twitter.com/> .

Now test your OPD, a social networks section should now appear at the page

Have ago at adding some other social media accounts use the documention to help you, http://opd.data.ac.uk/docs/social

RSS Feeds, Key Pages and beyond

Using the following documentation pages try and add more information to your OPD

Autodiscovery

Now we have our finished OPD, we can try and get the autodiscovery working.

For this to work you need to copy your opd somewhere that is web accessable, and have the ability to change the homepage of the organsiation (For this workshop you can use any web frontpage)

Once your OPD is online, you can check it will work by using options 2 on the checker.

If all that has worked follow the autodiscovery documentation and see you can get your OPD autodiscoverable http://opd.data.ac.uk/docs/auto


This workshop can be found here: http://opd.data.ac.uk/workshops/getting_started