CrossRef Help Site

CrossRef Help

copyright CrossRef. All rights reserved.http://help.crossref.org/

The information contained in this document is subject to change without notice.This document contains proprietary information which is protected by copyright.All rights are reserved. No part of this document may be photocopied, reproduced,or translated to another language without the prior written consent of CrossRef.

Table of ContentsHelp Center ..................................................................................................................................................................................... 1

About CrossRef DOIs .................................................................................................................................................................... 1What is a DOI .......................................................................................................................................................................... 1How do CrossRef DOIs work? .................................................................................................................................................. 2Who uses CrossRef DOIs ......................................................................................................................................................... 3Examples of DOI use ............................................................................................................................................................... 4

Getting Started ............................................................................................................................................................................. 5How CrossRef works ............................................................................................................................................................... 5Getting Started with CrossRef ................................................................................................................................................ 6CrossRef publishers and titles ................................................................................................................................................ 7Publishers ............................................................................................................................................................................... 8

Becoming a member ......................................................................................................................................................... 8Obtaining a DOI prefix ....................................................................................................................................................... 9Creating a DOI suffix pattern .......................................................................................................................................... 10Creating response pages ................................................................................................................................................. 11How depositing works ..................................................................................................................................................... 12How querying works ........................................................................................................................................................ 13Outbound linking ............................................................................................................................................................. 14

Libraries ................................................................................................................................................................................ 15Opening a library account ............................................................................................................................................... 15DOIs, OpenURL, and link resolvers .................................................................................................................................. 16Setting up your system for localized linking .................................................................................................................... 17

CrossRef Affiliates ................................................................................................................................................................. 18Depositing DOIs and metadata .................................................................................................................................................. 19

Deposit basics ...................................................................................................................................................................... 19Deposit content types ........................................................................................................................................................... 20Resource-only deposits ......................................................................................................................................................... 21Journal title-level DOIs .......................................................................................................................................................... 22Depositing and distributing references ................................................................................................................................. 23Deposit fees .......................................................................................................................................................................... 24Troubleshooting Deposits ..................................................................................................................................................... 25

Verifying your XML .......................................................................................................................................................... 25ISSN errors ...................................................................................................................................................................... 26Interpreting submission logs ........................................................................................................................................... 27Errors and warning messages ......................................................................................................................................... 28

Multiple Resolution ............................................................................................................................................................... 31Overview ......................................................................................................................................................................... 31Steps for implementation ................................................................................................................................................ 321. Permissions ................................................................................................................................................................. 332. Interim page template ................................................................................................................................................ 343. Enable DOIs ................................................................................................................................................................. 35Role of the DOI proxy ...................................................................................................................................................... 36Reversing multiple resolution .......................................................................................................................................... 37Depositing secondary URLs ............................................................................................................................................. 38

Using special characters ....................................................................................................................................................... 39Depositing translations ......................................................................................................................................................... 40Components ......................................................................................................................................................................... 41Best practices for depositing ................................................................................................................................................ 42NLM/JATS to CrossRef conversion ......................................................................................................................................... 43

Ancillary metadata ................................................................................................................................................................ 44Including JATS abstracts in deposits ................................................................................................................................ 44Including non-CrossRef DOIs in deposits ......................................................................................................................... 45Access Indicators ............................................................................................................................................................ 46As-crawled URLs .............................................................................................................................................................. 47

Queries & retrieving metadata ................................................................................................................................................... 48How to query ........................................................................................................................................................................ 48Controlling query execution .................................................................................................................................................. 49

Controlling query execution ............................................................................................................................................ 49Allowing multiple hits ...................................................................................................................................................... 51Secondary query ............................................................................................................................................................. 52

DOI-to-metadata query ......................................................................................................................................................... 54Author / article title query ..................................................................................................................................................... 55Querying with formatted citations ........................................................................................................................................ 56Querying with special characters .......................................................................................................................................... 57Querying for books ............................................................................................................................................................... 58Query samples ...................................................................................................................................................................... 59Best practices for querying ................................................................................................................................................... 60Query results ........................................................................................................................................................................ 61

Query results ................................................................................................................................................................... 61UNIXSD ............................................................................................................................................................................ 62UNIXREF .......................................................................................................................................................................... 63Query error messages ..................................................................................................................................................... 64

Storing queries to get future results ..................................................................................................................................... 65Deprecated query formats .................................................................................................................................................... 66Retrieving DOI info-metadata ............................................................................................................................................... 71Bulk metadata formats ......................................................................................................................................................... 72Retrieving DOIs by title ......................................................................................................................................................... 73Publication IDs ...................................................................................................................................................................... 74

Maintaining & working with DOIs ............................................................................................................................................... 75Building URLs with DOIs ........................................................................................................................................................ 75Updating URLs ...................................................................................................................................................................... 76Updating DOIs and metadata ............................................................................................................................................... 77Platform transfer ................................................................................................................................................................... 78Transferring DOI ownership .................................................................................................................................................. 79Updating title information ..................................................................................................................................................... 80Best practices for journal titles ............................................................................................................................................. 81Best Practices for maintaining DOIs ...................................................................................................................................... 82Resolving conflicts ................................................................................................................................................................ 83

What are conflicts? .......................................................................................................................................................... 83Resolving conflicts .......................................................................................................................................................... 84Sample conflict scenarios ................................................................................................................................................ 85Viewing conflicts using the web interface ....................................................................................................................... 86Assigning primary and alias status .................................................................................................................................. 88Accepting a conflict as is ................................................................................................................................................. 91Updating metadata to resolve conflicts ........................................................................................................................... 94Forcing prime/alias .......................................................................................................................................................... 95Sample conflict resolution files ....................................................................................................................................... 96

Reports ................................................................................................................................................................................. 97Reports Overview ............................................................................................................................................................ 97Depositor report .............................................................................................................................................................. 98

Missing Metadata / Field Report ...................................................................................................................................... 99DOI Crawler ................................................................................................................................................................... 100Conflict report ............................................................................................................................................................... 101Browsable Title List ....................................................................................................................................................... 102Go-Live report ............................................................................................................................................................... 103Status report ................................................................................................................................................................. 104XML Journal List (mddb.xml) ......................................................................................................................................... 105Resolution report ........................................................................................................................................................... 106Working with your Resolution report ............................................................................................................................. 107MIssed Conflict report ................................................................................................................................................... 108Quarterly deposit report ................................................................................................................................................ 109DOI Error report ............................................................................................................................................................. 110Schematron report ........................................................................................................................................................ 111

User Interfaces ......................................................................................................................................................................... 112CrossRef user interfaces ..................................................................................................................................................... 112System Interface ................................................................................................................................................................. 113

Accessing the CrossRef system ..................................................................................................................................... 113Submissions Administration .......................................................................................................................................... 114Tracking submissions .................................................................................................................................................... 115Submission queue ......................................................................................................................................................... 116Retrieving DOI history ................................................................................................................................................... 117

