Table of contents


Supported elements

Element rdf:type
Ontology owl:Ontology
Class owl:Class
rdfs:Class
Property rdf:Property
owl:AnnotationProperty
owl:ObjectProperty
owl:DatatypeProperty
owl:OntologyProperty
owl:DeprecatedProperty
Rule Set RIF group
Rule RIF rule
Vocabulary voaf#Vocabulary
voaf_old#Vocabulary
Dataset void:Dataset
dcat:Dataset
dcat_deri:Dataset

Supported metadata

This table describes the annotated properties relevant for adding metadata.

Property Scope Place Description
Ontology Class Property Individual Rule Set Rule Vocabulary Dataset Catalog Distribution VC Definition In use Documentation
rdfs:label supportedsupportedsupportedsupportedsupportedsupportedsupportedsupportedsupportedsupported supported

The label of the element. The range is a literal with a language tag (optional).

For example: <rdfs:label xml:lang="en">Temperature defect</rdfs:label>

dct:title supportedsupportedsupportedsupportedsupportedsupportedsupportedsupportedsupportedsupported supported

See rdfs:label

For example: <dct:title xml:lang="en">Temperature defect</dct:title>

dc:title supportedsupportedsupportedsupportedsupportedsupportedsupportedsupportedsupportedsupported supported

See rdfs:label

For example: <dc:title xml:lang="en">Temperature defect</dc:title>

skosxl:altLabel supportedsupportedsupportedsupportedsupportedsupportedsupportedsupportedsupportedsupported supported

An alternative label of a element. The range of the property is an instance of the class LexicalLabel.

For example: <skosxl:altLabel rdf:resource="http://www.example.org/skos/temperature-fault" />

skosxl:prefLabel supportedsupportedsupportedsupportedsupportedsupportedsupportedsupportedsupportedsupported supported

The preferred label of a element. The range of the property is an instance of the class LexicalLabel.

For example: <skosxl:prefLabel rdf:resource="http://www.example.org/skos/temperature-defect" />

skos:altLabel supportedsupportedsupportedsupportedsupportedsupportedsupportedsupportedsupportedsupported supported

An alternative label of a element. The range is a literal with a language tag.

For example: <skos:altLabel xml:lang="en">Temperature fault</skos:altLabel>

skos:prefLabel supportedsupportedsupportedsupportedsupportedsupportedsupportedsupportedsupportedsupported supported

The preferred label of a element. The range is a literal with a language tag (optional). In some cases, it is assumed that prefLabel assumes the role of the label for presentation purposes.

For example: <skos:prefLabel xml:lang="en">Temperature defect</skos:prefLabel>

Property Scope Place Description
Ontology Class Property Individual Rule Set Rule Vocabulary Dataset Catalog Distribution VC Definition In use Documentation
rdfs:comment supportedsupportedsupportedsupportedsupportedsupportedsupportedsupportedsupportedsupported

The description of the element. The range is a literal with a language tag.

For example: <rdfs:comment xml:lang="en">It is a defect having to do with temperature issues.</rdfs:comment>

dct:description supportedsupportedsupportedsupportedsupportedsupportedsupportedsupportedsupportedsupported

See rdfs:comment

For example: <dct:description xml:lang="en">It is a defect having to do with temperature issues.</dct:description>

dc:description supportedsupportedsupportedsupportedsupportedsupportedsupportedsupportedsupportedsupported

See rdfs:comment

For example: <dc:description>The Friend of a Friend (FOAF) RDF vocabulary, described using W3C RDFS and OWL.</dc:description>

Property Scope Place Description
Ontology Class Property Individual Rule Set Rule Vocabulary Dataset Catalog Distribution VC Definition In use Documentation
dct:creator supportedsupportedsupportedsupportedsupportedsupportedsupportedsupportedsupportedsupported place

An entity primarily responsible for making the element: a person, an organization or a service. Recommended best practice is to use a FOAF profile to describe a creator.

