Guidance for PLCS RDL Developers

Introduction

This section explains details of how to go about annotating the PLCS Reference Data.

Use of Annotation Properties

images/dublincore_logo.png http://dublincore.org/

The Dublin Core is an industry standard for data about Web resources managed by the Dublin Core Metadata Initiative (DCMI). Quoting from their Web site:

The Dublin Core Metadata Initiative is an open forum engaged in the development of interoperable online metadata standards that support a broad range of purposes and business models. DCMI's activities include consensus-driven working groups, global workshops, conferences, standards liaison, and educational efforts to promote widespread acceptance of metadata standards and practices.”

For annotating PLCS Reference Data elements, only a subset of the Dublin Core Elements and Terms are required. However, every Dublin Core Element or Term is not applicable to every PLCS Reference Data element. For use in OWL, these terms are provided as OWL Annotation Properties. An annotation property does not affect the semantics of the Ontology, Class or Property. For PLCS RDL, annotation properties are used as part of the process of managing the library itself.

In addition to the Dublin Core, the OWL language has built-in Annotation Properties that Reference Data developers can use.

The following matrix shows what OWL Annotation Properties and Dublin Core Elements and Terms to apply. The properties are hyperlinked to the resources on the Web where you will find their formal defintions.

Annotation Property

Brief Description

On Ontology

On Class

On Property

dc:creator (http://dublincore.org/documents/dcmi-terms/#creator)

person and organization

Required

Required

Required

dc:modified (http://dublincore.org/documents/dcmi-terms/#modified)

last date modified YYYY-MM-DD

Required

Required

Required

dc:created (http://dublincore.org/documents/dcmi-terms/#created)

date created YYYY-MM-DD

Required

Required

Required

dc:abstract (http://dublincore.org/documents/dcmi-terms/#abstract)

brief summary of content

Required

No

No

dc:title (http://dublincore.org/documents/dcmi-terms/#title)

formal name

Required

No

No

dc:source (http://dublincore.org/documents/dcmi-terms/#source)

standard or resource from which element was taken, use multiple dc:source annotations if required

Optional

Required

Optional

owl:versionInfo (http://www.w3.org/TR/owl-ref/#versionInfo-def)

version and subversion identifier n.nn (e.g. 0.1 or 1.1 or 2.43). Will be automatically set to 1.0 upon official publication of full RDL.

Required

Required

Required

rdfs:label (http://www.w3.org/TR/rdf-schema/#ch_label)

multi-language label

No

Optional

Optional

dc:references (http://dublincore.org/documents/dcmi-terms/#references)

Refers to any standard or other document referenced in the definition of the Reference Data item. use multiple dc:references annotations if required

No (or will be set automatically upon RDL publication)

Optional

Optional

dc:dateAccepted (http://dublincore.org/documents/dcmi-terms/#dateAccepted)

The date the Reference Data item reached the "Registered" status in the PLCS RDL.

No.

Required when Registered

Required when Registered

dc:subject (http://dublincore.org/documents/dcmi-terms/#subject)

Add keywords or classification codes to classify a RD item. Use multiple dc:subject annotations if required

No.

Optional

Optional

dc:issued (http://dublincore.org/documents/dcmi-terms/#issued)

Automatically added date of publication of entire PLCS RDL version.

Automated

Automated

Automated

dcterms:rightsHolder (http://dublincore.org/documents/dcmi-terms/#rightsHolder)

Used with rights to define any IPR

Optional

Optional

Optional

Table 1 — Use of Dublin Core

dc:creator is The PLCS Modeller who created RD

The Dublin Core term "creator" is the annotation to be used to define the person and organization who added the class to the RD Library. The form of the dc:creator value should be first name, last name, comma, and then organization name (e.g Rob Bodington, Eurostep).

dc:created is is the date creator added RD

The Dublin Core term "created" is the annotation to be used to define the date that the creator added the RD to their work space (e.g. YYYY-MM-DD).

dc:modified is date of most recent change to RD item

The Dublin Core term "modified" is the annotation to be used to define the date of the most recent change to the Reference Data item (e.g. YYYY-MM-DD).

dc:source is The original source of the RD

The Dublin Core term "source" is the annotation to be used to define any standard or organization that originally created the class and is responsible for publishing it and controlling its development. A unique name for any dc:source must be agreed by the RD developers.

If the RD is entirely new, created by the PLCS modeller, then the dc:source should be set to read "PLCS RDL n.n" where "n.n" is the version of the PLCS Reference Data Library in which the RD first appeared (e.g. PLCS RDL 1.0).

At the time of publication of each version of the PLCS RDL, any RD that does not have a dc:source set will have that value set with the applicable "PLCS RDL n.n" by default.

dc:dateAccepted is date Registered with PLCS

The Dublin Core term "dateAccepted" is the annotation to be used to define the date that the RD item reached the Registered status in the PLCS RD development process. The user is expected to set this date. (e.g. YYYY-MM-DD)

dc:issued is date of OASIS Publication of the specified version of the RD item

The Dublin Core term "issued" is the annotation to be used to define the date that the Reference Data item version was published as part of an official OASIS PLCS RDL version being published. This date is not changed if the item did not change between PLCS RDL version n.nn and n.nn+1.

This will be automatically set when a version of the PLCS RDL is published.

dc:language is the natural language

The Dublin Core term "language" is the annotation to be used to define the natural language in which a label, definition or comment is made (e.g. "en" for English).

The two letter codes specified in ISO 629-2 shall be used (http://www.loc.gov/standards/iso639-2/langcodes.html)

dc:publisher is OASIS PLCS TC

The Dublin Core term "publisher" is the annotation to be used to define that OASIS PLCS TC published the RDL. This will be set automatically upon official OASIS publication of a version of the RDL.

dc:references is reference to another standard or document

The Dublin Core term "references" is the annotation to be used to define any reference to another standard or document that appears as part of the definition of the RD item. (e.g. "ISO 10303-41").

dc:rightsHolder is IPR holder

The Dublin Core term "rightsHolder" is the annotation to be used to define who owns the Intellectual Property Rights, etc. related to an RD item. It is used in conjunction with "rights".

dc:rights is IPR

The Dublin Core term "rights" is the annotation to be used to define the Intellectual Property Rights, etc. related to the RD. It is used in conjunction with "rightsHolder".

dc:subject is used for keywords and classification of RD

The Dublin Core term "subject" is the annotation to be used to define the keywords or classifications codes (e.g. class of class) related to an RD item. Each keyword or classification code should be created in separate instances of "subject". (e.g. "Aircraft maintenance")

dc:title is the title of an OWL ontology in the RD

The Dublin Core term "title" is the annotation to be used to provide the title for an OWL ontology that is part of the RDL.

References

Dublin Core Metadata Initiative (http://dublincore.org/)

DCMI Metadata Terms (http://dublincore.org/documents/dcmi-terms/)