Web deposit form ............................................................................................................................................................... 118Simple Text reference deposit ............................................................................................................................................ 119

Machine Interfaces / APIs ......................................................................................................................................................... 120Using HTTP to POST files ..................................................................................................................................................... 120Using HTTP to query ........................................................................................................................................................... 121Retrieve submission results via HTTP ................................................................................................................................. 123OpenURL query interface .................................................................................................................................................... 124OAI-PMH query interface ..................................................................................................................................................... 127Deposit Harvester ............................................................................................................................................................... 129DOI Registration Agency tool .............................................................................................................................................. 131

Advanced topics ....................................................................................................................................................................... 132Content negotiation ............................................................................................................................................................ 132

CrossRef Services ..................................................................................................................................................................... 133CrossRef Metadata Services ............................................................................................................................................... 133

CMS Basic ...................................................................................................................................................................... 133CMS Enhanced .............................................................................................................................................................. 135

Cited-by linking ................................................................................................................................................................... 136Cited-by linking overview .............................................................................................................................................. 136Retrieving cited-by links ................................................................................................................................................ 137Depositing references ................................................................................................................................................... 138

FundRef .............................................................................................................................................................................. 139FundRef ......................................................................................................................................................................... 139FundRef Deposits .......................................................................................................................................................... 144FundRef API ................................................................................................................................................................... 146FundRef Registry ........................................................................................................................................................... 148

CrossRef Schema ..................................................................................................................................................................... 150Deposit schema .................................................................................................................................................................. 150CrossRef schema ................................................................................................................................................................ 151Elements ............................................................................................................................................................................. 153Face Markup ....................................................................................................................................................................... 156

MathML ............................................................................................................................................................................... 157Deprecated schema ............................................................................................................................................................ 158

Guidelines, Policies, and FAQs .................................................................................................................................................. 159FAQ: DOI display guidelines ................................................................................................................................................ 159Guidelines, Procedures, and Resources .............................................................................................................................. 160DOI Conflicts policy ............................................................................................................................................................. 161Useful Tools ........................................................................................................................................................................ 163

Help SiteCrossRef Help About CrossRef DOIs

Copyright 2012 CrossRef Page 1

What is a DOI?Similar to a bar code for a physical object, a Digital Object Identifier (DOI) is a unique alphanumeric string assigned to a digitalobject, such as an electronic journal, article, report, or thesis. Each DOI is unique and serves as a stable, persistent link to the full-text of an electronic item on the Internet. Unlike a URL, a DOI doesn't change over time; even if the item moves to a new location,the DOI stays the same.

DOIs are the only widely adopted persistent identifier for scholarly works. DOI names appear in printed materials and online aslinks.

A DOI name consists of two segments:

Prefix: a unique numeric string beginning with the numeral 10 assigned by CrossRef to the publisher that submitted theinformation about the digital object

Suffix: an alphanumeric string or series of strings used internally by the publisher to identify the digital object.

In this sample DOI name: 10.1006/jmbi.1995.0238 - 10.1006 is the prefix (in this case, for the publisher Elsevier)and jmbi.1995.0238 is the publisher-assigned suffix for the particular item (in this case, indicating that it is from the Journal ofMolecular Biology and was published in 1995).

Print, PDF, and HTML versions of the same digital item all use the same DOI names. Generally, a DOI name points to the item in asingle location; however, with multiple resolution, it is possible to point to more than one location.

For a more extensive discussion of DOIs, see The DOI Handbook (pdf) on the Digital Object Identifier System website.

Not all DOIs are CrossRef DOIs - use the DOI RA tool to identify the DOI registration agency.