For example: <dct:creator rdf:resource="http://www.wikier.org/foaf#wikier" />

dc:creator supportedsupportedsupportedsupportedsupportedsupportedsupportedsupportedsupportedsupported place

An entity primarily responsible for making the element: a person, an organization or a service. Typically, the name of a creator should be used to indicate the entity.

For example: <dc:creator>Sergio Fernández</dc:creator>

dct:contributor supportedsupportedsupportedsupportedsupportedsupportedsupportedsupportedsupportedsupported place

An entity responsible for making contributions to the resource: a person, an organization or a service. Recommended best practice is to use a FOAF profile to describe a contributor.

For example: <dct:contributor rdf:resource="http://berrueta.net/foaf.rdf#me" />

dc:contributor supportedsupportedsupportedsupportedsupportedsupportedsupportedsupportedsupportedsupported place

An entity responsible for making contributions to the resource: a person, an organization or a service. Typically, the name of a contributor should be used to indicate the entity.

For example: <dc:contributor>Diego Berrueta</dc:contributor>

dct:publisher supportedsupportedsupportedsupportedsupportedsupportedsupportedsupportedsupportedsupported place

An entity responsible for making the element available: a person, an organization or a service. Recommended best practice is to use a FOAF profile to describe a publisher.

For example: <dct:publisher rdf:resource="http://oreilly.com/" />

dc:publisher supportedsupportedsupportedsupportedsupportedsupportedsupportedsupportedsupportedsupported place

An entity responsible for making the element available: a person, an organization or a service. Typically, the name of a publisher should be used to indicate the entity.

For example: <dc:publisher>O'Reilly</dc:publisher>

foaf:maker supportedsupportedsupportedsupportedsupportedsupportedsupportedsupportedsupportedsupported supported

See dct:creator.

For example: <foaf:maker rdf:resource="http://berrueta.net/foaf.rdf#me" />

Property Scope Place Description
Ontology Class Property Individual Rule Set Rule Vocabulary Dataset Catalog Distribution VC Definition In use Documentation
dct:date supportedsupportedsupportedsupportedsupportedsupportedsupportedsupportedsupportedsupported place

The date of creation or publication of the element. Recommended best practice is to use the W3CDTF profile of ISO 8601.

For example: <dct:date>1981-01-20</dct:date>

dc:date supportedsupportedsupportedsupportedsupportedsupportedsupportedsupportedsupportedsupported place

The date of creation or publication of the element. Recommended best practice is to use the W3CDTF profile of ISO 8601.

For example: <dc:date>1981-01-20</dc:date>

dct:issued supportedsupportedsupportedsupportedsupportedsupportedsupportedsupportedsupportedsupported place

Date of formal issuance (e.g., publication) of the element. Recommended best practice is to use the W3CDTF profile of ISO 8601.

For example: <dct:issued>1979-03-23</dct:issued>

dct:modified supportedsupportedsupportedsupportedsupportedsupportedsupportedsupportedsupportedsupported place

The date on which the element was changed. Recommended best practice is to use the W3CDTF profile of ISO 8601.

For example: <dct:modified>2010-07-11</dct:modified>

Property Scope Place Description
Ontology Class Property Individual Rule Set Rule Vocabulary Dataset Catalog Distribution VC Definition In use Documentation
dct:license supportedsupportedsupportedsupportedsupportedsupportedsupportedsupportedsupported place

A legal document describing the copyright license of the element. Recommended best practice is to use Creative Commons licenses and to describe them in RDF with the Creative Commons Rights Expression Language (CC REL).

For example: <dct:license rdf:resource="http://creativecommons.org/licenses/by/3.0/" />

cc:license supportedsupportedsupportedsupportedsupportedsupportedsupportedsupportedsupported place

A legal document describing the copyright license of the element. Recommended best practice is to use Creative Commons licenses and to describe them in RDF with the Creative Commons Rights Expression Language (CC REL).

