Next: 1.9.3.1 <DescriptionReference>
Up: 1.9 Descriptive Elements
Previous: 1.9.2.1 Supplier Specific Property
Contents
Index
1.9.3 <Description>
A description is an optional document that provides humanly readable
information about the element which it is contained within.
When there are multiple <Description> elements supplied within a given
element, then it is expected that the type attribute will distinguish
between the <Description> elements. If this is not the case, or if
a range of types that are unknown to the Consumer then the
Consumer would not be expected to know what to utilise the alternative
<Description> elements for. In this case the Consumer would be expected
to only utilise the first <Description> element as a ``general
purpose description'' that describes the containing element.
If a Supplier wishes to provide a multipurpose IVES document that
is useful to multiple Suppliers who have different supported types
then the correct thing to do would be to include a generic un-typed
<Description> first that can be used by unknown Consumers and follow
this with a succession of typed <Description>s that are appropriate
for the different Consumers that require specific types of <Description>.
Attributes
- type
- optional string.
The type attribute is an optional string attribute that assigns the
given <Description> to a given class of documents. It is up to the
Supplier and the Consumer to come to an agreement as to the meaning
of the types that are supported.
- role
- optional string.
- supplierSpecificId
- (see )
May Contain
See Shared Description Components ()
Contained Within
- <Contacts>
- , optional and repeatable
- <Contact>
- , optional and repeatable
- <Credits>
- , optional and repeatable
- <Description>
- , optional and repeatable
- <DropInEvent>
- , optional and repeatable
- <Event>
- , optional and repeatable
- <Group>
- , optional and repeatable
- <PerformanceSpace>
- , optional and repeatable
- <Performance>
- , optional and repeatable
- <Person>
- , optional and repeatable
- <Schedule>
- , optional and repeatable
- <SupplierSpecificProperty>
- ,
optional and repeatable
- <Tickets>
- , optional and repeatable
- <TicketType>
- , optional and repeatable
- <Venue>
- , optional and repeatable
Subsections
Next: 1.9.3.1 <DescriptionReference>
Up: 1.9 Descriptive Elements
Previous: 1.9.2.1 Supplier Specific Property
Contents
Index
Alex Fiennes
2010-04-13