Document Description
(Codebook Header)
Document
|---DOCUMENT DESCRIPTION
|---Study Description
|---Data Files Description
|---Variables Description
|---Dataset Information
|---Other Study-Related Materials
The Document Description, or codebook header, consists of bibliographic information describing the marked-up codebook, or document instance, itself; it contains the basic elements necessary to uniquely identify the marked-up codebook. Note that the Document Description also contains a citation section for the source documentation -- that is, the hardcopy or electronic codebook that served as the source for the marked-up codebook.
Note also that some content of the Document Description's Citation -- e.g., Responsibility Statement -- may be identical to those of the Citation for the data collection.
Since the Document Description section may be used to identify the electronic codebook within an electronic resource discovery environment, this section should be as complete as possible.
To comply with the Dublin Core, it is recommended that the following elements in the Document Description be used when the appropriate information is available:
DUBLIN CORE DDI
------------------
Title 1.1.1.1 title (Title of Documentation)
Creator 1.1.2.1 AuthEnty (Authoring Entity)
Publisher 1.1.3.1 producer (Producer)
[NOTE: The Dublin Core specifies that the
publisher should be "the entity
responsible for making the resource
available *in its present form*"
(emphasis added). For a DDI codebook
the publisher should be the entity
responsible for making the
*electronic* version available.
Contributor 1.1.2.3 othId (Other Ident. & Acknowl.)
Date 1.1.3.3 prodDate (Date of Production)
[NOTE: The DC Date element
should refer to the date the
electronic resource (e.g., the DDI
version of the codebook) was created,
not any preceding paper version.]
Identifier Suggested DC Identifier: URL for DDI
Codebook, if applicable.
Alternatively, use the IDNo element within
the Document Description citation element.
Relation Partially maps to 1.4 docSrc (Documentation
Source). No mapping currently exists
for the relation type component.
Rights 1.1.3.2 copyright (Copyright)
Document Description
- Optional
- Not Repeatable
- Attributes: ID, xml:lang, source
- Contains Elements:
- Citation (of Documentation)
- Guide to Documentation
- Documentation Status
- Documentation Source
- Citation for the marked-up documentation. This element encodes the bibliographic information describing the electronic codebook, including title information, statement of responsibility, production and distribution information, series and version information, text of a preferred bibliographic citation, and notes (if any). It uses generic element A.6, found at the end of the DTD. A MARCURI attribute is provided to link to the MARC record for this citation.
- Optional
- Not Repeatable
- Attributes: ID, xml:lang, source, MARCURI
- Contains Elements:
- Title (of Documentation) Statement
- Responsibility (for Documentation) Statement
- Production (of Documentation) Statement
- Distributor (of Documentation) Statement
- Documentation Series Statement
- Documentation Version Statement
- Bibliographic Citation of Documentation
- Holdings Information for Documentation
- Notes
- Title (of Documentation) Statement
- Title statement for the documentation.
- Required
- Not Repeatable
- Attributes: ID, xml:lang, source
- Contains Elements:
- Title
- Subtitle
- Alternative Title
- Parallel Title
- ID Number
- Title
- Contains the full authoritative title of the documentation describing a data collection. This will in most cases be identical to the title of the data collection described. A full title should indicate the geographic scope of the data collection as well as the time period covered. Equivalent to Dublin Core Title.
- Example:
<titl>Domestic Violence Experience in Omaha, Nebraska, 1986-1987</titl>
- Required
- Not Repeatable
- Attributes: ID, xml:lang, source
- Contains #PCDATA.
- Subtitle
- A subtitle is a secondary title used to amplify or state certain limitations of the main title.
- Example:
<titl>Monitoring the Future: A Continuing Study of American Youth, 1995</titl>
<subTitl>A Continuing Study of American Youth, 1995</subTitl>
- Optional
- Repeatable
- Attributes: ID, xml:lang, source
- Contains #PCDATA.
- Alternative Title
- The alternative title may be the title by which a data collection is commonly referred or it may be an abbreviation for the title.
- Examples:
The Panel Study of Income Dynamics is often referred to as "PSID". The Equality of Educational Opportunity (Coleman) Study (EEOS), 1966, is often referred to as "The Coleman Study".
<altTitl>PSID</altTitl>
- Optional
- Repeatable
- Attributes: ID, xml:lang, source
- Contains #PCDATA.
- Parallel Title
- Title translated into another language.
- Example:
<parTitl>Politbarometer, 1997-1995 (Partielle Kumulation)</parTitl>
- Optional
- Repeatable
- Attributes: ID, xml:lang, source
- Contains #PCDATA.
- ID Number
- Unique string or number (producer's/archive's number) for the documentation file -- most likely identical to the number identifying the data collection itself. Equivalent to Dublin Core Identifier.
- Examples:
<IDNo agency='ICPSR'>6678</IDNo>
<IDNo agency='ZA'>2010</IDNo>
- Optional
- Repeatable
- Attributes: ID, xml:lang, source, agency
- Contains #PCDATA.
- Responsibility (for Documentation) Statement
- Responsibility statement for the documentation.
- Optional
- Not Repeatable
- Attributes: ID, xml:lang, source
- Contains Elements:
- Authoring Entity/Primary Investigator
- Other identifications/Acknowledgments
- Authoring Entity/Primary Investigator
- The person, corporate body, or agency responsible for the documentation's substantive and intellectual content. Usually the same as the principal investigator responsible for the data collection. Equivalent to Dublin Core Creator. Repeat the element for each author, and use affiliation attribute if available. Invert first and last name and use comma.
- Examples:
<AuthEnty>United States Department of Commerce. Bureau of the Census</AuthEnty>
<AuthEnty affil='European Commission'>Rabier, Jacques-Rene</AuthEnty>
- Optional
- Repeatable
- Attributes: ID, xml:lang, source, affiliation
- Contains #PCDATA.
- Other identifications/Acknowledgments
- Statements of responsibility not recorded in the title and statement of responsibility areas. Indicate here the persons or bodies connected with the work, or significant persons or bodies connected with previous editions and not already named in the description. Equivalent to Dublin Core Contributor. For example, the name of the person who compiled the documentation might be cited here, using the role and affiliation attributes.
Example:
<OthID role='editor' affil='INRA'>Jane Smith</OthID>
- Optional
- Repeatable
- Attributes: ID, xml:lang, source, type, role, affiliation
- Contains #PCDATA.
- Production (of Documentation) Statement
- Production statement for the documentation. Note: This section pertains to production of the marked-up codebook.
- Optional
- Not Repeatable
- Attributes: ID, xml:lang, source
- Contains Elements:
- Producer
- Copyright
- Date of Production
- Place of Production
- Software Used in Document Production
- Funding Agency
- Grant Number
- Producer
- The producer of the documentation is the person or organization with the financial or administrative responsibility for the physical processes whereby the marked-up codebook was brought into existence. Equivalent to Dublin Core Publisher.
- Example:
<producer abbr='ICPSR' affil='Institute for Social Research'>Inter-university Consortium for Political and Social Research</producer>
- Optional
- Repeatable
- Attributes: ID, xml:lang, source, abbr, affiliation, role
- Contains #PCDATA.
- Copyright Statement (of Documentation)
- Copyright statement for the marked up document. Equivalent to Dublin Core Rights.
Example:
<copyright>Copyright(c) ICPSR, 1998</copyright>
- Optional
- Not Repeatable
- Attributes: ID, xml:lang, source
- Contains #PCDATA.
- Date of Production
- Date the marked-up codebook was produced (not archived). Equivalent to Dublin Core Date. The ISO standard for dates (YYYY-MM-DD) is recommended for use with the date attribute. Example:
<prodDate date='1999-01-25'>January 25, 1999</prodDate>
- Optional
- Repeatable
- Attributes: ID, xml:lang, source
- Contains #PCDATA.
- Place of Production
- Address of the archive or agency that produced the marked-up codebook.
- Example:
<prodPlac> Ann Arbor, MI: Inter-university Consortium for Political and Social Research</prodPlac>
- Optional
- Repeatable
- Attributes: ID, xml:lang, source
- Contains #PCDATA.
- Software Used in Document Production
- Software used to produce the marked-up codebook. A "version" attribute permits specification of the software version number. The "date" attribute is provided to enable specification of the date (if any) for the software release. The ISO standard for dates (YYYY-MM-DD) is recommended for use with the date attribute.
Example:
<software version='8.0'>Arbortext Adept Editor</software>
- Optional
- Not Repeatable
- Attributes: ID, xml:lang, source, date, version
- Contains #PCDATA.
- Funding Agency
- The source(s) of funds for markup production of the documentation.
- Example:
<fundAg abbr='NSF'>National Science Foundation</fundAg>
- Optional
- Repeatable
- Attributes: ID, xml:lang, source, abbr, role
- Contains #PCDATA.
- Grant Number
- The grant/contract number of the project that sponsored the markup effort. If more than one, link to the appropriate agency using the "agency" attribute.
- Example:
<grantNo agency='Bureau of Justice Statistics'> J-LEAA-018-77</grantNo>
- Optional
- Repeatable
- Attributes: ID, xml:lang, source, agency, role
- Contains #PCDATA.
- Distributor (of Documentation) Statement
- Distribution statement for the marked-up codebook.
- Optional
- Not Repeatable
- Attributes: ID, xml:lang, source
- Contains Elements:
- Distributor
- Contact Persons
- Depositor
- Date of Deposit
- Date of Distribution
- Distributor
- The organization designated by the author or producer to generate copies of documentation including any necessary editions or revisions. Distributor of the marked-up codebook. Names and addresses may be specified, and other archives may be co-distributors. A URI attribute is included to provide a URN or URL to of the ordering service or download facility on a website.
- Example:
<dataDist abbr='ICPSR' affil='Institute for Social Research'> Ann Arbor, MI: Inter-university Consortium for Political and Social Research</dataDist>
- Optional
- Repeatable
- Attributes: ID, xml:lang, source, abbreviation, affiliation, URI
- Contains #PCDATA.
- Contact Persons
- Names and addresses of individuals responsible for the marked-up codebook. Individuals listed as contact persons will be used as resource persons regarding problems or questions raised by the user community. The URI attribute should be used to indicate a URN or URL for the homepage of the contact individual. The email attribute is used to indicate an email address for the contact individual.
Example:
<contact affil='University of Wisconsin'>Jane Smith</contact>
- Optional
- Repeatable
- Attributes: ID, xml:lang, source, affiliation, URI, email
- Contains #PCDATA.
- Depositor
- The name of the person (or institution) who provided this marked-up codebook to the archive storing it.
Example:
<depositr abbr='BJS' affil='U.S. Department of Justice'>Bureau of Justice Statistics</depositr>
- Optional
- Repeatable
- Attributes: ID, xml:lang, source, abbreviation, affiliation
- Contains #PCDATA.
- Date of Deposit
- The date that the marked-up codebook was deposited with the archive that originally received the documentation. The ISO standard for dates (YYYY-MM-DD) is recommended for use with the date attribute.
Example:
<depDate date='1999-01-25'>January 25, 1999<depDate/>
- Optional
- Repeatable
- Attributes: ID, xml:lang, source
- Contains #PCDATA.
- Date of Distribution
- The date that the marked-up codebook became operational in a computerized form and available for distribution/presentation. The ISO standard for dates (YYYY-MM-DD) is recommended for use with the date attribute.
Example:
<distDate date='1999-01-25'>January 25, 1999</distDate>
- Optional
- Not Repeatable
- Attributes: ID, xml:lang, source
- Contains #PCDATA.
- Documentation Series Statement
- Series statement for the documentation. The URI attribute is provided to point to a central Internet repository of series information.
- Optional
- Not Repeatable
- Attributes: ID, xml:lang, source, URI
- Contains Elements:
- Series Name
- Series Information
- Series Name
- The name of the documentation series to which this document belongs. This will probably be synonymous with the Series Name for the study or data collection (2.1.5.1).
- Optional
- Repeatable
- Attributes: ID, xml:lang, source, abbreviation
- Contains #PCDATA.
- Series Information
- Contains a history of the documentation series and a summary of those features that apply to the series as a whole. This will probably be synonymous with the Series Information for the study or data collection (2.1.5.2).
- Optional
- Repeatable
- Attributes: ID, xml:lang, source
- Contains #PCDATA.
- Documentation Version Statement
- Version statement for the marked-up codebook.
- Optional
- Repeatable
- Attributes: ID, xml:lang, source
- Contains Elements:
- Version
- Version Responsibility Statement
- Notes
- Version
- Also known as release or edition. If there have been substantive changes to the marked-up codebook since its creation, this statement should be used. The ISO standard for dates (YYYY-MM-DD) is recommended for use with the date attribute.
- Example:
<version type='edition' date='1999-01-25'>Second ICPSR XML Edition</version>
- Optional
- Not Repeatable
- Attributes: ID, xml:lang, source, type, (release, version, edition), date
- Contains #PCDATA.
- Version Responsibility Statement
- Used to indicate the organization or person responsible for the documentation version.
Example:
<verResp>Zentralarchiv fuer Empirische Sozialforschung</verResp>
- Optional
- Not Repeatable
- Attributes: ID, xml:lang, source, affiliation
- Contains #PCDATA. (Or alternatively, all of the elements available under the general responsibility statement above.)
- Notes
- Used to indicate additional information regarding the version or the version responsibility statement, in particular to indicate what makes a new version different from its predecessor. "Notes" sections appear in several places in the DTD. The attributes for notes permit a controlled vocabulary to be developed (type and subject), the level of the DTD to which the note refers to be identified (study, file, variable, etc.), and the author of the note to be indicated (resp).
Example:
<notes resp='Jane Smith'>Revised information on weighting has been added to the codebook since the previous version.</notes>
- Optional
- Not Repeatable
- Attributes: ID, xml:lang, source, type, subject, level, resp
- Contains #PCDATA.
- Bibliographic Citation of Documentation
- Complete bibliographic reference containing all of the standard elements of a citation that can be used to cite the marked-up codebook. The "format" attribute is provided to enable specification of the particular citation style used, e.g., APA, MLA, Chicago, etc.
- Example:
<biblCit> Rabier, Jacques-Rene, and Ronald Inglehart. EURO-BAROMETER 11: YEAR OF THE CHILD IN EUROPE, APRIL 1979 [Codebook file]. Conducted by Institut Francais D'Opinion Publique (IFOP), Paris, et al. ICPSR XML ed. Ann Arbor, MI: Inter-university Consortium for Political and Social Research [producer and distributor], 1981.</biblCit>
- Optional
- Not Repeatable
- Attributes: ID, xml:lang, source, format
- Contains #PCDATA.
- Holdings Information for Documentation
- Information concerning either physical or electronic holdings of the cited work. Attributes include:
location: The physical location where a copy is held
callno: The call number for a work at the location specified
URI: A URN or URL for accessing the electronic copy of the cited work.
- Example:
<holdings>Need example and definition here.<holdings>
- Optional
- Repeatable
- Attributes: ID, xml:lang, source, location, callno, URI
- Contains #PCDATA.
- Notes
- Used to indicate additional information about the citation for the marked-up codebook. "Notes" sections appear in several places in the DTD. The attributes for notes permit a controlled vocabulary to be developed (type and subject), the level of the DTD to which the note refers to be identified (study, file, variable, etc.), and the author of the note to be indicated (resp).
Example:
<notes>This codebook may be viewed with SGML viewer software such as Panorama.</notes>
- Optional
- Not Repeatable
- Attributes: ID, xml:lang, source, type, subject, level, resp
- Contains #PCDATA.
- List of terms and definitions used in the documentation. Provided to assist users in using the document correctly. For an example, see the Codebook Information section of any of the printed, bound codebooks distributed by ICPSR.
- Optional
- Not Repeatable
- Attributes: ID, xml:lang, source
- Contains #PCDATA.
- Use this field to indicate if the documentation is being presented/distributed before it has been finalized. Some data producers and social science data archives employ data processing strategies that provide for release of data and documentation at various stages of processing.
- Optional
- Not Repeatable
- Attributes: ID, xml:lang, source
- Contains #PCDATA.
- These elements describe the source of the marked-up documentation. This may be either a hardcopy or a machine-readable codebook. May partially map to Dublin Core Relation, although no mapping currently exists for the relation type component. If the source for the DDI codebook is a pre-existing paper version, the Dublin Core Source may apply as well, although use of the Source element is deprecated and Relation is preferred. A MARCURI attribute is provided to link to the MARC record for this citation.
- Optional
- Repeatable
- Attributes: ID, xml:lang, source, MARCURI
- Contains Elements:
- Title (of Documentation Source) Statement
- Responsibility (for Documentation Source) Statement
- Production (of Documentation Source) Statement
- Distributor (of Documentation Source) Statement
- Documentation (Source) Series Statement
- Documentation (Source) Version Statement
- Bibliographic Citation of Documentation Source
- Holdings Information for Documentation Source
- Notes
- Title (of Documentation Source) Statement
- Title statement for the documentation source.
- Required
- Not Repeatable
- Attributes: ID, xml:lang, source
- Contains Elements:
- Title
- Subtitle
- Alternative Title
- Parallel Title
- ID Number
- Title
- Contains the full authoritative title of the documentation source. This will in most cases be identical to the title of the marked-up documentation and of the data collection described. A full title should indicate the geographic scope of the data collection as well as the time period covered.
- Example:
<titl>Domestic Violence Experience in Omaha, Nebraska, 1986-1987</titl>
- Required
- Not Repeatable
- Attributes: ID, xml:lang, source
- Contains #PCDATA.
- Subtitle
- A subtitle is a secondary title used to amplify or state certain limitations of the main title.
- Example:
<titl>Monitoring the Future: A Continuing Study of American Youth, 1995</titl>
<subTitl>A Continuing Study of American Youth, 1995</subTitl>
- Optional
- Repeatable
- Attributes: ID, xml:lang, source
- Contains #PCDATA.
- Alternative Title
- The alternative title may be the title by which a data collection is commonly referred or it may be an abbreviation for the title.
- Examples:
The Panel Study of Income Dynamics is often referred to as "PSID". The Equality of Educational Opportunity (Coleman) Study (EEOS), 1966, is often referred to as "The Coleman Study".
<altTitl>PSID</altTitl>
- Optional
- Repeatable
- Attributes: ID, xml:lang, source
- Contains #PCDATA.
- Parallel Title
- Title translated into another language.
- Example:
<parTitl>Politbarometer, 1997-1995 (Partielle Kumulation)</parTitl>
- Optional
- Repeatable
- Attributes: ID, xml:lang, source
- Contains #PCDATA.
- ID Number
- Unique string or number (producer's/archive's number) for the source documentation. Can be identical to the number identifying the data collection itself. For a hardcopy codebook source, this could also be the ISBN Number.
- Examples:
<IDNo>ISBN 0-89138-881-8</IDNo>
<IDNo agency='ZA'>2010</IDNo>
- Optional
- Repeatable
- Attributes: ID, xml:lang, source, agency
- Contains #PCDATA.
- Responsibility (for Documentation Source) Statement
- Responsibility statement for the documentation source.
- Optional
- Not Repeatable
- Attributes: ID, xml:lang, source
- Contains Elements:
- Authoring Entity/Primary Investigator
- Other identifications/Acknowledgments
- Authoring Entity/Primary Investigator
- The person, corporate body, or agency responsible for the documentation source's substantive and intellectual content. Usually the same as the principal investigator responsible for the data collection. Repeat the element for each author, and use affiliation attribute if available. Invert first and last name and use comma.
- Examples:
<AuthEnty>United States Department of Commerce. Bureau of the Census</AuthEnty>
<AuthEnty affil='European Commission'>Rabier, Jacques-Renee </AuthEnty>
- Optional
- Repeatable
- Attributes: ID, xml:lang, source, affiliation
- Contains #PCDATA.
- Other identifications/Acknowledgments
- Statements of responsibility not recorded in the title and statement of responsibility areas. Indicate here the persons or bodies connected with the work, or significant persons or bodies connected with previous editions and not already named in the description. For example, the name of the person who compiled the source documentation might be cited here, using the role and affiliation attributes.
Example:
<OthID role='editor' affil='INRA'>Jane Smith</OthID>
- Optional
- Repeatable
- Attributes: ID, xml:lang, source, type, role, affiliation
- Contains #PCDATA.
- Production (of Documentation Source) Statement
- Production statement for the documentation source.
- Optional
- Not Repeatable
- Attributes: ID, xml:lang, source
- Contains Elements:
- Producer
- Copyright
- Date of Production
- Place of Production
- Software Used in Document Production
- Funding Agency
- Grant Number
- Producer
- The producer of the documentation source is the person or organization with the financial or administrative responsibility for the physical processes whereby the source codebook was brought into existence. Equivalent to Dublin Core Publisher.
- Example:
<producer abbr='ICPSR' affil='Institute for Social Research'>Inter-university Consortium for Political and Social Research</producer>
- Optional
- Repeatable
- Attributes: ID, xml:lang, source, abbr, affiliation, role
- Contains #PCDATA.
- Copyright Statement (of Documentation Source)
- Copyright statement for the documentation source.
Example:
<copyright>Copyright(c) ICPSR, 1998</copyright>
- Optional
- Not Repeatable
- Attributes: ID, xml:lang, source
- Contains #PCDATA.
- Date of Production
- Date the documentation source was produced (not archived). The ISO standard for dates (YYYY-MM-DD) is recommended for use with the date attribute.
Example:
<prodDate date='1999-01-25'>January 25, 1999</prodDate>
- Optional
- Not Repeatable
- Attributes: ID, xml:lang, source
- Contains #PCDATA.
- Place of Production
- Address of the archive or agency that produced the documentation source.
- Example:
<prodPlac> Ann Arbor, MI: Inter-university Consortium for Political and Social Research</prodPlac>
- Optional
- Not Repeatable
- Attributes: ID, xml:lang, source
- Contains #PCDATA.
- Software Used in Document Production
- Software used to produce the documentation source. A "version" attribute permits specification of the software version number. The "date" attribute is provided to enable specification of the date (if any) for the software release. The ISO standard for dates (YYYY-MM-DD) is recommended for use with the date attribute.
Example:
<software version='6.0'>Microsoft Word</software>
- Optional
- Not Repeatable
- Attributes: ID, xml:lang, source, date, version
- Contains #PCDATA.
- Funding Agency
- The source(s) of funds for production of the documentation source.
- Example:
<fundAg abbr='NSF'>National Science Foundation</fundAg>
- Optional
- Repeatable
- Attributes: ID, xml:lang, source, abbr, role
- Contains #PCDATA.
- Grant Number
- The grant/contract number of project that sponsored the documentation source. If more than one, link to the appropriate agency using the "agency" attribute.
- Example:
<grantNo agency='Bureau of Justice Statistics'> J-LEAA-018-77</grantNo>
- Optional
- Repeatable
- Attributes: ID, xml:lang, source, agency, role
- Contains #PCDATA.
- Distributor (of Documentation Source) Statement
- Distribution statement for the documentation source.
- Optional
- Not Repeatable
- Attributes: ID, xml:lang, source
- Contains Elements:
- Distributor
- Contact Persons
- Depositor
- Date of Deposit
- Date of Distribution
- Distributor
- The organization designated by the author or producer to generate copies of documentation source including any necessary editions or revisions. Distributor of the documentation source. Names and addresses may be specified, and other archives may be co-distributors. A URI attribute is included to provide a URN or URL to of the ordering service or download facility on a website.
- Example:
<dataDist abbr='ICPSR' affil='Institute for Social Research'> Ann Arbor, MI: Inter-university Consortium for Political and Social Research</dataDist>
- Optional
- Repeatable
- Attributes: ID, xml:lang, source, abbreviation, affiliation, URI
- Contains #PCDATA.
- Contact Persons
- Names and addresses of individuals responsible for the documentation source. Individuals listed as contact persons will be used as resource persons regarding problems or questions raised by the user community. The URI attribute should be used to indicate a URN or URL for the homepage of the contact individual. The email attribute is used to indicate an email address for the contact individual.
Example:
<contact affil='University of Wisconsin'>Jane Smith</contact>
- Optional
- Repeatable
- Attributes: ID, xml:lang, source, affiliation, URI, email
- Contains #PCDATA.
- Depositor
- The name of the person (or institution) who provided the documentation source to the archive storing it.
Example:
<depositr abbr='BJS' affil='U.S. Department of Justice'>Bureau of Justice Statistics</depositr>
- Optional
- Repeatable
- Attributes: ID, xml:lang, source, abbreviation, affiliation
- Contains #PCDATA.
- Date of Deposit
- The date that the documentation source was deposited with the archive that originally received the documentation. The ISO standard for dates (YYYY-MM-DD) is recommended for use with the date attribute.
Example:
<depDate date='1999-01-25'>January 25, 1999</depDate>
- Optional
- Repeatable
- Attributes: ID, xml:lang, source
- Contains #PCDATA.
- Date of Distribution
- The date that the documentation source became operational and available for distribution. The ISO standard for dates (YYYY-MM-DD) is recommended for use with the date attribute.
Example:
<distDate date='1999-01-25'>January 25, 1999</distDate>
- Optional
- Not Repeatable
- Attributes: ID, xml:lang, source
- Contains #PCDATA.
- Documentation (Source) Series Statement
- Series statement for the documentation source. The URI attribute is provided to point to a central Internet repository of series information.
- Optional
- Not Repeatable
- Attributes: ID, xml:lang, source, URI
- Contains Elements:
- Series Name
- Series Information
- Series Name
- The name of the documentation series to which this document belongs. This will probably be synonymous with the Series Name for the study or data collection (2.1.5.1).
- Optional
- Repeatable
- Attributes: ID, xml:lang, source, abbreviation
- Contains #PCDATA.
- Series Information
- Contains a history of the documentation series and a summary of those features that apply to the series as a whole. This will probably be synonymous with the Series Information for the study or data collection (2.1.5.2).
- Optional
- Repeatable
- Attributes: ID, xml:lang, source
- Contains #PCDATA.
- Documentation (Source) Version Statement
- Version statement for the documentation source.
- Optional
- Repeatable
- Attributes: ID, xml:lang, source
- Contains Elements:
- Version
- Version Responsibility Statement
- Notes
- Version
- Also known as release or edition. If there have been substantive changes to the documentation source since its creation, this statement should be used. The ISO standard for dates (YYYY-MM-DD) is recommended for use with the date attribute.
- Example:
<version type='edition' date='1999-01-25'>Second ICPSR Edition</version>
- Optional
- Not Repeatable
- Attributes: ID, xml:lang, source, type, (release, version, edition), date
- Contains #PCDATA.
- Version Responsibility Statement
- Used to indicate the organization or person responsible for the documentation source version.
Example:
<verResp>Zentralarchiv fuer Empirische Sozialforschung</verResp>
- Optional
- Not Repeatable
- Attributes: ID, xml:lang, source
- Contains #PCDATA. (Or alternatively, all of the elements available under the general responsibility statement above.)
- Notes
- Used to indicate additional information regarding the version or the version responsibility statement, in particular to indicate what makes a new version different from its predecessor. "Notes" sections appear in several places in the DTD. The attributes for notes permit a controlled vocabulary to be developed (type and subject), the level of the DTD to which the note refers to be identified (study, file, variable, etc.), and the author of the note to be indicated (resp).
Example:
<notes resp='Jane Smith'>Revised information on weighting has been added to the codebook since the previous version.</notes>
- Optional
- Not Repeatable
- Attributes: ID, xml:lang, source, type, subject, level, resp
- Contains #PCDATA.
- Bibliographic Citation of Documentation
- Complete bibliographic reference containing all of the standard elements of a citation that can be used to cite the documentation source. The "format" attribute is provided to enable specification of the particular citation style used, e.g., APA, MLA, Chicago, etc.
- Example:
<biblCit> Rabier, Jacques-Rene, and Ronald Inglehart. EURO-BAROMETER 11: YEAR OF THE CHILD IN EUROPE, APRIL 1979 [Codebook file]. Conducted by Institut Francais D'Opinion Publique (IFOP), Paris, et al. ICPSR ed. Ann Arbor, MI: Inter-university Consortium for Political and Social Research [producer and distributor], 1981.</biblCit>
- Optional
- Not Repeatable
- Attributes: ID, xml:lang, source, format
- Contains #PCDATA.
- Holdings Information (for Documentation Source)
- Information concerning either physical or electronic holdings of the cited work. Attibutes include:
location: The physical location where a copy is held
callno: The call number for a work at the location specified
URI: A URN or URL for accessing the electronic copy of the cited work.
- Example:
<holdings>Need example and definition here.<holdings>
- Optional
- Repeatable
- Attributes: ID, xml:lang, source, location, callno, URI
- Contains #PCDATA.
- Notes
- Used to indicate additional information about the citation for the documentation source. "Notes" sections appear in several places in the DTD. The attributes for notes permit a controlled vocabulary to be developed (type and subject), the level of the DTD to which the note refers to be identified (study, file, variable, etc.), and the author of the note to be indicated (resp).
Example:
<notes>This version of the hardcopy codebook is out of print.</notes>
- Optional
- Not Repeatable
- Attributes: ID, xml:lang, source, type, subject, level, resp
- Contains #PCDATA.
- Used to indicate additional information about the the documentation source. "Notes" sections appear in several places in the DTD. The attributes for notes permit a controlled vocabulary to be developed (type and subject), the level of the DTD to which the note refers to be identified (study, file, variable, etc.), and the author of the note to be indicated (resp).
Example:
<notes>This hardcopy codebook is available free to members of ICPSR.</notes>
- Optional
- Not Repeatable
- Attributes: ID, xml:lang, source, type, subject, level, resp
- Contains #PCDATA.
Return to the DDI Tag Library.
Comments to: ddi@icpsr.umich.edu)
Last update: 1999/11/18