Difference between revisions of "Documenting Browse Graphics"

From Earth Science Information Partners (ESIP)
(Created page with "Browse graphics and other multimedia samples are important aids to data discovery and assessment. ==Crosswalks== <table width="95%" border="1" cellpadding="3" cellspacing="3" ...")
 
Line 1: Line 1:
Browse graphics and other multimedia samples are important aids to data discovery
+
Browse graphics and other multimedia samples are important aids to data discovery and assessment and can also be used to create image links to resources. The common dialects treat browse graphics in similar ways with names, URLs, file types and descriptions.
and assessment.
+
 
 +
=NASA GCMD Directory Interchange Format=
 +
Browse Graphics are described in DIF using the [http://gcmd.nasa.gov/add/difguide/multimedia_sample.html Multimedia_Sample] field. They have the following properties:
 +
<pre>
 +
<dif:Multimedia_Sample>
 +
  <dif:File>dataSets_img.jpg </dif:File>
 +
  <dif:URL>http://gcmd.nasa.gov/images/gui/dataSets_img.jpg</dif:URL>
 +
  <dif:Format>jpg</dif:Format>
 +
  <dif:Caption>discover and access data descriptions, relevant to global change and Earth science research.</dif:Caption>
 +
  <dif:Description>The dataset image from the GCMD homepage </dif:Description>
 +
</dif:Multimedia_Sample>
 +
</pre>
 +
=ECHO=
 +
The ECHO model includes several types of browse images, each with a unique set of properties:
 +
<pre>
 +
  <echo:AssociatedBrowseImages>
 +
    <echo:ProviderBrowseId>/*/AssociatedBrowseImages/ProviderBrowseId</echo:ProviderBrowseId>
 +
  </echo:AssociatedBrowseImages>
 +
  <echo:AssociatedBrowseImageUrls>
 +
    <echo:ProviderBrowseUrl>
 +
      <echo:URL>/*/AssociatedBrowseImageUrls/ProviderBrowseUrl/URL</echo:URL>
 +
      <echo:FileSize>/*/AssociatedBrowseImageUrls/ProviderBrowseUrl/FileSize</echo:FileSize>
 +
      <echo:Description>/*/AssociatedBrowseImageUrls/ProviderBrowseUrl/Description</echo:Description>
 +
      <echo:MimeType>/*/AssociatedBrowseImageUrls/ProviderBrowseUrl/MimeType</echo:MimeType>
 +
    </echo:ProviderBrowseUrl>
 +
  </echo:AssociatedBrowseImageUrls>
 +
</pre>
 +
=ISO=
 +
The ISO Standards use mcc:MD_BrowseGraphic objects to describe online resources. They include the following properties:
 +
<pre>
 +
<mri:graphicOverview>
 +
    <mcc:MD_BrowseGraphic>
 +
        <mcc:fileName>
 +
            <gco:CharacterString>Name of the file</gco:CharacterString>
 +
        </mcc:fileName>
 +
        <mcc:fileDescription>
 +
            <gco:CharacterString>File Description</gco:CharacterString>
 +
        </mcc:fileDescription>
 +
        <mcc:fileType>
 +
            <gco:CharacterString>This should be a mimeType</gco:CharacterString>
 +
        </mcc:fileType>
 +
    </mcc:MD_BrowseGraphic>
 +
</mri:graphicOverview>
 +
<mri:graphicOverview>
 +
    <mcc:MD_BrowseGraphic>
 +
        <mcc:fileName>
 +
            <gcx:FileName src="http://browseGraphicFileName"/>
 +
        </mcc:fileName>
 +
        <mcc:fileDescription>
 +
            <gco:CharacterString>This form would be used when a browse graphic is distributed in a package (e.g. a zip file) with the dataset or in a situation where the location of the file is known (e.g. a file in a fixed location in a folder accessible by a web server).</gco:CharacterString>
 +
        </mcc:fileDescription>
 +
    </mcc:MD_BrowseGraphic>
 +
</mri:graphicOverview>
 +
<mri:graphicOverview>
 +
    <mcc:MD_BrowseGraphic>
 +
        <mcc:fileName>
 +
            <gcx:Anchor xlink:href="http://browseGraphicAnchor"/>
 +
        </mcc:fileName>
 +
        <mcc:fileDescription>
 +
            <gco:CharacterString>This form would be used when a browse graphic is in a web accessible location).</gco:CharacterString>
 +
        </mcc:fileDescription>
 +
    </mcc:MD_BrowseGraphic>
 +
</mri:graphicOverview>
 +
</pre>
 +
=Content Standard for Digital Geospatial Metadata (FGDC)=
 +
The [http://www.fgdc.gov/csdgmgraphical/ideninfo/brwseg.htm CSDGM Browse Graphic] includes a file name (typically a URL), a description, and a type.
 +
<pre>
 +
<browse>
 +
      <browsen>/fgdc:metadata/fgdc:idinfo/fgdc:browse/fgdc:browsen</browsen>
 +
      <browsed>/fgdc:metadata/fgdc:idinfo/fgdc:browse/fgdc:browsed</browsed>
 +
      <browset>/fgdc:metadata/fgdc:idinfo/fgdc:browse/fgdc:browset</browset>
 +
    </browse>
 +
</pre>
 +
 
 
==Crosswalks==
 
==Crosswalks==
<table width="95%" border="1" cellpadding="3" cellspacing="3" style="border-collapse: collapse;">
+
<table xmlns:xsl="http://www.w3.org/1999/XSL/Transform" xmlns:cw="http://www.ngdc.noaa.gov/metadata/published/xsd/crosswalk.xsd" xmlns:xs="http://www.w3.org/2001/XMLSchema" width="95%" border="1" cellpadding="3" cellspacing="3" style="border-collapse: collapse;"><tr><th width="15%">Concept</th><th width="25%">Description</th><th width="60%">Dialect (Fit) Paths</th></tr><tr><td>[[Concepts_Glossary#Browse_File_Name|Browse File Name]]</td><td>Name of the file holding the browse graphic.</td><td style="word-break:break-all;"><b>DIF</b> /dif:DIF/dif:Multimedia_Sample/dif:File<br><b>ECHO</b> /*/echo:AssociatedBrowseImages/echo:ProviderBrowseId<br><b>FGDC</b> /fgdc:metadata/fgdc:idinfo/fgdc:browse/fgdc:browsen<br><b>ISO</b> /*/gmd:identificationInfo/gmd:MD_DataIdentification/gmd:graphicOverview/gmd:MD_BrowseGraphic/gmd:fileName/gco:CharacterString<br><b>ISO-1</b> /mdb:MD_Metadata/mdb:identificationInfo/*/mri:graphicOverview/mcc:MD_BrowseGraphic/mcc:fileName/gco:CharacterString<br></td></tr><tr><td>[[Concepts_Glossary#URL|URL]]</td><td>Location of the browse file on the Web.</td><td style="word-break:break-all;"><b>DIF</b> /dif:DIF/dif:Multimedia_Sample/dif:URL<br><b>ECHO</b> /*/echo:AssociatedBrowseImageUrls/echo:ProviderBrowseUrl/echo:URL<br><b>ISO</b> /*/gmd:identificationInfo/gmd:MD_DataIdentification/gmd:graphicOverview/gmd:MD_BrowseGraphic/gmd:fileName/@src<br><b>ISO-1</b> /mdb:MD_Metadata/mdb:identificationInfo/*/mri:graphicOverview/mcc:MD_BrowseGraphic/mcc:fileName/gcx:Anchor/@xlink:href<br></td></tr><tr><td>[[Concepts_Glossary#Format|Format]]</td><td>Format of the multimedia sample or browse image.</td><td style="word-break:break-all;"><b>DIF</b> /dif:DIF/dif:Multimedia_Sample/dif:Format<br><b>ECHO</b> /*/echo:AssociatedBrowseImageUrls/echo:ProviderBrowseUrl/echo:MimeType<br><b>FGDC</b> /fgdc:metadata/fgdc:idinfo/fgdc:browse/fgdc:browset<br><b>ISO</b> /*/gmd:identificationInfo/gmd:MD_DataIdentification/gmd:graphicOverview/gmd:MD_BrowseGraphic/gmd:fileType/gco:CharacterString<br><b>ISO-1</b> /mdb:MD_Metadata/mdb:identificationInfo/*/mri:graphicOverview/mcc:MD_BrowseGraphic/mcc:fileType/gco:CharacterString<br></td></tr><tr><td>[[Concepts_Glossary#Caption|Caption]]</td><td>Brief description of the multimedia sample or browse image.</td><td style="word-break:break-all;"><b>DIF</b> /dif:DIF/dif:Multimedia_Sample/dif:Caption<br></td></tr><tr><td>[[Concepts_Glossary#Description|Description]]</td><td>Complete description of the multimedia sample or browse image.</td><td style="word-break:break-all;"><b>DIF</b> /dif:DIF/dif:Multimedia_Sample/dif:Description<br><b>ECHO</b> /*/echo:AssociatedBrowseImageUrls/echo:ProviderBrowseUrl/echo:Description<br><b>FGDC</b> /fgdc:metadata/fgdc:idinfo/fgdc:browse/fgdc:browsed<br><b>ISO</b> /*/gmd:identificationInfo/gmd:MD_DataIdentification/gmd:graphicOverview/gmd:MD_BrowseGraphic/gmd:fileDescription/gco:CharacterString<br><b>ISO-1</b> /mdb:MD_Metadata/mdb:identificationInfo/*/mri:graphicOverview/mcc:MD_BrowseGraphic/mcc:fileDescription/gco:CharacterString<br></td></tr></table>
<tr>
+
''xPath Note:'' The xPaths included in this table use several wildcards. // means any path, so //gmd:CI_ResponsibleParty indicates a gmd:CI_ResponsibleParty anywhere in an XML file. /*/ indicates a single level with several possible elements. This usually indicates one of several concrete realizations of an abstract object. For example /*/gmd:identificationInfo could be gmd:MD_Metadata/gmd:identificationInfo or gmi:MI_Metadata/gmd:identificationInfo and gmd:identificationInfo//*/gmd:descriptiveKeywords could be gmd:identificationInfo/gmd:MD_DataIdentification/gmd:descriptiveKeywords or gmd:identificationInfo/srv:SV_ServiceIdentification/gmd:descriptiveKeywords.
<th>Concept</th>
+
''Fit:'' The fit of the dialect path with the concept is estimated on a scale of 1 = excellent two-way fit, 2 = one-way fit or some other problem, 3 - extension required.
<th>Description</th>
 
<th>Paths</th>
 
</tr>
 
<tr>
 
<td style="word-break:break-all;">Browse File Name</td>
 
<td style="word-break:break-all;">Name of the file holding the browse graphic.</td>
 
<td style="word-break:break-all;"><b>ISO</b> /*/gmd:identificationInfo/gmd:MD_DataIdentification/gmd:graphicOverview/gmd:MD_BrowseGraphic/gmd:fileName/gco:CharacterString<br><b>FGDC</b> /metadata/idinfo/browse/browsen<br><b>DIF</b> /dif:DIF/dif:Multimedia_Sample/dif:File<br></td>
 
</tr>
 
<tr>
 
<td style="word-break:break-all;">URL</td>
 
<td style="word-break:break-all;">Location of the browse file on the Web.</td>
 
<td style="word-break:break-all;"><b>ECHO</b> /echo:Collection/echo:AssociatedBrowseImageUrls/echo:ProviderBrowseUrl/echo:URL<br><b>ISO</b> /*/gmd:identificationInfo/gmd:MD_DataIdentification/gmd:graphicOverview/gmd:MD_BrowseGraphic/gmd:fileName/@src<br><b>DIF</b> /dif:DIF/dif:Multimedia_Sample/dif:URL<br></td>
 
</tr>
 
<tr>
 
<td style="word-break:break-all;">Format</td>
 
<td style="word-break:break-all;">Format of the multimedia sample or browse image.</td>
 
<td style="word-break:break-all;"><b>ECHO</b> /echo:Collection/echo:AssociatedBrowseImageUrls/echo:ProviderBrowseUrl/echo:MimeType<br><b>ISO</b> /*/gmd:identificationInfo/gmd:MD_DataIdentification/gmd:graphicOverview/gmd:MD_BrowseGraphic/gmd:fileType/gco:CharacterString<br><b>FGDC</b> /metadata/idinfo/browse/browset<br><b>DIF</b> /dif:DIF/dif:Multimedia_Sample/dif:Format<br></td>
 
</tr>
 
<tr>
 
<td style="word-break:break-all;">Caption</td>
 
<td style="word-break:break-all;">Brief description of the multimedia sample or browse image.</td>
 
<td style="word-break:break-all;"><b>DIF</b> /dif:DIF/dif:Multimedia_Sample/dif:Caption<br></td>
 
</tr>
 
<tr>
 
<td style="word-break:break-all;">Description</td>
 
<td style="word-break:break-all;">Complete description of the multimedia sample or browse image.</td>
 
<td style="word-break:break-all;"><b>ECHO</b> /echo:Collection/echo:AssociatedBrowseImageUrls/echo:ProviderBrowseUrl/echo:Description<br><b>ISO</b> /*/gmd:identificationInfo/gmd:MD_DataIdentification/gmd:graphicOverview/gmd:MD_BrowseGraphic/gmd:fileDescription/gco:CharacterString<br><b>FGDC</b> /metadata/idinfo/browse/browsed<br><b>DIF</b> /dif:DIF/dif:Multimedia_Sample/dif:Description<br></td>
 
</tr>
 
</table>
 
''xPath Note:'' The xPaths included in this table use several wildcards. // means
 
any path, so //gmd:CI_ResponsibleParty indicates a gmd:CI_ResponsibleParty anywhere
 
in an XML file. /*/ indicates a single level with several possible elements. This
 
usually indicates one of several concrete realizations of an abstract object. For
 
example /*/gmd:identificationInfo could be gmd:MD_Metadata/gmd:identificationInfo
 
or gmi:MI_Metadata/gmd:identificationInfo and gmd:identificationInfo//*/gmd:descriptiveKeywords
 
could be gmd:identificationInfo/gmd:MD_DataIdentification/gmd:descriptiveKeywords
 
or gmd:identificationInfo/srv:SV_ServiceIdentification/gmd:descriptiveKeywords.
 
 
[[Category:Documentation Connections]]
 
[[Category:Documentation Connections]]

Revision as of 08:22, October 26, 2014

Browse graphics and other multimedia samples are important aids to data discovery and assessment and can also be used to create image links to resources. The common dialects treat browse graphics in similar ways with names, URLs, file types and descriptions.

NASA GCMD Directory Interchange Format

Browse Graphics are described in DIF using the Multimedia_Sample field. They have the following properties:

<dif:Multimedia_Sample>
   <dif:File>dataSets_img.jpg </dif:File>
   <dif:URL>http://gcmd.nasa.gov/images/gui/dataSets_img.jpg</dif:URL>
   <dif:Format>jpg</dif:Format>
   <dif:Caption>discover and access data descriptions, relevant to global change and Earth science research.</dif:Caption>
   <dif:Description>The dataset image from the GCMD homepage </dif:Description>
</dif:Multimedia_Sample>
 

ECHO

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

  <echo:AssociatedBrowseImages>
    <echo:ProviderBrowseId>/*/AssociatedBrowseImages/ProviderBrowseId</echo:ProviderBrowseId>
  </echo:AssociatedBrowseImages>
  <echo:AssociatedBrowseImageUrls>
    <echo:ProviderBrowseUrl>
      <echo:URL>/*/AssociatedBrowseImageUrls/ProviderBrowseUrl/URL</echo:URL>
      <echo:FileSize>/*/AssociatedBrowseImageUrls/ProviderBrowseUrl/FileSize</echo:FileSize>
      <echo:Description>/*/AssociatedBrowseImageUrls/ProviderBrowseUrl/Description</echo:Description>
      <echo:MimeType>/*/AssociatedBrowseImageUrls/ProviderBrowseUrl/MimeType</echo:MimeType>
    </echo:ProviderBrowseUrl>
   </echo:AssociatedBrowseImageUrls>

ISO

The ISO Standards use mcc:MD_BrowseGraphic objects to describe online resources. They include the following properties:

<mri:graphicOverview>
    <mcc:MD_BrowseGraphic>
        <mcc:fileName>
            <gco:CharacterString>Name of the file</gco:CharacterString>
        </mcc:fileName>
        <mcc:fileDescription>
            <gco:CharacterString>File Description</gco:CharacterString>
        </mcc:fileDescription>
        <mcc:fileType>
            <gco:CharacterString>This should be a mimeType</gco:CharacterString>
        </mcc:fileType>
    </mcc:MD_BrowseGraphic>
</mri:graphicOverview>
<mri:graphicOverview>
    <mcc:MD_BrowseGraphic>
        <mcc:fileName>
            <gcx:FileName src="http://browseGraphicFileName"/>
        </mcc:fileName>
        <mcc:fileDescription>
            <gco:CharacterString>This form would be used when a browse graphic is distributed in a package (e.g. a zip file) with the dataset or in a situation where the location of the file is known (e.g. a file in a fixed location in a folder accessible by a web server).</gco:CharacterString>
        </mcc:fileDescription>
    </mcc:MD_BrowseGraphic>
</mri:graphicOverview>
<mri:graphicOverview>
    <mcc:MD_BrowseGraphic>
        <mcc:fileName>
            <gcx:Anchor xlink:href="http://browseGraphicAnchor"/>
        </mcc:fileName>
        <mcc:fileDescription>
            <gco:CharacterString>This form would be used when a browse graphic is in a web accessible location).</gco:CharacterString>
        </mcc:fileDescription>
    </mcc:MD_BrowseGraphic>
</mri:graphicOverview>

Content Standard for Digital Geospatial Metadata (FGDC)

The CSDGM Browse Graphic includes a file name (typically a URL), a description, and a type.

<browse>
      <browsen>/fgdc:metadata/fgdc:idinfo/fgdc:browse/fgdc:browsen</browsen>
      <browsed>/fgdc:metadata/fgdc:idinfo/fgdc:browse/fgdc:browsed</browsed>
      <browset>/fgdc:metadata/fgdc:idinfo/fgdc:browse/fgdc:browset</browset>
    </browse>

Crosswalks

ConceptDescriptionDialect (Fit) Paths
Browse File NameName of the file holding the browse graphic.DIF /dif:DIF/dif:Multimedia_Sample/dif:File
ECHO /*/echo:AssociatedBrowseImages/echo:ProviderBrowseId
FGDC /fgdc:metadata/fgdc:idinfo/fgdc:browse/fgdc:browsen
ISO /*/gmd:identificationInfo/gmd:MD_DataIdentification/gmd:graphicOverview/gmd:MD_BrowseGraphic/gmd:fileName/gco:CharacterString
ISO-1 /mdb:MD_Metadata/mdb:identificationInfo/*/mri:graphicOverview/mcc:MD_BrowseGraphic/mcc:fileName/gco:CharacterString
URLLocation of the browse file on the Web.DIF /dif:DIF/dif:Multimedia_Sample/dif:URL
ECHO /*/echo:AssociatedBrowseImageUrls/echo:ProviderBrowseUrl/echo:URL
ISO /*/gmd:identificationInfo/gmd:MD_DataIdentification/gmd:graphicOverview/gmd:MD_BrowseGraphic/gmd:fileName/@src
ISO-1 /mdb:MD_Metadata/mdb:identificationInfo/*/mri:graphicOverview/mcc:MD_BrowseGraphic/mcc:fileName/gcx:Anchor/@xlink:href
FormatFormat of the multimedia sample or browse image.DIF /dif:DIF/dif:Multimedia_Sample/dif:Format
ECHO /*/echo:AssociatedBrowseImageUrls/echo:ProviderBrowseUrl/echo:MimeType
FGDC /fgdc:metadata/fgdc:idinfo/fgdc:browse/fgdc:browset
ISO /*/gmd:identificationInfo/gmd:MD_DataIdentification/gmd:graphicOverview/gmd:MD_BrowseGraphic/gmd:fileType/gco:CharacterString
ISO-1 /mdb:MD_Metadata/mdb:identificationInfo/*/mri:graphicOverview/mcc:MD_BrowseGraphic/mcc:fileType/gco:CharacterString
CaptionBrief description of the multimedia sample or browse image.DIF /dif:DIF/dif:Multimedia_Sample/dif:Caption
DescriptionComplete description of the multimedia sample or browse image.DIF /dif:DIF/dif:Multimedia_Sample/dif:Description
ECHO /*/echo:AssociatedBrowseImageUrls/echo:ProviderBrowseUrl/echo:Description
FGDC /fgdc:metadata/fgdc:idinfo/fgdc:browse/fgdc:browsed
ISO /*/gmd:identificationInfo/gmd:MD_DataIdentification/gmd:graphicOverview/gmd:MD_BrowseGraphic/gmd:fileDescription/gco:CharacterString
ISO-1 /mdb:MD_Metadata/mdb:identificationInfo/*/mri:graphicOverview/mcc:MD_BrowseGraphic/mcc:fileDescription/gco:CharacterString

xPath Note: The xPaths included in this table use several wildcards. // means any path, so //gmd:CI_ResponsibleParty indicates a gmd:CI_ResponsibleParty anywhere in an XML file. /*/ indicates a single level with several possible elements. This usually indicates one of several concrete realizations of an abstract object. For example /*/gmd:identificationInfo could be gmd:MD_Metadata/gmd:identificationInfo or gmi:MI_Metadata/gmd:identificationInfo and gmd:identificationInfo//*/gmd:descriptiveKeywords could be gmd:identificationInfo/gmd:MD_DataIdentification/gmd:descriptiveKeywords or gmd:identificationInfo/srv:SV_ServiceIdentification/gmd:descriptiveKeywords. Fit: The fit of the dialect path with the concept is estimated on a scale of 1 = excellent two-way fit, 2 = one-way fit or some other problem, 3 - extension required.