DOI Metadata Guidelines

Note

This page is under constructions. Contributions, comments, and improvements welcome in our Github Issues

ROOT

This is the root of the submission file document, and thus required.

Note that the content of the <resource> element is defined under an xs:all group, so that the immediate child nodes can appear in any order. The order here reflects the order in which they are listed in the schema.

REQUIRED

This is the assigned DOI identifier and must begin with the DataCite prefix “10.”

Required attribute: identifierType. This must have a value of DOI. For example:

<identifier identifierType="DOI">10.12345/abcde</identifier>

REQUIRED

This is the author list or equivalent. Creators should appear in priority order. Both individuals and institutions/organizations can be credited as creators.

If the only list we have is a list of editors, then it goes here, but also indicate in the <contributors> section that each person in the list is a contributor with the role of Editor. This is not an optimal solution, but it will do for now.

REQUIRED, repeatable

This class contains the identifying information for one creator. It is repeated for each creator. Note that the metadata schema does not distinguish between “authors” and “editors”. If some of the creators listed are editors rather than authors, repeat their creator information in the <contributors> section and indicate a role of “Editor”.

Fill out as much of this class as possible with information that was apropos at the time of the publication. So, if you know given name, include it; if you know the institutional affiliation, include it; if you can find and confirm the correct ORCID, include it; etc. This all helps in linking the data set into the literature and the author’s network.

REQUIRED

The string representing the name as it should appear in citations. For personal names, the format is “Family, Given” (all one string). Full first names are preferred for the metadata, in order to help identify authors unambiguously. (It is also relatively easy to turn a complete name into an initial.) For organizational names, use the full, formal name of the organization.

This tag has one optional XML attribute, nameType, which takes one of these values:

Organizational Personal

Best practice is to always include this attribute for creatorName.

OPTIONAL

For personal names, this should contain the string corresponding to the given name in the <creatorName> element. This should not be present for organizational names (but that is not enforced by the DataCite schema).

OPTIONAL

For personal names, this should contain the string corresponding to the family name (surname, patronymic, etc.). This should not be present for organizational names (but that is not enforced by the DataCite schema).

Note: For PDS purposes, at least, we should consider where to associate suffixes (Jr., Sr., III, etc.). If DataCite, ADS, or the AAS journals have a convention, we should follow that.

OPTIONAL, repeatable

This attribute provides a formal identifier for an individual or organization - for example, an author’s ORCID, or an organizational DOI. Only public identifiers should appear here, of course. If there is more than one applicable identifier, this element may be repeated.

Required attribute: nameIdentifierScheme. The value should be the common name or acronym for the identifier given (like “ORCID”). Optional attribute: schemeURI. The value should be the URI of the defining organization or schema (”http://orcid.org”, e.g.).

Where it can be obtained directly from the creator, or where we can be certain about a creator’s ORCID, we should add it to the metadata.

OPTIONAL, repeatable

This attribute provides an organizational affiliation (as free-format text) for the creator. It may be repeated. Organizational “creators” may also have affiliations, if that makes sense.

Optional attribute: affiliationIdentifier. The value should be a formal, permanent, unique identifier for the affiliated organization, beyond the name that is the value of the <affiliation> element. For example, a Research Organization Registry (ROR) ID would be ideal here.

Optional attribute: affiliationIdentifierScheme. The (human-recognizable) name of the identifier system (e.g., “ROR” would be sufficient in the above case.

Optional attribute: schemeURI. The URI of the identifier scheme, typically a URL.

REQUIRED

This class lists names or titles for the resource being identified. At least one title must be provided. This is the title that will be used to format citations, and it is also the title that users will see returned by various search interfaces. It needs to make sense in a general, non-PDS search context, so avoid acronyms and assuming that users will know that, for example, “Deep Impact” is also the name of a spacecraft and NASA mission.

Remember the primary title has to make sense in the context of an ADS-type search. Users may not know that data sets are included in their result set. The title we put here will be used to formulate citations of the data set as well as helping users to identify data of potential interest. So avoid acronyms (no matter how obvious they seem now) unless they include the full name. For example, “DIF” is not good on its own, but “Deep Impact Flyby (DIF) Spacecraft” is very good - explicit and contains the acronym that knowledgeable users might search on as well.

===