'$RCSfile: eml-resource.xsd,v $' Copyright: 1997-2002 Regents of the University of California, University of New Mexico, and Arizona State University Sponsors: National Center for Ecological Analysis and Synthesis and Partnership for Interdisciplinary Studies of Coastal Oceans, University of California Santa Barbara Long-Term Ecological Research Network Office, University of New Mexico Center for Environmental Studies, Arizona State University Other funding: National Science Foundation (see README for details) The David and Lucile Packard Foundation For Details: http://knb.ecoinformatics.org/ '$Author: jones $' '$Date: 2002-12-06 22:23:43 $' '$Revision: 1.75 $' This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version. This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA eml-resource

The eml-resource module contains general information that describes dataset resources, literature resources, protocol resources, and software resources. Each of the above four types of resources share a common set of information, but also have information that is unique to that particular resource type. Each resource type uses the eml-resource module to document the information common to all resources, but then extend eml-resource with modules that are specific to that particular resource type. For instance, all resources have creators, titles, and perhaps keywords, but only the dataset resource would have a "data table" within it. Likewise, a literature resource may have an "ISBN" number associated with it, whereas the other resource types would not. The eml-resource module is exclusively used by other modules, and is therefore not a stand-alone module.

all datasets no Resource Base Generic information about any resource that is being described. The 'ResourceBase' complexType contains information that is inherited by each resource type that is being documented. The subelements with the resource base are common to all resources. Please see the individual sub-fields for specific examples. Alternate Identifier A secondary identifier for this entity An additional, secondary identifier for this entity. The primary identifier belongs in the "id" attribute, but additional identifiers that are used to label this entity, possibly from different data management systems, can be listed here. VCR3465 Short Name A short name that describes the resource, sometimes a filename. The 'shortName' field provides a concise name that describes the resource that is being documented. It is the appropriate place to store a filename associated with other storage systems. vernal-data-1999 Title A brief description of the resource, providing enough detail to differentiate it from other similar resources. The 'title' field provides a description of the resource that is being documented that is long enough to differentiate it from other similar resources. Multiple titles may be provided, particularly when trying to express the title in more than one language (use the "xml:lang" attribute to indicate the language if not English/en). Vernal pool amphibian density data, Isla Vista, 1990-1996. Creator The people or organizations who created this resource. The 'creator' element provides the full name of the person, organization, or position who created the resource. The list of creators for a resource represent the people and organizations who should be cited for the resource. For a book, the creators are its authors. Metadata Provider The people or organizations who created provided documentation and other metadata for this resource. The 'metadataProvider' element provides the full name of the person, organization, or position who created documentation for the resource. The scientist who collected the data, sometimes a data technician, or other individual. Associated Party Other people or organizations who should be associated with this resource. The 'associatedParty' element provides the full name of other people, organizations, or positions who should be associated with the resource. These parties might play various roles in the creation or maintenance of the resource, and these roles should be indicated in the "role" element. The technician who collected the data. Role The role the party played with respect to the resource. Use this field to describe the role the party played with respect to the resource. Some potential roles include technician, reviewer, principal investigator, and many others. principalInvestigator Publication date The publication date of the resource. The 'pubDate' field represents the date that the resource was published. The format should be represented as: CCYY, which represents a 4 digit year, or as CCYY-MM-DD, which denotes the full year, month, and day. Note that month and day are optional components. Formats must conform to ISO 8601. 1999-10-26 Language The language in which the resource is written. The language in which the resource is written. This can be a well-known language name, or one of the ISO language codes to be more precise. English Series The series from which the resource came. This field describes the series of resources that include the resource being described. For example, a volume of a journal may be part of a series of the journal for a particular year. Volume 20 Abstract A brief overview of the resource. A brief overview of the resource that is being documented. The abstract should include basic information that summarizes the resource. Keyword information Keyword information that describes the resource. The 'keywordSet' element is a container for the 'keyword' and 'keywordThesaurus' fields. Each keywordSet field can contain one or more keywords and a name of a thesaurus for the set of keywords. Each keyword field should contain one and only one keyword (i.e., keywords should not be separated by commas or other delimiters). Please see the examples for the subfields contained within this field. Keyword A single keyword that describes the resource. This field names a keyword or keyphrase that concisely describes the resource or is related to the resource. Each keyword field should contain one and only one keyword (i.e., keywords should not be separated by commas or other delimiters). biodiversity Keyword type The type of each keyword. This field classifies the keyword that has been provided from a list of pre-determined categories. The possible types are listed in the example. "discipline","place","stratum","temporal","thematic", or "taxonomic" Keyword thesaurus The name of a thesaurus from which the keyword is derived. This field provides the name of the official keyword thesaurus from which keyword was derived. The keyword thesauri are usually discipline specific. IRIS keyword thesaurus Additional Information Any extra information pertitent to the resource. This field provides any information that is not characterized by the other resource metadata fields. Copyright 2001, Robert Warner Intellectual Property Rights Intellectual property rights regarding usage and licensing of this resource. Typically, an intellectual Rights element will contain a rights management statement for the resource, or reference a service providing such information. Rights information encompasses Intellectual Property Rights (IPR), Copyright, and various Property Rights. In the case of a data set, rights might incude requirements for use, requirements for attribution, or other requirements the owner would like to impose. Copyright 2001 Regents of the University of California Santa Barbara. Free for use by all individuals provided that the owners are acknowledged in any use or publication. Distribution Information Information on how the resource is distributed online and offline This element provides information on how the resource is distributed online and offline. Connections to online systems can be described as URLs and as a list of relevant connection parameters. Resource coverage Extent of the coverage of the resource. This element describes the extent of the coverage of the resource in terms of its spatial extent, temporal extent, and taxonomic extent. For data sets, this is useful to specify the entire extent to which all of the data might apply. See the coverage module for examples. Keyword type codes The list of keyword categories This field provides a restricted list of categories that a keyword may fall under. place Year or Date A type allowing a year or date value This type is the union of the built-in types for year and date. 1999, or 2001-03-15 Identifer A unique identifier for this additional metadata that can be used to reference it elsewhere. A unique identifier for this additional metadata that can be used to reference it elsewhere. This is a formal field in that it is an error to provide a value for the id attribute that is not unique within the document's set of id attributes. This is designed to allow other portions of the metadata to reference this section formally. knb.343.22 Identifer System The data management system within which an identifier is in scope and therefore unique. The data management system within which an identifier is in scope and therefore unique. This is typically a URL (Uniform Resource Locator) that indicates a data management system. All identifers that share a system must be unique. In other words, if the same identifier is used in two locations with identical systems, then by definition the objects at which they point are in fact the same object. http://metacat.somewhere.org/svc/mc/ Identifer Scope The scope of the identifier. The scope of the identifier. Scope is generally set to either "system", meaning that it is scoped according to the "system" attribute, or "document" if it is only to be in scope within this single document instance. In this particular use of scope, it is FIXED to be "system" because the packageId is required and always has the scope of the required "system". system Online Distribution Information Distribution information for accessing the resource online. Distribution information for accessing the resource online, represented either as a URL or as a series of named parameters that are needed in order to connect. The URL field is provided for the simple cases where a file is available for download directly from a web server or other similar server and a complex connection protocol is not needed. The connection field provides an alternative where a complex protocol needs to be named and described, along with the necessary parameters needed for the connection. Download site URL A URL (Uniform Resource Locator) from which this resource can be downloaded or information can be obtained about downloading it. A URL (Uniform Resource Locator) from which this resource can be downloaded or additional information can be obtained. If accessing the URL would directly return the data stream, then the "function" attribute should be set to "download". If the URL provides further information about downloading the object but does not directly return the data stream, then the "function" attribute should be set to "information". If the "function" attribute is omitted, then "download" is implied for the URL function. In more complex cases where a non-standard connection must be established that complies with application specific procedures beyond what can be described in the simple URL, then the "connection" element should be used instead of the URL element. http://data.org/getdata?id=98332 Connection A description of the information needed to make an application connection to a data service. A description of the information needed to make an application connection to a data service. The connection starts with a connectionDefinition which lists all of the parameters needed for the connection and possible default values for each. It then includes a list of parameter values, one for each parameter, that override the defaults for this particular connection. One parameter element should exist for every parameterDefinition that is present in the connectionDefinition, except that parameters that were defined with a defaultValue in their parameterDefinition can be ommitted from the connection and the default will be used. All information about how to use the parameters to establish a session and extract data is present in the connectionDefinition, possibly implicitly by naming a connection schemeName that is well-known. Connection Definition Definition of the connection protocol to be used for this connection. Definition of the connection protocol to be used for this connection. The definition has a "scheme" which identifies the protocol by name, and a detailed description of the scheme and its required parameters. Parameter A parameter to be used to make this connection. A parameter to be used to make this connection. This value overrides any default value that may have been provided in the connection definition. Parameter Name Name of the parameter to be used to make this connection. The name of the parameter to be used to make this connection. hostname Parameter Value The value of the parameter to be used to make this connection. The value of the parameter to be used to make this connection. This value overrides any default value that may have been provided in the connection definition. nceas.ucsb.edu Connection Definition The definition of a type of connection that will be used in another location in the EML document. The definition of a type of connection that will be used in another location in the EML document. This only provides the definition of the protocol and its parameters, but not the actual values to be used to make the connection (instead, see the connection element). medium of the resource the medium on which this resource is distributed, either digitally or as hardcopy the medium on which this resource is distributed digitally, such as 3.5" floppy disk, or various tape media types, or 'hardcopy' CD-ROM, 3.5 in. floppy disk, Zip disk Medium name Name of the medium that for this resource distribution Name of the medium on which this resource is distributed. Can be various digital media such as tapes and disks, or printed media which can collectively be termed 'hardcopy'. Tape, 3.5 inch Floppy Disk, hardcopy density of the digital medium the density of the digital medium if this is relevant. the density of the digital medium if this is relevant. Used mainly for floppy disks or tape. High Density (HD), Double Density (DD) units of a numerical density a numerical density's units if a density is given numerically, the units should be given here. B/cm storage volume total volume of the storage medium the total volume of the storage medium on which this resource is shipped. 650 MB medium format format of the medium on which the resource is shipped. the file system format of the medium on which the resource is shipped NTFS, FAT32, EXT2, QIK80 note about the media note about the media any additional pertinent information about the media Inline distribution Object data distributed inline in the metadata. Object data distributed inline in the metadata. Users have the option of including the data right inline in the metadata by providing it inside of the "inline" element. For many text formats, the data can be simply included directly in the element. However, certain character sequences are invalid in an XML document (e.g., <), so care will need to be taken to either 1) wrap the data in a CDATA section if needed, or 2) encode the data using a text encoding algorithm such as base64, and then include that in a CDATA section. The latter will be necessary for binary formats. Connection Definition The definition of a type of connection that will be used in another location in the EML document. The definition of a type of connection that will be used in another location in the EML document. This only provides the definition of the protocol and its parameters, but not the actual values to be used to make the connection (instead, see the connection element). The same connection definition may be used by multiple connections (e.g., to download different files from the same database), but each connection must provide or reference a valid connection definition. Scheme Name The name of the scheme used to identify this connection. The name of the scheme used to identify this connection. The scheme name is qualified by its system attribute. The scheme name implies a particular protocol for accessing information from the connection. Applications must have a knowledge of the scheme or be able to deduce the protocol from the scheme description in order to effectively access data over the connection. Many schemes will be unknown to client applications. At some later point in time a registry for connection schemes may be established in order to promote application interoperability, and we may expand this portion of EML to adopt a more comprehensive standard such as WSDL, but for now this simpler description is provided. metacat Scheme System The system in which this scheme name is relevant The computing system within which this scheme name has relevance. This attribute qualifies the scheme name in order to decrease the likelihood of scheme name collisions when more that one EML user defines a scheme name with the same name but different semantics. http://knb.ecoinformatics.org/knb/ Scheme Description The description of the scheme used to identify this connection. The description of the scheme used to identify this connection. The scheme name implies a particular protocol for accessing information from the connection. Applications must have a knowledge of the scheme or be able to deduce the protocol from the scheme description in order to effectively access data over the connection. The metacat application protocol. Applications must first log into metacat by sending an HTTP POST request in http-url-encoded format with the parameters action, username, and password. Action must be set to "login". If authentication is successful, the metacat server will respond with a session cookie. All future requests should include the session cookie in the HTTP header. To retrieve an object, the client then would send an HTTP POST in http-url-encoded format, with an action parameter set to "get" and the docid paramter set to the identifier for the desired object. The response will either be an XML document or a multipart-form-encoded response containing data. Parameter Definition The definition of a parameter that is needed to properly use this connection scheme. The definition of a parameter that is needed to properly use this connection scheme. Each parameter has a name and a definition that are used by applications to assess the type of information needed for the request. Parameters may also set default values that are used if a connection does not provide a value for a parameter. Parameter Name The Name of a parameter that is needed to properly use this connection scheme. The name of a parameter that is needed to properly use this connection scheme. hostname Parameter Definition The definition of a parameter that is needed to properly use this connection scheme. The definition of a parameter that is needed to properly use this connection scheme. The definition is used by applications to assess the type of information needed for the request. The fully qualified name of the internet host that is providing the metacat service, as would be returned by a Domain Name System (DNS) query. Default Parameter Value The default value for a parameter that is needed to properly use this connection scheme. The default value for a parameter that is needed to properly use this connection scheme. If a default value is set, then it should be used for connections that do not override the default with a connection-specific value. This allows a definition to be established that declares common information that might be shared by several connections as default values. Parameter values provided in the connection always override any default values provided in the conneciton definition. metacat.nceas.ucsb.edu References Group A group of elements repeatedly used throughout EML to reference IDs. A group containing the "references" element that is used throughout EML. References The id of another element in this EML document to be used to here in this context. The id of another element in this EML document to be used to here in this context. This is used instead of duplicating information when an identical piece of information needs to be used multiple times in an EML document. For example, if the same person is the creator, metadataProvider, and contact for a dataset, their name and address can be provided once as part of the "creator" element, and then their "id" can be used in the "references" element of metadataProvider and contact. This reduces the likelihood of error by reducing redundancy, and allows one to specify that two pieces of information are identical. To be a vaild EML document, the content of every "references" element MUST be defined in the document as the value of an "id" attribute on some element within the document. Other critical rules about the use of IDs and references in EML are provided in the text of the EML specification. knb.45.3