TL;DR We missed an error that led to resource resolution URLs of some 500,000+ records to be incorrectly updated. We have reverted the incorrect resolution URLs affected by this problem. And, we’re putting in place checks and changes in our processes to ensure this does not happen again.
How we got here Our technical support team was contacted in late June by Wiley about updating resolution URLs for their content. It’s a common request of our technical support team, one meant to make the URL update process more efficient, but this was a particularly large request.
Crossref Conversations is an audio blog we’re trying out that will cover various topics important to our community. This conversation is between colleagues Anna Tolwinska and Rosa Morais Clark, discussing how we can make research happen faster, with fewer hurdles, and how Crossref can help. Our members have been asking us how Crossref can support open science, and we have a few insights to share. So we invite you to have a listen.
We’ve just added to our input schema the ability to include affiliation information using ROR identifiers. Members who register content using XML can now include ROR IDs, and we’ll add the capability to our manual content registration form, participation reports, and metadata retrieval APIs in the near future. And we are inviting members to a Crossref/ROR webinar on 29th September at 3pm UTC.
The background We’ve been working on the Research Organization Registry (ROR) as a community initiative for the last few years.
We’re excited (and a little nervous) to launch a new research project designed to assess the effects of metadata on research communications. We’re expecting this effort to be a significant contribution to the existing research on the topic and we’re really looking forward to getting started. We’re also a little nervous because of course we don’t know what the conclusions will be (after all, if we did, we wouldn’t be starting this project).
It’s really important for consistency and usability that all members follow these guidelines. We rarely have to change them and usually only do so for very good reasons. Please note that this is for display of Crossref DOIs, not anyone else’s DOIs, as not all DOIs are made equal.
The goals of the guidelines are to:
Make it as easy as possible for users without technical knowledge to cut and paste or click to share Crossref DOIs (for example, using right-click to copy a URL).
Get users to recognize a Crossref DOI as both a persistent link as well as a persistent identifier, even if they don’t know what a DOI is.
Enable points 1 and 2 above by having all Crossref members display DOIs in a consistent way.
Enable robots and crawlers to recognize Crossref DOIs as URLs.
When linking to a research work, use its DOI rather than its URL. If the URL changes, the publisher will update the metadata in Crossref with the new URL, so that the DOI will always take you to the correct location of the work.
How to display a Crossref DOI
When displaying DOIs, it’s important to follow these display guidelines. Crossref DOIs should:
Crossref DOIs should be displayed as the full URL link wherever the bibliographic information about the content is displayed.
An obligation of membership is that Crossref DOIs must be displayed on members’ landing pages. We recommend that Crossref DOIs also be displayed or distributed in the following contexts:
Tables of contents
Full-text HTML and PDF articles, and other scholarly documents
Citation downloads to reference management systems
Metadata feeds to third parties
“How to Cite This” instructions on content pages
Social network links
Anywhere users are directed to a permanent, stable, or persistent link to the content.
Crossref members should not use proprietary, internal, or other non-DOI URLs in citation downloads, metadata feeds to third parties, nor in instructions to researchers on how to cite a document.
Crossref DOIs in reference lists and bibliographies
Linking references in journal articles using Crossref DOIs is a condition of membership. This means including the DOI for each item in your reference list. We strongly encourage members to link references for other content types too. Because there are space constraints even in online references lists, Crossref DOIs can be displayed in several ways, depending on the publisher’s preference and publication style. We recommend the following options:
use the Crossref DOI URL as the permanent link. Example: Soleimani N, Mohabati Mobarez A, Farhangi B. Cloning, expression and purification flagellar sheath adhesion of Helicobacter pylori in Escherichia coli host as a vaccination target. Clin Exp Vaccine Res. 2016 Jan;5(1):19-25. https://doi.org/10.7774/cevr.2016.5.1.19
display the text Crossref with a permanent DOI link behind the text. Example: Galli, S.J., and M. Tsai. 2010. Mast cells in allergy and infection: versatile effector and regulatory cells in innate and adaptive immunity. Eur. J. Immunol. 40:1843–1851. Crossref.
The International DOI Foundation created the ShortDOI service as an open system that creates shortcuts to DOIs. DOIs can be long, so this service aimed to to the same thing as URL shortening services. For example, for the DOI https://doi.org/10.7774/cevr.2016.5.1.1, the short form is https://doi.org/bwfc. Only one ShortDOI is created for each DOI, and the ShortDOI returns exactly the same results as the DOI. ShortDOIs are not widely used and are not really actual DOIs themselves, which is confusing. We recommend simply creating shorter DOIs in the first place. Learn more about constructing your DOIs.
Frequently Asked Questions (FAQs) about the March 2017 changes
Do we need to change how DOIs are displayed in already-published content and existing PDFs?
No - you can make the change for new content going forward and do not need to update existing PDF files. You can update existing content if you want to, but this is optional. The current form, for DOI links using http://dx.doi.org, will continue to work as long as Crossref and the DOI system exist.
Can we make the display changes now or do we need to wait?
These guidelines are now in effect. We set the date as March 2017, after giving our members six months' notice to make the changes.
Why does the DOI have to be displayed as a link on the page that the DOI links to?
Some members have reported resistance from colleagues to displaying the Crossref DOI on the landing page as a link (they say the DOI link in that location appears superfluous as it appears to link to itself). The Crossref DOI must be displayed as a link, because it is both an identifier and a persistent link. It is easier for users when members display the DOI as a full link as they can copy it easily. Also, many users don’t know what a DOI is, but they know what a link is. We want to encourage the DOI to be used as a persistent link, and to be shared and used in other applications (such as reference management tools). A fully linked DOI enables this, wherever it appears.
Do we need to redeposit our metadata to update the DOI display?
No - there is no need to redeposit metadata. These guidelines cover how you display DOIs on your website, not how to register them with us.
Why not use doi: or DOI:?
When Crossref was founded in 2000, we recommended that DOIs be displayed in the format doi:10.NNNN/doisuffix and many members still use doi:[space][doinumber], DOI: [space][doinumber], or DOI[space][doinumber]. At the time that the DOI system was launched in the late 1990s it was thought that doi: would become native to browsers and automatically resolve DOIs, like http:. This did not happen, and so doc:/DOI: is not a valid way of displaying or linking DOIs.
Advantages to changing the display to a resolvable URL (even on the page the DOI itself resolves to) include:
A DOI is both a link and an identifier. Users will more easily recognize Crossref DOIs as an actionable link, regardless of whether they know about DOIs
Users who do not know how to right-click on the link and choose Copy link will still be able to easily copy the DOI URL
Machines and programs (such as bots) will recognize the DOI as a link, thereby increasing discoverability and usage.
What about reference formats in style guides (such as APA, Chicago) that use doi: [doinumber]?
A number of style guides recommend including a DOI in the reference as an unlinked string. We are contacting the main style guides to request that they update their recommendations for DOIs to use the full-URL form.
Why not use dx as in http://0-dx.doi.org.library.alliant.edu/?
Originally the dx separated the DOI resolver from the International DOI Foundation (IDF) website but this changed a few years ago and the IDF recommends http://doi.org as the preferred form for the domain name in DOI URLs.
Why should we use HTTPS?
Providing the central linking infrastructure for scholarly publishing is something we take seriously. Because we form the connections between publisher content all over the web, it’s important that we do our bit to enable secure browsing from start to finish. In addition, HTTPS is now a ranking signal for Google, which gives sites using HTTPS a small ranking boost.
The process of enabling HTTPS on publisher sites will be a long one, and given the number of members we have, it may take a while before everyone’s made the transition. But by using HTTPS we are future-proofing scholarly linking on the web.
Some years ago we started the process of making our new services available exclusively over HTTPS. The Crossref Metadata API is HTTPS enabled, and Crossmark and our Assets CDN use HTTPS exclusively. In 2015 we collaborated with Wikipedia to make all of their DOI links HTTPS. We hope that we’ll start to see more of the scholarly publishing industry doing the same.
Page owner: Ginny Hendricks | Last updated 2021-April-21