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 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_en.odt">
...
</document-link>

Full example with all child elements:

   <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>

The document-link element can be repeated in any result element.

Changelog

Developer tools

Find the source of this documentation on github:

• Schema

• Extra Documentation

Subelements

• title
• description
• category
• language
• document-date