Prev Up Next Index
Go backward to 4.2.4 dataset
Go up to 4.2 THREDDS Catalog Configuration Elements
Go forward to 4.2.6 metadata

4.2.5 documentation

<!ELEMENT documentation (#PCDATA)>
<!ATTLIST documentation
    xlink:type (simple) #FIXED "simple"
    xlink:href CDATA #IMPLIED
    xlink:title CDATA #IMPLIED
    xlink:show (new | replace | embed) "new"
>

A documentation element contains or refers to content that should be displayed to an end-user when making selections from the catalog. The content may be HTML or plain text. We call this kind of content "human readable" information.

The documentation element may contain arbitrary plain text content, which should be displayed inline at the position of the aggregation or the dataset element that contains it.

The documentation element may also contain an XLink to an HTML or plain text web page. This text should be either shown inline or displayed when the user activates the XLink, depending on the value of the xlink:show attribute, whose default is new. If the value of xlink:show is new, then the content of the XLink should be displayed in a new window when the user selects it. If the value of xlink:show is embed, then the context should be displayed inline, as if it was text content in the documentation element. If the value of xlink:show is replace, the content should replace the existing window. The value of xlink:title is used for show and replace, and should be the displayed as the name that the user can click on to follow the XLink. The value of xlink:show and xlink:title are heuristics for the dataset choosing widget, which may not be able to fully implement them. These heuristics are intended to follow the XLink specification as closely as possible. Note that the XLink has a fixed type of simple that is part of the DTD, so does not have to be specified in the XML.


Tom Sgouros, 2004/07/07

Prev Up Next