Difference between revisions of "Documenting Online Resources"

From Earth Science Information Partners (ESIP)
(Created page with "As the World Wide Web has developed into a ubiquitous information source, links to on-line information and services have become critical elements in all metadata dialects. Some d...")
 
Line 50: Line 50:
 
#Types and Function Codes - All three dialects include a mechanism for classifying online resources. DIF and ISO use shared vocabularies and ECHO uses free text. The DIF vocabulary is hierarchical and includes roughly 35 choices. The ISO codeList includes 11 broad categories. The ECHO Collection metadata currently includes roughly 45 different values with some overlap with the DIF list. Given the variation in these existing approaches, it seems reasonable to map the DIF and ECHO types into the ISO name element, which is free text, rather than into the function element which is a codeList.
 
#Types and Function Codes - All three dialects include a mechanism for classifying online resources. DIF and ISO use shared vocabularies and ECHO uses free text. The DIF vocabulary is hierarchical and includes roughly 35 choices. The ISO codeList includes 11 broad categories. The ECHO Collection metadata currently includes roughly 45 different values with some overlap with the DIF list. Given the variation in these existing approaches, it seems reasonable to map the DIF and ECHO types into the ISO name element, which is free text, rather than into the function element which is a codeList.
  
=Crosswalks=
+
=Online Resources=
     <table border="1" cellpadding="3" width="100%">
+
 
      <tr>
+
Concept: URL
 +
Description: Address of the online resource
 +
<table border="1" cellpadding="10" width="100%">
 +
    <tr>
 +
        <th>DIF</th>
 +
        <th>ECHO</th>
 +
        <th>ECS</th>
 +
        <th>ISO</th>
 +
        <th>netCDF(ncML)</th>
 +
        <th>THREDDS</th>
 +
        <th>Open Geospatial Consortium Sensor Observation Service (SOS)</th>
 +
        <th>EML</th>
 +
        <th>FGDC</th>
 +
        <th>Dryad</th>
 +
    </tr>
 +
    <tr>
 +
        <td valign="top">/dif:DIF/dif:Related_URL/URL</td>
 +
        <td valign="top">/echo:OnlineAccessURLs/echo:OnlineAccessURL/echo:URL</td>
 +
        <td valign="top"></td>
 +
        <td valign="top">//gmd:CI_OnlineResource/gmd:linkage/gmd:URL</td>
 +
        <td valign="top"></td>
 +
        <td valign="top"></td>
 +
        <td valign="top"></td>
 +
        <td valign="top"></td>
 +
        <td valign="top">/eml:dataset/distribution/online/url/text</td>
 +
        <td valign="top">/fgdc:metadata/idinfo/citation/citeinfo/onlink | /fgdc:metadata/idinfo/browse/browsen</td>
 +
    </tr>
 +
</table>
 +
 
 +
Concept: Online Resource Description
 +
Description: A brief description of the online resource
 +
<table border="1" cellpadding="10" width="100%">
 +
    <tr>
 +
        <th>DIF</th>
 +
        <th>ECHO</th>
 +
        <th>ECS</th>
 +
        <th>ISO</th>
 +
        <th>netCDF(ncML)</th>
 +
        <th>THREDDS</th>
 +
        <th>Open Geospatial Consortium Sensor Observation Service (SOS)</th>
 +
        <th>EML</th>
 +
        <th>FGDC</th>
 +
        <th>Dryad</th>
 +
    </tr>
 +
    <tr>
 +
        <td valign="top">/dif:DIF/dif:Related_URL/dif:Description</td>
 +
        <td valign="top">/echo:OnlineAccessURLs/OnlineAccessURL/URLDescription</td>
 +
        <td valign="top"></td>
 +
        <td valign="top">//gmd:CI_OnlineResource/gmd:description/gco:CharacterString</td>
 +
        <td valign="top"></td>
 +
        <td valign="top"></td>
 +
        <td valign="top"></td>
 +
        <td valign="top"></td>
 +
        <td valign="top"></td>
 +
        <td valign="top"></td>
 +
     </tr>
 +
</table>
 +
 
 +
Concept: Online Resource Function
 +
