element <codeBook> (global)
Namespace:
ddi:codebook:2_5
Type:
codeBookType
Content:
complex, 10 attributes, 5 elements
Defined:
globally in codebook.xsd; see XML source
Used:
never
XML Representation Summary
<codeBook
   
ID
 = 
 xs:ID
xml-lang
 = 
 xs:NMTOKEN
xml:lang
 = 
 xs:language
source
 = 
 ("archive" | "producer") : "producer"
elementVersion
 = 
 xs:string
elementVersionDate
 = 
 (xs:dateTime | xs:date | xs:gYearMonth | xs:gYear)
ddiLifecycleUrn
 = 
 xs:anyURI
ddiCodebookUrn
 = 
 xs:anyURI
version
 = 
 "2.5"
codeBookAgency
 = 
 xs:NCName
    >
   
Content: 
 docDscr*, stdyDscr+, fileDscr*, dataDscr*, otherMat*
</codeBook>
Content model elements (5):
dataDscr, docDscr, fileDscr, otherMat, stdyDscr
Annotation

Codebook

Description

Every element in the DDI DTD/Schema has the following attributes:

ID - This uniquely identifies each element.

xml-lang - Use of this attribute is deprecated, and it will no longer be supported in the next major version of the DDI specification. For newly created XML documents, please use xml:lang.

xml:lang - This attribute specifies the language used in the contents and attribute values of any element in the XML document. Use of ISO (www.iso.org) language codes is recommended.

source - This attribute identifies the source that provided information in the element. If the documentation contains two differing sets of information on Sampling Procedure -- one provided by the data producer and one by the archive where the data is deposited -- this information can be distinguished through the use of the source attribute.

Note also that the DDI contains a linking mechanism permitting arbitrary links between internal elements (See Link) and from internal elements to external sources (See ExtLink).

The top-level element, codeBook, also includes a version attribute to specify the version number of the DDI specification.

codeBookAgency - This attribute holds the agency name of the creator or maintainer of the codeBook instance as a whole, and is designed to support forward compatibility with DDI-Lifecycle. Recommend the agency name as filed with the DDI Agency ID Registry with optional additional sub-agency extensions.

XML Source (w/o annotations (1); see within schema source)
<xs:element name="codeBook" type="codeBookType"/>
Attribute Detail (all declarations; 10/10)
codeBookAgency
Type:
xs:NCName, predefined
Use:
optional
Defined:
locally within codeBookType complexType
XML Source (see within schema source)
<xs:attribute name="codeBookAgency" type="xs:NCName" use="optional"/>
ddiCodebookUrn
Type:
xs:anyURI, predefined
Use:
optional
Defined:
locally within GLOBALS attributeGroup
Used to capture the DDI-Codebook type URN for the element. This is used to assign a DDI-Codebook specific URN to the element, according the format prescribed by the DDI-Codebook standard.
XML Source (w/o annotations (1); see within schema source)
<xs:attribute name="ddiCodebookUrn" type="xs:anyURI" use="optional"/>
ddiLifecycleUrn
Type:
xs:anyURI, predefined
Use:
optional
Defined:
locally within GLOBALS attributeGroup
Used to capture the DDI-Lifecycle type URN for the element. This may be captured during translation from DDI-Lifecycle to DDI-Codebook structure or in preparation for transferring to a DDI-Lifecycle structure.
XML Source (w/o annotations (1); see within schema source)
<xs:attribute name="ddiLifecycleUrn" type="xs:anyURI" use="optional"/>
elementVersion
Type:
xs:string, predefined
Use:
optional
Defined:
locally within GLOBALS attributeGroup
Captures version of the element
XML Source (w/o annotations (1); see within schema source)
<xs:attribute name="elementVersion" type="xs:string" use="optional"/>
elementVersionDate
Type:
dateSimpleType
Use:
optional
Defined:
locally within GLOBALS attributeGroup
Indicates version date for the element. Use YYYY-MM-DD, YYYY-MM, or YYYY formats.
Attribute Value
xs:dateTime | xs:date | xs:gYearMonth | xs:gYear
XML Source (w/o annotations (1); see within schema source)
<xs:attribute name="elementVersionDate" type="dateSimpleType" use="optional"/>
ID
Type:
xs:ID, predefined
Use:
optional
Defined:
locally within GLOBALS attributeGroup
XML Source (see within schema source)
<xs:attribute name="ID" type="xs:ID" use="optional"/>
source
Type:
anonymous simpleType (restriction of xs:NMTOKEN)
Use:
optional
Defined:
locally within GLOBALS attributeGroup
Attribute Value
enumeration of xs:NMTOKEN
Enumeration:
 "archive", "producer"
Default:
"producer"
Anonymous simpleType
Type Derivation Tree
xs:NMTOKEN (restriction)
  simpleType
Derivation:
restriction of xs:NMTOKEN
Facets:
enumeration:
"archive", "producer"
XML Source (see within schema source)
<xs:attribute default="producer" name="source">
<xs:simpleType>
<xs:restriction base="xs:NMTOKEN">
<xs:enumeration value="archive"/>
<xs:enumeration value="producer"/>
</xs:restriction>
</xs:simpleType>
</xs:attribute>
version
Type:
xs:string, predefined
Use:
optional
Defined:
locally within codeBookType complexType
Attribute Value
Fixed:
"2.5"
XML Source (see within schema source)
<xs:attribute fixed="2.5" name="version" type="xs:string"/>
xml-lang
Type:
xs:NMTOKEN, predefined
Use:
optional
Defined:
locally within GLOBALS attributeGroup
DO NOT USE THIS ATTRIBUTE. Its inclusion is an error that was persisted to retain backward compatibility. If this attribute has been used, transfer the content to xml:lang.
XML Source (w/o annotations (1); see within schema source)
<xs:attribute name="xml-lang" type="xs:NMTOKEN" use="optional"/>
xml:lang
Type:
xs:language, predefined
Use:
optional
Defined:
by reference within GLOBALS attributeGroup
XML Source (see within schema source)
<xs:attribute ref="xml:lang" use="optional"/>
Content Element Detail (all declarations; 5/5)
dataDscr
Type:
dataDscrType, complex content
Defined:
by reference within codeBookType complexType
XML Source (see within schema source)
<xs:element maxOccurs="unbounded" minOccurs="0" ref="dataDscr"/>
docDscr
Type:
docDscrType, complex content
Defined:
by reference within codeBookType complexType
XML Source (see within schema source)
<xs:element maxOccurs="unbounded" minOccurs="0" ref="docDscr"/>
fileDscr
Type:
fileDscrType, complex content
Defined:
by reference within codeBookType complexType
XML Source (see within schema source)
<xs:element maxOccurs="unbounded" minOccurs="0" ref="fileDscr"/>
otherMat
Type:
otherMatType, complex content
Defined:
by reference within codeBookType complexType
This should be used for materials that are primarily descriptions of the content and use of the study, such as appendices, sampling information, weighting details, methodological and technical details, publications based upon the study content, related studies or collection of studies, etc. This section is intended to include or to link to materials used in the production of the study or useful in the analysis of the study.
XML Source (w/o annotations (1); see within schema source)
<xs:element maxOccurs="unbounded" minOccurs="0" ref="otherMat"/>
stdyDscr
Type:
stdyDscrType, complex content
Defined:
by reference within codeBookType complexType
XML Source (see within schema source)
<xs:element maxOccurs="unbounded" ref="stdyDscr"/>
XML schema documentation generated with DocFlex/XML 1.8.7 using DocFlex/XML XSDDoc 2.7.0 template set