Profile

From OpenOrg
Revision as of 13:13, 27 October 2012 by AlexDutton (talk | contribs) (Abstact: Adding namespaces)
Jump to: navigation, search

Abstact

This document defines an organisational profile document, which can be used to discover datasets about aspects of the organisation, and standards-conformant APIs which can be used to interact with some aspect of the organisation.

The profile document is a dataset about the organisation.

Namespaces used in this document

Wherever possible, we seek to use pre-existing vocabularies and terms. Here are the namespaces we re-use:

Name Prefix Namespace Documentation
Organization ontology org http://www.w3.org/ns/org# http://www.epimorphics.com/public/vocabulary/org.html
vCard v http://www.w3.org/2006/vcard/ns# http://www.w3.org/TR/vcard-rdf/
SKOS (Simple Knowledge Organization System) skos http://www.w3.org/2004/02/skos/core# http://www.w3.org/2004/02/skos/

Format

The profile document should be available as either RDF/XML (application/rdf+xml) or Turtle (text/turtle). One may implement content negotiation, but it isn't required.

Content

The document should be of type oo:OrganizationProfileDocument, and contain a foaf:primaryTopic property pointing at the organization. We recommend that you use a class from the Organization ontology, such as org:FormalOrganization

<syntaxhighlight lang="xml"> <?xml version="1.0" encoding="utf-8"?> <rdf:RDF

   xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#"
   xmlns:foaf="http://xmlns.com/foaf/0.1/"
   xmlns:org="http://www.w3.org/ns/org#"
   xmlns:oo="http://purl.org/openorg/">
 <oo:OrganizationProfileDocument rdf:about="">
   <foaf:primaryTopic>
     <org:FormalOrganization rdf:about="http://id.example.org/">
     </org:FormalOrganization>
   </foaf:primaryTopic>
 </oo:OrganizationProfileDocument>

</rdf:RDF> </syntaxhighlight>

Organization metadata

We recommend that you include the following metadata about your organization:

Purpose Predicates Description Examples Requirement
Preferred name skos:prefLabel Use skos:prefLabel for the primary (e.g. legally-recognised) name. You may provide names in more than one language if necessary, but there should be at most one in any language. <syntaxhighlight lang="xml"><skos:prefLabel>Cardiff University</skos:prefLabel></syntaxhighlight>

<syntaxhighlight lang="xml"><skos:prefLabel xml:lang="en">Cardiff University</skos:prefLabel> <skos:prefLabel xml:lang="cy">Prifysgol Caerdydd</skos:prefLabel></syntaxhighlight>

MUST
Alternative names skos:altLabel Use skos:altLabel for trading names and abbreviations. You may include as many alternative names as you wish. <syntaxhighlight lang="xml"><skos:altLabel>UWE</skos:altLabel></syntaxhighlight> MAY
Hidden names skos:hiddenLabel Use skos:hiddenLabel for names your organization is known by, but which aren't official. Examples include colloquial names, and common misspellings. These names may be used to help find your organization in searches. You may include as many hidden names as you wish. <syntaxhighlight lang="xml"><skos:hiddenLabel>Leeds Met</skos:hiddenLabel></syntaxhighlight> MAY
Sort name ov:sortLabel A string by which your organization should be sorted. There should be at most one, and your preferred label will be used if one isn't provided. <syntaxhighlight lang="xml"><ov:sortLabel>Oxford, University of</ov:sortLabel></syntaxhighlight>

<syntaxhighlight lang="xml"><ov:sortLabel>Saint Andrews, University of</ov:sortLabel></syntaxhighlight>

MAY
Telephone number (voice) v:tel The main contact number for your organization. <syntaxhighlight lang="xml"><v:tel>
 <v:Voice rdf:about="tel:+44-1234-123456">
   <rdfs:label>01234 123456</rdfs:label>
   <rdf:value>+44-1234-123456</rdf:value>
 </v:Voice>

</v:tel></syntaxhighlight>

SHOULD
Telephone number (facsimile) v:tel The main fax number for your organization. <syntaxhighlight lang="xml"><v:tel>
 <v:Fax rdf:about="tel:+44-1234-123456">
   <rdfs:label>01234 123456</rdfs:label>
   <rdf:value>+44-1234-123456</rdf:value>
 </v:Fax>

</v:tel></syntaxhighlight>

SHOULD

Discovery

Discovering with well-known URI

The RFC 5758 defines a mechanism for reserving 'well-known' URIs on any Web server.

We intend to register the well-known URI /.well-known/openorg for the purpose of discovering the organisational profile document.