description

iati-activities/iati-activity/result/description

This is the reference page for the XML element description.

Definition

A longer, human-readable description.

Rules

This element must occur no more than once (within each parent element).

Example Usage

Example usage of description in a result of an iati-activity.

  <result type="1" aggregation-status="1">
   <title>
    <narrative>Result title</narrative>
   </title>
   <description>
    <narrative>Result description text</narrative>
   </description>
   <!--result-document-link example starts-->
   <document-link format="application/vnd.oasis.opendocument.text" url="http:www.example.org/docs/result_en.odt">
    <title>
     <narrative>Results Report 2013</narrative>
    </title>
    <description>
      <narrative>Report of results</narrative>
    </description>
    <category code="A01" />
    <language code="en" />
    <document-date iso-date="2014-02-05" />
   </document-link>
<!--result-document-link example ends-->
<!--result-reference starts-->
   <reference vocabulary="1" code="3429" />
   <reference vocabulary="7" code="861" />
   <reference vocabulary="99" code="B1" vocabulary-uri="http://example.com/indicators.html" />
<!--result-reference ends-->
<!--result-indicator starts-->
   <indicator measure="1" ascending="1" aggregation-status="1">
     <title>
      <narrative>Indicator title</narrative>
     </title>
     <description>
      <narrative>Indicator description text</narrative>
     </description>
     <document-link format="application/vnd.oasis.opendocument.text" url="http:www.example.org/docs/result_indicator_en.odt">
      <title>
       <narrative>Results Indicator Report 2013</narrative>
      </title>
      <description>
        <narrative>Report of results indicator</narrative>
      </description>
      <category code="A01" />
      <language code="en" />
      <document-date iso-date="2014-02-05" />
     </document-link>
     <reference vocabulary="1" code="3429" />
     <reference vocabulary="7" code="861" />
     <reference vocabulary="99" code="B1" indicator-uri="http://example.com/indicators.html" />
<!--result-baseline starts-->
     <baseline year="2012" iso-date="2012-01-01" value="10">
      <location ref="AF-KAN" />
      <location ref="KH-PNH" />
      <dimension name="sex" value="female" />
      <dimension name="age" value="adult" />
      <document-link format="application/vnd.oasis.opendocument.text" url="http:www.example.org/docs/result_baseline_en.odt">
       <title>
        <narrative>Results Baseline Report 2013</narrative>
       </title>
       <description>
         <narrative>Report of results baseline</narrative>
       </description>
       <category code="A01" />
       <language code="en" />
       <document-date iso-date="2014-02-05" />
      </document-link>
      <comment>
       <narrative>Baseline comment text</narrative>
      </comment>
     </baseline>
     <!--result-baseline ends-->
     <!--result-period starts-->
     <period>
      <period-start iso-date="2013-01-01" />
      <period-end iso-date="2013-03-31" />
      <target value="10">
       <location ref="AF-KAN" />
       <location ref="KH-PNH" />
       <dimension name="sex" value="female" />
       <dimension name="age" value="adult" />
       <comment>
        <narrative>Target comment text</narrative>
       </comment>
       <document-link format="application/vnd.oasis.opendocument.text" url="http:www.example.org/docs/result_period_target_en.odt">
        <title>
         <narrative>Results Period Target Report 2013</narrative>
        </title>
        <description>
          <narrative>Report of results period target</narrative>
        </description>
        <category code="A01" />
        <language code="en" />
        <document-date iso-date="2014-02-05" />
       </document-link>
      </target>
      <actual value="11">
       <location ref="AF-KAN" />
       <location ref="KH-PNH" />
       <dimension name="sex" value="female" />
       <dimension name="age" value="adult" />
       <comment>
         <narrative>Actual comment text</narrative>
       </comment>
       <document-link format="application/vnd.oasis.opendocument.text" url="http:www.example.org/docs/result_period_actual_en.odt">
        <title>
         <narrative>Results Period Actual Report 2013</narrative>
        </title>
        <description>
          <narrative>Report of results period actual</narrative>
        </description>
        <category code="A01" />
        <language code="en" />
        <document-date iso-date="2014-02-05" />
       </document-link>
      </actual>
     </period>
     <!--result-period ends-->
   </indicator>
   <!--result-indicator ends-->
  </result>

Changelog

2.01

Freetext is no longer allowed with this element. It should now be declared with the new child narrative element.

The @type attribute was removed.

Developer tools

Find the source of this documentation on github:

Subelements