Preview. Generated from the NewsML-G2 2.36 XML Schema by tools/xsdref. This layout is a harness for reviewing structure and content — it is not the published site.

<link>

A link from the current Item to a target Item or Web resource

Note

Usage note

User Note: They are different variants of links:

Links may allow for navigation from a newsItem to another related Item or a Web resource, and its title be displayed as supplemental information to the final user. Example: a News Item representing a section of a transcript (a “take” in the news language) may be linked to the previous and next take; an article about a person may be linked to the biography of this person.

Links may express a parent-child relationship. Example: a News Item representing an article may be linked to the article it is a translation of; a wrap-up may be linked to the previous stories used as source material for the article; a cropped picture may be linked to its source picture.

Links may express dependency on external Items which are required in order to fully present the composite content of the Item. If some target Items are not retrievable, then the recipient processor should fail gracefully. The most obvious example is a newsItem representing an illustrated article. The textual content of the News Item (usually formatted as NITF or XHTML) includes a reference to a photo which is represented by another News Item. As the NAR recipient processor is content agnostic, it cannot infer this dependency from processing the content. A dependency link from the article to the picture indicates that the recipient processor must retrieve the target newsItem before the article can be fully displayed.

Pointing at the latest version of an Item while exposing content metadata may lead to unwanted display or selection criteria if these metadata were subsequently modified; therefore only the stable content properties should be exposed in a link.

Content model

No child elements.

Attributes

Attribute Type Use Description

Attribute	Type	Use	Description
Declared on this element
`rel`	`QCodeType`	optional	The identifier of the relationship between the current Item and the target resource - expressed by a QCode
`reluri`	`IRIType`	optional	The identifier of the relationship between the current Item and the target resource - expressed by a URI
`rank`	`nonNegativeInteger`	optional	The rank of the link among other links
From targetResourceAttributes
`href`	`IRIType`	optional	The locator of the target resource.
`residref`	`string`	optional	The provider’s identifier of the target resource.
`residrefformat`	`QCodeType`	optional	The format of the provider’s identifier of the target resource - expressed by a QCode. The recommended CV to be used is http://cv.iptc.org/newscodes/valueformat/.
`residrefformaturi`	`IRIType`	optional	The format of the provider’s identifier of the target resource - expressed by a URI. The recommended CV to be used is http://cv.iptc.org/newscodes/valueformat/.
`version`	`positiveInteger`	optional	The version of the target resource. By default, the latest revision is retrieved when the link is activated.
`persistidref`	`string`	optional	Points to an element inside the target resource which must be identified by an ID attribute having a value which is persistent for all versions of the target resource, i.e. for its entire lifecycle. (added NAR 1.8)
`contenttype`	`string`	optional	The IANA (Internet Assigned Numbers Authority) Media Type of the target resource.
`contenttypestandardversion`	`string`	optional	Version of the standard identified by contenttype.
`contenttypevariant`	`string`	optional	A refinement of a generic content type (i.e. IANA Media Type) by a literal string value.
`contenttypevariantstandardversion`	`string`	optional	Version of the standard identified by contenttypevariant.
`format`	`QCodeType`	optional	A refinement of a generic content type (i.e. IANA Media Type) by a value from a controlled vocabulary - expressed by a QCode
`formaturi`	`IRIType`	optional	A refinement of a generic content type (i.e. IANA Media Type) by a value from a controlled vocabulary - expressed by a URI
`formatstandardversion`	`string`	optional	Version of the standard identified by the format.
`size`	`nonNegativeInteger`	optional	The size in bytes of the target resource.
`title`	`string`	optional	A short natural language name for the target resource.
From timeValidityAttributes
`validfrom`	`DateOptTimeType`	optional	The date (and, optionally, the time) before which a relationship is not valid.
`validto`	`DateOptTimeType`	optional	The date (and, optionally, the time) after which a relationship is not valid.
From i18nAttributes
`xml:lang`		optional	Specifies the language of this property and potentially all descendant properties. xml:lang values of descendant properties override this value. Values are determined by Internet BCP 47.
`dir`		optional	The directionality of textual content (enumeration: ltr, rtl)
From commonPowerAttributes
`id`	`ID`	optional	The local identifier of the property.
`creator`	`QCodeType`	optional	If the property value is not defined, specifies which entity (person, organisation or system) will edit the property value - expressed by a QCode. If the property value is defined, specifies which entity (person, organisation or system) has edited the property value.
`creatoruri`	`IRIType`	optional	If the property value is not defined, specifies which entity (person, organisation or system) will edit the property - expressed by a URI. If the property value is defined, specifies which entity (person, organisation or system) has edited the property.
`modified`	`DateOptTimeType`	optional	The date (and, optionally, the time) when the property was last modified. The initial value is the date (and, optionally, the time) of creation of the property.
`custom`	`boolean`	optional	If set to true the corresponding property was added to the G2 Item for a specific customer or group of customers only. The default value of this property is false which applies when this attribute is not used with the property.
`how`	`QCodeType`	optional	Indicates by which means the value was extracted from the content - expressed by a QCode
`howuri`	`IRIType`	optional	Indicates by which means the value was extracted from the content - expressed by a URI
`why`	`QCodeType`	optional	Why the metadata has been included - expressed by a QCode
`whyuri`	`IRIType`	optional	Why the metadata has been included - expressed by a URI
`pubconstraint`	`QCodeListType`	optional	One or many constraints that apply to publishing the value of the property - expressed by a QCode. Each constraint applies to all descendant elements.
`pubconstrainturi`	`IRIListType`	optional	One or many constraints that apply to publishing the value of the property - expressed by a URI. Each constraint applies to all descendant elements.
From deprecatedLinkAttributes
`guidref`	`string`	optional	The use of this attribute is DEPRECATED, use @residref instead. (was: The globally unique Identifier of the target Item.)
`hreftype`	`string`	optional	The use of this attribute is DEPRECATED, use @contenttype instead. (was: An IANA Media Type.)

