DDI 3.1 XML Schema Documentation (2009-10-18)
© DDI Alliance 2009 - licensed under the terms of the GNU Lesser General Public License
complexType "NoteType"
Namespace:
Content:
complex, 7 attributes, 6 elements
Defined:
globally in reusable.xsd, see XML source
Includes:
definitions of 2 attributes and 5 elements
Used:
XML Representation Summary
<...
    action
 = 
("Add" | "Update" | "Delete")
    id
 = 
xs:string
    isIdentifiable
 = 
"true"
    objectSource
 = 
xs:anyURI
    type
 = 
("Processing" | "Footnote" | "Addendum" | "System" | "Problem" | "Comment" | "Other")
    urn
 = 
xs:anyURI
    xml:lang
 = 
xs:language
    >
   
Content: 
UserID*, Subject?, Relationship+, Responsibility?, Header*, Content+
</...>
Content Model Elements (6):
All Direct / Indirect Based Elements (1):
Known Usage Locations
Annotation
Includes a footnote or annotation to a section of the documentation, and is designed to be an inherent part of the DDI. (Unlike XML comments or other types of system-level annotations, which may be removed during processing.)
Type Definition Detail
Type Derivation Tree
  IdentifiableType (extension)
      NoteType (extension)
XML Source (w/o annotations (7); see within schema source)
<xs:complexType name="NoteType">
<xs:complexContent>
<xs:extension base="IdentifiableType">
<xs:sequence>
<xs:element minOccurs="0" name="Subject" type="CodeValueType"/>
<xs:element maxOccurs="unbounded" ref="Relationship"/>
<xs:element minOccurs="0" name="Responsibility" type="xs:string"/>
<xs:element maxOccurs="unbounded" minOccurs="0" name="Header" type="InternationalStringType"/>
<xs:element maxOccurs="unbounded" minOccurs="1" ref="Content"/>
</xs:sequence>
<xs:attribute ref="xml:lang" use="optional"/>
<xs:attribute name="type" type="NoteTypeCodeType" use="required"/>
</xs:extension>
</xs:complexContent>
</xs:complexType>
Attribute Detail (defined in this component only; 2/7)
type
Type:
Use:
required
Specifies the type of note.
Attribute Value
enumeration of xs:NMTOKEN
Enumeration:
"Processing"
 - 
A note related to the processing.
"Footnote"
 - 
A footnote related to the data or metadata being documented.
"Addendum"
 - 
An addendum to the information contained in a DDI section or module. Information of a factual nature as opposed to commentary.
"System"
 - 
A note generated by the processing system that produced the data or metadata.
"Problem"
 - 
A problem, as reported by a human user or system generated. Generally a temporary note providing information for review and correction.
"Comment"
 - 
A human-readable comment, typically of a more subjective nature than a footnote.
"Other"
 - 
Any other type of note.
XML Source (w/o annotations (1); see within schema source)
<xs:attribute name="type" type="NoteTypeCodeType" use="required"/>

xml:lang
Type:
xs:language, predefined
Use:
optional
XML Source (see within schema source)
<xs:attribute ref="xml:lang" use="optional"/>
Content Element Detail (defined in this component only; 5/6)
Content
Type:
StructuredStringType, mixed content
The content of the note.
XML Source (w/o annotations (1); see within schema source)
<xs:element maxOccurs="unbounded" minOccurs="1" ref="Content"/>

Header
Type:
InternationalStringType, simple content
A brief label or heading for the note contents.
Simple Content
xs:string
XML Source (w/o annotations (1); see within schema source)
<xs:element maxOccurs="unbounded" minOccurs="0" name="Header" type="InternationalStringType"/>

Relationship
Type:
RelationshipType, complex content
Reference to the section of the DDI to which this note is related.
XML Source (w/o annotations (1); see within schema source)
<xs:element maxOccurs="unbounded" ref="Relationship"/>

Responsibility
Type:
xs:string, predefined, simple content
The person or agency responsible for adding the note.
XML Source (w/o annotations (1); see within schema source)
<xs:element minOccurs="0" name="Responsibility" type="xs:string"/>

Subject
Type:
CodeValueType, simple content
The subject of the note.
Simple Content
xs:string
XML Source (w/o annotations (1); see within schema source)
<xs:element minOccurs="0" name="Subject" type="CodeValueType"/>

XML schema documentation generated with DocFlex/XML SDK 1.7.2 using DocFlex/XML XSDDoc 2.1.0 template set