For example: <cc:license rdf:resource="http://creativecommons.org/licenses/by/3.0/" />

cc-deprecated:license supportedsupportedsupportedsupportedsupportedsupportedsupportedsupportedsupported place

A legal document describing the copyright license of the element. Recommended best practice is to use Creative Commons licenses and to describe them in RDF with the Creative Commons Rights Expression Language (CC REL).

For example: <cc-deprecated:license rdf:resource="http://creativecommons.org/licenses/by/3.0/" />

dc:rights supportedsupportedsupportedsupportedsupportedsupported place

Information about rights held in and over the element.

For example: <dc:rights>CTIC Foundation, some rights reserved</dc:rights>

Property Scope Place Description
Ontology Class Property Individual Rule Set Rule Vocabulary Dataset Catalog Distribution VC Definition In use Documentation
owl:versionInfo supportedsupportedsupportedsupportedsupportedsupported place

Provides a hook suitable for use by versioning systems.

For example: <owl:versionInfo>1.17</owl:versionInfo>

vs:term_status supportedsupportedsupportedsupported place

Status of a term, expressed as a short symbolic string; known values include 'unstable','testing', 'stable' and 'archaic'.

For example: <vs:term_status>testing</vs:term_status>

owl:deprecated supportedsupportedsupportedsupported

An annotation with the owl:deprecated annotation property and the value equal to "true"^^xsd:boolean can be used to specify that an IRI is deprecated. There are other ways to mark as deprecated an ontology or a class, using owl:DeprecatedProperty, owl:DeprecatedClass

For example: <owl:deprecated rdf:datatype="http://www.w3.org/2001/XMLSchema#boolean">true</owl:deprecated>

foaf:depiction supportedsupportedsupportedsupportedsupportedsupported supported

An image associated with the element.

For example: <foaf:depiction rdf:resource="http://farm5.static.flickr.com/4014/4396193788_707ae6ec23.jpg" />

og:video supportedsupportedsupportedsupportedsupportedsupported supported

A video associated with the element.

For example: <og:video rdf:resource="http://www.youtube.com/watch?v=5h10QHpA5EU" />

rdfs:seeAlso supportedsupportedsupportedsupportedsupportedsupportedsupportedsupportedsupported supported

Specifies a resource that might provide additional information about the element.

For example: <rdfs:seeAlso rdf:resource="http://www.ietf.org/rfc/rfc1766.txt" />

dct:source supported place

The resources from which the rules are derived. Typically, they are documentary sources (as candidate rules), but diagrams, plans or pictures are also possible.

For example: <dct:source rdf:resource="http://example.org/candidate-rule" />

Property Scope Place Description
Ontology Class Property Individual Rule Set Rule Vocabulary Dataset Catalog Distribution VC Definition In use Documentation
vann:preferredNamespacePrefix supportedsupported place

The preferred namespace prefix when using entities of an ontology or a vocabulary.

For example: <vann:preferredNamespacePrefix>whois</vann:preferredNamespacePrefix>

vann:preferredNamespaceUri supportedsupported place

The preferred namespace URI to use when using terms from an ontology or a vocabulary.

For example: <vann:preferredNamespaceUri>http://www.kanzaki.com/ns/whois#</vann:preferredNamespaceUri> or <vann:preferredNamespaceUri rdf:resource="http://www.kanzaki.com/ns/whois#"/>

voaf:classNumber supported place

The number of classes defined in the vocabulary.

For example: <voaf:classNumber>42</voaf:classNumber>

voaf_old:classNumber supported place

The number of classes defined in the vocabulary.

For example: <voaf_old:classNumber>42</voaf_old:classNumber>

voaf:propertyNumber supported place

The number of properties defined in the vocabulary.

For example: <voaf:propertyNumber>55</voaf:propertyNumber>

voaf_old:propertyNumber supported place

The number of properties defined in the vocabulary.

For example: <voaf_old:propertyNumber>55</voaf_old:propertyNumber>

