USGS Home
Contact USGS
Search USGS

Metadata in plain language

Plain-language resources for metadata creators and reviewers

Figure 1. Diagram depicting the flow of metadata from data producers to data users. This information transfer cannot occur using plain language alone because unstructured information cannot be reliably indexed by topic, place, time, and other characteristics, nor can it be reliably reexpressed in a variety of formats suiting the needs of diverse users. Consequently the metadata must be expressed using some technical terminology in a standardized structure and parseable format; these allow computer software to index it appropriately and reexpress the metadata in plain language as well as technical terminology.
This diagram is also available as a line drawing in PDF:

<http://geology.usgs.gov/tools/metadata/tools/doc/ctc/pathway-bw.pdf>

Plain-language approaches to creating, reviewing, and reading metadata

1. Understanding metadata and learning how to write it
   • Metadata in Plain Language: A guide for metadata creators and reviewers

     <http://geology.usgs.gov/tools/metadata/tools/doc/ctc/>
     

     The goals of these pages are to put the metadata standard's many elements into perspective and to show how to create a metadata record using a heuristic procedure. They present the FGDC metadata standard as a series of plain-language questions; for each question they show which elements of the metadata standard should hold the answers, and how to express the answers correctly.
2. Expressing metadata as answers to standard questions
   • The USGS metadata parser mp reads, checks, and re-expresses metadata

     <http://geology.usgs.gov/tools/metadata/tools/doc/mp.html>
     

     MP checks the structure of metadata against the FGDC standard, indicating where and how the metadata record doesn't conform. MP then re-expresses the metadata in a variety of formats that are likely to be useful in different ways. MP can create SGML, XML, parseable text (its input formats), as well as HTML and DIF, a form used by the NASA Global Change Master Directory. Of particular interest is the new FAQ-style HTML, which presents the metadata as answers to the same plain-language questions given in Metadata in Plain Language. The abbreviation FAQ as commonly found on the internet refers to frequently-asked questions; since metadata are produced before a data set is used extensively by the public, FAQ here refers to frequently-anticipated questions. This form is likely to be more readable by people who are unfamiliar with the FGDC standard.
     How to generate FAQ-style HTML using mp:
     The simplest method is to invoke mp with the -f option:

     mp info.met -f info.html
     

     This will place into the file info.html the FAQ-style HTML output.
     An alternative method is to specify the form of the file name in a config file. Under output:html the name of the FAQ-style HTML output is specified using the element faq as follows:

     output:
       html:
         file: %s.html
         faq: %s.faq.html
     

     Here the file element contains a template showing how mp should compose the name of the outline-style HTML file; in the template, the string %s is replaced with the name of the input file (with its extension removed). Likewise, the faq element contains a template showing how mp should compose the name of the FAQ-style HTML file.
     Note that the Clearinghouse server software currently in use (May-1999) assumes that if the SGML metadata document selected is info.sgml (for example) then the HTML document to be returned to the user is info.html. That strategy will normally return the outline form of HTML to the user. If you wish to return the FAQ-style HTML first, then you should change the values shown above like this:

     output:
       html:
         file: %s.out.html
         faq: %s.html
     

     Using these config file elements, the FAQ-style output will be the one returned by the server through a Z39.50 PRESENT request.
     NOTE: mp now provides in its HTML output a link to each of the other output formats that you requested when running mp. These links are relative to the current directory by default, and will work correctly when someone retrieves a metadata record directly through a web server. However, HTML metadata records retrieved through the Clearinghouse gateway interface come tagged with the URL of the gateway, consequently these links will not work by default with HTML records found through the gateway interface. To make these links work without regard to the retrieval method, place a BASE tag into the HEAD element of the output HTML code. As you might guess, mp can do this for you, but it needs to know the URL where your metadata will be available as web pages. It gets this information from a config file entry as follows:

     output:
       html:
         base: URL
     

     So if your web site has a URL like

       http://www.our-data.org/metadata/
     

     that will contain your metadata records, put this into your config file:

     output:
       html:
         base: http://www.our-data.org/metadata/
     

     Obviously you have to use the -c config_file command line option for mp, substituting for config_file the name of the actual config file you'll be using.
   • How mp writes FGDC metadata elements in plain language

     <http://geology.usgs.gov/tools/metadata/tools/doc/plain.faq.html>
     

     This is a specially constructed record showing how mp composes plain- language output from FGDC elements. Generated entirely by mp, it shows where the elements of the metadata standard appear in the output as answers to questions. This file should not be regarded as authoritative, since there are many choices that must be made when creating metadata, however it may help people to understand how mp composes answers to the plain-language questions using the standard FGDC elements.
3. Examples showing plain-language and technical terminology
   • Geology of the onshore part of San Mateo County, California: A digital database
     • Questions & Answers (FAQ-style HTML)
       <http://geo-nsdi.er.usgs.gov/metadata/open-file/98-137/metadata.faq.html>
     • Outline (original-recipe HTML)
       <http://geo-nsdi.er.usgs.gov/metadata/open-file/98-137/metadata.html>
     • Parseable text (not HTML)
       <http://geo-nsdi.er.usgs.gov/metadata/open-file/98-137/metadata.met>
   • Additional examples can be found on the U.S. Geological Survey Geoscience Data node of the National Geospatial Data Clearinghouse

     <http://geo-nsdi.er.usgs.gov/>