Description: A description of the function of the online resource
 +
<table border="1" cellpadding="10" width="100%">
 +
    <tr>
 +
        <th>DIF</th>
 
         <th>ECHO</th>
 
         <th>ECHO</th>
 +
        <th>ECS</th>
 +
        <th>ISO</th>
 +
        <th>netCDF(ncML)</th>
 +
        <th>THREDDS</th>
 +
        <th>Open Geospatial Consortium Sensor Observation Service (SOS)</th>
 +
        <th>EML</th>
 +
        <th>FGDC</th>
 +
        <th>Dryad</th>
 +
    </tr>
 +
    <tr>
 +
        <td valign="top"></td>
 +
        <td valign="top"></td>
 +
        <td valign="top"></td>
 +
        <td valign="top">//gmd:CI_OnlineResource/gmd:description/gco:CharacterString</td>
 +
        <td valign="top"></td>
 +
        <td valign="top"></td>
 +
        <td valign="top"></td>
 +
        <td valign="top"></td>
 +
        <td valign="top"></td>
 +
        <td valign="top"></td>
 +
    </tr>
 +
</table>
 +
 +
Concept: Online Resource Name/Title
 +
Description: A name or title of the online resource
 +
<table border="1" cellpadding="10" width="100%">
 +
    <tr>
 
         <th>DIF</th>
 
         <th>DIF</th>
 +
        <th>ECHO</th>
 +
        <th>ECS</th>
 
         <th>ISO</th>
 
         <th>ISO</th>
         <th>Note</th>
+
         <th>netCDF(ncML)</th>
      </tr>
+
        <th>THREDDS</th>
      <tr>
+
        <th>Open Geospatial Consortium Sensor Observation Service (SOS)</th>
         <td valign="top">OnlineAccessURLs/OnlineAccessURL/URL</td>
+
         <th>EML</th>
         <td valign="top">/DIF/Related_URL/URL</td>
+
        <th>FGDC</th>
         <td valign="top">/gmi:MI_Metadata/gmd:distributionInfo// gmd:distributor//gmd:distributorTransferOptions//gmd:onLine/ gmd:CI_OnlineResource/gmd:linkage/gmd:URL</td>
+
         <th>Dryad</th>
 +
    </tr>
 +
    <tr>
 +
         <td valign="top">/dif:DIF/dif:Related_URL/dif:URL_Content_Type/dif:Type > /dif:DIF/dif:Related_URL/dif:URL_Content_Type/dif:Subtype</td>
 +
        <td valign="top"></td>
 
         <td valign="top"></td>
 
         <td valign="top"></td>
      </tr>
+
         <td valign="top">//gmd:CI_OnlineResource/gmd:name/gco:CharacterString</td>
      <tr>
 
        <td valign="top">OnlineAccessURLs/OnlineAccessURL/URLDescription</td>
 
        <td valign="top">/DIF/Related_URL/Description</td>
 
         <td valign="top">/gmi:MI_Metadata/gmd:distributionInfo// gmd:distributor//gmd:distributorTransferOptions//gmd:onLine/ gmd:CI_OnlineResource/gmd:description/gco:CharacterString</td>
 
 
         <td valign="top"></td>
 
         <td valign="top"></td>
      </tr>
 
      <tr>
 
        <td valign="top">OnlineAccessURLs/OnlineAccessURL/MimeType</td>
 
 
         <td valign="top"></td>
 
         <td valign="top"></td>
        <td valign="top">/gmi:MI_Metadata/gmd:distributionInfo// gmd:distributor//gmd:distributorTransferOptions//gmd:onLine/ gmd:CI_OnlineResource/gmd:applicationProfile/gco:CharacterString</td>
 
 
         <td valign="top"></td>
 
         <td valign="top"></td>
      </tr>
 
      <tr>
 
        <td valign="top">OnlineResources/OnlineResource/URL</td>
 
        <td valign="top">/DIF/Related_URL/URL</td>
 
        <td valign="top">/gmi:MI_Metadata/gmd:distributionInfo// gmd:distributor//gmd:distributorTransferOptions//gmd:onLine/ gmd:CI_OnlineResource/gmd:linkage/gmd:URL</td>
 
 
         <td valign="top"></td>
 
         <td valign="top"></td>
      </tr>
 
      <tr>
 
        <td valign="top">OnlineResources/OnlineResource/Description</td>
 
        <td valign="top">/DIF/Related_URL/Description</td>
 
        <td valign="top">/gmi:MI_Metadata/gmd:distributionInfo// gmd:distributor//gmd:distributorTransferOptions//gmd:onLine/ gmd:CI_OnlineResource/gmd:description/gco:CharacterString</td>
 
 
         <td valign="top"></td>
 
         <td valign="top"></td>
      </tr>
 
      <tr>
 
        <td valign="top">OnlineResources/OnlineResource/Type</td>
 
        <td valign="top">/DIF/Related_URL/URL_Content_Type/Type and /DIF/Related_URL/URL_Content_Type/Subtype</td>
 
        <td valign="top">/gmi:MI_Metadata/gmd:distributionInfo// gmd:distributor//gmd:distributorTransferOptions//gmd:onLine/ gmd:CI_OnlineResource/gmd:name/gco:CharacterString</td>
 
 
         <td valign="top"></td>
 
         <td valign="top"></td>
      </tr>
