element <varFormat> (global)
Namespace:
ddi:codebook:2_5
Type:
varFormatType
Content:
mixed (allows character data), 15 attributes, 24 elements
Defined:
globally in codebook.xsd; see XML source
Used:
at 1 location
XML Representation Summary
<varFormat
   
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
type
 = 
 ("character" | "numeric") : "numeric"
formatname
 = 
 xs:string
schema
 = 
 ("SAS" | "SPSS" | "IBM" | "ANSI" | "ISO" | "XML-Data" | "other") : "ISO"
otherSchema
 = 
 xs:NMTOKEN
category
 = 
 ("date" | "time" | "currency" | "other") : "other"
otherCategory
 = 
 xs:NMTOKEN
URI
 = 
 xs:string
    >
   
Content: 
 {text} × (ExtLink* | Link* | div | emph | head | hi | list | p | xhtml:h1 | xhtml:h2 | xhtml:h3 | xhtml:h4 | xhtml:h5 | xhtml:h6 | xhtml:ul | xhtml:ol | xhtml:dl | xhtml:p | xhtml:div | xhtml:pre | xhtml:blockquote | xhtml:address | xhtml:hr | xhtml:table)*
</varFormat>
Content model elements (24):
ExtLink, Link, div, emph, head, hi, list, p, xhtml:address, xhtml:blockquote, xhtml:div, xhtml:dl, xhtml:h1, xhtml:h2, xhtml:h3, xhtml:h4, xhtml:h5, xhtml:h6, xhtml:hr, xhtml:ol, xhtml:p, xhtml:pre, xhtml:table, xhtml:ul
Included in content model of elements (1):
var
Known Usage Locations
Annotation

Variable Format

Description

The technical format of the variable in question. Attributes for this element include: "type," which indicates if the variable is character or numeric; "formatname," which in some cases may provide the name of the particular, proprietary format actually used; "schema," which identifies the vendor or standards body that defined the format (acceptable choices are SAS, SPSS, IBM, ANSI, ISO, XML-data or other); "category," which describes what kind of data the format represents, and includes date, time, currency, or "other" conceptual possibilities; and "URI," which supplies a network identifier for the format definition. If the "other" value is used for the schema attribute, a value from a controlled vocabulary must be used with the "otherSchema" attribute, and the complex element controlledVocabUsed should be used to identify the controlled vocabulary to which the selected term belongs. For the category attribute, a value from a controlled vocabulary may be provided if the "other" value is chosen. In this case, the term from the controlled vocabulary should be placed in the "othercategory" attribute, and the controlledVocabUsed element should also be filled in.

Example

<var> <varFormat type="numeric" schema="SAS" formatname="DATE" category="date">The number in this variable is stored in the form 'ddmmmyy' in SAS format.</varFormat> </var> <var> <varFormat type="numeric" formatname="date.iso8601" schema="XML-Data" category="date" URI="http://www.w3.org/TR/1998/NOTE-XML-data/">19541022</varFormat> </var>
XML Source (w/o annotations (1); see within schema source)
<xs:element name="varFormat" type="varFormatType"/>
Attribute Detail (all declarations; 15/15)
category
Type:
anonymous simpleType (restriction of xs:NMTOKEN)
Use:
optional
Defined:
locally within varFormatType complexType
Attribute Value
enumeration of xs:NMTOKEN
Enumeration:
 "date", "time", "currency", "other"
Default:
"other"
Anonymous simpleType
Type Derivation Tree
xs:NMTOKEN (restriction)
  simpleType
Derivation:
restriction of xs:NMTOKEN
Facets:
enumeration:
"date", "time", "currency", "other"
XML Source (see within schema source)
<xs:attribute default="other" name="category">
<xs:simpleType>
<xs:restriction base="xs:NMTOKEN">
<xs:enumeration value="date"/>
<xs:enumeration value="time"/>
<xs:enumeration value="currency"/>
<xs:enumeration value="other"/>
</xs:restriction>
</xs:simpleType>
</xs:attribute>
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"/>
formatname
Type:
xs:string, predefined
Use:
optional
Defined:
locally within varFormatType complexType
XML Source (see within schema source)
<xs:attribute name="formatname" type="xs:string"/>
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"/>
otherCategory
Type:
xs:NMTOKEN, predefined
Use:
optional
Defined:
locally within varFormatType complexType
XML Source (see within schema source)
<xs:attribute name="otherCategory" type="xs:NMTOKEN" use="optional"/>
otherSchema
Type:
xs:NMTOKEN, predefined
Use:
optional
Defined:
locally within varFormatType complexType
XML Source (see within schema source)
<xs:attribute name="otherSchema" type="xs:NMTOKEN" use="optional"/>
schema
Type:
anonymous simpleType (restriction of xs:NMTOKEN)
Use:
optional
Defined:
locally within varFormatType complexType
Attribute Value
enumeration of xs:NMTOKEN
Enumeration:
 "SAS", "SPSS", "IBM", "ANSI", "ISO", "XML-Data", "other"
Default:
"ISO"
Anonymous simpleType
Type Derivation Tree
xs:NMTOKEN (restriction)
  simpleType
