Difference between revisions of "ORCID Support"
| Line 7: | Line 7: | ||
==ORCID Support== | ==ORCID Support== | ||
| + | ===ORCID Field=== | ||
| + | ORCID Support adds a new 'ORCID' field to both the 'Creators' and 'Editors' field, as well as the adding a new stage to the edit user workflow where an ORCID may be stored. All of these fields are of type 'ORCID', a special type of text field that validates the ORCID is of the correct format, 16 digits broken into 4 groups of 4 separated by a dash, e.g. 0000-0003-1495-7122. The field also checks that the final digit of the ORCID, the checksum, is valid and a warning is displayed if the ORCID is invalid in any way. | ||
| + | |||
| + | [[File:orcid_creators.png|800px|thumb|none]] | ||
| + | |||
| + | [[File:orcid_user_profile.png|800px|thumb|none]] | ||
| + | |||
| + | [[File:orcid_warning.png|800px|thumb|none]] | ||
| + | |||
| + | The lookup script for the 'Creators' and 'Editors' fields has also been updated to include the ORCID where this can be retrieved from other records where the ORCID has already been stored. | ||
| + | |||
| + | === | ||
| + | |||
| + | |||
| + | ===RIOXX=== | ||
| + | Where the [http://bazaar.eprints.org/390/ RIOXX] plugin has been installed, ORCIDs will be added as the 'id' attribute for <rioxxterms:author> elements. | ||
===For Developers=== | ===For Developers=== | ||
Revision as of 14:10, 2 October 2017
Contents
Introduction
The 'ORCID Support' and 'ORCID Support Advance' plugins have been developed to group together various ORCID developments from across a range of repositories
'ORCID Support' provides basic ORCID functionality for the repository including the addition of a new ORCID metafield, ORCID rendering and validation, and basic reporting with the Generic Reporting Framework.
'ORCID Support Advance' builds upon the functionality of 'ORCID Support', and allows users to connect their repository profiles with their accounts on orcid.org. Once an account has been connected, the user may manage their orcid.org permissions, controlling how the repository reads and writes from orcid.org. If read permissions have been granted, works from orcid.org may be imported to the user's work area. If write permissions have been granted, records where the user's ORCID is present may be exported to their orcid.org profile.
ORCID Support
ORCID Field
ORCID Support adds a new 'ORCID' field to both the 'Creators' and 'Editors' field, as well as the adding a new stage to the edit user workflow where an ORCID may be stored. All of these fields are of type 'ORCID', a special type of text field that validates the ORCID is of the correct format, 16 digits broken into 4 groups of 4 separated by a dash, e.g. 0000-0003-1495-7122. The field also checks that the final digit of the ORCID, the checksum, is valid and a warning is displayed if the ORCID is invalid in any way.
The lookup script for the 'Creators' and 'Editors' fields has also been updated to include the ORCID where this can be retrieved from other records where the ORCID has already been stored.
=
RIOXX
Where the RIOXX plugin has been installed, ORCIDs will be added as the 'id' attribute for <rioxxterms:author> elements.
For Developers
Updating Citations
ORCID Support provides a function for rendering green ORCID badges which show the user's ORCID in a tooltip when hovered over. To add these in a citation, simply include the following when displaying creator or editor fields.
<!-- For Creators --> <print expr="people_with_orcids(creators)" /> <!-- For Editors --> <print expr="people_with_orcids(editors)" />
ORCID Support Advance
ORCID Support is required for ORCID Support Advance
