fielddef

Defines the content and structure of a VDF payload field. A fielddef element may also contain display "hints" that can be used by graphical clients to control application layout. These hints are often provided in the form of ui elements belonging to the http://xmlns.escenic.com/2008/interface-hints namespace. For detailed information about these elements, see interface-hints.

Syntax

<fielddef
    name="text"
    label="text"
    xsdtype="text" mediatype="text"?
  >
  (<choice>...</choice>|<listdef>...</listdef>)?(ANYTHING|text)
</fielddef>

Attributes

name="text"

The name of the field.

label="text"

The display label of the field, for use in interactive clients.

xsdtype="text" (optional)

The type of the value in the field. A subset of XSD data types are used. For information about XSD data types, see http://www.w3.org/TR/xmlschema-2/#built-in-datatypes.

mediatype="text" (optional)

The MIME type of the value in the field. This attribute provides additional type information about the value in the field. The MIME types used fall into two categories:

• Standard MIME type identifiers defined in the IANA MIME type registry (http://www.iana.org/assignments/media-types/).

• Proprietary MIME types defined by Escenic. Currently only one such MIME type is used:

  com.escenic.relationType

  Indicates that the field contains an Escenic relation.

Although fielddef elements with an xsdtype always have a mediatype attribute as well, the mediatype attribute does not always contain useful information. Clients should always check the mediatype attribute for fields with an xsdtype of string or link. For all other xsdtype values, mediatype is always set to text/plain and carries no meaning.