Difference between revisions of "CI OnlineResource"

From NGDC Wiki
Jump to: navigation, search
m (XPaths)
 
m (More Information)
 
(3 intermediate revisions by 3 users not shown)
Line 1: Line 1:
==Purpose==
+
<table class="wikitable">
CI_OnlineResource is a NGDC local metadata extension intended to take advantage of the ISO 19115 standard and provide more detailed information about online sources from which the dataset, specification, or community profile name and extended metadata elements can be obtained.
+
<tr>
 +
<th colspan="3">Elements</th>
 +
<th><i>Definition and Recommended Practice</i></th>
 +
</tr>
 +
<tr>
 +
<td bgcolor="FFFF99">1</td>
 +
<td bgcolor="FFFF99">[[URL|linkage]]</td>
 +
<td bgcolor="FFFF99">1</td>
 +
<td bgcolor="FFFFFF><i>Internet address which uses a Uniform Resource Locator address or similar addressing scheme. Provide complete address to active URL. Do not provide URLs in other elements.<br/>'''''Example''''': <code>https://www.noaa.gov</code></i></td>
 +
</tr>
 +
<tr>
 +
<td bgcolor="CCFFFF"> 2 </td>
 +
<td bgcolor="CCFFFF">[[CharacterString|protocol]]</td>
 +
<td bgcolor="CCFFFF">0..1</td>
 +
<td bgcolor="FFFFFF><i>The connection protocol to be used. When applicable, use the identifier values in this [https://github.com/OSGeo/Cat-Interop/blob/master/LinkPropertyLookupTable.csv codelist] hosted by Open Source Geospatial Foundation. </i></td>
 +
</tr>
 +
<tr>
 +
<td bgcolor="CCFFFF"> 3</td>
 +
<td bgcolor="CCFFFF">[[CharacterString|applicationProfile]]</td>
 +
<td bgcolor="CCFFFF">0..1</td>
 +
<td bgcolor="FFFFFF><i>Name of an application profile that can be used with the online resource.</i></td>
 +
</tr>
 +
<tr>
 +
<td bgcolor="CCFFFF"> 4</td>
 +
<td bgcolor="CCFFFF">[[CharacterString|name]]</td>
 +
<td bgcolor="CCFFFF">0..1</td>
 +
<td bgcolor="FFFFFF><i>Title of the online resource. For HTML pages, use the html title tag. Recommend providing at least a name or a description.</i></td>
 +
</tr>
 +
<tr>
 +
<td bgcolor="CCFFFF"> 5</td>
 +
<td bgcolor="CCFFFF">[[CharacterString|description]]</td>
 +
<td bgcolor="CCFFFF">0..1</td>
 +
<td bgcolor="FFFFFF><i>Brief text explaining content or purpose of online resource. Recommend providing at least a name or a description.  <br/>'''Example:''' <code>NOAA homepage</code></i>
 +
</td>
 +
</tr>
 +
<tr>
 +
<td bgcolor="CCFFFF"> 6</td>
 +