+
    </tr>
      <tr>
+
</table>
        <td valign="top">OnlineResources/OnlineResource/MimeType</td>
+
 
 +
Concept: Format of the Online Resource
 +
Description: Identify the format of the online resource
 +
<table border="1" cellpadding="10" width="100%">
 +
    <tr>
 +
        <th>DIF</th>
 +
        <th>ECHO</th>
 +
        <th>ECS</th>
 +
        <th>ISO</th>
 +
        <th>netCDF(ncML)</th>
 +
        <th>THREDDS</th>
 +
        <th>Open Geospatial Consortium Sensor Observation Service (SOS)</th>
 +
        <th>EML</th>
 +
        <th>FGDC</th>
 +
        <th>Dryad</th>
 +
    </tr>
 +
    <tr>
 
         <td valign="top"></td>
 
         <td valign="top"></td>
         <td valign="top">/gmi:MI_Metadata/gmd:distributionInfo// gmd:distributor//gmd:distributorTransferOptions//gmd:onLine/ gmd:CI_OnlineResource/gmd:applicationProfile/gco:CharacterString</td>
+
         <td valign="top">echo:OnlineAccessURLs/echo:OnlineAccessURL/MimeType</td>
 
         <td valign="top"></td>
 
         <td valign="top"></td>
      </tr>
+
        <td valign="top">//gmd:CI_OnlineResource/gmd:applicationProfile/gco:CharacterString</td>
      <tr>
 
 
         <td valign="top"></td>
 
         <td valign="top"></td>
 
         <td valign="top"></td>
 
         <td valign="top"></td>
        <td valign="top">/gmi:MI_Metadata/gmd:distributionInfo// gmd:distributor//gmd:distributorTransferOptions//gmd:onLine/ gmd:CI_OnlineResource/gmd:function/gmd:CI_OnLineFunctionCode</td>
 
 
         <td valign="top"></td>
 
         <td valign="top"></td>
      </tr>
 
      <tr>
 
 
         <td valign="top"></td>
 
         <td valign="top"></td>
 
         <td valign="top"></td>
 
         <td valign="top"></td>
        <td valign="top">/gmi:MI_Metadata/gmd:distributionInfo// gmd:distributor//gmd:distributorTransferOptions//gmd:onLine/ gmd:CI_OnlineResource/gmd:protocol/gco:CharacterString</td>
 
 
         <td valign="top"></td>
 
         <td valign="top"></td>
      </tr>
+
    </tr>
    </table>
+
</table>
  
 
[[Category:Documentation Connections]]
 
[[Category:Documentation Connections]]

Revision as of 16:13, August 8, 2012

As the World Wide Web has developed into a ubiquitous information source, links to on-line information and services have become critical elements in all metadata dialects. Some dialects emerged during the early days of the web when less was known about how it would develop and flourish. URLs were simple and self-explanatory and it was enough to include just the bare URL in the metadata. As URLs have increased in complexity, it has become more important to provide supporting information along with the links.

