You are viewing VERSION 2.03 of IATI Standard Reference View another version
document-link
iati-activities/iati-activity/result/indicator/period/actual/document-link
This is the reference page for the XML element document-link.
Definition
A link to an online, publicly accessible web page or document expanding on the result.
Rules
This element may occur any number of times.
Attributes
- @url
The target URL of the external document, e.g. “http://www.example.org/doc.odt”.
This attribute is required.
This value must be of type xsd:anyURI.
- @format
An IANA code for the MIME type of the document being referenced, e.g. “application/pdf”.
This attribute is required.
This value must be of type xsd:string.
This value must be on the FileFormat codelist.
Example Usage
Example document-link in a actual in a period in a indicator in a result element.
This element is a parent for other child elements.
The @format attribute declares a valid code (application/vnd.oasis.opendocument.text) from the FileFormat codelist.
The @url attribute provides the document location.
<document-link format="application/vnd.oasis.opendocument.text" url="http:www.example.org/docs/result_period_actual_en.odt">
...
</document-link>
Full example with all child elements:
<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>
The document-link element can be repeated in any result element.
Changelog
2.03
The optional document-link element was added.
Developer tools
Find the source of this documentation on github:
Subelements