Documentation

Registering updates

Typically, when an editorially significant update is made to a document, the publisher will not modify the original document, but will instead issue a separate document (such as a correction or retraction notice) which explains the change. This separate document will have a different DOI from the document that it corrects and will there have different metadata. This process is complementary to versioning.

A retraction notice updates an article, which is updated by the retraction notice

In this example, article A (with the DOI 10.5555/12345678) is eventually retracted by a retraction notice RN (with the DOI 10.5555/24242424x). Each document has Crossmark metadata, but the fact that RN updates article A is only recorded in the RN’s Crossmark deposit. The Crossmark internal API has to tie the two documents together and indicate in metadata of the original document (A), that it has been updated_by the second document (RN).

The Crossmark part of the metadata schema is used to register updates, but this doesn’t mean that you need to have implemented other parts of Crossmark to deposit updates. In the examples below, in the <crossmark> section you can use only the <update> field in the deposit XML if you don’t usually deposit other Crossmark metadata.

Example 1: simple retraction

This is a simple example of article A being retracted by a retraction notice RN where both A and RN have Crossmark metadata deposited.

First, the PDF is produced and the XML deposited to Crossref.

When the retraction is issued, it is issued as a separate “retraction notice” with its own DOI, PDF, and Crossref metadata.

Example 2: simple correction

This is a simple example of article B being corrected by a correction notice CN where both B and CN have Crossmark metadata deposited. The only real difference between this and the previous example is that we are creating a different kind of update.

Example 3: in-situ correction

When a member does not issue a separate update/correction/retraction notice and instead just makes the change to the document (without changing its DOI either), this is called an in-situ update. In-situ updates or corrections are not recommended because they tend to obscure the scholarly record. How do you tell what the differences are between what you downloaded and the update? How do you differentiate them when citing them (remember, we are only talking about “significant updates” here)? However, some members need to support in-situ updates, and this is how they can be supported.

Example 4: correction of article that has no Crossmark metadata deposited

If you deposit Crossmark metadata for a retraction or and update notice which, in turn, points at an article that does not have Crossmark metadata assigned to it, we will generate a “stub” Crossmark for the item being updated. The stub metadata will simply copy essential Crossmark metadata. This metadata can be queried via our API, but won’t activate anything on your site unless you add the Crossmark widget to the corresponding page of the item being updated.

Still, note that if you query Crossmark metadata for Article E, you will get a Crossmark stub which has been automatically been generated by Crossref.

The procedure for updating the content follows the same pattern as a simple correction or retraction:

Example 5: correction notice that corrected multiple documents

Sometimes members issue correction or clarification notices which provide corrections for multiple documents. This too can be supported by Crossmark. In the following example, one correction/clarification document provides updates to two documents (F and G)

Page owner: Martyn Rittman   |   Last updated 2024-May-27