NASA GCMD Directory Interchange Format

URL's are described in DIF using the Related_URL field. They have the following properties:

<dif:Related_URL uuid="UUID">
    <dif:URL_Content_Type/>
    <dif:URL/>
    <dif:Description/>
</dif:Related_URL>

The URL_Content_Type field comes from the URL Content Type Keywords which provide standard names for a number of data systems and services. Data access URLs can be recognized by the URL_Content_Type = "GET DATA". The Related_URL field is highly recommended and may be repeated.

ECHO

The ECHO model includes several types of URLs, each with a unique set of properties:

<OnlineAccessURL>
    <URL/>
    <URLDescription/>
    <MimeType/>
</OnlineAccessURL>

<OnlineResource>
    <URL/>
    <Description/>
    <Type/>
    <MimeType/>
</OnlineResource>

<ProviderBrowseUrl>
    <URL/>
    <FileSize/>
    <Description/>
    <MimeType/>
</ProviderBrowseUrl>

ISO

The ISO Standards use CI_OnlineResources to describe links. They include the following properties:

<gmd:CI_OnlineResource>
    <gmd:linkage/>
    <gmd:protocol/>
    <gmd:applicationProfile/>
    <gmd:name/>
    <gmd:description/>
    <gmd:function/>
</gmd:CI_OnlineResource>

Connections

All of these approaches to describing online resources include properties that make links more self-explanatory and easier to use. There are some differences that need to be considered when comparing them:

  1. Types and Function Codes - All three dialects include a mechanism for classifying online resources. DIF and ISO use shared vocabularies and ECHO uses free text. The DIF vocabulary is hierarchical and includes roughly 35 choices. The ISO codeList includes 11 broad categories. The ECHO Collection metadata currently includes roughly 45 different values with some overlap with the DIF list. Given the variation in these existing approaches, it seems reasonable to map the DIF and ECHO types into the ISO name element, which is free text, rather than into the function element which is a codeList.

Online Resources

Concept: URL Description: Address of the online resource

DIF ECHO ECS ISO netCDF(ncML) THREDDS Open Geospatial Consortium Sensor Observation Service (SOS) EML FGDC Dryad
/dif:DIF/dif:Related_URL/URL /echo:OnlineAccessURLs/echo:OnlineAccessURL/echo:URL //gmd:CI_OnlineResource/gmd:linkage/gmd:URL /eml:dataset/distribution/online/url/text /fgdc:metadata/idinfo/citation/citeinfo/onlink | /fgdc:metadata/idinfo/browse/browsen

Concept: Online Resource Description Description: A brief description of the online resource

DIF ECHO ECS ISO netCDF(ncML) THREDDS Open Geospatial Consortium Sensor Observation Service (SOS) EML FGDC Dryad
/dif:DIF/dif:Related_URL/dif:Description /echo:OnlineAccessURLs/OnlineAccessURL/URLDescription //gmd:CI_OnlineResource/gmd:description/gco:CharacterString

Concept: Online Resource Function Description: A description of the function of the online resource

DIF ECHO ECS ISO netCDF(ncML) THREDDS Open Geospatial Consortium Sensor Observation Service (SOS) EML FGDC Dryad
//gmd:CI_OnlineResource/gmd:description/gco:CharacterString

Concept: Online Resource Name/Title Description: A name or title of the online resource

DIF ECHO ECS ISO netCDF(ncML) THREDDS Open Geospatial Consortium Sensor Observation Service (SOS) EML FGDC Dryad
/dif:DIF/dif:Related_URL/dif:URL_Content_Type/dif:Type > /dif:DIF/dif:Related_URL/dif:URL_Content_Type/dif:Subtype //gmd:CI_OnlineResource/gmd:name/gco:CharacterString

Concept: Format of the Online Resource Description: Identify the format of the online resource

DIF ECHO ECS ISO netCDF(ncML) THREDDS Open Geospatial Consortium Sensor Observation Service (SOS) EML FGDC Dryad
echo:OnlineAccessURLs/echo:OnlineAccessURL/MimeType //gmd:CI_OnlineResource/gmd:applicationProfile/gco:CharacterString