Documentation

Participating in Crossmark

Fully implementing Crossmark is a relatively technical process, much more so than just registering DOIs for your content. You’ll need to deposit Crossmark-specific metadata for each DOI that you register. Additionally, you’ll need to include the DOI in a html tag in each article landing page where Crossmark is implemented, as well as include a script in the source code for each page that calls the Crossmark dialog box. Not all members will be able to implement Crossmark, so it’s important that you read through the steps carefully and check with your technical teams before starting.

On this page, learn more about:

Step one: Check your content registration tool

  • If you’re using Metadata Manager to register content, you need to contact us before starting to use the Crossmark service. We need to take action to make the relevant fields available to you in Metadata Manager.
  • If you’re using any deposit method except Metadata Manager, you can immediately move to step 2.

Step two: Designate a Crossmark policy page and assign it a DOI

You’ll need a way to explain Crossmark to your readers. To do this, you’ll need a page on your website explaining that you are participating in the Crossmark service and have committed to maintaining version of record copies of content that display the Crossmark button. This page should be registered and have a DOI to enable persistent linking. It should explain your policies on corrections, retractions, withdrawals and other updates, and may contain definitions and explanations of any additional custom metadata fields that are being used. The page could also include links to other relevant policies such as author submission guidelines, and peer review guidelines. You may already have a suitable page on your website, but don’t forget to register it with us so it has a DOI.

Learn more about creating a Crossmark policy page.

Step three: Deposit the minimum Crossmark metadata for all your content

It’s important to apply the Crossmark button to all of your current content, not just content that has updates. The problem with partial implementation of Crossmark is that when an item of content is published, you won’t know if it might need to be updated at some point in the future. Therefore, a researcher may download a PDF article today without a Crossmark button, but if the article is subsequently updated and the Crossmark button is added, the researcher has no way of knowing if their locally-saved article is still current, as it had no Crossmark button at the point when they downloaded it. If you’re using the Crossmark service, we’d expect you to display the Crossmark button on all your content, whether or not it has an update.

The minimum metadata required for the Crossmark button to display is:

  • The DOI of the content the Crossmark is being applied to
  • The DOI for your Crossmark Policy Page

Deposit Crossmark metadata by direct deposit of XML

If you usually register your content with us by uploading XML files into the admin tool or sending us XML by HTTPS POST, then you can include Crossmark metadata in your initial deposit. You can also add Crossmark metadata to existing DOIs using a resource only deposit.

Deposit Crossmark metadata using Metadata Manager or web deposit form

Simply add your Crossmark metadata into the relevant fields.

In Metadata Manager, you need to add the Crossmark Policy Page up at journal level. Go to the journal-level record for your publication, add your Crossmark policy page DOI, and click Save.

Add Crossmark policy page DOI in Metadata Manager

Deposit Crossmark metadata using the Crossref plugin for OJS

This is not currently available, but should be coming soon.

Step four: Add metadata that reflects any updates to specific items

If there is an update to a content item, you need to add extra Crossmark metadata to indicate this. Updates should only be deposited for editorially significant changes - those that are likely to affect the interpretation or crediting of the work, and not for minor changes such as spelling corrections or formatting changes.

There are 12 defined types of accepted update within Crossmark:

  • addendum
  • clarification
  • correction
  • corrigendum
  • erratum
  • expression_of_concern
  • new_edition
  • new_version
  • partial_retraction
  • removal
  • retraction
  • withdrawal

If an update does not fall into one of these categories, it should instead be placed in the more information section of the pop-up box by being deposited as an assertion. Please note - @order is an optional attribute. If @order is absent, it will return results in the order in which you list them in your deposit, but this is not guaranteed. If you want to be sure of the order, then you can use @order. Learn more about the Crossmark deposit elements (including what is optional) in the schema.

When deposited content corrects or updates earlier content, the DOI(s) of the corrected content must be supplied in the Crossmark metadata. See the Crossref unixref documentation section on updates for examples of how this is recorded in the Crossmark metadata. When a correction is made in situ (that is, it replaces the earlier version completely), then the DOI of the corrected content will be the same as the DOI for the original Crossref deposit. In situ updates are not considered best practice as they obscure the scholarly record.

Step five: Apply the Crossmark button to your HTML pages

Add the button

We supply a templated HTML/JavaScript code widget which will embed the Crossmark button and functionality into your web pages. The latest version of the widget (v2.0) is below. Do ensure you are using the latest version and that it points to our production server. Do not alter the script or host the button locally.

<!-- Start Crossmark Snippet v2.0 -->
<script src="https://0-crossmark--cdn-crossref-org.brum.beds.ac.uk/widget/v2.0/widget.js"></script>
 <a data-target="crossmark"><img src="https://0-crossmark--cdn-crossref-org.brum.beds.ac.uk/widget/v2.0/logos/CROSSMARK_BW_horizontal.svg" width="150" /></a>
