r4 - 2015-10-14 - 00:31:55 - NickCrossleyYou are here: TWiki >  LinkedData Web > BestPractices > UseRdfsLabelAndCommentInVocabularies
This wiki: The development wiki is a work area where Jazz development teams plan and discuss technical designs and operations for the projects at Jazz.net. Work items often link to documents here. You are welcome to browse, follow along, and participate. Participation is what Jazz.net is all about! But please keep in mind that information here is "as is", unsupported, and may be outdated or inaccurate. For information on released products, consult IBM Knowledge Center, support tech notes, and the Jazz.net library. See also the Jazz.net Terms of Use.

New product names: The CE/CLM products were renamed in version 7.0. For details on the name change, see Renaming the IBM Continuous Engineering Portfolio. Some content might continue to use the previous names or contain a combination of the previous and current names.

Best Practice: Use rdfs:label and rdfs:comment in RDF Vocabularies

State: Approved

Contact: Nick Crossley

Scope

This Best Practice recommends appropriate usage of rdfs:label and rdfs:comment in RDF vocabularies.

This Best Practice is closely related to Best Practice: When to Use rdfs:label Versus =dcterms:title= which discusses when to use similar terms defined in the Dublin Core vocabulary.

Recommendation

The RDF Schema vocabulary defines the terms rdfs:label and rdfs:comment, which have a similar meaning to Dublin Core vocabulary terms dcterms:title and dcterms:description.

The RDF Schema terms SHOULD only be used in vocabulary documents. The value of rdfs:label SHOULD be the part of the URI that comes after the final hash or slash. The value of rdfs:comment should be a brief description of the term.

On the other hand, the Dublin Core terms SHOULD be used in descriptions of individual document-like resources, e.g. those defined in Open Services for Lifecycle Collaboration (OSLC) specifications. dcterms:title SHOULD be a one line summary of the resource, e.g. the title of an article or the headline of a bug report. dcterms:description should be a longer description, possibly containing multiple paragraphs. If either term contains markup then the datatype MUST be XML Literal. The preferred markup for text is XHTML. Note that RDF Schema 1.1 introduced a new literal type for HTML, so this Best Practice needs to be revised.

Examples

Here is an example snippet of an RDF vocabulary document:

@prefix oslc: <http://open-services.net/ns/core#> .
@prefix rdfs: <http://www.w3.org/2000/01/rdf-schema#> .

oslc:ServiceProvider a rdfs:Class ;
   rdfs:isDefinedBy oslc: ;
   rdfs:label "ServiceProvider" ;
   rdfs:comment "The Service Provider resource" ;
   rdfs:seeAlso <http://open-services.net/bin/view/Main/OslcCoreSpecification#Resource_Service_Provider> .

See Also

Edit | WYSIWYG | Attach | Printable | Raw View | Backlinks: Web, All Webs | History: r4 < r3 < r2 < r1 | More topic actions
 
This site is powered by the TWiki collaboration platformCopyright © by the contributing authors. All material on this collaboration platform is the property of the contributing authors.
Contributions are governed by our Terms of Use
Ideas, requests, problems regarding TWiki? Send feedback