foaf:homepage supportedsupportedsupported place

The homepage (typically a Web page in HTML format) of the vocabulary.

For example: <foaf:homepage rdf:resource="http://rdfs.org/sioc/spec/" />

void:vocabulary supported place

A vocabulary or owl:Ontology whose classes or properties are used in the dataset.

For example: <void:vocabulary rdf:resource="http://xmlns.com/foaf/0.1/" />

rdfs:isDefinedBy supportedsupportedsupportedsupportedsupportedsupported place

Used to indicate where this element has been defining.

For example: <rdfs:isDefinedBy rdf:resource="http://purl.org/vocab/vann/" />

owl:versionIRI supported place

Identifies the version IRI of an ontology.

For example: <owl:versionIRI rdf:resource="http://www.lingvoj.org/ontology_v2.0.ttl" />

owl:priorVersion supported place

Indicates the predecessor ontology of a given ontology.

For example: <owl:priorVersion rdf:resource="http://datos.bcn.cl/ontologies/bcn-biographies/1.2/bcn-biographies.rdf" />

owl:incompatibleWith supported place

Indicates that a given ontology is incompatible with another ontology.

For example: <owl:incompatibleWith rdf:resource="http://www.lingvoj.org/ontology_v1.3.rdf" />

Property Scope Place Description
Ontology Class Property Individual Rule Set Rule Vocabulary Dataset Catalog Distribution VC Definition In use Documentation
void:dataDump supported place

An RDF dump, partial or complete, of the dataset.

For example: <void:dataDump rdf:resource="http://ec.europa.eu/eurostat/ramon/rdfdata/migs.rdf" />

void:sparqlEndpoint supported place

The SPARQL endpoint of the dataset.

For example: <void:sparqlEndpoint rdf:resource="http://risp.asturias.es/sparql" />

dct:identifier supported place

A unique identifier of the dataset.

For example: <dct:identifier>dataset-1314</dct:identifier>

dct:language supportedsupported place

This refers to the language used in the textual metadata describing titles, descriptions, etc. of the element.

For example: <dct:language rdf:resource="http://id.loc.gov/vocabulary/iso639-1/es" />

dc:language supportedsupported place

The language used in the textual metadata describing titles, descriptions, etc. of the element (Recommended best practice is to use a controlled vocabulary such as RFC 4646).

For example: <dc:language>es</dc:language>

dct:spatial supportedsupported place

The geographical area covered by the element.

For example: <dct:spatial rdf:resource="http://datos.gob.es/recurso/sector-publico/territorio/provincia/33" />

foaf:page supported place

A page or document about the element.

For example: <foaf:page rdf:resource="http://example.org/related-page" />

dcat:keyword supported place

A keyword or tag describing the element.

For example: <dcat:keyword>Astronomy</dcat:keyword>

dcat_deri:keyword supported place

A keyword or tag describing the element.

For example: <dcat_deri:keyword>Astronomy</dcat_deri:keyword>

dcat:landingPage supported place

A Web page that can be navigated to in a Web browser to gain access to the element.

For example: <dcat:landingPage rdf:resource="http://example.org/dataset3_1.html" />

dcat_deri:landingPage supported place

A Web page that can be navigated to in a Web browser to gain access to the element.

For example: <dcat_deri:landingPage rdf:resource="http://example.org/dataset3_1.html" />

dcat:distribution supported place

Connects a element to its available distributions.

For example: <dcat:distribution rdf:resource="http://example.org/distribution4_79" />

dcat_deri:distribution supported place

Connects a element to its available distributions.

For example: <dcat_deri:distribution rdf:resource="http://example.org/distribution4_79" />

dcat:dataset supported place

A dataset that is part of the element.

For example: <dcat:dataset rdf:resource="http://example.org/dataset3_1" />

dcat_deri:dataset supported place

A dataset that is part of the element.

For example: <dcat_deri:dataset rdf:resource="http://example.org/dataset3_1" />

