This version is DEPRECATED, v2.03 is the latest version
description
iati-activities/iati-activity/result/indicator/description
This is the reference page for the XML element 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 an indicator
in a result
element.
<result type="1" aggregation-status="1">
<title>Result 1 title</title>
<description>Result 1 description text</description>
<indicator measure="1" ascending="1">
<title>Indicator 1 title</title>
<description>Indicator1descriptiontext</description>
<baseline year="2012" value="10">
<comment>Baseline comment text</comment>
</baseline>
<period>
<period-start iso-date="2013-01-01" />
<period-end iso-date="2013-03-31" />
<target value="10">
<comment>Target comment text</comment>
</target>
<actual value="11">
<comment>Actual comment text</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:
<result type="1" aggregation-status="1">
<title>Result 1 title</title>
<title xml:lang="fr">Result 1 titre</title>
<description>Result 1 description text</description>
<description xml:lang="fr">Result 1 texte de description</description>
<indicator measure="1" ascending="1">
<title>Indicator 1 title</title>
<title xml:lang="fr">Indicator 1 titre</title>
<description>Indicator1descriptiontext</description>
<descriptionxml:lang="fr">Indicator1textededescription</description>
<baseline year="2012" value="10">
<comment>Baseline comment text</comment>
<comment xml:lang="fr">Baseline comment texte</comment>
</baseline>
<period>
<period-start iso-date="2013-01-01"/>
<period-end iso-date="2013-03-31"/>
<target value="10">
<comment>Target comment text</comment>
<comment xml:lang="fr">Target comment texte</comment>
</target>
<actual value="11">
<comment>Actual comment text</comment>
<comment xml:lang="fr">Actual comment texte</comment>
</actual>
</period>
</indicator>
</result>
Developer tools
Find the source of this documentation on github: