Editing ORCID Support (section)

=ORCID Support=
==ORCID Field==
ORCID Support adds a new <tt>orcid</tt> field to both the <tt>creators</tt> and <tt>editors</tt> 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 <tt>orcid</tt>, a special type of text field that validates the ORCID is of the [https://support.orcid.org/hc/en-us/articles/360006897674-Structure-of-the-ORCID-Identifier 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 <tt>creators</tt> and <tt>editors</tt> fields has also been updated to include the ORCID where this can be retrieved from other records where the ORCID has already been stored.

The <tt>creators</tt> and <tt>editors</tt> fields will also be automatically be populated from user profiles if the <tt>creators</tt> or <tt>editors</tt> ID subfields can be used to lookup a corresponding user profile.

==Display ORCIDS==
ORCIDs are always displayed next to a small, green ORCID badge, and in form of a link to the corresponding orcid.org profile.

[[File:orcid_rendering.png|800px|thumb|none]]

Where space on the screen is more restricted, such as in citations, the ORCID itself is removed and only the green ORCID badge is displayed. The badge still links to the orcid.org profile and when hovered over, the ORCID is displayed in a green tooltip.

[[File:orcid_tooltip.png|800px|thumb|none]]

==Reports==
Where the [[Generic Reporting Framework]] plugin has been installed, new reports will become available, under the heading ''ORCID Dashboard''.

The ''All users with and without ORCIDs'' report will show all the users in the repository, showing users without an ORCID as non-compliant and users with an ORCID as compliant.

[[File:orcid_all_users_report.png|800px|thumb|none]]

The ''Users with ORCIDs'' report, is similar to the ''All users'' report, but instead only shows the users who have ORCIDs in their user profile.

Finally, the ''Creators with ORCIDs'' report will highlight all EPrint records that have <tt>creators</tt> values with ORCIDs assigned to them.

[[File:orcid_creators_report.png|800px|thumb|none]]

==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==
===Existing ORCID Fields===
The ORCID Support plugin will add an ORCID field in the the following three places:
# As a sub-field of <tt>creators</tt> for an EPrint.  Check the <tt>Details</tt> stage of your EPrint workflow. 
# As a sub-field of <tt>editors</tt> for an EPrint.  Check the <tt>Details</tt> stage of your EPrint workflow when the EPrint id of type <tt>Book</tt> or <tt>Book Section</tt>.
# As a field for a <tt>user</tt>. Check the <tt>Profile</tt> stage in your user workflow.  
If you already have an <tt>orcid</tt> field in any of these three locations, the ORCID Support will skip creating its own.  However, it will not update the existing field to the new <tt>orcid</tt> type.  Therefore if one or more of the fields exist you will need to edit them manually to change their type from <tt>text</tt> to <tt>orcid</tt> after the ORCID Support plugin has been installed:
 {
   'sub_name' => 'orcid',
   'type' => 'text',
   'input_cols' => 20,
   'allow_null' => 1,
 }

becomes

 {
   'sub_name' => 'orcid',
   'type' => 'orcid',
   'input_cols' => 20,
   'allow_null' => 1,
 }

If you have pre-configured the <tt>creators</tt>' or <tt>editors</tt>' <tt>orcid</tt> sub-field, this will likely be in your archive's <tt>cfg/cfg.d/eprint_fields.pl</tt>.  The user's <tt>orcid</tt> field will most likely be in your archive's <tt>cfg/cfg.d/user_fields.pl</tt>.

===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.

<pre>
<!-- For Creators -->
<print expr="people_with_orcids(creators)" /> 

<!-- For Editors -->
<print expr="people_with_orcids(editors)" /> 
</pre>

==Change Log==
'''v2.0'''

Accessibility fixes through additional of alt text to images. 

Refactor application of ORCID field to a list of contributor fields, rather than arbitrarily hardcoding implementation for creators/editors.

Additional Editors with ORCID report.

Update logo to use svg version of image.

Merge phrases into a single file.

'''v1.7'''

Update reports to show custom content in headers, i.e. change ''outputs'' to ''users'' and hide compliance information when not relevant.

'''v1.6'''

Update ORCID rendering to display in format starting with https://orcid.org/

'''v1.5'''

Add German phrases and add missing ORCID search form phrases.