dcat:accessURL supported place

Could be any kind of URL that gives access to a distribution of the element. E.g. landing page, download, feed URL, SPARQL endpoint.

For example: <dcat:accessURL rdf:resource="http://example.org/dataset3_1/sparql" />

dcat_deri:accessURL supported place

Could be any kind of URL that gives access to a distribution of the element. E.g. landing page, download, feed URL, SPARQL endpoint.

For example: <dcat_deri:accessURL rdf:resource="http://example.org/dataset3_1/sparql" />

dcat:downloadURL supported place

This is a direct link to a downloadable file in a given format (e.g. CSV file or RDF file)

For example: <dcat:accessURL rdf:resource="http://example.org/dataset3_1.csv" />

dcat:byteSize supported place

The size of a element in bytes.

For example: <dcat:byteSize>5020</dcat:byteSize>

dct:format supported place

The file format of the element.For example:

<dct:format>
  <dct:IMT>
    <rdf:value>text/csv</rdf:value>
    <rdfs:label>CSV</rdfs:label>
  </dct:IMT>
<dct:format>

Namespace references and prefixes

Prefix Namespace
cc http://creativecommons.org/ns#
cc-deprecated http://web.resource.org/cc/
dc http://purl.org/dc/elements/1.1/
dct http://purl.org/dc/terms/
foaf http://xmlns.com/foaf/0.1/
og http://ogp.me/ns#
owl http://www.w3.org/2002/07/owl#
rdfs http://www.w3.org/2000/01/rdf-schema#
skosxl http://www.w3.org/2008/05/skos-xl#
skos http://www.w3.org/2004/02/skos/core#
vann http://purl.org/vocab/vann/
voaf http://purl.org/vocommons/voaf#
voaf_old http://labs.mondeca.com/vocab/voaf#
void http://rdfs.org/ns/void#
vs http://www.w3.org/2003/06/sw-vocab-status/ns#
dcat http://www.w3.org/ns/dcat#
dcat_deri http://vocab.deri.ie/dcat#

Icons in Parrot

Icon Definition
data property A data property is used to describe attributes of resources, such as the height of a person or the population of a country.
object property An object property is used to describe relations to other resources, such as the mother of a person or the capital of a country.
annotation property An annotation property is used to give more information of resources.
reflexive object property A reflexive property describes a relation where every resource is related to itself.
irreflexive object property A irreflexive property describes a relation where none resource is related to itself.
symmetric object property Symmetric property
asymmetric object property Asymmetric property
transitive object property Transitive property
functional object property Functional property
inverse functional object property Inverse functional property

Use as a REST service

Generate report from URL/s

URL/parrot
MethodGET
QuerystringdocumentUriURL of an input document
mimetypeMimetype of the input document. Supported values are
  • default Allow content negotiation
  • application/rdf+xml OWL ontology
  • text/n3 N3 ontology
  • text/turtle Turtle ontology
  • application/n-triples N-triples ontology
  • application/xhtml+xml XHTML+RDFa document
  • text/html HTML+RDFa documentn
  • application/rif+xml RIF XML document
  • text/x-rif-ps RIF PS document
profile (optional)The profile for generate a customize report. Supported values are
  • technical
  • business
Default value is technical.
language (optional)The language uses to generate the report. The possible values are in the IANA registry of language tags. Default value is en (English).
customizeCssUrl (optional)The URL of a customize CSS
Returns200 OK
400 Illegal Request
500 Unexpected error
You can send multiple documentUri parameter values. In that case, each one should be accompanied by a mimetype parameter.

For example:

GET /parrot?documentUri=http://purl.org/dc/terms/&mimetype=default&profile=business&language=en


Generate report from direct input

