description

Definition

A longer, human-readable description. May be repeated for different languages.

Attributes

@type

A machine readable code describing the type of thing being referenced. The value should be available on a related codelist.

This value must be of type xsd:string.

This value must be on the DescriptionType codelist.

@xml:lang

ISO 2 letter code specifying the language of text in this element.

This value should be on the Language codelist.

Example Usage

Example usage of description in context of result element.

<resulttype="1"aggregation-status="1">
<title>Result1title</title>
<description>Result1descriptiontext</description>
<indicatormeasure="1"ascending="1">
<title>Indicator1title</title>
<description>Indicator1descriptiontext</description>
<baselineyear="2012"value="10">
<comment>Baselinecommenttext</comment>
</baseline>
<period>
<period-startiso-date="2013-01-01"/>
<period-endiso-date="2013-03-31"/>
<targetvalue="10">
<comment>Targetcommenttext</comment>
</target>
<actualvalue="11">
<comment>Actualcommenttext</comment>
</actual>
</period>
</indicator>
</result>

It may be appropriate to repeat the description in other languages using xml:lang attribute. In this example, the language en has been set in the ‘’iati-activity’’ element:

<resulttype="1"aggregation-status="1">
<title>Result1title</title>
<titlexml:lang="fr">Result1titre</title>
<description>Result1descriptiontext</description>
<descriptionxml:lang="fr">Result1textededescription</description>
<indicatormeasure="1"ascending="1">
<title>Indicator1title</title>
<titlexml:lang="fr">Indicator1titre</title>
<description>Indicator1descriptiontext</description>
<descriptionxml:lang="fr">Indicator1textededescription</description>
<baselineyear="2012"value="10">
<comment>Baselinecommenttext</comment>
<commentxml:lang="fr">Baselinecommenttexte</comment>
</baseline>
<period>
<period-startiso-date="2013-01-01"/>
<period-endiso-date="2013-03-31"/>
<targetvalue="10">
<comment>Targetcommenttext</comment>
<commentxml:lang="fr">Targetcommenttexte</comment>
</target>
<actualvalue="11">
<comment>Actualcommenttext</comment>
<commentxml:lang="fr">Actualcommenttexte</comment>
</actual>
</period>
</indicator>
</result>

Developer tools

Find the source of this documentation on github:

• Schema

• Extra Documentation