How do CrossRef DOIs work?A DOI link consists of two parts: the DOI directory URL (http://dx.doi.org/), and the DOI itself. When combined with dx.doi.org, theDOI is made into a link. When you click on a DOI link you are directed to the URL registered for the DOI.

For example:

http:/dx.doi.org/10.1006/jmbi.1995.0238

URLs in the DOI directory are updated when an item changes location, ensuring persistence. The DOI System and directory ismanaged by the International DOI Foundation.

CrossRef DOIsIn addition to creating durable links, CrossRef DOIs reliably identify content. If you follow a CrossRef DOI to an article youre assuredthat the page you view is the publisher maintained version of the article.

CrossRef members deposit DOIs by submitting XML containing citation metadata and DOIs to the CrossRef system. CrossRef storesthe metadata in our lookup service, and registers the DOI and URL in the central DOI directory. As a result, citation metadata isassociated with all CrossRef DOIs, making them retrievable via CrossRef lookup services. This allows CrossRef DOIs to be widelydistributed, and supports collaborative reference linking between CrossRef members. See How CrossRef works for details.



Who uses CrossRef DOIs and why?The four primary types of CrossRef DOI users are publishers, affiliates (including agents and journal hosting platforms), libraries,and individual researchers. Using CrossRef DOIs offers significant benefits to each of these groups:

Publisher + show benefits

Affiliate + show benefits

Library + show benefits

Researcher + show benefits

CrossRef publishers and titles



Examples of CrossRef DOIs in useDOI names appear in both print and online materials. DOI names are often included in tables of contents; header information for adigital item, such as an article; and citations, such as a footnote.

CrossRef DOIs should always be displayed as a permanent URL, for example:

http://dx.doi.org/10.1115/1.2803632DOI response page for journal article: + show/hide example

DOI response page for journal article with journal DOI: + show/hide example

DOI response page for book chapter: + show/hide example

CrossRef DOI Display Guidelines

Help SiteCrossRef Help Getting Started


How CrossRef worksCrossRef enables linking in scholarly content on a cross-publisher basis by providing two basic services:

DOI deposit and registration: CrossRef registers DOI names and URLs in a central DOI directory (developed and1.maintained by the International DOI Foundation) on behalf of publisher members. The directory works by looking up thecurrent URL for the specific DOI and sending the end user to that location. When a publisher changes the location of thecontent they need to update the URL in only one place: with CrossRef. If the item moves to a new location, the URL link seenby users will still work, thereby establishing a permanent link. All CrossRef DOIs must resolve to a valid response page.Foreach content item deposited with CrossRef, the publisher creates a unique DOI name by appending a suffix of their choosingto the prefix they've been assigned by CrossRef . The publisher also creates an XML file which associates citation metadatawith the DOI. The publisher then submits (uploads) the file to the CrossRef system.The metadata associated with a DOI caninclude:Basic bibliographic values including all authors, volume, issue, page number or article number, article titlenThe references being cited within the itemnA list of figures, tables, images or other parts of the item (we call these components) which may benefit from having theirnown DOI for linking.

DOI lookup service: CrossRef's query interfaces allow users (including publishers, libraries, researchers, authors or the2.public) who know some amount of information about an item to retrieve a DOI and create persistent links. Users submitqueries to CrossRef which include as much metadata as they have (e.g. journal title, author, article title) and CrossRef looksfor the corresponding DOI and returns it to the user.Although most transactions with CrossRef are made by automatedsystems we have put in place several services designed for use by people. For smaller publishers who have limited technicalresources or for end users like authors, researchers and librarians these services are intended for low volume activity. Fordetailed instructions on these services please see User Interfaces.

How it fits togetherThe data flow described in this diagram (+ show/hide diagram ) has a 'target' entity which is the item being referenced and the'referring' entity contains the citation to the target.

Using a DOI prefix assigned by CrossRef, publishers create DOIs for content items. A publisher must also construct an XML file1.and upload to the CrossRef system. When content is published online, the DOI name and metadata should be deposited withCrossRef as soon as possible (within 24 hours is preferable). The publisher also submits the citations contained in each deposited content item to CrossRef. This way, the publisher can, as2.part of its electronic production process or online publishing system, add outbound links to any of an item's citations thatpoint to content already registered in the CrossRef system. The member can also use DOI names to link references to theirown content. It is an obligation of CrossRef members to link references using the DOI name. See "CrossRef DOI DisplayGuidelines".Members then use the DOI names retrieved from CrossRef to create persistent outbound links to other members' content.3.An end user reading the content on-line finds a DOI based link and clicks on it.4.The user's browser first goes to the DOI central registry to retrieve the actual URL of the item.5.The user's browser is redirected to the DOI response page URL registered by the publisher.6.

CrossRef provides initiatives and tools that supplement our core DOI registration and linking services, see CrossRefServices.



Getting startedOrganizations participate in CrossRef by joining under one of these three categories:

Member: a publisher or content owner who will be depositing DOIs with metadata1.Library: a no-fee account for querying the CrossRef system primarily used to support a local linking service2.Affiliate: an organization (commercial or non-profit) which will be querying the CrossRef system, using CrossRef bulk3.metadata or acting as an agent for member publishers.

To see who is currently participating in CrossRef please see:Publishers & Societies: current publishers and societies that participate in CrossRef.nCrossRef Voting Members: a listing of all voting members.nLibraries: list of library membersnCrossRef Affiliates: organizations that are affiliates or agentsn

Qualifications for membershipPublishers International Linking Association, Inc. (PILA) is a not-for-profit membership organization. PILA runs the CrossRef service,enabling links to and from online scholarly content. According to the PILA bylaws, membership is open to any organization engagedin the business of publishing original scholarly materials.

The following conditions must also be met:The organization applying for membership must publish primary scholarly content that is available online in full text.nThe organization must submit metadata, as defined by PILA, for substantially all its content that is online in full text. nIn an organization with multiple divisions, the largest legal entity is considered the PILA member and all the divisions arensubject to the terms of the PILA Membership Agreement.To ensure fairness in reviewing candidates for membership, prospective members must supply information about the contentnthey intend to deposit.

Only publishers who pay an annual membership fee and own the content represented by CrossRef's metadata are consideredmembers who are entitled to vote for CrossRef's board of directors. Publishers may participate in CrossRef without actually being amember themselves if they are represented by a Sponsoring Member.



CrossRef publishers and titlesCrossRef has hundreds of participating publishers depositing for thousands of journals, book, conference proceedings, workingpapers, dissertations/thesis and databases. Please use the links below to find out who they are and what publications arerepresented.

View a list of the publishers that use CrossRef DOIsnUse the browsable title list to view a list of the titles for which CrossRef DOIs have been depositedn

Lists of libraries and affiliates (associations, organizations, agents, and linking solution partners) that use CrossRef are alsoavailable.

Help SiteCrossRef Help Publishers


Becoming a memberCrossRef operates a technical service on behalf of its member publishers helping them establish URL links between their contentand the content of other CrossRef publishers. These links primarily go from the references listed in an item's bibliography to theitem being cited by the author. CrossRef services are technical in nature and require member's staff responsible for integrating withCrossRef's offerings to have some understanding of XML and Web technologies and to have a thorough understanding of their ownproduction processes.

Membership processPublishers join CrossRef by completing and signing the membership application and membership agreement. After joining CrossRef,you receive a DOI prefix, a user name and password to access the CrossRef system, and the general login to the members' area ofthe CrossRef web site. For information about the cost of joining CrossRef as a publisher, see Publisher Fees on the CrossRef website.

Join CrossRef using our membership request form.1.When you become a member, you will be assigned a DOI prefix. You must establish a DOI suffix pattern before creating DOIs.2.Build deposit XML for containing your DOIs and their metadata (non-technical users try our basic Web deposit form).3.Add DOIs to your DOI response pages4.Retrieve and construct outbound DOI links for the references in your content5.

Publishers may also participate in other CrossRef services.

Member obligationsWhen participating in CrossRef members are expected to:

Build and operate the necessary systems on their side which compose the XML deposit files and submit them to CrossRefnadd DOI links (when available) to the reference list for journal articles deposited with CrossRefnRegularly monitor their transactions with CrossRef, and identify and correct errors.nRemain vigilant about updating the metadata for their DOIs, particularly the URL of the resource.nReview the various CrossRef reports issued to members and correct any identified errors.nUse commercially reasonable efforts to make your content available and ensure persistance of links through an authorizednarchive if you are no longer able to host your content.

More information on becoming a CrossRef member is available on the CrossRef website. For a complete list ofmember obligations, see Publisher Rules.



Obtaining a DOI prefixOnce your organization joins CrossRef, CrossRef assigns it a unique DOI prefix beginning with "10.". You do not need to get a DOIprefix prior to joining CrossRef nor pay a separate fee to the International DOI Foundation (IDF). Member organizations may alsoobtain multiple DOI prefixes upon request.

Note that the prefix of a DOI does not reliably identify the current publisher of the item. Once you associate an individual DOI with aparticular content item, the DOI is permanently assigned to that content regardless of the owner. While specific publishers mustassign DOIs using their unique prefix, ownership and control of individual DOIs can (and should) be transferred when a title changeshands.



Establishing a DOI suffix patternBefore you can assign DOIs to articles or other content items, you must devise a DOI assignment scheme. CrossRef gives you a DOIprefix that you must use, but you can create your own pattern and system for suffixes.

The DOI suffix has a very flexible syntax. It can be any alphanumeric string, consisting of a single node or multiple nodes. A node isa portion of a character string. A single node has no delimiters (periods, colons, pipes, and so on), for example: 123456. A characterstring with multiple nodes must include a delimiter (a period, colon, pipe, and so on) between each one, for example: 12.34.56.Each suffix must be unique within a prefix.

Because the DOI is an opaque string intended to remain unique and persistent throughout changes in ownership and location of thecontent, you do not need to include any specific or descriptive information in the DOI. Such information forms the metadataassociated with each DOI, which is submitted along with the DOI and URL. If you choose to include such bibliographic information ina DOI string, it will have no meaning within the CrossRef or DOI system. Existing identifiers can also be used for the DOI suffix, suchas an ISBN, PII (personally identifying information), or existing internal numbering scheme.

Sample suffix patternsCrossRef members have established a variety of schemes for creating their DOI suffixes. One or more of these patterns may beappropriate for your situation: Sample DOI suffix patterns

GuidelinesBe concise: Make the suffix as concise as possible to facilitate human readability. Remember, DOIs will appear online and innprint; users will also re-type DOIs.Be unique: A suffix must be unique within a given prefix.nBe case insensitive: A suffix is case insensitive, so 10.1006/abc is the same as 10.1006/ABC.nBe consistent: The suffix should reflect a consistent, logical system that can be easily documented and readily understoodnby employees of your organization, so that the task of assigning DOIs can be passed from one employee to the next. Forexample, you might want the suffix to include existing internal identifiers.Avoid page numbers: It is possible to use traditional bibliographic metadata (such as journal, volume, and page) innconstructing DOI suffixes because both this metadata and the DOI are persistent. However, some issues need carefulconsideration before choosing such an approach. DOIs should be active as soon as articles appear online. Choosing a schemethat is tied to page numbers makes it difficult to put content online before pagination is complete for a print version or if theitems are published online only.Only use approved characters: "a-z", "A-Z", "0-9" and "-._;()/"nUse one or more nodes: You can use suffix nodes to reflect hierarchical information or levels of granularity. For example,nthe first node might be a multiple-letter code for the journal title, while successive nodes encode the year of article acceptanceand the order of article acceptance. This is the scheme used by Academic Press, with resulting DOIs such as10.1006/jmbi.1998.2354.Make suffixes extensible: DOI suffixes should be extensible. In the future, for instance, parts of articles, such as figures,ngraphs, and supplementary materials, might be assigned DOIs. Using the preceding Academic Press example, the secondfigure in the article might be assigned this DOI: 10.1006/jmbi.1998.2354.f002.

DOIs are case-insensitive: 10.5555/ABC123 is the same DOI as 10.5555/abc123

DSpace repositories should review DOIs and DSpace repositories before constructing a DOI suffix pattern



Creating response pagesResponse pages (sometimes called landing pages) should be created before DOIs and metadata are deposited. DOI names areactive immediately after deposit.

When metadata and DOIs are deposited with CrossRef, the publisher must have active response pages so that incoming links canbe received. As soon as metadata and DOIs are deposited in CrossRef, users will be able to retrieve the DOIs and create links. MostCrossRef publishers take users to the abstract page and permit authenticated users to access the full text automatically. If the fulltext is available at no charge, users can access it immediately. Many publishers also present unauthenticated users with pay-pe--view options.

A minimal response page consists of a full bibliographic citation, including the DOI, displayed to the user. The DOI should bedisplayed as a URL. Additionally, a response page must display some mechanism by which the user can access the full text. Accessto the full text is completely controlled by the publisher but the response page must be accessible to anyone. CrossRef highlyencourages including a full abstract.

Sample response page: + show/hide

CrossRef DOI display guidelines are available here. The guidelines recommend that CrossRef DOIs always be displayed asa permanent URL.



How depositing worksDepositing metadata to CrossRef involves the creation of XML according to our deposit schema. This XML is submitted to theCrossRef System via public or machine interfaces. During the submission process, DOIs and metadata are added to the CrossRefsystem, and DOIs are registered with the Handle resolver. Once deposited, DOIs may be resolved by prepending the DOI withhttp://dx.doi.org. DOIs (and metadata) may also be retrieved by querying once a deposit has been processed successfully.

The deposit process is described in detail in Deposit basics.



How querying worksQuerying is the process of retrieving data from CrossRef. There are two basic query modes:

Metadata query: you know the bibliographic data and wish to retrieve the DOI for the item1.DOI query: you have a DOI and would like to retrieve associated metadata2.

The majority of query transactions occur automatically by users who build systems that make simple HTTP GET requests to ourserver. XML query files may also be submitted by HTTP POST or via the CrossRef system web interface. Bulk query options are alsoavailable.

CrossRef provides web-based query forms which are useful for individual authors or researchers looking to find a specific article, orby a member's technical staff when trying to investigate a particular problem.

Query processes and options are described in detail in Queries & retrieving metadata



Outbound linkingCrossRef Members are required to create outbound DOI links within their references, meaning members must add DOI links (whenavailable) to the reference list for journal articles deposited with CrossRef. Outbound linking for other content types is encouragedbut not required.

The CrossRef Board of Directors has changed the penalty for members who have not implemented outbound linking. Starting in2011, instead of being charged a non-linking fee of 22 cents per DOI, CrossRef members who are not linking within the initial 18months of joining CrossRef may have their accounts suspended.

Creating outbound links1. Query for DOIs: The first step is to retrieve DOIs for all available references. Several different query interfaces are available:

Simple Text Query form: cut-and-paste reference lists into a web form. This is a manual interface suitable for low volumenquerying.Simple Text Query upload: upload reference lists as .txt files and receive query results via email. This is a manual interfacensuitable for low volume querying.XML Queries: XML formatted using the CrossRef query schema may be submitted to our system as individual requests or as anbatch upload. XML querying allows for significant control over query execution and results, and is the preferred method ofquerying for most members (details).

2. Link to DOIs in your references: After DOIs have been retrieved via querying, members must display and link DOIs in theirreferences. To make a DOI into a link, precede it with http://dx.doi.org/ (as in http://dx.doi.org/10.1006/jmbi.1998.2354).

Sample outbound linking

Queries & retrieving metadata, Querying with XML, crossref_query_input2.0.xsd schema documentation, CrossRefDOI Display Guidelines, Building URLs for DOIs containing special characters

Help SiteCrossRef Help Libraries


CrossRef for librariesThrough CrossRef, libraries can create links to CrossRef member publishers without signing bilateral linking agreements with eachpublisher, and without having to track publishers' individual linking schemes. The CrossRef system also serves as a source ofmetadata to enhance OpenURL-based local link resolvers and supports DOI re-direction for the purposes of localized linking withinlibrary holdings. Some libraries have created their own link resolvers, and many libraries purchase the services of one of a numberof vendors who now provide link resolution software.

In most cases, information providers (publisher, database producers, and so on) use CrossRef to add DOIs to their content anddatabases, so libraries do not need to use CrossRef for DOI retrieval alone. If libraries host local content, the content providersshould add DOIs before delivering the content. Users browsing online content will see DOI links and click them; there is no chargefor clicking and following DOIs links.

There is no charge for libraries to get a CrossRef account to retrieve DOIs or metadata. More information is available on theCrossRef website.

To view a list of libraries with CrossRef accounts, see Libraries on the CrossRef web site.nFor information about how the DOI integrates with local link servers, see DOIs, OpenURL, and link resolvers.n



DOIs, OpenURL, and link resolversFor optimal integration with library linking systems, information providers are implementing the OpenURL standard. OpenURL is amechanism for transporting metadata and identifiers describing a publication for the purpose of context-sensitive linking through alocal link resolver.

A link resolver is a system for linking within an institutional context that can interpret incoming OpenURLs, take the local holdingsand access privileges of that institution (usually a library) into account, and display links to appropriate resources. A link resolverallows the library to provide a range of library-configured links and services, including links to the full-text, a local catalogue tocheck print holdings, document delivery or ILL services, databases, search engines, and so on.

Why libraries need local link resolversDOIs point to the authoritative version of content on the publisher's web site and to publisher-designated resources. Yet for theuser working in an institutional context, it is often useful to be directed to other resources. For example, the institution may notsubscribe to the electronic journal itself but may still be able to offer the user access to the desired article through an aggregateddatabase or through print holdings. In addition, the library may want to provide a range of linking options beyond what is availableat the publisher's web site.

How the DOI System and OpenURL work togetherThe DOI and the OpenURL work together in several ways. First, the DOI directory itselfwhere link resolution occurs in the CrossRefsystemis OpenURL-enabled. This means that it can recognize a user with access to a local resolver. When such a user clicks aDOI, the CrossRef system allows the DOI to be used as a key to pull the metadata needed to create the OpenURL targeting the locallink resolver out of the CrossRef database and redirects that DOI back to the user's local resolver. Consequently, the institutionaluser clicking the DOI is directed to appropriate resources. By using the CrossRef DOI system to identify their content, publishers ineffect make their products OpenURL aware.

Localized linking via DOI redirection occurs in this sequence, as shown in the following illustration: + show/hide illustration

A library user clicks a DOI link within a link resolver-enabled resource.1.A cookie on the users machine alerts the DOI proxy server to redirect this DOI to the local linking server.2.The local linking server receives the metadata needed for local resolution either from the source of the link or from CrossRef3.via OpenURL.

An OpenURL link that contains a DOI name is persistent in the same way a DOI name is. Publishers who use the CrossRef DOIsystem to identify their content, in effect, make their products OpenURL-aware.

Using the Open URL Query Interface, Setting up your system for localized linkingFor more information on OpenURL, see http://library.caltech.edu/openurl.



Setting up your system for localized linkingTo take advantage of localized linking, your localized linking server must have a recognized BASE-URL. BASE-URLs are collectedfrom library affiliates when they sign up with CrossRef, and forwarded to the IDF for registration.Once the BASE-URL is registered, go to http://www.doi.org/cgi-bin/pushcookie.cgi?BASE-URL={your BASE-URL} to download acookie, which contains the URL for your local content server. This cookie makes your browser OpenURL-enabled, which means thatthe CrossRef system will redirect relevant requests to your local resolver.

If you upgrade or change your local link resolver, send your new BASE-URL to [email protected].

For more detailed information about BASE-URL and cookie pusher script, seehttp://www.exlibris-usa.com/sfx_cookiepusher.htm.



CrossRef AffilatesCrossRefs Affiliate programs are for organizations that are not primary publishers but want to retrieve CrossRef DOIs andbibliographic metadata for persistent linking to publisher full text. A range of affiliate programs are available. More information isavailable on the CrossRef website.

Help SiteCrossRef Help Depositing DOIs and metadata


Deposit basicsHow depositing worksDepositing metadata to CrossRef involves the creation of XML according to our deposit schema. This XML is submitted to theCrossRef System via public or machine interfaces. During the submission process, DOIs and metadata are added to the CrossRefsystem, and DOIs are registered with the Handle resolver. Once deposited, DOIs may be resolved by prepending the DOI withhttp://dx.doi.org. DOIs (and metadata) may also be retrieved by querying once a deposit has been processed successfully.

Step-by-stepThe basic process for depositing consists of these steps:

Create XML using the CrossRef deposit schema (non-technical users may use the Web Deposit form). 1.Verify your XML.2.Upload your XML (via a web interface or programatically).3.

Submit your deposit.6.

The upload process is very basic and performs no data validation at the time of upload. The 'Success' acknowledgment you receiveafter submission step simply indicates that your file has been received. Each uploaded file then goes into a queue to awaitprocessing which validates your XML using the Xerces parser. This step verifies that the XML is well formed and conforms to therules of the CrossRef schema and performs certain logic checks on the data in the file (see below).

Reviewing submission logsAfter a deposit is processed, you receive an email indicating the results (in an XML format) which lists the status of each DOIcontained in the file. Note that while many DOIs in a file may successfully get deposited, individual DOIs may fail. Submission logsmust be examined, and any flagged problems should be corrected and the file(s) resubmitted.

Deposit tipsFor efficient processing, keep file sizes under 150KBytes. File size should not exceed 1.5MBytes. During times of very heavy loads,jobs may take several hours to reach the top of the queue and large files can take an hour or more to process. You can track yoursubmission's progress and, if necessary, request that CrossRef staff move it up in the queue.

Deposit rulesMost of the rules which govern the data allowed/required in a deposit are specified in the CrossRef schema and enforced via XMLvalidation. A few rules exist outside the schema and are enforced by the software which processes the deposit:

DOIs may only contain the following characters: "a-z", "A-Z", "0-9" and "-._;()/"1.Publication title ownership is enforced. This means that CrossRef recognizes a single publisher as owning a title and thus only2.DOIs using the prefix of that publisher may be assigned to the publication. Please contact [email protected] to resolve anyissues associated with this rule.Every time a DOI is deposited it must be given a timestamp, the value of which must increment with subsequent updates.3.This value is a string of text that gets interpreted as a number. The recommended format is YYYYMMDDHHMM (ex:200810021422). Timestamps need to be incremented when DOIs are updated.

Deposit content types, Best practices for depositing



Deposit content types: what can be deposited?CrossRef enables DOI assignment for a variety of content types and at multiple levels:

Journals: DOIs may optionally be assigned to the journal itself, a specific volume or a specific issue. However, we stronglynencourage the assignment of a DOI at the journal title level (journal title DOIs often use the ISSN as the suffix). DOIs should beassigned to all articles published within the journal and may be assigned to other content as well (e.g. book reviews, editorialsetc.). Items that are part of an article which may benefit from having their own identifier can be registered as components andgiven a DOI unique from that of the article. These items include figures, tables or supporting data files. Books: DOIs are always assigned at the book title level and frequently at the chapter level as well. Books may also bendeposited as part of a series in which case the series is assigned a DOI unique from the DOI of any volume within the series.Book deposits should have an ISBN when available for each volume title and must have an ISSN for each series title.Conference proceedings: Conference proceedings are quite similar to journals/articles with the major exception being thenmetadata includes information about the conference event as well as the proceedings title. Each paper within the proceedingsis treated like a journal article.Components: Components are parts of some other content type which are to be given their own DOI. They require a parentnDOI which may be the DOI of an article, journal, book, chapter, standard or any other DOI. Components may be depositedalong with their parent or they can be deposited by themselves in a separate XML file.Dissertations and thesis: DOIs are assigned to each dissertation or thesis. DOIs are not assigned to an aggregation of thisncontent type (e.g. if a collection of dissertations is published together it most likely would be deposited as a book).Reports and working-papers: This content type resembles books in many ways with the major difference being an ISBN isnnot required. DOIs need not but are strongly encouraged to be assigned at the title level. Lower level "content-items" may alsobe given their own DOI (similar to chapters in a book). Reports/working-papers may be published as part of a series in whichcase the series title is given a unique DOI and must have an ISSN. Volumes published with a series must also have an ISBN.Standards: Standards are assigned a DOI at the title level and may also have DOIs assigned to lower level "content-items".nStandards published as stand alone publications do not need an ISBN but like reports if they're published in a series ISBNs andISSNs are required. The metadata for standards differ primarily in the inclusion of additional designators along with the titlewhich are commonly used when referring to a standard.Database: Databases are another top level construct which can be assigned a DOI. Lower level items within a database, calledndatasets, are each given a unique DOI and any database/dataset DOI may include components. This content type has beenused to address a number of situations that do not easily fall into the other categories. While originally intended for moretraditional collections of data we have found this content type useful for allowing to DOIs to be assigned to a number ofcollections which might not be considered a 'database' but which defy easy classification into the other content type.

DOIs can be assigned to any object that is accessible online. Each DOI is assigned a primary URL during the deposit process whichpoints to what we call the response page. DOI response pages must meet CrossRef membership rules, which at a minimum requiresdisplay of the bibliographic data (article title, author, publication title, date of publication) and the DOI displayed as a URL.

CrossRef deposit schema



DOI resource depositsSome ancillary metadata may be deposited separately from metadata deposits as resource deposits. These deposits append theincluded metadata to the citation metadata already stored in the CrossRef system, and do not need to be included in citationmetadata updates. Resource deposits use the doi_resources4.3.2.xsd schema (documentation) with the exception of stand-alonecomponents which use the main deposit schema.

Reference depositsnURLs: A primary URL must be included in all DOI deposits. Additional URLs may also be included, for:n

as-crawled URLs (used for CrossCheck)nMultiple Resolution secondary URLsncontent version or text mining URLsn

ComponentsnFundRefnCrossMarknAccess Indicatorsn



Journal title-level DOIsCrossRef publishers are not required to create DOIs for journal titles but are strongly encouraged to do so. There are no depositfees for title-level DOIs.

Title-level DOI best practices are as follows:A distinct DOI should be created for each version of a title deposited with CrossRef. Any changes requiring a new ISSN shouldnresult in a new title-level DOI as well.A title-level DOI should resolve to a response page that displays the same title and ISSN recorded in the CrossRef database.nOnce assigned, a title-level DOI should be maintained.nResponsibility for maintaining a title-level DOI transfers to the new owner when title ownership is transferred.nAs with all DOIs registered via CrossRef, the DOI being resolved should appear on the DOI response page.n

The ISSN standard, ISO 3297, recommends that a DOI suffix contain the ISSN (with hyphen), preceded by the lowercase lettersnissn and a period, for example: 10.5930/issn.1994-4683Journal DOIs are required to comply with COUNTER release 4.n

Depositing title-level DOIsTitle, volume, and issue DOIs may be included with journal article deposits, or may be deposited separately. Once deposited, ajournal, volume, or issue DOI does not need to be included in subsequent deposits but, as with all DOIs, the URL should bemaintained. The web deposit form supports deposit of title-level DOIs.



Depositing and distributing referencesIn addition to article metadata, CrossRef members may also deposit reference lists. Reference deposit is optional, but required forcited-by linking participants.

By default, references deposited for a DOI are only distributed to the current owner of the DOI or to OAI-PMH subscribers (whengiven permission by the current publisher). CrossRef member publishers may also now elect to include deposited references inUNIXML query results as well as OAI-PMH results, making references publically available. This feature is managed on a prefix basis.Contact [email protected] if you would like reference distribution enabled for your prefix(es). Reference distribution isencouraged for all members.



Deposit fees and publication dateDOI deposit fees are determined by the content type and publication date included in a deposit, with backfile deposits beingcharged at a lower rate. The publication year included in the initial DOI metadata submission determines whether or not a DOI isconsidered a Current Year (CY) or Back Year (BY) DOI. The CrossRef schema supports deposit of both an online and print publicationdates. For individual items, when both online and print publication years are present, the fee charged is determined by the printyear. If a print year is not included in the deposit, the online publication year is considered.

When depositing journals be aware that each individual item is considered separately, regardless of the publication year included atthe journal volume or issue level. For example, a deposit including both a print publication date of 1990 and an online date of2013 at the issue level and only an online publication date of 2013 at the article level will be considered a current year deposit. Ifthe print date of 1990 is included at the article level, the back year fee will be charged.Example: Fees charged by publication year type Issue Year Article Year Fee level

DOI1 2013 (online), 1971 (print) 2013 (online), 1971 (print) BY rateDOI2 2013 (online), 1971 (print) 2013 (online), no print date CY rateDOI3 2013 (online), no print 2013 (online), 1971 (print) BY rateDOI4 2013 (online), no print 1971 (print) BY rate

Current deposit fees

Help SiteCrossRef Help Troubleshooting Deposits


Verifying your XMLIf you are new to CrossRef or intend to deposit a new content type, it is recommended that you verify the format and structure ofan XML file before submitting it as a deposit to the system. Using these methods is quicker than verifying your XML by trial anderror.

You can validate your XML by:

1. Using the XML Parser on the CrossRef web siteWhen you send data to the XML Parser no processing occurs. If the files parses successfully you will see a count of the numbernof DOIs found in the file. Failures will be displayed as errors generated by the Xerces parser.The validator will validate against all CrossRef schema but only schema versions 4.3.0 and up are valid for deposits.n

Best for: quickly validating a few files

2. Using the test system at http://test.crossref.org

CrossRef maintains a test system at http://test.crossref.org. The test system functions identically to our live system but uses a testdatabase and does not register DOIs with Handle. To use, direct your browser or deposit program to test.crossref.org instead ofdoi.crossref.org.

Best for: testing large numbers of files or new titles

If you are a new CrossRef member the test database might not be have been updated with your login credentials orprefix. If you are denied access, contact [email protected].



Common ISSN and ISBN ErrorsCrossRef has implement strict title, ISSN, and ISBN checks to prevent title duplication and errors. The title/ISSN/ISBN combinationsubmitted in a deposit must match the title/ISSN/ISBN combination in the CrossRef database. title/ISSN/ISBN combinations areextracted from the first deposit of a title, and can only be edited by CrossRef staff.

Error: ISSN "{ISSN}" has already been assigned to a different title/publisher/genre

This error indicates the ISSN and/or title in your deposit does not match data in our system, or the title is owned by anotherpublisher. Possible causes:

Title and ISSN in deposit do not match title associated with ISSN in the systemnTitle is owned by another publishernDOI is owned by another publisher (if DOI is being updated)n

+ show/hide solution

Error: ISSN "{ISSN}" has already been assigned to a different publisher {publisher name}({publisherprefix}) or ISBN "{ISBN}" has already been assigned to a different publisher {publishername}({publisher prefix})

This error indicates that the title you are depositing is owned by another publisher/prefix. If you are the correct publisher for thetitle being deposited, verify that you have followed the title ownership procedures described in Transferring DOI ownership. If youhave followed transfer procedures. contact [email protected].

Error: ISSN "{ISSN}" is invalid

This error indicates that the ISSN provided in the deposit is not valid. All ISSNs must have a valid check digit as described here. Thisvalidation prevents transcription errors, which are common. If your deposit failes because of this error:

Carefully verify that the ISSN in your deposit is correct. If it is not, correct and resubmit your deposit.nIf the ISSN matches the ISSN you believe is assigned to your title, check your ISSN against the ISSN assigned by the ISSNnRegister (or your ISSN registrar). Transcription errors may occur when the ISSN is assigned. If you are not able to verify yourISSN, contact [email protected] and we will look it up for you.

Updating or correcting title information, Best practices for journal titles



Interpreting submission logsSubmission logs contain valuable information about items submitted to the CrossRef system. After a file has been processed, areport is emailed to the address specified in the submission.

Successful submission + show/hide exampleIn this example, the number of items submitted () equals the number of successful deposits().

Submission with problems + show/hide exampleThis example contains failures (4 ). Records with a status of "Failure" indicate the DOI was notdeposited. A status of "Warning" indicates that the DOI was deposited but may need further action.

Each error should be corrected and the deposit resubmitted. See Error and warning messages for details.

If you do not receive an email:verify that the email address included in your submission is correctnuse the Submission Administration interface to retrieve your reportnif you are still not able to retrieve your report, contact [email protected]. Please specify the time and date of your deposit.n

Deposits whose XML will not parse will be rejected in their entirety.nAll DOIs in the file will not be processed if any XML errors are encountered whether the error is just a simple omission of datanfrom one record or a major structural problem with the XML.



Error and warning messagesDOIs with a "Warning" status have been deposited but may need extra attention. A status of "Failure" means that a DOI within adeposit, or an entire deposit, has failed. Failures may be the result of a system check or validation / processing error.

WarningsWarning Meaning Solution

Added withconflict

Two DOIs are in the system with the same metadata. This usuallyoccurs when an article is published ahead of print such that noenumeration or page values are available.

Review and resolveconflicts

Error messages: system checksThe CrossRef system performs a number of checks that are beyond the scope of schema validation. These checks prevent theintroduction of bad data to our system.

Error Message Meaning SolutionRecord not processed becausesubmitted version: xxxxxxx isless or equal to previouslysubmitted version (DOI match)

The timestamp in this update isdated before a previous update.The timestamp in the submissionneeds to be numerically greaterthan the timestamp in the previoussubmission.

Review and edit the timestampincluded in the deposit. Timestampscan be found in the Depositor report,by reviewing DOI history, or byretrieving DOI info-metadata.

User with ID: {0} cant submitinto handle, please contact theCrossRef admin

The handle system username andpassword assigned to this prefix isincorrect in the CrossRef system

Contact [email protected] - includesubmission ID in your email

User not allowed to add recordsfor prefix: {0}

The CrossRef account used doesnot allow deposits for this prefix

Confirm that you are using theappropriate account and prefix thencontact [email protected]. Includesubmission ID in your email.

All prefixes in a submissionmust match (DOI[{0}])

In a given XML file all DOIs beingdeposited must have the sameprefix, regardless of ownership.

Revise submission to include a singleprefix (create multiple submissions ifneeded)

year: {0} in not a valid integer Year must be a string that convertsto a valid 4 digit year

Review and edit year

title "{title}" was previouslydeleted by a CrossRef admin

The title being deposited/updatedpreviously existed in the systembut was deleted

Review your title and compare toprevious deposits - if it is correct,contact [email protected]. Includesubmission ID in your email

user not allowed to add orupdate records for the title"{title}"

The CrossRef account used doesnot allow deposits for this title.

Review title to confirm that you areusing the appropriate account andprefix then [email protected]. Includesubmission ID in your email.

ISSN "12345678" has alreadybeen assigned to a differenttitle/publisher/genre

The ISSN, title, or ownership ofyour deposit does not matchinformation in the system

Refer to ISSN error troubleshootingguide

Error messages: common validation and processing errors



Error Message Meaning Solution[error] :286:24:Invalid content starting with element {elementname}'. The content must match'(("http://www.crossref.org/schema/4.3.0": item_number) {0-3},("http://www.crossref.org/schema/4.3.0": identifier) {0-10})

This is an exampleof a parsing errorbeing reported inthe log file. Sincethis output comesdirectly from theXerces parser theactual messagewill varydepending on theerror.

Review file at line /column indicated (inthis example line 286col. 24) edit and re-submit.Contact [email protected] for help if needed.

org.jdom.input.JDOMParseException: Error on line 312 ofdocumentfile:///export/home/resin/journals/crossref/inprocess/395032106:The content of elements must consist of well-formed characterdata or markup.

Indicatesunacceptablemarkup in file

Review the file asindicated, correct, andre-submit.

[fatal error] :1:1: Content is not allowed in prolog. Indicatescharacters (BOM)precede the XML -usually occurswhen wordprocessingprograms are used

Open file in a text /XML editor andremove characters(usually )

java.io.UTFDataFormatException: invalid byte 1 of 1-byte > UTF-8 sequence (0x92)

Indicates badlyencoded character

Locate and correctcharacter - see UsingSpecial Characters formore information

java.sql.SQLException: ORA-00001: unique constraint(ATYPON.NDX1_CIT_RELS) violated

This error messageoccurs when 2 filescontaining thesame DOIs aresubmittedsimultaneously,orwhen a DOI isincluded twice inthe same file. Thesystem attemptsto process bothdeposits - only onedeposit will besuccessful. Theunsuccessfuldeposit willgenerate thiserror.

Review DOI history tomake sure DOI isupdated with correctmetadata



Error Message Meaning Solutionjava.lang.NullPointerException Most often this

means a citation-only deposit ormultiple resolutionresource-onlydeposit has beenuploaded as ametadata deposit(or vice-versa)

Resubmit deposit as'DOI Resources' (whenusing the CrossRefSystem) ordoDOICitUpload (HTTPtransaction). If thisdoes not apply to yourdeposit, [email protected] details.

Submission version NULL is invalid Schemadeclaration is notcorrect

Resubmit with correctschema declaration

Interpreting submission logs, Submission details, Viewing the Submission Administration report

Help SiteCrossRef Help Multiple Resolution


Multiple Resolution OverviewCrossRef's Multiple Resolution service allows multiple URLs to be assigned to a single DOI. The DOI resolves to an interim page,which presents a list of link choices to the end user. Publishers most commonly implement Multiple Resolution for content with co-hosting agreements.

Multiple Resolution operates by directing the DOI to a service hosted by CrossRef which uses a HTML template to present a brandedpage (known as an interim page) to the end user. Templates may be assigned on a title or prefix basis (e.g. a unique template perpublication title, or one template for all titles associated with a given prefix).

Example interim page: + show/hide

Multiple Resolution detailsImplementing Multiple Resolutionn

Depositing secondary URLsnRole of the DOI proxynReversing multiple resolutionn

The current version of CrossRef's Multiple Resolution service has been active since May 2008. The pilot version has beendiscontinued. Differences between the pilot and production version are described here.



Implementing Multiple ResolutionMultiple resolution typically involves coordination between a primary depositor and a secondary depositor, the primary depositorbeing the content owner, and the secondary depositor(s) being additional entities with permission to assign additional URLs to aDOI. The primary depositor deposits metadata for a DOI and creates the multiple resolution interim page, whereas the secondarydepositor supplies URLs.

Steps involved in depositing Multiple Resolution DOI:

Establish permissions: the primary depositor notifies CrossRef of their intention to deposit Multiple Resolution DOIs1.If needed, the secondary depositor may coordinate multiple resolution activity with CrossRef. Permission from the primaryndepositor must be provided. (more info)CrossRef assigns appropriate permissions to depositors and prefixes, and creates MR-only deposit accounts (if necessary).n

Interim page template: an interim page template is constructed and sent to CrossRef (typically this is done by the primary2.depositor)Enable DOIs: the primary depositor deposits (if necessary) and unlocks Multiple Resolution DOIs. 3.Deposit secondary URLs: secondary depositor(s) deposits secondary URLs4.



Authorizing Multiple Resolution depositsMultiple resolution typically involves two (or more) publishers involved in a co-hosting agreement. For the purposes of multipleresolution, the primary depositor is the content owner, meaning they represent the organization that holds copyright for thecontent or is otherwise known as the publisher. Multiple resolution DOIs are owned by the primary depositor's prefix. Thesecondary depositor co-hosts content with the primary depositor - they have been authorized by the content owner to serve thecontent on-line and assign additional URL to DOIs. CrossRef will always defer to the primary depositor's instructions regardingchanges to DOI metadata including all assigned URLs.

PermissionsBefore depositing, the primary or secondary depositor must notify CrossRef of the intention to deposit multiple resolution DOIs, andall titles and prefixes involved. The secondary depositor may coordinate multiple resolution activity with CrossRef with permissionfrom the primary depositor - this can be an email to [email protected] stating "XYZ Publishing has permission to coordinatemultiple resolution activity on our behalf for titles (...)"

Enabling a deposit account for multiple resolutionThe Multiple Resolution process only permits URL data to be deposited by secondary depositors - other metadata can only bedeposited and updated by the primary depositor. The primary depositor will be able to perform all multiple resolution functionsusing their current CrossRef system account. The secondary depositor will be assigned a new system account to be used formultiple resolution deposits only.

Creating an interim page template, Enable DOIs for Multiple Resolution, Deposit Secondary URLs



Building the interim page templateThe interim page is displayed based on an HTML template. The template operates on a simple text replacement process. Thecurrent interim page function currently supports directives which can appear anywhere in the template HTML file:

will be replaced by the DOIn will be replaced by metadata associated with the DOI as HTML table rows and data cellsn will be replaced by URL of one MR target (multiple uses of this directive will iterate through the available MRnsecondary targets) will be replaced by the primary URL (presumably the content owner's URL)n will be replaced by the URL of the MR target deposited with the specified label. Labels used in must match the label supplied in deposits by the secondary depositor.

HTML template download sample or + show/hide example

Example HTML (populated with MR data) + show/hide example

Example interim page: http://dx.doi.org/10.1177/152216280100400206Images and stylesheets may be provided along with the template as needed.nMultiple resolution DOIs deposited without an associated template will default to a generic CrossRef template (notnrecommended)The directive will be replaced by all links to all MR targets as a HTML table rows and data cells (one link per row).nThis directive is part of the system template but is not recommended as the result is ugly.

Establishing Multiple Resolution permissions, Enable DOIs for Multiple Resolution, Deposit Secondary URLs



Enable DOIs for Multiple ResolutionThe primary depositor must enable (or 'unlock') each multiple resolution DOI before secondary URLs can be deposited. This can bedone by using either the main deposit schema or the DOI resources schema. It is expected that once a content owner givespermission for multiple resolution to be attached to DOIs of a given title, or to all their content, that the content owner will routinelyenable multiple resolution when creating/updating their DOIs.

Unlock DOIs using the main deposit schemaThis mode should be used for all new DOIs created after the content owner has recognized that secondary deposits will be takingplace. It allows the primary content owner to enable the DOI MR permission at the same time the DOI is initially created.

The XML used by the content owner to create (or update) the DOI must include an a element with the multi-resolutionattribute set to 'unlock'. + show/hide example

Unlock DOIs using the DOI resources schemaThis approach can be used for all pre-existing DOIs or can be used for new DOIs if the content owner does not wish to include thismetadata in their main DOI deposit. The resource file can be uploaded using the Web form on the doi.crossref.org system or using aprogrammed HTTP transaction. + show/hide example

Resource-only deposits should be uploaded as 'DOI Resources' when using the system interface or'operation=doDOICitUpload' when doing a programmed HTTP transaction

Establishing Multiple Resolution permissions, Creating an interim page template, Deposit Secondary URLs



Role of the DOI proxySignificant changes were made to the DOI proxy (dx.doi.org), which is maintained by CNRI on behalf of the IDF, in order toimplement multiple resolution. Prior to these changes the resolution service provided by the proxy were a very simple redirection tosingle URL (known by many as the default URL). In this mode each DOI had one URL which would always be selected whenever auser requested resolution. The Handle system stores DOI data in properties or name value pairs and the name for this property wasURL.

Multiple resolution required the introduction of an additional Handle property for DOIs to exhibit this new behaviour. This property iscalled "10320/loc", which is itself a Handle.

Sample Handle record:

In the sample handle record the default URL is set to represent the content's primary location. This is typically the platform of thecontent owner, or its primary publisher. The presence of property 10320/loc, containing an XML snippet, indicates to the proxy thatmultiple resolution is enabled for this DOI. The XML is interpreted as follows:

element, chooseby: specifies the order of rules to be applied by the proxy when selecting from thenelements.

locatt: used if the DOI request specifies a specific location itemncountry: used if any location item specifies a specific country which must match the country of the requesternweight: a weighted random selection from those elements having weight valuesn

element identifies a specific locationnid: a unique ID given to each location elementncr_type: a CrossRef property that specifies the type of multiple resolution to supportncr_src: a CrossRef property that identifies which CrossRef user deposited the location valuenlabel: used by CrossRef to identify the co-hostnhref: the URL of the locationnw

Documents

CrossRef Help Site