URL/parrot
MethodPOST
Request BodydocumentTextThe input source text.
mimetypeTextMimetype of the input source text. Supported values are
  • default Allow content negotiation
  • application/rdf+xml OWL ontology
  • text/n3 N3 ontology
  • text/turtle Turtle ontology
  • application/n-triples N-triples ontology
  • application/xhtml+xml XHTML+RDFa document
  • text/html HTML+RDFa documentn
  • application/rif+xml RIF XML document
  • text/x-rif-ps RIF PS document
profile (optional)The profile for generate a customize report. Supported values are
  • technical
  • business
Default value is technical.
language (optional)The language uses to generate the report. The possible values are in the IANA registry of language tags. Default value is en (English).
customizeCssUrl (optional)The URL of a customize CSS
Returns200 OK
400 Illegal Request
500 Unexpected error

For example:

POST /parrot documentText=<rdf:RDF xmlns:owl="http://www.w3.org/2002/07/owl#" xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#"> <owl:Ontology rdf:about="http://ontorule-project.eu/resources/steel-30"> <rdfs:label xml:lang="en">Steel Ontology</rdfs:label> </owl:Ontology> </rdf:RDF> mimetypeText=application/rdf+xml profile=business language=en customizeCssUrl=http://example.org/style.css

You can send multiple documentText parameter values. In that case, each one should be accompanied by a mimetype parameter.

Generate report from existing report

URL/parrot
MethodGET
QuerystringreportURLURL of the existing report
profile (optional)The profile for generate a customize report. Supported values are
  • technical
  • business
Default value is technical.
language (optional)The language uses to generate the report. The possible values are in the IANA registry of language tags. Default value is en (English).
customizeCssUrl (optional)The URL of a customize CSS
Returns200 OK
400 Illegal Request
500 Unexpected error

For example:

GET /parrot?reportURL=http://ontorule-project.eu/resources/parrot/examples/previous-report-metadata.html&profile=business&language=en

Tips

PARROT example compilation

In the PARROT example compilation there are available multiple examples of usage of PARROT with ontologies, rules, datasets, vocabularies and more.

Label order

If you want to add a label to an element, the preferred property order to set it is:

  1. http://www.w3.org/2008/05/skos-xl#prefLabel
  2. http://www.w3.org/2004/02/skos/core#prefLabel
  3. http://www.w3.org/2008/05/skos-xl#altLabel
  4. http://www.w3.org/2004/02/skos/core#altLabel
  5. http://purl.org/dc/terms/title
  6. http://purl.org/dc/elements/1.1/title
  7. http://www.w3.org/2000/01/rdf-schema#label

Description order

If you want to add a description to an element, the preferred property order to set it is:

  1. http://purl.org/dc/terms/description
  2. http://purl.org/dc/elements/1.1/description
  3. http://www.w3.org/2000/01/rdf-schema#comment

Button RDFa

You can create a report from a webpage with RDFa. Just add a button in your webpage in order to create a link to the Parrot report.

Document with Parrot

We encourage you to use the XHTML code below (or its HTML equivalent), but you may use a different code to integrate the icon within your web page as long as the icon is used as a link to document the Web page it is in. Sample code is as follows:

 
   <p>
      <a href="http://ontorule-project.eu/parrot?referer=true"><img
          src="http://ontorule-project.eu/parrot/images/button-referer.png"
          alt="Document with Parrot" /></a>
    </p>
  

Compilation of tips

This is a compilation of the tip of the day feature

Did you know ...

Other features

If a resource has more than one rdf:type, this resource will be document in the report just once (with no priority to document the resource like a concrete rdf:type).

For instance, if a resource is declared like:


<rdf:RDF xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#">
	<rdf:Description rdf:about="http://example.org/resource">
		<rdf:type rdf:resource="http://www.w3.org/2002/07/owl#Ontology"/>
		<rdf:type rdf:resource="http://rdfs.org/ns/void#Dataset"/>
	</rdf:Description>
</rdf:RDF> 

The documentation for the resource http://example.org/resource will only appears once (like an ontology or like a dataset).

License of third-party elements used

Some icons has been created by Mark James and there are distributed under CreativeCommons-by 2.5 license.