element <embargo> (global)
Namespace:
ddi:codebook:2_5
Type:
embargoType
Content:
mixed (allows character data), 11 attributes, 24 elements
Defined:
globally in codebook.xsd; see XML source
Used:
at 2 locations
XML Representation Summary
<embargo
   
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
date
 = 
 xs:string
event
 = 
 ("notBefore" | "notAfter") : "notBefore"
format
 = 
 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)*
</embargo>
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 (2):
nCube, var
Known Usage Locations
Annotation

Embargo

Description

Provides information on variables/nCubes which are not currently available because of policies established by the principal investigators and/or data producers. The ISO standard for dates (YYYY-MM-DD) is recommended for use with the "date" attribute. An "event" attribute is provided to specify "notBefore" or "notAfter" ("notBefore" is the default). A "format" attribute is provided to ensure that this information will be machine-processable, and specifies a format for the embargo element.

The "format" attribute could be used to specify other conventions for the way that information within the embargo element is set out, if conventions for encoding embargo information were established in the future.

This element may be repeated to support multiple language expressions of the content.

Example

<var> <embargo event="notBefore" date="2001-09-30"> The data associated with this variable/nCube will not become available until September 30, 2001, because of embargo provisions established by the data producers.</embargo> </var>
XML Source (w/o annotations (1); see within schema source)
<xs:element name="embargo" type="embargoType"/>
Attribute Detail (all declarations; 11/11)
date
Type:
xs:string, predefined
Use:
optional
Defined:
locally within simpleTextAndDateType complexType
XML Source (see within schema source)
<xs:attribute name="date" type="xs:string" 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"/>
event
Type:
anonymous simpleType (restriction of xs:NMTOKEN)
Use:
optional
Defined:
locally within embargoType complexType
Attribute Value
enumeration of xs:NMTOKEN
Enumeration:
 "notBefore", "notAfter"
Default:
"notBefore"
Anonymous simpleType
Type Derivation Tree
xs:NMTOKEN (restriction)
  simpleType
Derivation:
restriction of xs:NMTOKEN
Facets:
enumeration:
"notBefore", "notAfter"
XML Source (see within schema source)
<xs:attribute default="notBefore" name="event">
<xs:simpleType>
<xs:restriction base="xs:NMTOKEN">
<xs:enumeration value="notBefore"/>
<xs:enumeration value="notAfter"/>
</xs:restriction>
</xs:simpleType>
</xs:attribute>
format
Type:
xs:string, predefined
Use:
optional
Defined:
locally within embargoType complexType
XML Source (see within schema source)
<xs:attribute name="format" 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"/>
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>
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