Declared on this element

rel

QCodeType

optional

The identifier of the relationship between the current Item and the target resource - expressed by a QCode

reluri

IRIType

optional

The identifier of the relationship between the current Item and the target resource - expressed by a URI

rank

nonNegativeInteger

optional

The rank of the link among other links

From targetResourceAttributes

href

IRIType

optional

The locator of the target resource.

residref

string

optional

The provider’s identifier of the target resource.

residrefformat

QCodeType

optional

The format of the provider’s identifier of the target resource - expressed by a QCode. The recommended CV to be used is http://cv.iptc.org/newscodes/valueformat/.

residrefformaturi

IRIType

optional

The format of the provider’s identifier of the target resource - expressed by a URI. The recommended CV to be used is http://cv.iptc.org/newscodes/valueformat/.

version

positiveInteger

optional

The version of the target resource. By default, the latest revision is retrieved when the link is activated.

persistidref

string

optional

Points to an element inside the target resource which must be identified by an ID attribute having a value which is persistent for all versions of the target resource, i.e. for its entire lifecycle. (added NAR 1.8)

contenttype

string

optional

The IANA (Internet Assigned Numbers Authority) Media Type of the target resource.

contenttypestandardversion

string

optional

Version of the standard identified by contenttype.

contenttypevariant

string

optional

A refinement of a generic content type (i.e. IANA Media Type) by a literal string value.

contenttypevariantstandardversion

string

optional

Version of the standard identified by contenttypevariant.

format

QCodeType

optional

A refinement of a generic content type (i.e. IANA Media Type) by a value from a controlled vocabulary - expressed by a QCode

formaturi

IRIType

optional

A refinement of a generic content type (i.e. IANA Media Type) by a value from a controlled vocabulary - expressed by a URI

formatstandardversion

string

optional

Version of the standard identified by the format.

size

nonNegativeInteger

optional

The size in bytes of the target resource.

title

string

optional

A short natural language name for the target resource.

From timeValidityAttributes

validfrom

DateOptTimeType

optional

The date (and, optionally, the time) before which a relationship is not valid.

validto

DateOptTimeType

optional

The date (and, optionally, the time) after which a relationship is not valid.

From i18nAttributes

xml:lang

optional

Specifies the language of this property and potentially all descendant properties. xml:lang values of descendant properties override this value. Values are determined by Internet BCP 47.

dir

optional

The directionality of textual content (enumeration: ltr, rtl)

From commonPowerAttributes

id

ID

optional

The local identifier of the property.

creator

QCodeType

optional

If the property value is not defined, specifies which entity (person, organisation or system) will edit the property value - expressed by a QCode. If the property value is defined, specifies which entity (person, organisation or system) has edited the property value.

creatoruri

IRIType

optional

If the property value is not defined, specifies which entity (person, organisation or system) will edit the property - expressed by a URI. If the property value is defined, specifies which entity (person, organisation or system) has edited the property.

modified

DateOptTimeType

optional

The date (and, optionally, the time) when the property was last modified. The initial value is the date (and, optionally, the time) of creation of the property.

custom

boolean

optional

If set to true the corresponding property was added to the G2 Item for a specific customer or group of customers only. The default value of this property is false which applies when this attribute is not used with the property.

how

QCodeType

optional

Indicates by which means the value was extracted from the content - expressed by a QCode

howuri

IRIType

optional

Indicates by which means the value was extracted from the content - expressed by a URI

why

QCodeType

optional

Why the metadata has been included - expressed by a QCode

whyuri

IRIType

optional

Why the metadata has been included - expressed by a URI

pubconstraint

QCodeListType

optional

One or many constraints that apply to publishing the value of the property - expressed by a QCode. Each constraint applies to all descendant elements.

pubconstrainturi

IRIListType

optional

One or many constraints that apply to publishing the value of the property - expressed by a URI. Each constraint applies to all descendant elements.

From deprecatedLinkAttributes

guidref

string

optional

The use of this attribute is DEPRECATED, use @residref instead. (was: The globally unique Identifier of the target Item.)

hreftype

string

optional

The use of this attribute is DEPRECATED, use @contenttype instead. (was: An IANA Media Type.)

This element is an extension point: properties from other XML namespaces may be added.

Used by

<itemMeta> — 0..∞
<partMeta> — 0..∞
<rightsInfo> — 0..∞, in any order (choice)