G2 CR00149: Adding scheme description to catalog

IPTC G2-Standards: Change Request document

Title: Adding scheme description to catalog

Change Request number: CR..
Standard to be changed (delete the inappropriate ones): NewsML-G2
Standard’s version to be changed: 2.10

 
Change Request History
Version Date Author(s) Notes
1 2011-11-29 Michael Steidl, for NAR-dev group  
2 2012-01-27 NAR-dev group: reviewed, agreed  

 

Typographic note
Changes to existing documents/specifications are highlighted in yellow.
Editing notes for the spec documents are highlighted in cyan.
In drafts only: Text highlighted in magenta needs further discussion

Description of the change:
Adding a set of properties to a Scheme Definition for describing the semantics and the use of a Controlled Vocabulary.


Rationale for the change:
A concept has a rich set of properties for describing it: a name, a definition, a note and more - but a vocabulary of concepts has nothing like this. But users of IPTC vocabularies are requesting a persistent name plus a detailled description of the semantics and the intended use of them.

A first proposal to meet this requirement was to create a Schema of Schemes but then it was felt that this requires to much of administrative overhead. As a catalog is already a list of schemes - including the mapping of an alias to a scheme URI - it was found that extending this structure requires the least overhead.

Reference to related IPTC discussion(s) (on Yahoo groups etc):
See notes of the NAR-dev conference call on 11 November 2011 on the NAR-dev Yahoo group.


Formalised change request:

A) Add child elements to the scheme element of a catalog

Header

Value

(XML) Data Model

 Element

Namespace (prefix

nar

Name

 scheme

Title

 Scheme Declaration

Definition

A scheme alias-to-URI mapping with an optional description of the scheme.

User Note(s)

  

Implementation Note(s)

 

XML Schema Spec

At: both CCL and PCL

Datatype

 

Internally Ctrl Values

 

Externally Ctrl Values

 

Attributes

optional attribute group name

Name Cardinality; Datatype; Definition

 

{Attributes are not modified!}

 

Child elements

optional element group name

Name

Cardinality

{existing element}

sameAs

 0..unbounded

{reuse name element of concept}

 name 0..unbounded

{reuse definition element of concept}

definition

0..unbounded

{reuse note element of concept}

note

0..unbounded

 

 

 

 

 

 

 

XML Schema Note(s)

 

Example(s)

<scheme alias="colin" uri="http://cv.iptc.org/newscodes/colourindicator/">

     <name xml:lang="en-GB">Colour Indicator</name>

     <definition xml:lang="en-GB">Indicates the basic colouring of an image.</definition>

</scheme>

 