Derivation:
restriction of xs:NMTOKEN
Facets:
enumeration:
"SAS", "SPSS", "IBM", "ANSI", "ISO", "XML-Data", "other"
XML Source (see within schema source)
<xs:attribute default="ISO" name="schema">
<xs:simpleType>
<xs:restriction base="xs:NMTOKEN">
<xs:enumeration value="SAS"/>
<xs:enumeration value="SPSS"/>
<xs:enumeration value="IBM"/>
<xs:enumeration value="ANSI"/>
<xs:enumeration value="ISO"/>
<xs:enumeration value="XML-Data"/>
<xs:enumeration value="other"/>
</xs:restriction>
</xs:simpleType>
</xs:attribute>
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>
type
Type:
anonymous simpleType (restriction of xs:NMTOKEN)
Use:
optional
Defined:
locally within varFormatType complexType
Attribute Value
enumeration of xs:NMTOKEN
Enumeration:
 "character", "numeric"
Default:
"numeric"
Anonymous simpleType
Type Derivation Tree
xs:NMTOKEN (restriction)
  simpleType
Derivation:
restriction of xs:NMTOKEN
Facets:
enumeration:
"character", "numeric"
XML Source (see within schema source)
<xs:attribute default="numeric" name="type">
<xs:simpleType>
<xs:restriction base="xs:NMTOKEN">
<xs:enumeration value="character"/>
<xs:enumeration value="numeric"/>
</xs:restriction>
</xs:simpleType>
</xs:attribute>
URI
Type:
xs:string, predefined
Use:
optional
Defined:
locally within varFormatType complexType
XML Source (see within schema source)
<xs:attribute name="URI" 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; 24/24)
div
Type:
divType, complex content
Defined:
by reference within FORM group
XML Source (see within schema source)
<xs:element ref="div"/>
emph
Type:
emphType, mixed content
Defined:
by reference within FORM group
XML Source (see within schema source)
<xs:element ref="emph"/>
ExtLink
Type:
ExtLinkType, mixed content
Defined:
by reference within PHRASE group
XML Source (see within schema source)
<xs:element maxOccurs="unbounded" minOccurs="0" ref="ExtLink"/>
head
Type:
headType, mixed content
Defined:
by reference within FORM group
XML Source (see within schema source)
<xs:element ref="head"/>
hi
Type:
hiType, mixed content
Defined:
by reference within FORM group
XML Source (see within schema source)
<xs:element ref="hi"/>
Link
Type:
LinkType, mixed content
Defined:
by reference within PHRASE group
XML Source (see within schema source)
<xs:element maxOccurs="unbounded" minOccurs="0" ref="Link"/>
list
Type:
listType, complex content
Defined:
by reference within FORM group
XML Source (see within schema source)
<xs:element ref="list"/>
p
Type:
pType, mixed content
Defined:
by reference within FORM group
XML Source (see within schema source)
<xs:element ref="p"/>
xhtml:address
Type:
xhtml:address.type, mixed content
Defined:
by reference within xhtml:BlkPhras.class group
XML Source (see within schema source)
<xs:element ref="address"/>
xhtml:blockquote
Type:
xhtml:blockquote.type, complex content
Defined:
by reference within xhtml:BlkPhras.class group
XML Source (see within schema source)
<xs:element ref="blockquote"/>
xhtml:div
Type:
xhtml:div.type, mixed content
Defined:
by reference within xhtml:BlkStruct.class group
XML Source (see within schema source)
<xs:element ref="div"/>
xhtml:dl
Type:
xhtml:dl.type, complex content
Defined:
by reference within xhtml:List.class group
XML Source (see within schema source)
<xs:element ref="dl"/>
xhtml:h1
Type:
xhtml:h1.type, mixed content
Defined:
by reference within xhtml:Heading.class group
XML Source (see within schema source)
<xs:element ref="h1"/>
xhtml:h2
Type:
xhtml:h2.type, mixed content
Defined:
by reference within xhtml:Heading.class group
XML Source (see within schema source)
<xs:element ref="h2"/>
xhtml:h3
Type:
xhtml:h3.type, mixed content
Defined:
by reference within xhtml:Heading.class group
XML Source (see within schema source)
<xs:element ref="h3"/>
xhtml:h4
Type:
xhtml:h4.type, mixed content
Defined:
by reference within xhtml:Heading.class group
XML Source (see within schema source)
<xs:element ref="h4"/>
xhtml:h5
Type:
xhtml:h5.type, mixed content
Defined:
by reference within xhtml:Heading.class group
XML Source (see within schema source)
<xs:element ref="h5"/>
xhtml:h6
Type:
xhtml:h6.type, mixed content
Defined:
by reference within xhtml:Heading.class group
XML Source (see within schema source)
<xs:element ref="h6"/>
xhtml:hr
Type:
xhtml:hr.type, empty content
Defined:
by reference within xhtml:BlkPres.class group
XML Source (see within schema source)
<xs:element ref="hr"/>
xhtml:ol
Type:
xhtml:ol.type, complex content
Defined:
by reference within xhtml:List.class group
XML Source (see within schema source)
<xs:element ref="ol"/>
xhtml:p
Type:
xhtml:p.type, mixed content
Defined:
by reference within xhtml:BlkStruct.class group
XML Source (see within schema source)
<xs:element ref="p"/>
xhtml:pre
Type:
xhtml:pre.type, mixed content
Defined:
by reference within xhtml:BlkPhras.class group
XML Source (see within schema source)
<xs:element ref="pre"/>
xhtml:table
Type:
xhtml:table.type, complex content
Defined:
by reference within xhtml:Table.class group
XML Source (see within schema source)
<xs:element ref="table"/>
xhtml:ul
Type:
xhtml:ul.type, complex content
Defined:
by reference within xhtml:List.class group
XML Source (see within schema source)
<xs:element ref="ul"/>
XML schema documentation generated with DocFlex/XML 1.8.7 using DocFlex/XML XSDDoc 2.7.0 template set