Difference between revisions of "CrossRef"

From PKP Wiki
Jump to: navigation, search
(added stub)
Line 2: Line 2:
  
 
== Project Contacts ==
 
== Project Contacts ==
* PKP: [mailto:juan@alperin.ca Juan Pablo Alperin]
+
* PKP: [mailto:pkp.contact@gmail.com James MacGregor]
  
 
== Project Information ==
 
== Project Information ==
  
This project offers an extension of the existing DOI support for OJS. While OJS has for a long time offered the ability to produce XML to send to crossref, it now offers the ability to submit that XML without manual intervention. Setting up this service requires configuration of TWO plugins. First, it is the "Public Identifier Plugin" that can be found in the category of that name. Some documentation regarding this category can be [http://pkp.sfu.ca/wiki/index.php?title=DOIPluginsDocumentation found here]. The second is in the "import/export" plugin category that now has settings that need to be entered, including CrossRef member credentials.  
+
PKP and CrossRef are collaborating to help publishers and journals using Open Journal Systems (OJS) take better advantage of CrossRef services. As of 2014, PKP has become a Sponsoring Entity of CrossRef, and as such will be providing much improved CrossRef integration and overall support for the service. Additionally, PKP can now act as a sponsor representative for OJS journals wishing to apply for CrossRef membership, and is in some cases able to waive fees.
  
== Information for testers ==
+
== DOI and Associated Metadata Export ==
  
There are three aspects of testing that need to be tested.  
+
PKP is working with CrossRef to improve the level of overall DOI export support provided within OJS. OJS has included a basic manual export plugin for several years; this plugin will be extended in the following ways, and will be freely available to any journal using OJS (2.4.5+).
  
1. Basic plugin workings. Exporting things, saving settings, acron tasks getting installed, links working, etc.
+
- automatic DOI deposit to CrossRef on article publication (2.4.5);
* Should be able to select articles, issues, or from unregistered items for export or registration
+
– inclusion of other article metadata in the CrossRef deposit, including author ORCID iDs; article abstracts; and more (OJS 2.4.5);
* Export should produce an XML file, Registering should upload one to CrossRef
+
– inclusion of FundRef funding data (forthcoming);
* Upon installation (or upgrade) an acron task should be loaded to execute CrossrefInfoSender regularly
+
– support for the CrossMark publication record service (forthcoming);
* known bug: I think clicking "export" link next to article name was not working. Selecting checkbox and hitting "export" at bottom was.
+
and more.
  
2. Checking the XML output. This can be exported the traditional way and someone can manually look over the XML and upload it for validation.
+
==PKP as Sponsoring Entity==
* The XML produce has changed somewhat since the last version of the plugin.
+
* basic sanity checks are needed (is metadata in file correct)
+
* but also XML produced should be checked and uploaded to crossref manually for verification at test.crossref.org
+
  
3. The automatic registration and subsequent check deposit status.
+
As a CrossRef Sponsoring Entity, PKP can also act as sponsor and representative for other journals to join CrossRef through PKP. Journals from low-income countries may be eligible for sponsorship, allowing these journals to become CrossRef members and deposit DOIs into the CrossRef system at no cost.  
* should only work is "automatic registration is enabled
+
* The driver of the automatic registration can be [https://github.com/pkp/ojs/blob/ojs-stable-2_4/plugins/importexport/crossref/CrossrefInfoSender.inc.php found here]. Especially in the "execute" method. The logic is essentially:
+
** grab of journals that have "automatic registration" turned on
+
** grab all unregistered objects for that journal
+
** update the deposit status by doing one of two checks:
+
*** check the new API to see if there was at least one successful deposit
+
*** search for the DOI on http://search.crossref.org and mark as registered if you found the DOI from a previous deposit
+
** for everything that remains unregistered, submit the XML produced (see above) to the new API
+
* To check, see the "unregistered objects" page in the plugin. Upon first run, all unregistered items should report a "submitted" status until processing happens. Checking back on that page, items should begin to disappear.  
+
  
== Internal (PKP) notes ==  
+
===Eligible countries===
 +
 
 +
{| class="wikitable"
 +
|-
 +
| Afghanistan (LIC) || Central African Republic (LIC)|| Gambia (LIC) || Liberia (LIC)|| Niger (LIC)|| Sudan (LMC)
 +
|-
 +
| Bangladesh (LIC) || Chad (LIC) || Guinea (LIC)||  Madagascar (LIC)|| Pakistan (LMC)|| Tajikistan (LIC)
 +
|-
 +
| Benin (LIC) || Comoros (LIC) || Guinea-Bassau (LIC)|| Malawi (LIC)|| Rwanda (LIC)|| Tanzania (LIC)
 +
|-
 +
| Benin (LIC) || Congo, Democratic Republic (LIC) || Haiti (LIC)|| Mali (LIC)|| Sao Tome and Principe (LMC)|| Togo (LIC)
 +
|-
 +
| Burkina Faso (LIC) || Cote d’Ivoire (LMC) || Kenya (LIC)|| Mauritania (LMC)|| Senegal (LMC)|| Uganda (LIC)
 +
|-
 +
| Burundi (LIC) || Djibouti (LMC) || Korea, Democratic Republic (LIC)|| Mozambique (LIC)|| Sierra Leone (LIC)|| Yemen Republic (LMC)
 +
|-
 +
| Cambodia (LIC) || Eritrea (LIC) || Kyrgyz Republic (LMC)|| Myanmar (LIC)|| Somalia (LIC)|| Zambia (LMC)
 +
|-
 +
| Cameroon (LMC) || Ethiopia (LIC) || LAO PDR (LMC) || Nepal (LIC)|| South Sudan (LMC)|| Zimbabwe (LIC)
 +
|}
 +
 
 +
For further eligibility criteria and any other information, contact us.
 +
 
 +
==PKP Publishing Services clients==
 +
 
 +
PKP Publishing Services provides additional CrossRef support. All hosted clients can rely on our internal expertise to assist with plugin setup and support. Additionally, Enterprise clients will now have CrossRef represented membership and DOI deposits included as part of the Enterprise hosting package.  For more information, please contact us.
 +
 
 +
== Internal (PKP) notes and current status ==  
  
 
- The documentation at [DOIPluginsDocumentation] needs updating to include the fact that CrossRef can now also be automatically registered  
 
- The documentation at [DOIPluginsDocumentation] needs updating to include the fact that CrossRef can now also be automatically registered  
 
- Should decide how to handle existing items. Should everything be marked as registered upon plugin installation? Should user be warned when enabling automatic installation?
 
- Should decide how to handle existing items. Should everything be marked as registered upon plugin installation? Should user be warned when enabling automatic installation?

Revision as of 13:27, 12 September 2014

-intro to the project-

Project Contacts

Project Information

PKP and CrossRef are collaborating to help publishers and journals using Open Journal Systems (OJS) take better advantage of CrossRef services. As of 2014, PKP has become a Sponsoring Entity of CrossRef, and as such will be providing much improved CrossRef integration and overall support for the service. Additionally, PKP can now act as a sponsor representative for OJS journals wishing to apply for CrossRef membership, and is in some cases able to waive fees.

DOI and Associated Metadata Export

PKP is working with CrossRef to improve the level of overall DOI export support provided within OJS. OJS has included a basic manual export plugin for several years; this plugin will be extended in the following ways, and will be freely available to any journal using OJS (2.4.5+).

- automatic DOI deposit to CrossRef on article publication (2.4.5); – inclusion of other article metadata in the CrossRef deposit, including author ORCID iDs; article abstracts; and more (OJS 2.4.5); – inclusion of FundRef funding data (forthcoming); – support for the CrossMark publication record service (forthcoming); – and more.

PKP as Sponsoring Entity

As a CrossRef Sponsoring Entity, PKP can also act as sponsor and representative for other journals to join CrossRef through PKP. Journals from low-income countries may be eligible for sponsorship, allowing these journals to become CrossRef members and deposit DOIs into the CrossRef system at no cost.

Eligible countries

Afghanistan (LIC) Central African Republic (LIC) Gambia (LIC) Liberia (LIC) Niger (LIC) Sudan (LMC)
Bangladesh (LIC) Chad (LIC) Guinea (LIC) Madagascar (LIC) Pakistan (LMC) Tajikistan (LIC)
Benin (LIC) Comoros (LIC) Guinea-Bassau (LIC) Malawi (LIC) Rwanda (LIC) Tanzania (LIC)
Benin (LIC) Congo, Democratic Republic (LIC) Haiti (LIC) Mali (LIC) Sao Tome and Principe (LMC) Togo (LIC)
Burkina Faso (LIC) Cote d’Ivoire (LMC) Kenya (LIC) Mauritania (LMC) Senegal (LMC) Uganda (LIC)
Burundi (LIC) Djibouti (LMC) Korea, Democratic Republic (LIC) Mozambique (LIC) Sierra Leone (LIC) Yemen Republic (LMC)
Cambodia (LIC) Eritrea (LIC) Kyrgyz Republic (LMC) Myanmar (LIC) Somalia (LIC) Zambia (LMC)
Cameroon (LMC) Ethiopia (LIC) LAO PDR (LMC) Nepal (LIC) South Sudan (LMC) Zimbabwe (LIC)

For further eligibility criteria and any other information, contact us.

PKP Publishing Services clients

PKP Publishing Services provides additional CrossRef support. All hosted clients can rely on our internal expertise to assist with plugin setup and support. Additionally, Enterprise clients will now have CrossRef represented membership and DOI deposits included as part of the Enterprise hosting package. For more information, please contact us.

Internal (PKP) notes and current status

- The documentation at [DOIPluginsDocumentation] needs updating to include the fact that CrossRef can now also be automatically registered - Should decide how to handle existing items. Should everything be marked as registered upon plugin installation? Should user be warned when enabling automatic installation?