Documentation

Required, recommended, and optional elements

Each content type we support has a unique set of requirements and recommended metadata. Contributor metadata is consistent across content types and, while not always required, has consistent recommendations if present.

Required metadata must be included or your submission will be rejected. Recommended metadata should be included to create a complete metadata record. Optional metadata should be included if relevant, but will not be relevant for most records.

Contributor metadata

Required
Surname
Recommended
given_name, suffix, affiliation, ORCID

Journal and article metadata

Required
Journal (journal_metadata) full_title, ISSN or title-level DOI and URL
Issue (issue_metadata) issue, publication_date (year)
Article (article_metadata) titles, publication_date (year), doi_data

Issue elements are only required if a DOI is being deposited at the issue level. Article elements are likewise only required for article DOI deposits.

Recommended
Journal (journal_metadata) abbrev_title, doi_data, coden, journal_issue, archive-locations (with one archive name), title-level DOI and URL
Issue (issue_metadata) publication_date (month, day), journal_volume, contributors, issue, doi_data
Article (article_metadata) contributors, ORCID, publication_date (day, month), pages (first_page, last_page), citation_list, funding, license, Crossmark metadata and JATS-formatted abstracts
Optional
publisher_item, special_numbering, component_list

Book metadata

Required
Series titles, ISSN, volume, publication_date (year), publisher (publisher_name)
Set titles, volume
Book titles, publication_date (year), publisher
Chapter doi_data
Recommended
Series doi_data,edition_number, ISBN, contributors, coden, series_number, citation_list
Set contributors, ISBN, edition_number, citation_list, doi_data
Book contributors, ISBN, edition_number, doi_data, citation_list,funding, license, and Crossmark metadata
Chapter contributors, titles, pages, publication_date, citation_list, funding, license, and Crossmark metadata
Optional
publisher_item, part_number, component_number,component_list

Conference Proceeding metadata

Required
Series titles, ISSN
Proceeding level proceedings_title, publisher, publication_date (year)
Conference paper contributors, titles, doi_data
Recommended
Series level doi_data, contributors, series_number, ISBN
Conference level volume, contributors, ISBN, event_metadata (conference_date, conference_location, conference_acronym, conference_theme, conference_sponsor, conference_number), proceedings_subject
Conference paper publication_date, pages, citation_list, funding, license, and Crossmark metadata
Optional
publisher_item, coden, component_list

Dataset metadata

Required
Database level titles
Dataset level doi_data
Recommended
Database level contributors, description, database_date, publisher, institution, doi_data
Dataset level contributors, titles, database_date, description, format, citation_list, component_list, funding, license, and Crossmark metadata
Optional
publisher_item, component_list

Dissertation metadata

Required
titles, approval_date, institution, doi_data
Recommended
contributors, ISBN, degree, ORCID, funding, license, and Crossmark metadata
Optional
citation_list, component_list

Posted content metadata

Required
titles, posted_date, doi_data
Recommended
group_title, contributors, acceptance_date, institution, item_number, abstracts, doi_data, citation_list, funding, license, Crossmark metadata and JATS-formatted abstracts
Optional
component_list

Report / Working paper metadata

Required
Series level titles, ISSN
Report level title, publication_date (year)
Recommended
Series level contributors, coden, series_number, volume, doi_data, edition_number, approval_date, publisher, institution, doi_data, citation_list
Report level contributors, ORCIDs, edition_number, approval_date, ISBN, publisher, institution, citation_list, funding, license, and Crossmark metadata
Optional
publisher_item, contract_number

Standard metadata

Required
Standard level title, designator, approval_date, standard_body_name, standard_body_acronym
Item level contributors, titles, component_number, publication_date (year), pages, publisher_item, doi_data
Recommended
Standard level contributors, edition_number, ISBN, institution, citation_list, funding, license, and Crossmark metadata metadata
Item level citation_list
Optional
publisher_item, content_item, component_list

Peer Review metadata

Required
title, review_date (year), relation (isReviewOf)
Recommended
contributors, institution, competing_interest_statement, running_number, license metadata

Page owner: Patricia Feeney   |   Last updated 2021-May-13