<td bgcolor="CCFFFF">[[ISO 19115 and 19115-2 CodeList Dictionaries#CI_OnLineFunctionCode|function]]</td>
 +
<td bgcolor="CCFFFF">0..1</td>
 +
<td bgcolor="FFFFFF><i>Categorize the purpose of this online resource. Use 'download' for direct access to files or ftp sites. Use 'information' for pages with only descriptive information about the resource. Use 'search' for interfaces that support users interaction to find the resource of interest. </i></td>
 +
</tr>
 +
</table>
  
==Description==
+
===Community Requirements===
===XPaths===
 
*<nowiki>*/citeinfo/CI_OnlineResource</nowiki><br />
 
*/metadata/distinfo/stdorder/digform/digtopt/onlinopt/computer/networka/CI_OnlineResource
 
  
===Child Elements===
+
''M = Mandatory; C = Conditional; R = Recommended; blank cell = user discretion''
  
{|border="1" cellspacing ="0"
+
<table class="wikitable" border="1">
|-style="background:#cccccc"
+
    <tr>
!Name
+
      <th>Community</th>
!Definition
+
      <th>Element</th>
!Obligation/Condition
+
      <th>M/C/R</th>
!Domain
+
      <th>Notes</th>
|-
+
    </tr>
|Linkage
+
    <tr bgcolor="FFFFFF" border="2">
|location (address) for on-line access using a Uniform Resource Locator address or similar addressing scheme such as <code><nowiki>http://www.statkart.no/isotc211</nowiki></code>
+
      <td rowspan="6"> NOAA Completeness Rubric V2 </td>
|Mandatory
+
      <td>linkage</td>
|Free Text - URL<nowiki>(IETF RFC1738 IETF RFC 2056)</nowiki>
+
      <td align="center">M</td>
|-
+
      <td></td>
|Protocol
+
    </tr>
|Connection protocol to be used, such as http or ftp
+
    <tr bgcolor="FFFFFF">
|Optional
+
      <td>protocol</td>
|Free Text
+
      <td align="center">C</td>
|-
+
<td>Required when the URL is for Data Access</td>
|Application_Profile
+
     
|Name of an application profile that can be used with the online resource. For example: ''web browser'' or ''PDF reader''.
+
    </tr>
|Optional
+
    <tr bgcolor="FFFFFF">
|Free Text
+
      <td>applicationProfile</td>
|-
+
      <td align="center"></td>
|Name
+
<td></td>
|Name of the online resource.
+
   
|Optional
+
    </tr>
|Free Text
+
    <tr bgcolor="FFFFFF">
|-
+
      <td>name</td>
|Description
+
      <td align="center">C</td>
|Detailed text description of what the online resource is/does.
+
    <td>Provide if description field is null.</td>
|Optional
+
    </tr>
|Free Text
+
    <tr bgcolor="FFFFFF">
|-
+
      <td>description</td>
|Function
+
      <td align="center">C</td>
|Code for function performed by the online resource.
+
      <td>Provide if name field is null.</td>
|Optional
+
    </tr>
|"download" "information" "offlineAccess" "order" "search"
+
    <tr bgcolor="FFFFFF">
|}
+
      <td>function</td>
 +
      <td align="center">M</td>
 +
      <td></td>
 +
    </tr>
 +
    <tr>
 +
      <th colspan="6"></th>
 +
    </tr>
 +
    <tr bgcolor="FFFFFF" border="2">
 +
      <td rowspan="6"> OneStop Project </td>
 +
      <td>linkage</td>
 +
      <td align="center">M</td>
 +
      <td></td>
 +
    </tr>
 +
    <tr bgcolor="FFFFFF">
 +
      <td>protocol</td>
 +
      <td align="center">C</td>
 +
<td>Required when the URL is for Data Access</td>
 +
    </tr>
 +
    <tr bgcolor="FFFFFF">
 +
      <td>applicationProfile</td>
 +
      <td align="center"></td>
 +
      <td></td>
 +
    </tr>
 +
    <tr bgcolor="FFFFFF">
 +
      <td>name</td>
 +
      <td align="center">C</td>
 +
<td>Provide if description field is null.</td>
 +
    </tr>
 +
    <tr bgcolor="FFFFFF">
 +
      <td>description</td>
 +
      <td align="center">C</td>
 +
      <td>Provide if name field is null.</td>
 +
    </tr>
 +
    <tr bgcolor="FFFFFF">
 +
      <td>function</td>
 +
      <td align="center">M</td>
 +
      <td></td>
 +
    </tr>
 +
    </table>
  
==Examples==
+
===More Information===
Examples of how CI_OnlineResource information is represented in various formats.
 
  
===HTML===
+
<table class="wikitable">
  More Information:
 
    [http://www.class.noaa.gov/nsaa/products/search?datatype_family=AERO100 CLASS: Aerosol Optical Thickness (100 KM)]
 
    Information about Aerosol Optical Thickness (100 KM) dataset.
 
  
===Text===
+
<tr><td colspan="3" bgcolor="FFFFFF">'''UML'''</td><td bgcolor="FFFFFF">[[Image:CI OnlineResource.png|thumb|left|CI OnlineResource.png]]</td></tr>
<pre>
+
<tr><td colspan="3" bgcolor="FFFFFF">'''Links'''</td><td>
CI Online Resource:
+
*[[Online Resources]]</td></tr>
  Linkage:
 
    http://www.class.noaa.gov/nsaa/products/search?datatype_family=AERO100
 
  Protocol:
 
    http
 
  Application Profile:
 
    web browser
 
  Name:
 
    CLASS: Aerosol Optical Thickness (100 KM)
 
  Description:
 
    Information about Aerosol Optical Thickness (100 KM) dataset.
 
  Function:
 
    information
 
</pre>
 
  
===FGDC XML===
+
<tr><td colspan="3" bgcolor="FFFFFF">'''Examples'''</td><td>
 
<pre>
 
<pre>
<CI_OnlineResource>
+
&lt;gmd:CI_OnlineResource&gt;
  <linkage>
+
&lt;gmd:linkage&gt;
    http://www.class.noaa.gov/nsaa/products/search?datatype_family=AERO100
+
  &lt;gmd:URL&gt;http://www.ngdc.noaa.gov/dem/squareCellGrid/download/258&lt;/gmd:URL&gt;
  </linkage>
+
  &lt;/gmd:linkage&gt;
  <protocol>
+
   &lt;gmd:name&gt;
    http
+
  &lt;gco:CharacterString&gt;Adak, AK 1 arc-second Tsunami Inundation DEM&lt;/gco:CharacterString&gt;
  </protocol>
+
  &lt;/gmd:name&gt;
  <applicationProfile>
+
   &lt;gmd:description&gt;
    web browser
+
  &lt;gco:CharacterString&gt;Download page for accessing DEM, metadata record and development report.&lt;/gco:CharacterString&gt;
  </applicationProfile>
+
   &lt;/gmd:description&gt;
   <name>
+
   &lt;gmd:function&gt;
    CLASS: Aerosol Optical Thickness (100 KM)
+
  &lt;gmd:CI_OnLineFunctionCode
  </name>
+
     codeList="http://www.ngdc.noaa.gov/metadata/published/xsd/schema/resources/Codelist/gmxCodelists.xml#CI_OnLineFunctionCode"
   <description>
+
    codeListValue="download"&gt;
    Information about Aerosol Optical Thickness (100 KM) dataset.
+
    download
   </description>
+
    &lt;/gmd:CI_OnLineFunctionCode&gt;
   <function>
+
  &lt;/gmd:function&gt;
     information
+
&lt;/gmd:CI_OnlineResource&gt;
  </function>
 
</CI_OnlineResource>
 
 
</pre>
 
</pre>
 +
</td></tr>
  
===DIF XML===
+
</table>
<pre>
 
<Related_URL>
 
  <URL_Content_Type>
 
    <Type>VIEW RELATED INFORMATION</Type>
 
  </URL_Content_Type>
 
  <URL>
 
    http://www.class.noaa.gov/nsaa/products/search?datatype_family=AERO100
 
  </URL>
 
  <Description>
 
    Information about Aerosol Optical Thickness (100 KM) dataset.
 
  </Description>
 
</Related_URL>
 
</pre>
 
  
[[Category:Metadata]]
+
{{template:isoOrderingFooter}}

Latest revision as of 23:18, 17 December 2019

Elements Definition and Recommended Practice
1 linkage 1 Internet address which uses a Uniform Resource Locator address or similar addressing scheme. Provide complete address to active URL. Do not provide URLs in other elements.
Example: https://www.noaa.gov
2 protocol 0..1 The connection protocol to be used. When applicable, use the identifier values in this codelist hosted by Open Source Geospatial Foundation.
3 applicationProfile 0..1 Name of an application profile that can be used with the online resource.
4 name 0..1 Title of the online resource. For HTML pages, use the html title tag. Recommend providing at least a name or a description.
5 description 0..1 Brief text explaining content or purpose of online resource. Recommend providing at least a name or a description.
Example: NOAA homepage
6 function 0..1 Categorize the purpose of this online resource. Use 'download' for direct access to files or ftp sites. Use 'information' for pages with only descriptive information about the resource. Use 'search' for interfaces that support users interaction to find the resource of interest.

Community Requirements

M = Mandatory; C = Conditional; R = Recommended; blank cell = user discretion

Community Element M/C/R Notes
NOAA Completeness Rubric V2 linkage M
protocol C Required when the URL is for Data Access
applicationProfile
name C Provide if description field is null.
description C Provide if name field is null.
function M
OneStop Project linkage M
protocol C Required when the URL is for Data Access
applicationProfile
name C Provide if description field is null.
description C Provide if name field is null.
function M

More Information

UML
CI OnlineResource.png
Links
Examples
<gmd:CI_OnlineResource>
 <gmd:linkage>
  <gmd:URL>http://www.ngdc.noaa.gov/dem/squareCellGrid/download/258</gmd:URL>
   </gmd:linkage>
  <gmd:name>
   <gco:CharacterString>Adak, AK 1 arc-second Tsunami Inundation DEM</gco:CharacterString>
   </gmd:name>
  <gmd:description>
   <gco:CharacterString>Download page for accessing DEM, metadata record and development report.</gco:CharacterString>
  </gmd:description>
  <gmd:function>
   <gmd:CI_OnLineFunctionCode 
    codeList="http://www.ngdc.noaa.gov/metadata/published/xsd/schema/resources/Codelist/gmxCodelists.xml#CI_OnLineFunctionCode" 
    codeListValue="download">
     download
    </gmd:CI_OnLineFunctionCode>
   </gmd:function>
</gmd:CI_OnlineResource>

Legend