G2 CR00205: new element derivedFromValue

IPTC G2-Standards: Change Request document

Title: Add new element derivedFromValue

Change Request number: G2 CR00205
Standard to be changed: NewsML-G2
Standard’s version to be changed: 2.27

 
Change Request History
VersionDateAuthor(s)Notes
12018-06-08Dave Compton for NAR DevInitial draft.
22018-06-20Dave Compton for NAR DevAdded assert/sameAs considerations.
32018-06-22Dave Compton for NAR DevFinalised Description text.
42018-06-29Dave Compton for NAR DevUpdated B) Adding derivedFromValue to item root elements
52018-09-07Dave Compton for NAR DevMinor edits of the Example.
 6 2018-09-07Dave Compton for NAR Dev

Minor edits.

CR AGREED: NAR Dev Group

7

2018-09-25

Dave Compton for NAR Dev

Clarified B/ during XSD v2.28 creation:

- sourceidref: xs:IDREF, not xs:ID

- Add derivedFromValue .. as child element of all items (except <catalogItem>).

- derivedFromValue should repeatable, i.e. 0..N (not 0..1).

- derivedFromValue and derivedFrom should be allowed in any order.

8

2018-10-02

Dave Compton for NAR Dev

Added the last bullet point above, and associated clarification in the CR text.

 

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 /  TODOs in pink

Description of the change: (free-text)
Add a new element derivedFromValue to all top-level Items.


Rationale for the change:
The top-level Items already support the derivedFrom element, which allows a derivation relationship between Concepts to be included, e.g. 'this code was added due to the existance of this other code'.

Newer use cases, often associated with automated content generation, now require a derivation relationship to be supported a non-Concept 'data value' to a Concept or non-Concept, e.g. 'these codes were added due to the existance of this specific Slugline'.


Reference to related IPTC discussion(s) (on Yahoo groups etc):
https://groups.yahoo.com/neo/groups/iptc-news-architecture-dev/conversations/messages/10678


Formalised change request: (spec table etc.)
A/ Define a new element <derivedFromValue>.

Header

Value

(XML) Data Model

 Element

Namespace (prefix)

nar

Name

derivedFromValue

Title

Derived From Value

Definition

Represents the non-Concept value that was used for deriving the value of one or more properties in this NewsML-G2 item.

User Note(s)

 

Implementation Note(s)

 

XML Schema Spec

At: PCL (no changes to CCL since v 2.25)

Datatype

 

Internally Ctrl Values

 

Externally Ctrl Values

 

Attributes

optional attribute group name

Name; Cardinality; Datatype; Definition

commonPowerAttributes group

 .... existing ones

 

sourceidref; (1..1); xs:IDREF; Refers to the id of the element that provides the value used for the derivation.

 

idrefs; (1..1); xs:IDREFS; Refers to the ids of elements whose values have been derived from the value represented by this property.

 

 

 

 

 

 

 

Child elements

optional element group name

Name

Cardinality

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

XML Schema Note(s)

 

Example(s)

Use Case: The Slugline has the associated subject data in Set1:

 

<slugline id="slug1">MIDEAST-CRISIS/</slugline>


<!-- Set1 -->
<subject id="i314d1"  qcode="G:Q" confidence="100" relevance="100" how="howextr:tool" why="why:inferred"/>
<subject id="i314d2"  qcode="M:LK" confidence="100" relevance="100" how="howextr:tool" why="why:inferred"/>
<subject id="i314d3"  qcode="M:N5" confidence="100" relevance="100" how="howextr:tool" why="why:inferred"/>
<subject id="i314d4" qcode="M:EL" confidence="100" relevance="100" how="howextr:tool" why="why:inferred"/>

 

Show that the subjects in Set1 are derived from the Slugline:

<!-- Derived From: Data -->

<derivedFromValue idrefs="i314d1 i314d2 i314d3 i314d4" sourceidref="slug1" />

  

  

 

B) Adding <derivedFromValue> to item root elements

The derivedFromValue element will be added

  • as child element of all items (except <catalogItem>).
  • with optional (and repeatable) cardinality
  • after derivedFrom, but both derivedFrom and derivedFromValue should be allowed in any order after inlineRef.

C/ Revise the <derivedFrom> @idrefs description.

Note: This is simply aligning the derivedFrom/@idrefs description based on the derivedFromValue/@idrefs description in B/ above.

Change the derivedFrom/@idrefs description to the following: Refers to the ids of elements whose values have been derived from the concept represented by this property

 

 

 

 

 

 

(END)

 
close