pressbooks / ideas

Ideas for Pressbooks.
GNU General Public License v3.0
12 stars 4 forks source link

Produce Crossref-compatible XML metadata exports to make DOI registration faster #423

Open SteelWagstaff opened 2 years ago

SteelWagstaff commented 2 years ago

As a publisher, I'd like to create & register DOIs for content published with Pressbooks as simply and easily as possible.

Notes

Pressbooks allows users to associate books and parts of books (front/back matter, chapters, etc.) with individual digital object identifiers [DOIs]. A digital object identifier (DOI) is a persistent identifier used to identify unique online resources. One of the most widely used DOI issuers is Crossref, but registration of DOIs for chapter-level content can be time consuming and tedious. Crossref provides three methods for creating DOIs:

  1. the Crossref XML plugin for OJS: https://www.crossref.org/documentation/content-registration/ojs-plugin/
  2. their web deposit form: https://www.crossref.org/documentation/content-registration/web-deposit-form/
  3. direct deposit of XML: https://www.crossref.org/documentation/content-registration/direct-deposit-xml/

Possible solutions

Perhaps we could develop a Crossref XML plugin like the one built for OJS. Perhaps we could develop an export option for Pressbooks that includes the metadata required by Crossref's XML schema: https://data.crossref.org/reports/help/schema_doc/5.3.1/index.html

SteelWagstaff commented 2 years ago

A network manager writes: I want to be able to "Facilitate metadata export from Pressbooks in a form suitable for XML upload to CrossRef for DOI registration"

Digital Object Identifiers (DOIs) are persistent identifiers [PIDs] used to identify unique online resources. DOIs are commonly assigned to scholarly journal articles, acting both as a PID and a means for authors to track their individual usage and dissemination. Chapter-level DOIs are increasingly requested by academic authors.

The Pressbooks platform offers a chapter-level DOI field. However, the background functionality to export the resulting metadata from PressBooks in a form compatible with CrossRef XML upload requirements for DOI registration does not currently exist.

CrossRef is the leading DOI registration agency. Adding a metadata CrossRef XML export function would be attractive to the majority of PressBooks clients at educational institutions with the same use-case as ours.

Currently the only option is to manually enter the metadata and DOIs using CrossRef’s web deposit form: https://www.crossref.org/documentation/content-registration/web-deposit-form/. This is feasible for single book-level DOIs, but not in the volume required by chapter-level DOIs, where it is too time-consuming.

CrossRef also allows direct upload of XML, which would be far preferable. Could developers add a metadata export option to PressBooks conforming to their XML schema as below? https://data.crossref.org/reports/help/schema_doc/5.3.1/index.html

SteelWagstaff commented 2 years ago

Users at Sussex were able to "successfully extracted required metadata [for a book with over 100 DOIs] from the exported PressBooks XHTML file, using a Python script. The resultant file was tested against CrossRef's parser test page, which reported it was valid for upload to CrossRef. This was then uploaded. All DOIs were successfully registered and now resolve. We are very happy to share approach and code to help build an official PressBooks export file."