<!-- End Crossmark Snippet -->

There are a number of variations of the Crossmark button available so that you can choose one that fits well on your site. You can change the Crossmark button that is used simply by changing the src attribute of the img element to point to one of the following:

Alternatively, this you can view source on this page to see the correct code snippets for each style of button.

The button can be resized according to your design needs by changing the image width in the image tag but do follow the Crossmark button guidelines.

Don’t forget to record the DOI in the HTML metadata

The Crossmark button needs to have a DOI to reference in order to pull in the relevant information. This needs to be embedded in the head of the HTML metadata for all content to which Crossmark buttons are being applied as follows:

<meta name="dc.identifier" content="doi:10.5555/12345678"/>

Step six: Apply the Crossmark button to your PDF content

At a minimum, this metadata must include the DOI of the content and the optional Crossmark domain(s). A minimal XMP file for the above PDF would look like this:

<?xml version="1.0" encoding="UTF-8"?>
<?xpacket begin="?" id="W5M0MpCehiHzreSzNTczkc9d"?>
<x:xmpmeta xmlns:x="adobe:ns:meta/" x:xmptk="Adobe XMP Core 4.0-c316 44.253921, Sun Oct 01 2006 17:14:39">
<rdf:RDF xmlns:rdf = "http://www.w3.org/1999/02/22-rdf-syntax-ns#"
xmlns:pdfx = "http://ns.adobe.com/pdfx/1.3/"
xmlns:pdfaid = "http://www.aiim.org/pdfa/ns/id/"
xmlns:xap = "http://ns.adobe.com/xap/1.0/"
xmlns:xapRights = "http://ns.adobe.com/xap/1.0/rights/"
xmlns:dc = "http://purl.org/dc/elements/1.1/"
xmlns:dcterms = "http://purl.org/dc/terms/"
xmlns:prism = "http://prismstandard.org/namespaces/basic/2.0/"
xmlns:crossmark = "http://crossref.org/crossmark/2.0/">
<rdf:Description rdf:about="">
<dc:identifier>doi:10.5555/12345678</dc:identifier>
<prism:doi>10.5555/12345678</prism:doi>
<prism:url>http://0-dx.doi.org.brum.beds.ac.uk/10.5555/12345678</prism:url>
<crossmark:MajorVersionDate>2015-08-14</crossmark:MajorVersionDate>
<crossmark:DOI>10.5555/12345678</crossmark:DOI>
<pdfx:doi>10.5555/12345678</pdfx:doi>
<pdfx:CrossmarkMajorVersionDate>2015-08-14</pdfx:CrossmarkMajorVersionDate>
</rdf:Description>
</rdf:RDF>
</x:xmpmeta>
<?xpacket end="w"?>

It may appear redundant to apply Crossmark elements both in their own Crossmark namespace as well in the pdfx namespace, but the latter is necessary to ensure the Crossmark elements appear in the PDF dictionary, a specific requirement for some search engines. Any metadata found in the pdfx namespace will be copied over to the document info dictionary. Simply make sure that Crossmark metadata is in the pdfx namespace in the XMP provided to the tool.

The link structure for Crossmark links from PDFs looks like this:

https://0-crossmark-crossref-org.brum.beds.ac.uk/dialog/?doi=10.5555/12345678&amp;domain=pdf&amp;date_stamp=2008-08-14

where:

  • doi is the DOI of the content item
  • domain tells the Crossmark system what kind of static content the link is coming from, and will change for different static formats (such as epub)
  • date_stamp tells the Crossmark system the date on which a last Major Version of the PDF was generated. In most cases, this will be the date the article was published. However, when a member makes significant corrections to a PDF in-situ (no notice issued, and no new version of the work with a new DOI) then the date_stamp should reflect when the PDF was regenerated with the corrections. The system will then use the date_stamp in order to tell whether the reader needs to be alerted to updates or not. The date_stamp argument should be recorded in the form YYYY-MM-DD (learn more about ISO 8601).

Further options: adding more information to the Crossmark button

The Crossmark box has a section for you to show any additional non-bibliographic information about the content. You decide what to include here (you are not required to add anything). In this section, Crossmark participants often include publication history dates, details of the peer review process used, and links to supporting information.

Use Metadata Manager to add custom metadata, or use the assertion element in your XML.

Several metadata elements will automatically display in the Crossmark box if you are registering them:

If you are already registering this additional metadata at the time you implement Crossmark, there is nothing more you need to do. If you start to register these metadata elements after you have set up Crossmark, they will automatically be put into the Crossmark box.

Page owner: Rachael Lammey   |   Last updated 2020-April-08