Difference between revisions of "Citation Documentation"
(Created page with "Citations in metadata provide important information about how users should cite the resource that is described by the metadata. These citations are an important part of the id...") |
|||
| Line 1: | Line 1: | ||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | + | I need to provide references for datasets and associated resources. | |
| + | |||
| + | == _I need to provide references for datasets and associated resources._ == | ||
| + | |||
| + | = Overview = | ||
| + | |||
| + | ---- | ||
| + | |||
| + | Citations are used to provide information about citing the resource being described in the metadata or to refer to resources outside of the metadata record. These citations are an important part of the identification information and, as such, they are in a special location in the record. In addition, they can provide connection to relevant materials that can not be included in the metadata. | ||
| + | |||
| + | = Structure = | ||
| + | |||
| + | ---- | ||
| + | |||
| + | The CI_Citation includes two required and eleven optional elements and introduces several new objects. The CI_Series object gives the name, issue, and page numbers of an article in a periodical. The ISBN and ISSN elements are internationally recognized identifiers for books and periodicals. The MI_Identifier and CI_Date objects are discussed below. | ||
| + | |||
| + | = Usage = | ||
| + | |||
| + | ---- | ||
| + | |||
| + | CI_Citation serves two purposes in the ISO 19115 Standard. First, it gives the information required to cite the data or the service (the resource) that is being described in the metadata. This CI_Citation can be part of the gmd:MD_DataIdentification or srv:ServiceIdentification objects. | ||
| + | |||
| + | <!-- table start --> | ||
| + | {| border=1 width="100%" cellspacing="0" cellpadding="4" style="border-color:#eee" class="wikitable sortable" | ||
| + | <!-- header row start --> | ||
| + | !Usage!!Description and Xpath | ||
| + | <!-- header row end --> | ||
| + | |- | ||
| + | | Resource Citation<br/> <br/> | ||
| + | |}<!-- table end --> | ||
| + | |||
| + | <br/> | ||
| + | !800px-WhereAreCI_Citations.MD_Identification.png | ||
| + | | thumbnail=true,width=250! | ||
| + | | The Resource Citation includes information that should be used when citing the resource that is being described by the metadata record. It includes descriptions of the people involved in the creation of the resource. They usually have roles of originator, author, or principleInvestigator.<br/> <br/> | ||
| + | |||
| + | An important enhancement to the CI_Citation object occured in ISO 19115-1. The enhancement includes the addition of OnlineResource and BrowseGraphic fields which enable online digital resources and graphics to be referenced from the CI_Citation object. An expanded description is available in the Revisions section of this page.<br/> <br/> | ||
| + | |||
| + | /gmi:MI_Metadata/gmd:identificationInfo/gmd:MD_DataIdentification/gmd:citation<br/> <br/> | ||
| + | |||
| + | or<br/> <br/> | ||
| + | |||
| + | /gmi:MI_Metadata/gmd:identificationInfo/srv:ServiceIdentification/gmd:citation | ||
| + | |||
| + | ~~ATTACHED_IMAGE~~180px-CI_Citation.png | ||
| + | = CI_Citation++ = | ||
| + | |||
| + | ---- | ||
| + | |||
| + | Second, CI_Citations provide information about external references that are related to the resource being described and provide additional documentation. This Figure shows most of the places where CI_Citations occur. Those shown in red were added in ISO 19115-1. In many of these situations the CI_Citation is in an object with a generally small amount of additional annotation information. This additional information is available to the user so they may not need to look up the resource cited in the CI_Citation. These objects are termed CI_Citation++. | ||
| + | |||
| + | The most straightforward member of this group is the MI_Identifier, which includes a code, the identifier, and a CI_Citation for the authority for the code. The MD_Identifier is used throughout the standard to attach a unique identifier to objects, including CI_Citations. | ||
| + | |||
| + | <!-- table start --> | ||
| + | {| border=1 width="100%" cellspacing="0" cellpadding="4" style="border-color:#eee" class="wikitable sortable" | ||
| + | <!-- header row start --> | ||
| + | !Usage!!Description and Xpath | ||
| + | <!-- header row end --> | ||
| + | |- | ||
| + | | Identifier<br/> <br/> | ||
| + | |}<!-- table end --> | ||
| + | |||
| + | <br/> | ||
| + | !180px-WhereAreCI_Citations.MD_Identifier.png! | ||
| + | | CI_Citation + code = MD_Identifier | ||
| + | The MD_Identifier is the simplest of the CI_Citation++ objects. It includes a code and an authority. The code is an alphanumeric value identifying an object in a namespace that is maintained by the authority. In this case the CI_Citation cites the authority for the code. In many ways this is similar to the namespace for the code. It is the authority which understands and can explain or resolve the code. There is no agreed upon approach for how the namespace is described in the CI_Citation.<br/> <br/> | ||
| + | |||
| + | ISO 19115-1 addresses this limitation by adding a codeSpace field to the MD_Identifier object. The codeSpace field unambiguously defines the namespace for the identifier. ISO 19115-1 also includes description and version fields in the MD_Identifier object. The description field enables a brief description of the code to be documented, and the version field enables the the Identifier version to be documented.<br/> | ||
| + | <br/> | ||
| + | //gmd:MD_Identifier | ||
| + | |- | ||
| + | | Reference System Identifier<br/> <br/> | ||
| + | !180px-WhereAreCI_Citations.RS_Identifier.png! | ||
| + | | CI_Citation + code + codeSpace + version = RS_Identifier | ||
| + | The RS_Identifier extends the MD_Identifier by adding a codeSpace and a version for the namespace. These additions address the lack of an agreed upon approach for describing a namespace using the authority/gco:CI_Citation alone. However, the standard only supports RS_Identifiers in the referenceSystemInfo class.<br/> <br/> | ||
| + | |||
| + | Note: In ISO 19115-1 the RS_Identifier object is replaced with an MD_Identifier object which includes codeSpace, version and description fields. See the MD_Identifier description above.<br/> <br/> | ||
| + | |||
| + | <br/> | ||
| + | //gmd:RS_Identifier | ||
| + | |- | ||
| + | | Keyword Thesaurus Citation<br/> <br/> | ||
| + | !180px-WhereAreCI_Citations.MD_Keywords.png! | ||
| + | | CI_Citation + keyword + type = MD_Keywords | ||
| + | The MD_Keywords object is similar to an MD_Identifier in that it gives a keyword that is unique in a "namespace" that is maintained by the individual or organization cited in the thesaurusName. In this case, the type codeList is used to group related keywords.<br/> <br/> | ||
| + | |||
| + | Note: In ISO 19115-1, 10 additional GCMD keyword type codes have been added to the codelist. These codes will help improve consistent data discovery, particularly using faceted searches. <br/> | ||
| + | <br/> | ||
| + | /gmi:MI_Metadata/gmd:identificationInfo/gmd:MD_DataIdentification | ||
| + | | srv:ServiceIdentification/gmd:descriptiveKeywords/gmd:MD_Keywords/gmd:thesaurusName | ||
| + | |- | ||
| + | | Algorithm Citation<br/> <br/> | ||
| + | !180px-WhereAreCI_Citations.LE_Algorithm.png! | ||
| + | | CI_Citation + description = LE_Algorithm | ||
| + | The Algorithm Citation is straightforward. It includes a description that, like the description in the CI_OnlineResource object, should provide information that identifies the algorithm used to process data so that a user can understand that information without following the citation. The description is similar to an abstract for the algorithm referenced in the CI_Citation.<br/> | ||
| + | <br/> | ||
| + | /gmi:MI_Metadata/gmd:dataQualityInfo/gmd:MD_DataQuality/gmd:lineage/gmd:LE_Lineage/gmd:processStep/gmd:LE_ProcessStep/gmd:processingInformation/gmd:LE_Processing/gmd:algorithm/LE_Algorithm/gmd:citation | ||
| + | |- | ||
| + | | Conformance Standard Specification Citation<br/> <br/> | ||
| + | !180px-WhereAreCI_Citations.DQ_ConformanceResult.png! | ||
| + | | CI_Citation + explanation + pass = DQ_ConformanceResult | ||
| + | The DQ_ConformanceResult is a good example of including critical information in the standard while referencing an external resource for more information. In this case the critical information is a brief explanation of the conformance test and the result of the test. If a user needs more information about the specifics of the test, they can follow the citation to the specification. <br/> | ||
| + | <br/> | ||
| + | /gmi:MI_Metadata/gmd:dataQualityInfo/gmd:MD_DataQuality/gmd:report/gmd:DQ_Element/gmd:result/gmd:DQ_Result/gmd:DQ_ConformanceResult/gmd:specification | ||
| + | |- | ||
| + | | Source Citation<br/> <br/> | ||
| + | !180px-WhereAreCI_Citations.LE_Source.png! | ||
| + | | CI_Citation + description + scaleDenominator + sourceReferenceSystem + sourceExtent + processedLevel + resolution + sourceStep = LE_Source. LE_Source fields enable the sources utilized to generate a data product to be described and referenced. Sources are both used and produced by process steps. Documenting the chain of sources and process steps utilized to generated a data product is an important role of high-quality metadata. <br/> | ||
| + | <br/> | ||
| + | /gmi:MI_Metadata/gmd:dataQualityInfo/gmd:MD_DataQuality/gmd:lineage/gmd:LE_Lineage/gmd:source | ||
| + | | gmd:output/gmd:LE_Source/gmd:sourceCitation<br/> <br/> | ||
| + | |||
| + | |||
| + | |- | ||
| + | | Data Quality Evaluation Procedure Citation<br/> <br/> | ||
| + | !180px-WhereAreCI_Citations.DQ_Element.png! | ||
| + | | /gmi:MI_Metadata/gmd:dataQualityInfo/gmd:MD_DataQuality/gmd:report/gmd:DQ_Element/gmd:evaluationProcedure | ||
| + | |- | ||
| + | | Feature Catalog Citation<br/> <br/> | ||
| + | !180px-WhereAreCI_Citations.MD_FeatureCatalogDescription.png! | ||
| + | | /gmi:MI_Metadata/gmd:contentinfo/gmd:MD_ContentInformation/gmd:MD:FeatureCatalogDescription/gmd:featureCatalogueCitation | ||
| + | |- | ||
| + | | Application Schema Citation<br/> <br/> | ||
| + | !180px-WhereAreCI_Citations.MD_ApplicationSchemaInformation.png! | ||
| + | | CI_Citation + schemaLanguage + constraintLanguage + schemaAscii + graphicsFile + softwareDevelopmentFile + softwareDevelopmentFIleFormat = MD_ApplicationSchemaInformation<br/> | ||
| + | <br/> | ||
| + | /gmi:MI_Metadata/gmd:applicationSchemaInfo/gmd:MD_ApplicationSchemaInformation/gmd:name | ||
| + | !180px-WhereAreCI_Citations.png | ||
| + | | border=1,height=135,width=180! | ||
| + | |||
| + | = Notes = | ||
| + | |||
| + | ---- | ||
| + | |||
| + | == CodeLists as Types == | ||
| + | |||
| + | As described earlier, codeLists provide shared vocabularies throughout the ISO Standard. The fact that these vocabularies are shared makes it possible to use them as well known tags for content in the standard. An excellent example of this occurs in the CI_Date object that gives dates for CI_Citations. That object includes a date string and the CI_DateTypeCode codeList that can be either creation, publication, or revision. This single date, along with the codeList, covers three common types of dates that are required in citations. Contrast this with the editionDate attribute that is a single date the purpose of which is expressed in the name of the attribute rather than with a tag. | ||
| + | |||
| + | == Revisions == | ||
| + | |||
| + | The ISO 19115 CI_Citation object works well for citing physical objects (books, articles, scientific papers, etc), but is not well suited for referencing online digital resources. These important resources can only be associated with a CI_Citation using a rather circuitous path: //gmd:CI_Citation/gmd:citedResponsibleParty/gmd:CI_ResponsibleParty/gmd:contactInfo/gmd:CI_Contact/gmd:onlineResource and it is not at all clear that a URL in the contact information for the citedResponsibleParty is actually the URL for the resource being cited. In short, the ISO 19115 CI_Citation does not work well for citations to online resources. | ||
| + | |||
| + | ISO 19115 -1 has addressed this shortcoming by adding an OnlineResource field to the CI_Citation object. Also included in the 19115-1 revision is the BrowseGraphic field for referencing online images. | ||
Revision as of 14:49, September 15, 2015
I need to provide references for datasets and associated resources.
_I need to provide references for datasets and associated resources._
Overview
Citations are used to provide information about citing the resource being described in the metadata or to refer to resources outside of the metadata record. These citations are an important part of the identification information and, as such, they are in a special location in the record. In addition, they can provide connection to relevant materials that can not be included in the metadata.
Structure
The CI_Citation includes two required and eleven optional elements and introduces several new objects. The CI_Series object gives the name, issue, and page numbers of an article in a periodical. The ISBN and ISSN elements are internationally recognized identifiers for books and periodicals. The MI_Identifier and CI_Date objects are discussed below.
Usage
CI_Citation serves two purposes in the ISO 19115 Standard. First, it gives the information required to cite the data or the service (the resource) that is being described in the metadata. This CI_Citation can be part of the gmd:MD_DataIdentification or srv:ServiceIdentification objects.
| Usage | Description and Xpath |
|---|---|
| Resource Citation |
!800px-WhereAreCI_Citations.MD_Identification.png
| thumbnail=true,width=250!
| The Resource Citation includes information that should be used when citing the resource that is being described by the metadata record. It includes descriptions of the people involved in the creation of the resource. They usually have roles of originator, author, or principleInvestigator.
An important enhancement to the CI_Citation object occured in ISO 19115-1. The enhancement includes the addition of OnlineResource and BrowseGraphic fields which enable online digital resources and graphics to be referenced from the CI_Citation object. An expanded description is available in the Revisions section of this page.
/gmi:MI_Metadata/gmd:identificationInfo/gmd:MD_DataIdentification/gmd:citation
or
/gmi:MI_Metadata/gmd:identificationInfo/srv:ServiceIdentification/gmd:citation
~~ATTACHED_IMAGE~~180px-CI_Citation.png
CI_Citation++
Second, CI_Citations provide information about external references that are related to the resource being described and provide additional documentation. This Figure shows most of the places where CI_Citations occur. Those shown in red were added in ISO 19115-1. In many of these situations the CI_Citation is in an object with a generally small amount of additional annotation information. This additional information is available to the user so they may not need to look up the resource cited in the CI_Citation. These objects are termed CI_Citation++.
The most straightforward member of this group is the MI_Identifier, which includes a code, the identifier, and a CI_Citation for the authority for the code. The MD_Identifier is used throughout the standard to attach a unique identifier to objects, including CI_Citations.
| Usage | Description and Xpath |
|---|---|
| Identifier |
!180px-WhereAreCI_Citations.MD_Identifier.png!
| CI_Citation + code = MD_Identifier
The MD_Identifier is the simplest of the CI_Citation++ objects. It includes a code and an authority. The code is an alphanumeric value identifying an object in a namespace that is maintained by the authority. In this case the CI_Citation cites the authority for the code. In many ways this is similar to the namespace for the code. It is the authority which understands and can explain or resolve the code. There is no agreed upon approach for how the namespace is described in the CI_Citation.
ISO 19115-1 addresses this limitation by adding a codeSpace field to the MD_Identifier object. The codeSpace field unambiguously defines the namespace for the identifier. ISO 19115-1 also includes description and version fields in the MD_Identifier object. The description field enables a brief description of the code to be documented, and the version field enables the the Identifier version to be documented.
//gmd:MD_Identifier
|-
| Reference System Identifier
!180px-WhereAreCI_Citations.RS_Identifier.png!
| CI_Citation + code + codeSpace + version = RS_Identifier
The RS_Identifier extends the MD_Identifier by adding a codeSpace and a version for the namespace. These additions address the lack of an agreed upon approach for describing a namespace using the authority/gco:CI_Citation alone. However, the standard only supports RS_Identifiers in the referenceSystemInfo class.
Note: In ISO 19115-1 the RS_Identifier object is replaced with an MD_Identifier object which includes codeSpace, version and description fields. See the MD_Identifier description above.
//gmd:RS_Identifier
|-
| Keyword Thesaurus Citation
!180px-WhereAreCI_Citations.MD_Keywords.png!
| CI_Citation + keyword + type = MD_Keywords
The MD_Keywords object is similar to an MD_Identifier in that it gives a keyword that is unique in a "namespace" that is maintained by the individual or organization cited in the thesaurusName. In this case, the type codeList is used to group related keywords.
Note: In ISO 19115-1, 10 additional GCMD keyword type codes have been added to the codelist. These codes will help improve consistent data discovery, particularly using faceted searches.
/gmi:MI_Metadata/gmd:identificationInfo/gmd:MD_DataIdentification
| srv:ServiceIdentification/gmd:descriptiveKeywords/gmd:MD_Keywords/gmd:thesaurusName
|-
| Algorithm Citation
!180px-WhereAreCI_Citations.LE_Algorithm.png!
| CI_Citation + description = LE_Algorithm
The Algorithm Citation is straightforward. It includes a description that, like the description in the CI_OnlineResource object, should provide information that identifies the algorithm used to process data so that a user can understand that information without following the citation. The description is similar to an abstract for the algorithm referenced in the CI_Citation.
/gmi:MI_Metadata/gmd:dataQualityInfo/gmd:MD_DataQuality/gmd:lineage/gmd:LE_Lineage/gmd:processStep/gmd:LE_ProcessStep/gmd:processingInformation/gmd:LE_Processing/gmd:algorithm/LE_Algorithm/gmd:citation
|-
| Conformance Standard Specification Citation
!180px-WhereAreCI_Citations.DQ_ConformanceResult.png!
| CI_Citation + explanation + pass = DQ_ConformanceResult
The DQ_ConformanceResult is a good example of including critical information in the standard while referencing an external resource for more information. In this case the critical information is a brief explanation of the conformance test and the result of the test. If a user needs more information about the specifics of the test, they can follow the citation to the specification.
/gmi:MI_Metadata/gmd:dataQualityInfo/gmd:MD_DataQuality/gmd:report/gmd:DQ_Element/gmd:result/gmd:DQ_Result/gmd:DQ_ConformanceResult/gmd:specification
|-
| Source Citation
!180px-WhereAreCI_Citations.LE_Source.png!
| CI_Citation + description + scaleDenominator + sourceReferenceSystem + sourceExtent + processedLevel + resolution + sourceStep = LE_Source. LE_Source fields enable the sources utilized to generate a data product to be described and referenced. Sources are both used and produced by process steps. Documenting the chain of sources and process steps utilized to generated a data product is an important role of high-quality metadata.
/gmi:MI_Metadata/gmd:dataQualityInfo/gmd:MD_DataQuality/gmd:lineage/gmd:LE_Lineage/gmd:source
| gmd:output/gmd:LE_Source/gmd:sourceCitation
|-
| Data Quality Evaluation Procedure Citation
!180px-WhereAreCI_Citations.DQ_Element.png!
| /gmi:MI_Metadata/gmd:dataQualityInfo/gmd:MD_DataQuality/gmd:report/gmd:DQ_Element/gmd:evaluationProcedure
|-
| Feature Catalog Citation
!180px-WhereAreCI_Citations.MD_FeatureCatalogDescription.png!
| /gmi:MI_Metadata/gmd:contentinfo/gmd:MD_ContentInformation/gmd:MD:FeatureCatalogDescription/gmd:featureCatalogueCitation
|-
| Application Schema Citation
!180px-WhereAreCI_Citations.MD_ApplicationSchemaInformation.png!
| CI_Citation + schemaLanguage + constraintLanguage + schemaAscii + graphicsFile + softwareDevelopmentFile + softwareDevelopmentFIleFormat = MD_ApplicationSchemaInformation
/gmi:MI_Metadata/gmd:applicationSchemaInfo/gmd:MD_ApplicationSchemaInformation/gmd:name
!180px-WhereAreCI_Citations.png | border=1,height=135,width=180!
Notes
CodeLists as Types
As described earlier, codeLists provide shared vocabularies throughout the ISO Standard. The fact that these vocabularies are shared makes it possible to use them as well known tags for content in the standard. An excellent example of this occurs in the CI_Date object that gives dates for CI_Citations. That object includes a date string and the CI_DateTypeCode codeList that can be either creation, publication, or revision. This single date, along with the codeList, covers three common types of dates that are required in citations. Contrast this with the editionDate attribute that is a single date the purpose of which is expressed in the name of the attribute rather than with a tag.
Revisions
The ISO 19115 CI_Citation object works well for citing physical objects (books, articles, scientific papers, etc), but is not well suited for referencing online digital resources. These important resources can only be associated with a CI_Citation using a rather circuitous path: //gmd:CI_Citation/gmd:citedResponsibleParty/gmd:CI_ResponsibleParty/gmd:contactInfo/gmd:CI_Contact/gmd:onlineResource and it is not at all clear that a URL in the contact information for the citedResponsibleParty is actually the URL for the resource being cited. In short, the ISO 19115 CI_Citation does not work well for citations to online resources.
ISO 19115 -1 has addressed this shortcoming by adding an OnlineResource field to the CI_Citation object. Also included in the 19115-1 revision is the BrowseGraphic field for referencing online images.
