This presentation has been superceded by a more recent presentation. See http://www.slideshare.net/CrossRef/introduction-to-crossref-webinar-17423381 for the latest information.
This a non-technical introduction to CrossRef and includes a brief outline of how CrossRef works.
14. http://dx.doi.org/ + DOI = persistent URL http://dx.doi.org/10.1577/H02-043 http://dx.doi.org//10.1577/H02-043
15. International DOI Foundation (IDF): oversees the central DOI system, promote DOI as a standard, and provides an organizational infrastructure that ensures persistence and interoperability. Corporation for National Research Initiatives (CNRI):they (among other things) are responsible for the Handle system, which is the technology that causes DOIs to resolve. Registration Agencies (RAs): Register DOIs on behalf of other organizations. CrossRef is a RA.
16. DOI Registration agencies European Union Office of Publications TIB (TechnischeInformationsbibliotek) R.R. Bowker Nielsen Bookdata Copyright Agency Limited (CAL) mEDRA Wanfang Data DataCite CrossRef
20. Member obligations: outbound reference linking deposit all current journal articles resolve any DOI conflicts update metadata and URLs do not publicize CrossRef DOIs until links are live make plans for long term archiving
26. Readily implementedPrefix: Assigned to members Format is 10.XXXX Identifies who intially created the DOI Prefix does not identify the current owner of the DOI
27. Creating a DOI Suffix Keep it simple: 10.5664/sleep.1000 10.3183/NPPRJ-1986-01-03-p004-013 10.3103/S0005105507050032 10.4260/BJFT20094508 10.1632/074069503X85526 Allowed characters: "a-z", "A-Z", "0-9" and "-._;()/” Establishing a suffix pattern: http://www.crossref.org/help/CrossRef_Help_CSH.htm#02_Getting_started/Establishing_a_DOI_suffix_pattern.htm
28. Publish DOI response page Response page must include: bibliographic information about the item means to access full text the DOI New DOI Display guidelines! http://www.crossref.org/02publishers/doi_display_guidelines.html CrossRef DOIs should always be displayed as permanent URLs in the online environment. YES: http://dx.doi.org/10.5555/imadoi NO: doi: 10.5555/imadoi
39. Deposit Process Handle Thanks! <journal> <journal_metadata> <full_title>Test Publication</full_title> <abbrev_title>T27P</abbrev_title> <issnmedia_type='print'>99999999</issn> </journal_metadata> <journal_issue> <publication_datemedia_type='print'> <month>5</month> <day>5</day> <year>2001</year> </publication_date> <journal_volume> Researcher Where is my DOI? submission Publisher who did not review their submission log CMS subscriber Member querying for outbound links
43. Public interface Web deposit formhttp://www.crossref.org/webDeposit/ Enter data into form Form generates XML and sends it to the system DOI is deposited (or not, be sure to check your submission log)
48. Querying for outbound links Public interfaces: SimpleText Query Guest Query http://doi.crossref.org Machine interfaces: HTTP POST or GET OpenURL OAI-PMH (for CMS subscribers)
52. Guest Query form http://www.crossref.org/guestquery Bibliographic metadata search Author / title search Formatted reference parsing DOI-to-metadata Query Build an XML Query
53. Machine interface: HTTP POST or GET Get http://doi.crossref.org/servlet/query?usr=<USR>&pwd=<PWD>&qdata= |%20Natl%20Acad.%20Sci.%20USA|Zhou|94|24|13215|1997||| %0A|.%20Biol.|Hagerman|260|||1996||| POST /servlet/query?usr=secret&pwd=passwerd&format=unixref HTTP/1.1 Host: doi.crossref.org Connection: Keep-Alive, TE TE: trailers, deflate, gzip, compress User-Agent: RPT-HTTPClient/0.3-3 Accept-Encoding: deflate, gzip, x-gzip, compress, x-compress Content-type: application/x-www-form-urlencoded Content-length: 560 ==== Body 560 bytes Body => usr=<USR> Body => &pwd=<PWD> Body => &qdata=%3C%3Fxml+version+%3D+%221.0%22+encoding%3D%22UTF-8%22%3F%3E%3Cquery_batch+version%3D%222.0%22 ns+%3D+%22http%3A%2F%2Fwww.crossref.org%2Fqschema%2F2.0%22+xmlns%3Axsi%3D%22http%3A%2F%2Fwww.w3.org%2F2001%2FXMLSchema-instance% E%3Chead%3E%3Cemail_address%3Eckoscher%40crossref.org%3C%2Femail_address%3E%3Cdoi_batch_id%3Ew001%3C%2Fdoi_batch_id%3E%3C%2Fhead 3Cbody%3E%3Cquery+key%3D%22555-555%22+expanded-results%3D%22true%22%3E%3Cdoi%3E10.1103%2FPhysRevD.7.2467%3C%2Fdoi%3E+%3C%2Fquery 3C%2Fbody%3E%3C%2Fquery_batch%3E%0A ==== Post XML Query help: http://www.crossref.org/help/CrossRef_Help_CSH.htm#04_Queries_and_retrieving/CrossRef%20Data%20Formats.htm
56. New guidelines http://www.crossref.org/02publishers/doi_display_guidelines.html Ghosh, M.K., M.L. Harter. 2003. A viral mechanism for remodeling chromatin structure in G0 cells. Mol. Cell. 12:255–260, http://dx.doi.org/10.1016/S1097-2765(03)00225-9 Ghosh, M.K., M.L. Harter. 2003. A viral mechanism for remodeling chromatin structure in G0 cells. Mol. Cell. 12:255–260, http://doi.org/bm6 Ghosh, M.K., M.L. Harter. 2003. A viral mechanism for remodeling chromatin structure in G0 cells. Mol. Cell. 12:255–260 http://dx.doi.org/10.1016/S1097-2765(03)00225-9 Ghosh, M.K., M.L. Harter. 2003. A viral mechanism for remodeling chromatin structure in G0 cells. Mol. Cell. 12:255–260 Ghosh, M.K., M.L. Harter. 2003. A viral mechanism for remodeling chromatin structure in G0 cells. Mol. Cell. 12:255–260, CrossRef. Ghosh, M.K., M.L. Harter. 2003. A viral mechanism for remodeling chromatin structure in G0 cells. Mol. Cell. 12:255–260, Article.
57. Maintaining DOIs and Metadata URL updateH:email=pfeeney@crossref.org;fromPrefix=10.5555;toPrefix=10.555510.5555/doi1 http://www.yoururl.com/journal/art110.5555/doi2 http://www.yoururl.com/journal/art210.5555/doi2 http://www.yoururl.com/journal/art12 Updating metadata To make changes to your metadata, resubmit your entire deposit There is no charge for updating your DOIs – we encourage you to update them as often as needed.
58. Maintaining Journal Titles Title and ISSN combinations are determined by the publisher. A valid ISSN is required for all journal titles The title / ISSN combination in your deposit must match the title / ISSN combination in our system. If a title changes, a new ISSN is required Journals should be deposited under the original title Title list: http://www.crossref.org/titleList/
What is it? Digital Object Identifier, alphanumeric string that uniquely identifies an item and where it lives online DOIs can be used to identify things online, basically anything that you can link to (html pages, images, audio, raw data, programs, etc.) Once a DOI has been assigned to an item, the DOI URL (if properly maintained) can remain a consistent locator for the item.
Why are DOIs important? They solve the problem of ‘link rot’ i.e. broken links. (image) Broken links are a big problem with online content – titles move from publisher to publisher, publishers upgrade their sites regularly, which usually involves changing URLs.
A CrossRef DOI reliably identifies content. If you follow a DOI to an article, for example, you’re assure that the page you view is the publisher maintained version of an article. This is very important, because research articles are corrected, retracted, enhanced regularly.
1. A DOI link consists of two parts: the DOI resolver URL, and the DOI itself. 2. When combined, the DOI is ‘made actionable’, that is, made into a link. 3. When you click on the link, you’re taken to the current URL of the item.The URL for the DOI in this example has been updated 5 times since it was initially deposited in June 2004. 4. We updated our DOI display guidelines in early August – we now ask that DOIs be represented as a link with the http://dx.doi.orgprefix
There are a number of DOI RAs, all overseen by the International DOI Foundation. CrossRef is the largest RA – we registered over 90% of the DOIs – at last count the percentage was 96%. We register DOIs for scholarly and professional materials, other RAs assign DOIs to different materials, or use the DOI differently.
As of April 2011 there were over 51 million DOIs registered. CrossRef registers a lot of DOIs, now (as of last week) nearing 49 million
The majority of CrossRef content is journals but as we grow we’re seeing increases in deposits of other content types, particularly books. The main content types we accept are journals, books, conference proceedings, reports, standards, dissertations, and supplementary materials, but we do have some flexibility so if you want to assign DOIs to a content type not listed here, please ask.
Our range is broad chronologically as well – we of course have a significant amount of current content but deposits range back as far as 1665.
Publisher members: What does it mean to be a ‘CrossRef Member’ – member obligations outbound reference linking : Members are required to create outbound DOI links within their references, meaning members must add DOI links (when available) to the reference list for journal articles deposited with CrossRef .deposit all current journal articles: no other content types are required, back files aren’t required, but we encourage themresolve any DOI conflicts: a ‘conflict’ happens when two DOIs share the same metadata, meaning more than one DOI has been assigned to a single item. This can happen for a number of reasons - we provide tools to identify and resolve conflicts.update metadata and URLs: a DOI is only as good as its most recent URL. If your URL changes, the DOI must be updated.Do not publicize CrossRef DOIs until links are liveMake plans for long term archiving: this is new, you need to decide what you’re going to do if you go out of business – there are a number of archiving organizations that are very willing to host journals that have ceased publications (Portico, CLOCKSS, KLB)
In this next section I’m going to go over the different stages of registering and managing CrossRef DOIs. These are presented step-by-step, but this isn’t necessarily the order you need to do things in and don’t view it as a recommended workflow.
When you first join CrossRef as a member, you are given a DOI prefix - the DOI consists of two parts: a prefix and a suffix.
When creating a suffix, keep it simple. Here are some example suffixes – the DOI is an opaque string intended to remain unique and persistent throughout changes in ownership and location of the content, so you do not need to include any specific or descriptive information in the DOI. Descriptive information is included in the DOI’s metadata. If you choose to include such bibliographic information in a DOI string, it will have no meaning within the CrossRef or DOI system or to end users. To the end user, a DOI is a DOI – the prefix/suffix combination have no meaning, it’s a string of letters and numbers.Existing identifiers can also be used for the DOI suffix, such as an ISBN, or existing internal numbering scheme. We have an allowed character set – any DOIs outside of this character set will not be created.
Your journal article, book, report, etc. will need what we call a ‘DOI response page’ which is the page the DOI resolves to. Usually this is the same as the article landing page.A DOI ‘response page’ must include the DOI, bibliographic information about the item, and a means to access full text.In a perfect world, DOIs would be published and deposited with CrossRef spontaneously, but realistically we ask you to keep the gap between publication and deposit within 24 hours.
DOIs are required on the DOI response page but we also recommend you include them whenever a persistent link is needed – in your tables of contents, abstracts, citation downloads, metadata feeds, etc. etc. – they’re not just for reference linking.
So, here are some examples of DOIs in the wild. Here’s one from PNAS, included with other bibliographic metadata
this example is following the new guidelines already, which is excellent
And a third example of a title-level book DOI. DOIs can be assigned to both chapters and books.
The next steps are the most complex and involve sending and receiving data from CrossRef. You deposit your DOIs and metadata with us, which enables inbound linking, meaning you (and others) are able to use DOIs to link to your content. You also look up DOIs for other publishers and include them in your references as outbound links. I’m going to cover depositing first but Querying and outbound linking can happen at whatever point in your workflow makes sense to you. Depositing:Publishers send in metadata for every DOI they register. We call this process ‘depositing’. We sometimes use the terms ‘deposit’ and ‘register’ interchangeably but they’re slightly different - when a publisher ‘deposits’ a DOI, the metadata is added to the CrossRef database, making the DOI retrievable. The DOI is also registered with the Handle resolver, meaning the DOI and URL only – no citation metadata is recorded by the Handle resolver. Regarding the deposit process: You send the XML to the CrossRef system, where it is placed in our system’s submission queue. When the submission is processed, CrossRef registers the DOI and URL with the Handle resolver.Immediately after the submission is processed, the system sends you a submission log. This is very important - data is often messy, and we try to keep the messy stuff out of our database, so there are many reasons your submission might fail. Once the DOI has been registered, it is resolvable and queryable, meaning it can be used for linking and can be retrieved from our system by end users.
XML must comply with the CrossRef deposit schema – quickly, here’s a sample of an XML deposit – it includes basic journal metadata like title, ISSN, volume issue publication date. Article metadata includes title, authors (all, preferably), page number, and of course the DOI and URL.
Submission methods vary from very robust complicated systems to one guy cutting and pasting stuff from Word into our web deposit form (which converts the data to XML). Most deposits are made via machine interfaces. Data is sent to us via HTTP POST – we do have a simple java-based tool that can be used for uploads, it’s available in our help documentation. Many publishers prefer to create their own tools. We do not currently accept FTP deposits.
We have one main Public interface for depositing, the web deposit form: enter your metadata field by field into the form. XML will be generated for you and sent to the system
This is only suitable for low volume deposits for obvious reasons – someone needs to enter all of the metadata into the form. It’s a good option if you publish infrequently or only publish a small number of articles at a time. It’s also handy if you need to update a single DOI and don’t want to redo an entire deposit. The web deposit form accepts deposits for journals and articles, books and book chapters, conference proceedings and conference papers, and reports.1.Enteryourmetadata field by field into the form, and XML will be generated for you and sent to the system. You first enter basic title-level metadata – for journals, that’s title, ISSN, volume, issue, date – and any title or issue-level DOIs you want to create. Title level DOIs are not required for journals but we recommend them.2. Next, enter item-level metadata, so for example, for a journal you’d enter article title, authors, and page numbers and publication date. It’s in everyone’s best interest if all available metadata is entered, including all authors – it’s easy to just enter one, but entering all increases the chance that members, users, and subscribers will be able to find your DOIs.3. Last step: submit! There’s a tick box for ‘send XML’ which is selected by default – we recommend that you leave this selected.After you hit the ‘submit’ button, an XML file is sent to the system for deposit. Submitting the form doesn’t mean your DOIs have been deposited, it just means they’ve been submitted. When the deposit has been processed, you’ll get an emailed submission log. We also send you a second email containing the XML from your deposit – it can come in handy if you discover errors in your deposit and need to update your metadata –you can edit the XML instead of re-entering everything into the form.Note; You can also upload single NLM files to this interface
We do have a public interface to our system which can be used to upload deposit and query files. This is where you’d go if you needed to resubmit an XML file generated by the web deposit form.
Query CrossRef to retrieve DOI matches for outbound linking: meaning you need to search our database for DOI matches for your journal articles. Outbound linking is required for recent journal articles but we encourage publishers to link references for back issues and other content types as well, since it strengthens the linking network for everyone.Public interface: STQ – again, suitable only for low volume querying. The STQ form basically breaks your citatons into XML , then submits the XML to our system as a query.XML / bulk querying: if you are able to separate your citations to fit our schema, XML querying is the way to go – we have a number of methods you can use for querying. You can upload bulk XML queries, poll the system using XML queries, or do OpenURL queries.
To use, cut-and-paste a list of citations into the form and…
Your list will be returned to you with any DOI matches.
We also have a ‘guest query’ form which provides a number of single-DOI searches. It’s not a tool you’d want to use for bulk querying, but it’s an excellent resource for testing out queries. It’s a good practice to query for your own DOIs, just to make sure they are discoverable. The GQ has a ‘bibliographic metadata search’, which allows you to enter fielded metadata into the form There’s also an author/title search, which can be useful if you don’t have full article metadata Next, there’s a formatted reference parser, you can enter a single reference here – for multiple references you’ll need to use the STQ There is a DOI-to-metadata query, you enter a DOI and get back the metadata You’re also able to submit an XML query – this is quite handy for troubleshooting and testing, we’ve got several options for controlling query execution so it’s pretty easy to just cut and paste a query into the box and edit it on the fly.
Here is another example of outbound linking - this publisher is including the full DOI url in their references, making it very easy to cut and paste etc. This is recommended in our new DOI guidelines…
The complete guidelines are on our website, there’s a link, I’ve included the different reference linking options here. 1. uses the complete DOI link in the referenceGhosh, M.K., M.L. Harter. 2003. A viral mechanism for remodeling chromatin structure in G0 cells. Mol. Cell. 12:255–260, http://dx.doi.org/10.1016/S1097-2765(03)00225-9 2.—Use a ShortDOI as the permanent link - a ShortDOI is a shortcut DOI name - if you find yourself in possession of a long DOI that adds extra lines to your references or is otherwise difficult to represent, you can create a shortcut using the shortDOI service at http://shortdoi.org/ ExampleGhosh, M.K., M.L. Harter. 2003. A viral mechanism for remodeling chromatin structure in G0 cells. Mol. Cell. 12:255–260, http://doi.org/bm6 3—Displays the CrossRef linking graphic next to the permanent DOI link.Linking graphics can be found on the member logo page. ExampleGhosh, M.K., M.L. Harter. 2003. A viral mechanism for remodeling chromatin structure in G0 cells. Mol. Cell. 12:255–260 http://dx.doi.org/10.1016/S1097-2765(03)00225-9 4—Display the CrossRef linking graphic with the permanent URL behind it, so if you click on the graphic you resolve the DOILinking graphics can be found on the member logo page. ExampleGhosh, M.K., M.L. Harter. 2003. A viral mechanism for remodeling chromatin structure in G0 cells. Mol. Cell. 12:255–260 5—Display the text “CrossRef” with a permanent DOI link behind the text ExampleGhosh, M.K., M.L. Harter. 2003. A viral mechanism for remodeling chromatin structure in G0 cells. Mol. Cell. 12:255–260, CrossRef. 6—Display the words “Full Text” or “Article” or something similar with the permanent DOI link behind the text. ExampleGhosh, M.K., M.L. Harter. 2003. A viral mechanism for remodeling chromatin structure in G0 cells. Mol. Cell. 12:255–260, Article. So, once your DOIs have been included in your references, you’re done! Until the next issue. Or unless there are problems..
Making changes: for the most part, if the metadata you send us is thorough and accurate, DOIs don’t need to be touched. There are some circumstances that require attention - Common changes are:Updating URLs: this is the most frequent change, for obvious reasons. If you make changes to your site or acquire DOIs from another publisher, DOIs can be updated easily by either:Redepositing your metadata with the new URLs – the metadata in our system will be overwrittenSending support@crossref.org a tab separated list of DOIs and their new URLs. These updates can usually be processed within 24 hours (excluding weekends). If you have a large number of DOIs to update (say over 100,000) contact us in advance and we can give you an estimate of the time involved.Changing metadata: if you’ve discovered errors in your metadata or otherwise need to make an update, redeposit your metadata with the changes – any deposits already in the system will be overwritten, so make sure the redeposit is complete. For example, if you deposit your DOIs with an online publication date before the item has been published in print, you can update the metadata once the print info is available. There is no charge for updating your DOIs – we encourage you to update them as often as you like.
If you have titles that have gone through name changes, you’ll need to pay attention to our title management policies.Titles in the CrossRef system are created from publisher metadata with the first deposit of a journal. Title and ISSN combinations are not verified with an external agency. A check digit validation is performed on every ISSN submitted in a deposit. Once a title or ISSN is introduced into the CrossRef system, a new publication with the same title or ISSN cannot be created without CrossRef intervention. The publisher determines the exact title and ISSN included in the deposit. At least one ISSN is required for each journal deposited with CrossRef, but publishers are encouraged to deposit all ISSN available for a title. If you are depositing a series that predates ISSNs, they can be assigned retroactively – there’s no charge for assigning ISSNs.The title / ISSN combination in your deposit must match the title / ISSN combination in our system. We do allow for minor variances, like Journal of… vs. The Journal of… or mixing and and &Publishers requesting significant changes to a title are instructed to request a new ISSN from the appropriate agency. This isn’t a CrossRef policy, it’s an ISSN Centre policy and is actively supported by the Library of Congress (for those of you in the US)5. Journals should be deposited with the correct title – sometimes journals appear online under the most current title. We really need to make sure that the title in our database is the original title, since that title will be used in citations, which turn into CrossRef queries. We can add multiple versions of a title to a title record to help with querying, but it’s important that DOIs be attached to the correct title.
The Resolution Report is emailed monthly to the business contact we have on file. This report is comprised of statistics we extract from DOI resolution logs and contains data about how many times your DOIs have been clicked and your overall resolution failure rate (successes vs. failures)More info: http://www.crossref.org/help/CrossRef_Help_CSH.htm#03_The%20CrossRef%20user%20interfaces/07_Reports/Resolution_Report.htm
Depositor reports are generated for journals, books and conference proceedings – the report lists all titles and DOIs for each publisher. The report is linked from the members page (http://www.crossref.org/06members/index.html) under Technical Info
The status page is in the members area as well and lists statistics about CrossRef DOIs as a whole including the total number of DOIs deposited overall and for each content type, and statistics about deposits and query success rates.
This is another members area report – it lists prefix data for all members.
Conflict report: this report is linked through the members area. Alerts are also sent out monthly to technical contacts when you have conflicts to resolve. If you don’t have any conflicts, you won’t get this report. Again, conflicts are what happens when two DOIs are created with the same metadata. More info on conflicts: http://www.crossref.org/help/CrossRef_Help_CSH.htm#06_Maintaining%20DOIs/Resolving_conflicts/Resolving_conflicts.htm
This report is emailed as needed to the technical contact. These alerts are compiled from complaints about unresolving DOIs submitted to us by end users. If an end user tries to resolve a DOI that has not been registered, they are delivered to a form that they can submit to us with comments and their email address. When the DOI has been registered, we send them an alert. Any comments are passed on to publishers.
We also have something called the Schematron report –Schematronis a validation language. These reports are used to identify messy metadata We need to be flexible and accommodate variances in data, so our deposit schema can’t keep all of the questionable data out without blocking good data as well, so we do a post-deposit review of metadata and pick out items that we think might be incorrect. These reports are emailed out weekly on Saturday, and we send out an average of 45 reports a week.
Here’s an idea of what we consider ‘messy data’ – the schematron report identified that the #1 most common problem was including ‘JR’ in the surname field. This is a big deal, since author surnames are weighted heavily in querying – we do some fuzzy matching, but it’s very probably that a surname like ‘Smith JR’ wont’ be matched. As you can see, we also get a lot of deposits with garbage in the surname, like footnote remnants – it really can make the difference between someone finding your DOI and not finding it.
Here’s an example of what the actual schematron report looks like
We also have a separate ‘labs’ website for more experimental efforts – these aren’t considered in production so while they are generally reliable I need to tell you to use them at your own risk. The labs offers browser plugins that make it easy to cite using DOIs, tools for adding linked images or CrossRef metadata to PDFs, and an experimental CrossRef metadata search interface.