Schema SDD_09.xsd

(Documentation of the SDD schema version 0.9, released 1. Dec. 2003. This is the recommended version of the schema documentation. See the "Overview of available documentation" for further information.

Note that all diagram are hyperlinked, you can click on the symbols to explore elements or types. Please read Schema design modeling symbols for explanations of the symbols used in the schema diagrams!

This documentation is based on html code generated by the XML Spy schema editor (http://www.altova.com/xmlspy/). The code has then been modified by G. Hagedorn to make it more compact and more readable.

element Document

diagram
identity constraints	Name   Refer   Selector   Field(s)   key   AudienceDefinitionKey      ProjectDefinition/Audiences/Audience   @audiencekey   key   GlossaryEntryKey      Terminology/Glossary/GlossaryEntry   @key   unique   GlossaryEntry_UniqueTerm      Terminology/Glossary/GlossaryEntry/Representation   Term   @audience   key   CodingStatusKey      Terminology/CodingStatusValues/CodingStatus   @key   unique   CodingStatus_UniqueLabelText      Terminology/CodingStatusValues/CodingStatus/Label/Representation   Text   @audience   key   StatisticalMeasureKey      Terminology/StatisticalMeasures/StatisticalMeasure   @key   unique   StatisticalMeasure_UniqueLabelText      Terminology/StatisticalMeasures/StatisticalMeasure/Label/Representation   Text   @audience   unique   StatisticalMeasure_UniqueMethodAndValue      Terminology/StatisticalMeasures/StatisticalMeasure/Generalization   Method   MethodValue   key   ProbModifierKey      Terminology/Modifiers/Probability/Modifier   @key   unique   Probability_UniqueLabelText      Terminology/Modifiers/Probability/Modifier/Label/Representation   Text   @audience   key   FrequModifierKey      Terminology/Modifiers/Frequency/Modifier   @key   unique   Frequency_UniqueLabelText      Terminology/Modifiers/Frequency/Modifier/Label/Representation   Text   @audience   key   GeneralModifierKey      Terminology/Modifiers/General/Modifier   @key   unique   GeneralModifier_UniqueLabelText      Terminology/Modifiers/General/Modifier/Label/Representation   Text   @audience   unique   CombinedModifierKey      Terminology/Modifiers/*/Modifier   @key   key   ModifierSetKey      Terminology/Modifiers/Sets/Set   @key   unique   ModifierSet_UniqueLabelText      Terminology/Modifiers/Sets/Set/Label/Representation   Text   @audience   key   CharacterDefinitionKey      Terminology/Characters/Character   @key   unique   Character_UniqueLabelText      Terminology/Characters/Character/Label/Representation   Text   @audience   key   CharacterStateKey      Terminology/Characters/Character/Categorical/States/StateDefinition | Terminology/Characters/Character/Categorical/States/StateReference   @key   key   CharacterStatMeasureKey      Terminology/Characters/Character/Numerical/StatisticalMeasures/StatisticalMeasure   @key   key   CombinedCharStateOrMeasureKey      Terminology/Characters/Character/Categorical/States/StateDefinition | Terminology/Characters/Character/Categorical/States/StateReference | Terminology/Characters/Character/Numerical/StatisticalMeasures/StatisticalMeasure   @key   key   ConceptTreeKey      Terminology/ConceptTrees/ConceptTree   @key   unique   ConceptTree_UniqueLabelText      Terminology/ConceptTrees/ConceptTree/Label/Representation   Text   @audience   key   ConceptTreeNodeKey      .//Concept   @key   key   GenericStateKey      .//Concept/GenericStates/StateDefinition   @key   key   ClassResourceKey      Entities/Classes/Class   @key   key   ClassHierarchyKey      Entities/ClassHierarchies/ClassHierarchy   @key   key   ObjectResourceKey      Entities/Objects/Object   @key   key   AgentResourceKey      Resources/Agents/Agent   @key   key   PublicationResourceKey      Resources/Publications/Publication   @key   key   LocalityResourceKey      Resources/Geography/Locality   @key   key   MediaResourceKey      Resources/MediaResources/MediaResource   @key   key   DescriptionKey      Descriptions/CodedDescription | Descriptions/NaturalLanguageDescription   @key   key   DesignedKeyDefKey      Keys/Key   @key   unique   DesignedKey_UniqueLabelText      Keys/Key/Label/Representation   Text   @audience   key   DesignedKeyNodeKey      .//Lead   @key
annotation	documentation  Provides root element. Note that the version of the SDD standard used is defined in the namespace declaration and needs no separate data element.Note: until xInclude is sufficiently widespread implemented to combine data from different documents, terminology, descriptions, and resources must be in the same document!

element Document/GenerationMetadata

diagram
type	GenerationMetadataSectionType
attributes	Name   Type   Use   Default   Fixed   Annotation GeneratorName   String255   required         documentation  Name of the application that has generated this document. The term 'application' should be understood in a loose sense; it may be a script that is not part of a larger application (compare the Routine attribute, which may provide the detailed name of scriptis that are part of an application!). GeneratorVersion   String255   required         documentation  Version of the application that has generated this document. The attribute should not be named 'Version' to avoid confusion with the version of the content (see ProjectDefinition). GeneratorNotes   String255   optional         documentation  Additional information about the generating application that is not part of the name or version. Documenting the copyright of the generating application is not recommended, but if desired, a copyright string may be placed here. Routine   String255   optional         documentation  Optionally allows a generating application to identify which export routine created the document; some applications may have several alternative export routines. This attribute may also be used, to identify different conditions under which the export routine may behave differently. TransformingScripts   String255   optional         documentation  Scripts (e. g. XSL transformations) that modify existing xml documents in a relatively minor way should add their name to this (semicolon-separated) list of transforming scripts (rather than replacing the GenerationMetadata with their own information). TimeStamp   xs:dateTime   required         documentation  Date and time (UTC or local time with timezone information) at which the current document or data stream was created by the generator. TerminologyIsExcerpt   xs:boolean   optional   false      documentation  If this document is produced in response to a query and therefore only contains a subset of the terminology defined in the project, this optional element should be set to true to inform consumers that a more complete version can be found elsewhere. DescriptionIsExcerpt   xs:boolean   optional   false      documentation  If this document is produced in response to a query and therefore only contains a subset of descriptions available, this optional element should be set to true to inform consumers that a more complete version can be found elsewhere. UpdateQueryURI   xs:anyURI   optional         documentation  If the document is a snapshot (complete or extract) of data held otherwise, and the data are served through a URI, this attribute informs about the point to query for up-to-date information. If possible this should be a complete web-query string.
annotation	documentation  Describes the application or script that produced this document. The information is transient (informs the import process, but is discarded after import). Intended for debugging purposes and to improve import quality (esp. if some generators are known to produce problematic code).

element Document/ProjectDefinition

diagram
type	ProjectDefinitionSectionType
annotation	documentation  Required information defining the project itself. Refers to the entire document, (terminology, descriptions, keys, etc.)

element Document/Terminology

diagram
type	TerminologySectionType
annotation	documentation  Defines the terminology (parts, characters, states, etc.) in which the descriptions are expressed.

element Document/Entities

diagram
type	EntitiesSectionType
annotation	documentation  The classes (biology: taxa) and objects (biology: specimens) that are being described.

element Document/Resources

diagram
type	ResourcesSectionType
annotation	documentation  Lists of external resources used in terminology or descriptions (persons, publications, media resources). This provides an interface as well as a cache.

element Document/Descriptions

diagram
type	DescriptionsSectionType
annotation	documentation  Descriptions of either an abstract class concept (taxon, disease, etc.) or a physical object (individual specimen, part of individual, etc.).

element Document/Keys

diagram
type	KeysSectionType
annotation	documentation  Dichotomous or multifurcating authored keys (including legacy data)

group AnnotationGroup

diagram
used by	element  ProjectDefinitionSectionType/__LanguageRules/LanguageRule complexTypes  CharacterCodingStatusNLDType CharacterMeasureNLDType CharacterStateData_BaseType CharacterStateNLDType ClassHierarchyNodeType ConceptTreeDefType DescriptionBaseType DesignedKeyDefType DesignedKeyNodeType GlossaryEntryRepresentationType ModifierSetType ProjectDefinitionSectionType ResourceConnectorBaseType
annotation	documentation  = reuse of Annotation and ApplicationData, i. e. designer and application 'annotations'

element AnnotationGroup/Annotation

diagram
type	StringN
facets	minLength  1 whiteSpace  collapse
annotation	documentation  Internal notes/management comments (not multilingual). Annotations should be displayed only in a 'designer' or 'revision' mode' and are expected to be invisible to users who only want to apply the data. They are appropriate for rough, unedited comments, but should not contain confidential information.

element AnnotationGroup/ApplicationData

diagram
type	ApplicationDataType
annotation	documentation  Application-specific data(= extension mechanism)

group DelimiterGroup

diagram
used by	element  ProjectDefinitionSectionType/__LanguageRules/LanguageRule/Wording/OrDelimiters complexType  NatLangWording3Type
annotation	documentation  @@ check later whether still necessary!

element DelimiterGroup/SingleDelimiterText

diagram
type	NatLangWordingType
annotation	documentation  This delimiter is used if only 2 elements are present. Examples: en: ' or ', de: ' oder '

element DelimiterGroup/RepeatedDelimiterText

diagram
type	NatLangWordingType
annotation	documentation  If 3 or more elements are present, this delimiter is used between all elements, except before the last element. Examples: en: ', ', de: ', '

element DelimiterGroup/LastDelimiterText

diagram
type	NatLangWordingType
annotation	documentation  If 3 or more elements are present, this delimiter is used between the second-but-last and the last element.Examples: en: ', or ', de: ' oder '

group RichAnnotationGroup

diagram
used by	complexTypes  CharacterDefType ConceptTreeNodeType ModifierDefBaseType StateDefBaseType StatisticalMeasureDefType
annotation	documentation  = AnnotationGroup+ GlossaryEntry reference.

element RichAnnotationGroup/GlossaryEntry

diagram
type	GlossaryEntryRefType
attributes	Name   Type   Use   Default   Fixed   Annotation ref   KeyValue   required         documentation  Refers to a GlossaryEntry (Terminology/Glossary/GlossaryEntry) debugref   xs:string   optional         documentation
identity constraints	Name   Refer   Selector   Field(s)   keyref   GlossaryEntryKeyref   GlossaryEntryKey   .   @ref
annotation	documentation  Reference to the definition of term or concept in the glossary; may be provided for multiple audiences and may include media resources like images.[ATTR: ref]

element RichAnnotationGroup/Annotation

diagram
type	StringN
facets	minLength  1 whiteSpace  collapse
annotation	documentation  Internal notes/management comments of the designer (not multilingual).Internal notes should not be displayed to consumers of a data set. Appropriate for rough, unedited comments, but should not contain confidential information.

element RichAnnotationGroup/ApplicationData

diagram
type	ApplicationDataType
annotation	documentation  Application-specific data(= extension mechanism)

complexType __FormattedBlockTextType

diagram
type	extension of FormattedSimpleTextType
annotation	documentation  [Unused!] Extends the FormattedInlineTextType and allows the following block level elements as well: p, ol, ul, li, h1-h6. This should be defined through reference to a full xhtml fragment definition, but it must be without html/header/body elements!

element __FormattedBlockTextType/p

diagram
type	FormattedSimpleTextType
annotation	documentation  Currently only p element added as a example for the discussion. p would need attributes added to function properly!! If possible reuse xhtml modules!

complexType __FormattedInlineTextType

diagram
type	extension of FormattedSimpleTextType
annotation	documentation  [Unused!] Extends the FormattedSimpleTextType and allows in addition to basic character formatting also the use of <img> and <a> elements. This should probably be implemented through references to types from the real a xhtml schema, if it is possible to refer to an appropriate subset.

element __FormattedInlineTextType/a

diagram
type	extension of FormattedSimpleTextType
attributes	Name   Type   Use   Default   Fixed   Annotation name   xs:NMTOKEN            href   xs:anyURI            hreflang   xs:language
annotation	documentation  anchor/hyperlink element

element __FormattedInlineTextType/img

diagram
attributes	Name   Type   Use   Default   Fixed   Annotation src   xs:anyURI   required         alt   xs:string   required         longdesc   xs:anyURI            height   xs:positiveInteger            width   xs:positiveInteger
annotation	documentation  image element

complexType __OptionalCreatorsType

diagram
annotation	documentation  [Unused!] Creators = authors, editors or contributors. It is generally desirable that at least on author/editor is named. In the case of legacy data, this may, however, not be feasible.Currently we are attempting to require the presence of at least one creator. If this should not be possible, we may have to go back to this type!

element __OptionalCreatorsType/Authors

diagram
type	AgentRefsType
identity constraints	Name   Refer   Selector   Field(s)   unique   Authors_UniqueAgent2      Agent   @ref
annotation	documentation  Authors that have originated the content; in the sequence of importance.

element __OptionalCreatorsType/Editors

diagram
type	AgentRefsType
identity constraints	Name   Refer   Selector   Field(s)   unique   Editors_UniqueAgent2      Agent   @ref
annotation	documentation  Editors that have revised content generated by multiple authors or contributors; in the sequence of importance. In general Editors should co-occur with Authors or Contributors (which is, however, not enforced).

element __OptionalCreatorsType/Contributors

diagram
type	AgentRefsType
identity constraints	Name   Refer   Selector   Field(s)   unique   Contributors_UniqueAgent2      Agent   @ref
annotation	documentation  The sequence of Contributor Agents must be preserved during processing, but the semantics of it are defined by the authors or editors of the project: either importance or alphabetical sequence.

element __OptionalCreatorsType/Translators

diagram
type	AgentRefsType
identity constraints	Name   Refer   Selector   Field(s)   unique   Translators_UniqueAgent2      Agent   @ref
annotation	documentation  In addition to authors/editors, several people may have translated audience-specific texts. @@Request for discussion: These are currently not listed in the Representation elements, but could a single one could be easily (however, not several!). Also: should one Representation be marked as Original/SourceForTranslation/Etc.? @@

complexType AgentConnectorType

diagram
type	extension of ResourceConnectorBaseType
used by	element  ResourcesSectionType/Agents/Agent
attributes	Name   Type   Use   Default   Fixed   Annotation key   KeyValue   required         debugkey   xs:string   optional         documentation  An optional attribute to add a human-readable equivalent to the numeric primary identity key, intended to simplify debugging SDD applications. The attribute can be discarded or updated at any time. Applications should not produce exports containing this attribute, instead it can be generated using xslt (based on labels/abbreviations.
annotation	documentation  Used for Agent documentation (an Agent is a person, project, organisation, or software agent). Currently used for authors, editors, contributors, and translators. Ideally it connects to an outside definition or documentation of the Agent.

element AgentConnectorType/LastName

diagram
type	String255
facets	minLength  1 maxLength  255 whiteSpace  collapse
annotation	documentation  This may be a person as well as an organisation name

element AgentConnectorType/FirstNames

diagram
type	String255
facets	minLength  1 maxLength  255 whiteSpace  collapse
annotation	documentation  Applicable only to persons

element AgentConnectorType/Homepage

diagram
type	xs:anyURI
annotation	documentation  This is an information URL pointing to a homepage with further information. If the person has a truly global URN representing its name, it is expected that this is used as the ExternalID above.

element AgentConnectorType/__OtherElements_ToBeDefined

diagram

complexType AgentRefsType

diagram
used by	elements  CreatorsType/Authors __OptionalCreatorsType/Authors CreatorsType/Contributors __OptionalCreatorsType/Contributors CreatorsType/Editors CreatorsType/Editors __OptionalCreatorsType/Editors CreatorsType/Translators __OptionalCreatorsType/Translators
annotation	documentation  A collection of AgentRefType elements, i. e. Agents forming a team like an author team.

element AgentRefsType/Agent

diagram
type	AgentRefType
attributes	Name   Type   Use   Default   Fixed   Annotation ref   KeyValue   required         documentation  Reference to a Agents (Resources/Agents/Agent) debugref   xs:string   optional         documentation  FirstContributionDate   xs:dateTime   optional         documentation  The first time a creator-agent has made a contribution to the object to which it was added by reference. The first/last contribution records are specific to the role of a creator-agent. If a creator has contributed both as an author and later as an editor of data, two references in two role containers will exist. Consequently, the dates for the two roles are recorded separately. LastContributionDate   xs:dateTime   optional
identity constraints	Name   Refer   Selector   Field(s)   keyref   AgentResourceKeyref   AgentResourceKey   .   @ref
annotation	documentation  (The xml sequence of elements in this collection is informative!)[ATTR: ref]

complexType AgentRefType

diagram
used by	element  AgentRefsType/Agent
attributes	Name   Type   Use   Default   Fixed   Annotation ref   KeyValue   required         documentation  Reference to a Agents (Resources/Agents/Agent) debugref   xs:string   optional         documentation  FirstContributionDate   xs:dateTime   optional         documentation  The first time a creator-agent has made a contribution to the object to which it was added by reference. The first/last contribution records are specific to the role of a creator-agent. If a creator has contributed both as an author and later as an editor of data, two references in two role containers will exist. Consequently, the dates for the two roles are recorded separately. LastContributionDate   xs:dateTime   optional
annotation	documentation  Defines an element with a ref attribute pointing to an Agent (Resources/Agents/Agent)

complexType ApplicationDataType

diagram
used by	elements  AnnotationGroup/ApplicationData RichAnnotationGroup/ApplicationData
annotation	documentation  Application specific data, providing an extension mechanism to the SDD model.SDD conforming editing applications are expected to preserve the information of other applications when importing and later exporting data to support lossless round tripping.Recommendation: Each application may read out its own information. Any other target information present should be preserved and output when a new document is generated. This is designed to support item potent round tripping data between two applications. This implies that no dependency between the settings and the descriptions and the terminology setting should be relied upon.

element ApplicationDataType/Application

diagram
attributes	Name   Type   Use   Default   Fixed   Annotation name   String255   required         documentation  Identifier chosen by the target application for which the current information is intended. The only purpose of this attribute is that the application generating data in the application container recognizes the target identifier as its own, while other applications just pass this through. version   String255   optional         documentation  Optional information about which version of the application generated these application-specific data.
annotation	documentation  The Application element must contain application-defined element content (not further validated by SDD). It is not possible to directly store a text string (content model mixed="false").[ATTR: name, version]

complexType AudienceRefType

diagram
used by	complexTypes  GlossaryEntryRepresentationType ProjectDefRepresentationType ReportedNoteRepresentationType SimpleLabelRepresentationType
attributes	Name   Type   Use   Default   Fixed   Annotation audience   xs:Name   required
annotation	documentation  Base type; defines an element with a ref attribute pointing to Audience definitions (different data type from generic ref!)

complexType AudiencesType

diagram
used by	element  ProjectDefinitionSectionType/Audiences
attributes	Name   Type   Use   Default   Fixed   Annotation defaultaudience   xs:Name   required         documentation  The default audience is used whenever the setup of the consuming application has no other preference specified. The user interface of the application may then allow to choose a different audience/language available.
annotation	documentation  An Audience is a combination of language (including dialect) and expertise (pupil, beginner, expert). Multiple audiences can be defined for the same language and expertise, distinguished only by their label.[ATTR: defaultaudience]

element AudiencesType/Audience

diagram
attributes	Name   Type   Use   Default   Fixed   Annotation audiencekey   xs:Name   required         documentation  The key value that is referenced whenever an audience="xxx" attribute is used in audience-specific elements. lang   xs:language   required         ExpertiseLevel   ExpertiseLevelEnum   required         documentation  ExpertiseLevel is restricted to values from 1-5. These categories allow to communicate expected expertise between different applications using the SDD schema. The recommended interpretation is:1 = elementary school (year 1 to 6);2 = middle school (year 7 to 10);3 = high school (year 11 above) and general public (trying to avoid any specialized terminology or jargon);4 = university students or (partly) trained personnel (using terminology, but avoiding or explaining problematic terminology);5 = experts (using the full range of terminology).
annotation	documentation  The audiencekey attribute of this element is an arbitrary string. It is referenced in all audience specific elements (labels, definitions) to specify the intended audience.Recommendation: audience keys should consist of the language code used in xml:lang plus the expertise level from 1-5 (plus a letter (a, b, ...) if a second audience for the same language and expertise level is defined).[ATTR: audiencekey, lang, dir, ExpertiseLevel]

element AudiencesType/Audience/LabelText

diagram
type	String255
facets	minLength  1 maxLength  255 whiteSpace  collapse
annotation	documentation  A concise label for the audience; expressed in the language and ability of the audience.

element AudiencesType/Audience/Description

diagram
type	StringN
facets	minLength  1 whiteSpace  collapse
annotation	documentation  Further text beyond a short label; perhaps clarifying the definition of the audience. Expressed in the language of the audience.

complexType CharacterCodingStatusDataType

diagram
type	extension of CharacterStateData_BaseType
used by	element  CharacterDataType/CodingStatus complexType  CharacterCodingStatusNLDType
attributes	Name   Type   Use   Default   Fixed   Annotation ref   KeyValue   required         documentation  ref refers to a character state key debugref   xs:string   optional         documentation
annotation	documentation  Similar to CharacterStateDataType, this one is intended for CodingStatus references. The ref attribute points to the key of Terminology/CodingStatusValues/CodingStatus@@Is it ok to inherit the ref attribute from the state base type, even though it points elsewhere?

complexType CharacterCodingStatusNLDType

diagram
type	restriction of CharacterCodingStatusDataType
used by	element  CharacterNLDType/CodingStatus
attributes	Name   Type   Use   Default   Fixed   Annotation ref   KeyValue   required         documentation  ref refers to a character state key debugref   xs:string   optional         documentation
annotation	documentation  Variant to be used inside the NaturalLanguageDescription markup container.

element CharacterCodingStatusNLDType/Text

diagram
type	MarkupTextType
attributes	Name   Type   Use   Default   Fixed   Annotation parsed   xs:boolean   optional

element CharacterCodingStatusNLDType/Note

diagram
type	ReportedNoteType

complexType CharacterData_BaseType

diagram
type	extension of CharacterRefType
used by	complexTypes  CharacterDataType CharacterRawDataType
attributes	Name   Type   Use   Default   Fixed   Annotation ref   KeyValue   required         documentation  ref refers to a character definition key (Terminology/Characters/Character) debugref   xs:string   optional         documentation
annotation	documentation  Abstract base type for character data in coded descriptions. It primarily contains a reference to a Character definition key, plus a set of references to character state definition keys.@@This base type may be redundant. Is Sequence really relevant both in coded synthetical data as well as in raw data?@@

element CharacterData_BaseType/Sequence

diagram
type	restriction of xs:Name
facets	enumeration  description enumeration  terminology
annotation	documentation  Constrained to 'description' or 'terminology' (default). If Sequence = description the sequence of states in the xml document is considered to be meaningful and can be used to distinguish between, e. g. 'round or elliptic' and 'elliptic or round'.

complexType CharacterDataType

diagram
type	extension of CharacterData_BaseType
used by	element  CodedDescriptionType/CharacterData/Character complexType  CharacterNLDType
attributes	Name   Type   Use   Default   Fixed   Annotation ref   KeyValue   required         documentation  ref refers to a character definition key (Terminology/Characters/Character) debugref   xs:string   optional         documentation
annotation	documentation  Used in coded descriptions to make statements covering a single character of a class or object. The type provides a ref to the definition of a character (it is derived from CharacterRefType)

element CharacterDataType/State

diagram
type	CharacterStateDataType
attributes	Name   Type   Use   Default   Fixed   Annotation ref   KeyValue   required         documentation  ref refers to a character state key debugref   xs:string   optional         documentation
identity constraints	Name   Refer   Selector   Field(s)   keyref   CharacterStateKeyref_Coded   CharacterStateKey   .   @ref
annotation	documentation  States are 'scored' in a description by referring to a state in the character definition. All notes and modifiers are applicable to this element.[ATTR: ref]

element CharacterDataType/StatisticalMeasure

diagram
type	CharacterMeasureDataType
attributes	Name   Type   Use   Default   Fixed   Annotation ref   KeyValue   required         documentation  ref refers to a character state key debugref   xs:string   optional         documentation  Value   xs:double   required
identity constraints	Name   Refer   Selector   Field(s)   keyref   CharacterStatMeasureKeyref_Coded   CharacterStatMeasureKey   .   @ref
annotation	documentation  Statistical measures contain synthetic information like distribution parameters, sample size, etc. Refers to a StatisticalMeasure defined for the current character. It may have associated Notes (public notes) and Probability modifiers, but no general or frequency modifiers.The value is stored in an attribute of type double. [ATTR: ref, Value]

element CharacterDataType/CodingStatus

diagram
type	CharacterCodingStatusDataType
attributes	Name   Type   Use   Default   Fixed   Annotation ref   KeyValue   required         documentation  ref refers to a character state key debugref   xs:string   optional         documentation
identity constraints	Name   Refer   Selector   Field(s)   keyref   CodingStatusKeyref_Coded   CodingStatusKey   .   @ref
annotation	documentation  Inapplicable, unknown, etc. It may have associated Notes, but no modifiers.[ATTR: ref]Note: In an object (= specimen) description only a single indicator may occur per character. However, for a class (e. g. a genus) it is up to the aggregation/generalization process whether to create multiple coding status values or not. For example, an expression "unknown or not applicable" may be useful for analytical purposes.

element CharacterDataType/MediaResources

diagram
type	MediaResourceRefsType
annotation	documentation  Media specific to the character and the current object or class described.Example: microscopic pictureof spore shape in a specimen.

complexType CharacterDefType

diagram
used by	elements  TerminologySectionType/__TemplateCharacters/Character TerminologySectionType/Characters/Character
attributes	Name   Type   Use   Default   Fixed   Annotation key   KeyValue   required         debugkey   xs:string   optional         documentation  An optional attribute to add a human-readable equivalent to the numeric primary identity key, intended to simplify debugging SDD applications. The attribute can be discarded or updated at any time. Applications should not produce exports containing this attribute, instead it can be generated using xslt (based on labels/abbreviations.
annotation	documentation  Defines a character in the terminology

element CharacterDefType/Label

diagram
type	LabelPlusAbbreviationType
identity constraints	Name   Refer   Selector   Field(s)   unique   Char_UniqueLabelRepresentation      Representation   @audience
annotation	documentation  Label includes abbreviations (e. g. for tabular reports) but no natural language wording.(Natural language wording for characters is available through concept trees!).

element CharacterDefType/RevisionData

diagram
type	RevisionDataType

element CharacterDefType/Type

diagram
type	CharacterTypeEnum
facets	enumeration  nominal enumeration  ordinal enumeration  __ordinal-discrete enumeration  __ordinal-interval enumeration  cardinal enumeration  interval enumeration  color
annotation	documentation  - cardinal data scale = integer (incl. negative values, although these are extremely rare in descriptive biological data; DELTA: type 'IN')- interval = real numeric = floating point values (DELTA: type 'RN')- nominal = unordered categorical states (DELTA: type 'UM')- ordinal-discrete = ordered categorical states (DELTA: type 'OM')@@ Should we make a distinction between ordinal-discrete and ordinal-interval [= ordered categorical states (DELTA: type 'OM'). Like ordinal-discrete but states can intergrade. Example: no / few / many hairs, ovate / ellipsoid. However, also intergrade without order: - Color @@ introduce a separate datatype for color? Exact value are not very practical, but polygons in color space would be very usefull!

element CharacterDefType/Numerical

diagram
annotation	documentation  Only applicable if character type is cardinal or interval (not controlled by schema!)

element CharacterDefType/Numerical/StatisticalMeasures

diagram
identity constraints	Name   Refer   Selector   Field(s)   unique   Char_UniqueStatMeasureRefs      StatisticalMeasure   @ref
annotation	documentation  Constrains which project-wide StatisticalMeasure definitions can appear in descriptions of this character.Note: Some statistical measure definitions (min, median, mode, etc.) could apply also to ordinal or even nominal types. This is, however, not yet supported in SDD.

element CharacterDefType/Numerical/StatisticalMeasures/StatisticalMeasure

diagram
type	CharacterStatMeasureDefType
attributes	Name   Type   Use   Default   Fixed   Annotation ref   KeyValue   required         documentation  Refers to a generic statistical measure debugref   xs:string   optional         documentation  key   KeyValue   required         debugkey   xs:string   optional         documentation  An optional attribute to add a human-readable equivalent to the numeric primary identity key, intended to simplify debugging SDD applications. The attribute can be discarded or updated at any time. Applications should not produce exports containing this attribute, instead it can be generated using xslt (based on labels/abbreviations.
identity constraints	Name   Refer   Selector   Field(s)   keyref   StatisticalMeasureKeyref   StatisticalMeasureKey   .   @ref
annotation	documentation  The key attribute must be unique and is referred to in the descriptions. The ref refers to the semantics defined in the project-wide statistical measure definitions.[ATTR: key, ref]

element CharacterDefType/Numerical/Mappings

diagram
annotation	documentation  Mappings of numerical ranges to categories (like DELTA Key States)

element CharacterDefType/Numerical/Mappings/Mapping

diagram
annotation	documentation  Each mapping defines a lower and an upper value to map numerical ranges to categorical states in the same character. A CompareWith attribute defines which kind of statistical measure (mean, confidence interval, or min/max) is used for the comparison.

element CharacterDefType/Numerical/Mappings/Mapping/From

diagram
attributes	Name   Type   Use   Default   Fixed   Annotation LowerValue   xs:double   required         UpperValue   xs:double   required         CompareWith   StatisticalMeasureCompareWithEnum   optional   central      documentation  The type of statistical measure with which the mapping range defined through Lower/UpperValue is compared. This may be a central value (mean, median), the range (quantile, confidence interval, etc.) or the extremes (minimum/maximum). Currently only these three categories are defined.
annotation	documentation  Defines a range through 2 attributes LowerValue and UpperValue (inclusive range)[ATTR: LowerValue, UpperValue, CompareWith]

element CharacterDefType/Numerical/Mappings/Mapping/To

diagram
type	CharacterStateRefType
attributes	Name   Type   Use   Default   Fixed   Annotation ref   KeyValue   required         documentation  ref refers to a character state key debugref   xs:string   optional         documentation
identity constraints	Name   Refer   Selector   Field(s)   keyref   CharacterStateKeyref_NumMapping   CharacterStateKey   .   @ref   keyref   CharacterStateKeyref_NumMapping2   WithinCharacterStateKey   .   @ref
annotation	documentation  [ATTR: ref]

element CharacterDefType/Numerical/MeasurementUnit

diagram
type	extension of FormattedSimpleTextType
attributes	Name   Type   Use   Default   Fixed   Annotation Postfix   xs:boolean   optional   true
annotation	documentation  Unit like mm, µm, °C. The content allows some xhtml formatting to support e. g. "mm<sup>2</sup>".A Postfix attribute may be set to false to output string before a value (e. g. 'pH 7.0').

element CharacterDefType/Numerical/__MeasurementMethod

diagram
type	GlossaryEntryRefType
attributes	Name   Type   Use   Default   Fixed   Annotation ref   KeyValue   required         documentation  Refers to a GlossaryEntry (Terminology/Glossary/GlossaryEntry) debugref   xs:string   optional         documentation
annotation	documentation  @@ Methods should ideally be defined in Glossary entries. Or should this become free-form text?[ATTR: ref]

element CharacterDefType/Numerical/__MeasurementAccuracy

diagram
type	String255
facets	minLength  1 maxLength  255 whiteSpace  collapse
annotation	documentation  Free-form information about accuracy of measurement. @@ free-form is language and audience dependent and can not be included in analysis. Currently this is rather a specific InternalNote. Any way to improve this? Ideally a numeric value for a confidence interval of measurements would be desirable!

element CharacterDefType/Categorical

diagram
annotation	documentation  Applicable to all character types; categorical states can be defined in addition to statistical measures!

element CharacterDefType/Categorical/States

diagram
identity constraints	Name   Refer   Selector   Field(s)   unique   Char_UniqueGenericStateRefs      StateReference   @ref   unique   CharState_UniqueLabelText      StateDefinition/Label/Representation   Text   @audience
annotation	documentation  (States are defined outside the type specific tree, since categorical states may be present in addition to numerical data)

element CharacterDefType/Categorical/States/StateDefinition

diagram
type	CharacterStateDefType
attributes	Name   Type   Use   Default   Fixed   Annotation key   KeyValue   required         debugkey   xs:string   optional         documentation  An optional attribute to add a human-readable equivalent to the numeric primary identity key, intended to simplify debugging SDD applications. The attribute can be discarded or updated at any time. Applications should not produce exports containing this attribute, instead it can be generated using xslt (based on labels/abbreviations.
annotation	documentation  Local definition of a state[ATTR: key]

element CharacterDefType/Categorical/States/StateReference

diagram
attributes	Name   Type   Use   Default   Fixed   Annotation ref   KeyValue   required         documentation  Refers to a generic character state (those defined within the concept tree, which may be used in multiple characters) debugref   xs:string   optional         documentation  key   KeyValue   required         debugkey   xs:string   optional         documentation  An optional attribute to add a human-readable equivalent to the numeric primary identity key, intended to simplify debugging SDD applications. The attribute can be discarded or updated at any time. Applications should not produce exports containing this attribute, instead it can be generated using xslt (based on labels/abbreviations.
identity constraints	Name   Refer   Selector   Field(s)   keyref   GenericStateKeyref   GenericStateKey   .   @ref
annotation	documentation  Reference to a single generic state (as defined project-wide at a concept tree node).[ATTR: key, ref]

element CharacterDefType/Categorical/AutoAddStates

diagram
identity constraints	Name   Refer   Selector   Field(s)   unique   Char_UniqueAutoAddRefs      StateSet   @ref
annotation	documentation  A collection of references to sets of generic states (i. e. to tree nodes). If a generic state is added to any of these sets, it will be added to the states in the current character (as a StateReference). This occurs not through xml or schema mechanisms, but is a contract with SDD applications. Only applications modifying generic state sets are required to fulfill this contract.

element CharacterDefType/Categorical/AutoAddStates/GenericStateSet

diagram
type	CharacterNodeRefType
attributes	Name   Type   Use   Default   Fixed   Annotation ref   KeyValue   required         documentation  Refers to a node in a concept tree (Terminology/ConceptTrees/ConceptTree/...) debugref   xs:string   optional         documentation
identity constraints	Name   Refer   Selector   Field(s)   keyref   GenericStateKeyref_AutoAdd   ConceptTreeNodeKey   .   @ref
annotation	documentation  (this refers to a node (= group) in a concept tree, since generic states are defined at nodes)[ATTR: ref]

element CharacterDefType/Categorical/Mappings

diagram
identity constraints	Name   Refer   Selector   Field(s)   unique   Char_UniqueCategoricalMapping      Mapping   From/@ref   To/@ref
annotation	documentation  Mappings between categorical states (e. g. subovate may be mapped to ovate to simplify identification choices).

element CharacterDefType/Categorical/Mappings/Mapping

diagram
annotation	documentation  Each mapping defines a source and a destination state. Both From and To may point multiple times to the same state, but the combination From + To must be unique. Both state must be defined in the current character (validated through identity constraint!)

element CharacterDefType/Categorical/Mappings/Mapping/From

diagram
type	CharacterStateRefType
attributes	Name   Type   Use   Default   Fixed   Annotation ref   KeyValue   required         documentation  ref refers to a character state key debugref   xs:string   optional         documentation
identity constraints	Name   Refer   Selector   Field(s)   keyref   CharacterStateKeyref_CatMapping1   CharacterStateKey   .   @ref   keyref   CharacterStateKeyref_CatMapping2   WithinCharacterStateKey   .   @ref
annotation	documentation  [ATTR: ref]

element CharacterDefType/Categorical/Mappings/Mapping/To

diagram
type	CharacterStateRefType
attributes	Name   Type   Use   Default   Fixed   Annotation ref   KeyValue   required         documentation  ref refers to a character state key debugref   xs:string   optional         documentation
identity constraints	Name   Refer   Selector   Field(s)   keyref   CharacterStateKeyref_CatMapping3   CharacterStateKey   .   @ref   keyref   CharacterStateKeyref_CatMapping4   WithinCharacterStateKey   .   @ref
annotation	documentation  [ATTR: ref]

element CharacterDefType/ModifierSets

diagram
identity constraints	Name   Refer   Selector   Field(s)   unique   Char_UniqueModifierSetRefs      ModifierSet   @ref
annotation	documentation  The project-wide modifier definitions become applicable to the current character only if a modifier set containing them is referenced here. Modifier usage in descriptions is not controlled by the schema, i. e. modifiers not present in any set may be present in descriptions for this character. Additional validations are, however, possible.

element CharacterDefType/ModifierSets/ModifierSet

diagram
type	ModifierSetRefType
attributes	Name   Type   Use   Default   Fixed   Annotation ref   KeyValue   required         documentation  Refers to a modifier set (Terminology/Modifiers/Sets/Set) debugref   xs:string   optional         documentation
identity constraints	Name   Refer   Selector   Field(s)   keyref   ModifierSetKeyref   ModifierSetKey   .   @ref
annotation	documentation  Multiple modifier sets can be referenced in each character. The applicable modifiers are the union of all modifiers in the referenced sets (duplicates are ignored)[ATTR: ref]

complexType CharacterMeasureDataType

diagram
type	extension of CharacterStateData_BaseType
used by	element  CharacterDataType/StatisticalMeasure complexType  CharacterMeasureNLDType
attributes	Name   Type   Use   Default   Fixed   Annotation ref   KeyValue   required         documentation  ref refers to a character state key debugref   xs:string   optional         documentation  Value   xs:double   required
annotation	documentation  Similar to CharacterStateDataType, this one is intended for statistical measures. The ref attribute points to a statistical measure definition inside a character definition.@@Note: the necessity of Note inside statistical measures needs to be discussed. On measures like min, max, mean this will be difficult to support during natural language reporting! However, on measures like sample size they may be valuable.

element CharacterMeasureDataType/Probability

diagram
type	ProbabilityModifierRefType
attributes	Name   Type   Use   Default   Fixed   Annotation ref   KeyValue   required         documentation  Refers to an probability modifier debugref   xs:string   optional         documentation
identity constraints	Name   Refer   Selector   Field(s)   keyref   ProbModifierKeyref_StatMeasure   ProbModifierKey   .   @ref
annotation	documentation  Expressions of probability:'probably', 'perhaps', etc. are defined for numeric values and statistical measures. Frequency expressions are considered not applicable to statistical measures![ATTR: ref]

complexType CharacterMeasureNLDType

diagram
type	restriction of CharacterMeasureDataType
used by	element  CharacterNLDType/StatisticalMeasure
attributes	Name   Type   Use   Default   Fixed   Annotation ref   KeyValue   required         documentation  ref refers to a character state key debugref   xs:string   optional         documentation  Value   xs:double   required
annotation	documentation  Variant to be used inside the NaturalLanguageDescription markup container.

element CharacterMeasureNLDType/Text

diagram
type	MarkupTextType
attributes	Name   Type   Use   Default   Fixed   Annotation parsed   xs:boolean   optional

element CharacterMeasureNLDType/Note

diagram
type	ReportedNoteType
identity constraints	Name   Refer   Selector   Field(s)   unique   NLDMeasure_UniqueNoteRepresentation      Representation   @audience
annotation	documentation  Public notes or comments (for multiple audiences, esp. languages) associated with the state.

element CharacterMeasureNLDType/Probability

diagram
type	ProbabilityModifierNLDType
attributes	Name   Type   Use   Default   Fixed   Annotation ref   KeyValue   required         documentation  Refers to an probability modifier debugref   xs:string   optional         documentation
identity constraints	Name   Refer   Selector   Field(s)   keyref   ProbModifierKeyref_StatMeasureNLD   ProbModifierKey   .   @ref
annotation	documentation  Expressions of probability: 'probably', 'perhaps', etc. are defined for numeric values. Note that frequency expressions are not defined here![ATTR: ref]

complexType CharacterNLDType

diagram
type	restriction of CharacterDataType
used by	elements  NaturalLanguageDescriptionType/DescriptionData/Character GroupNLDType/Character
attributes	Name   Type   Use   Default   Fixed   Annotation ref   KeyValue   required         documentation  ref refers to a character definition key (Terminology/Characters/Character) debugref   xs:string   optional         documentation
annotation	documentation  For NaturalLanguageDescriptions.The sequence and cardinality of elements is undefined and Text elements may be freely interspersed.

element CharacterNLDType/Text

diagram
type	MarkupTextType
attributes	Name   Type   Use   Default   Fixed   Annotation parsed   xs:boolean   optional
annotation	documentation  Any text within a character not yet identified a one of the following elements.[ATTR: parsed]

element CharacterNLDType/State

diagram
type	CharacterStateNLDType
attributes	Name   Type   Use   Default   Fixed   Annotation ref   KeyValue   required         documentation  ref refers to a character state key debugref   xs:string   optional         documentation
identity constraints	Name   Refer   Selector   Field(s)   keyref   CharacterStateKeyref_NLD   CharacterStateKey   .   @ref
annotation	documentation  Character state data that permit Text elements within.[ATTR: ref]

element CharacterNLDType/StatisticalMeasure

diagram
type	CharacterMeasureNLDType
attributes	Name   Type   Use   Default   Fixed   Annotation ref   KeyValue   required         documentation  ref refers to a character state key debugref   xs:string   optional         documentation  Value   xs:double   required
identity constraints	Name   Refer   Selector   Field(s)   keyref   CharacterStatMeasureKeyref_NLD   CharacterStatMeasureKey   .   @ref
annotation	documentation  Statistical measure that permits Text elements within.[ATTR: ref, Value]