Table of Contents
In the following all elements of UDDF version 3.1.0 are listed. For each element a description is given which comprises these seven points:
Occurrence:
There are two by two possibilities:
optional: This element may be given, but it's not a must. For example, if the address of a buddy isn't known, it cannot be given.
compulsory: This element must be given. For example the profile data of a dive can only be given inside the <profiledata> element (section), therefore this element is compulsory, it must not be omitted if a dive profile is to be stored in an UDDF file.
Some elements are optional on the one hand, and compulsory on the other, depending on context.
single: An element marked single is allowed to appear only once inside its parent element. For example, it makes no sense to give the date twice a dive was made.
multiple: This element may appear more than once. For example, a dive can be made using two regulators. Therefore, two <regulator> elements can be given.
Attributes:
Some elements contain an additional so-called "attribute". In most cases this is an unique identifier of this element
(e.g. a part of equipment described, a dive), for the sake of a proper machine identification of this element.
If not stated otherwise, an attribute id=... is compulsory!
Description:
A description in words, what that element is good for, and some additional hints.
Parent Elements:
Parent elements are these elements, inside which the element described may occur.
Child Elements:
Child elements are these elements, which may appear inside the element described.
See Also:
Additional links to "related" elements with additional examples.
Examples:
To nearly all elements an examples is given, to illustrate the use of this element. Also links to related elements are given here.
quality=exact | estimated
This attribute indicates the exactness of the giving of the number of individuals. Possible values
are exact in case the number of individuals is exactly given, or estimated in
case the number is only an estimated value (e.g. the number of individuals in a swarm).
— optional
occurrence=kind of occurrence of animals (solitary, swarm, colony etc.)
Allowed keywords for the kind of occurrence of animals are:
not-ascertainable,
single-individual,
loose-association,
swarm,
colony.
— optional
Indicates the number of individuals (abundance) of a species seen (given as an integer). If the number of individuals cannot be ascertained, either <abundance> is omitted, or <abundance>0</abundance> is given. The attribute quality describes the "quality" of the giving of the number of individuals. Additionally, in case of describing an animal the attribute occurrence can be given. With plants, to describe the degree of covering <dominance> is available.
<species>
<!-- abundance couldn't be ascertained -->
<!-- (in this case the element also can be omitted) -->
<abundance>0</abundance>
<!-- 10 individuals (animals, or plants) seen -->
<abundance>10</abundance>
<!-- 10 individuals (animals, or plants) seen -->
<!-- (this form giving the attribute quality="exact" is the same as above, because -->
<!-- of this minor number we can assume that the value is an exact one) -->
<abundance quality="exact">10</abundance>
<!-- swarm of 30 individuals seen, but the number is more or less guessed -->
<abundance occurrence="swarm" quality="estimated">30</abundance>