From cd9055ea302a9734501446195b4fcce8c0d3a454 Mon Sep 17 00:00:00 2001 From: Catalina Oyler Date: Wed, 11 Jul 2018 13:01:59 -0700 Subject: [PATCH] more comment cleanup --- .../record_3.0_rc1/history-3.0_rc1.xsd | 24 ++++------ .../record_3.0_rc1/membership-3.0_rc1.xsd | 2 +- .../record_3.0_rc1/search-3.0_rc1.xsd | 2 +- .../record_3.0_rc1/service-3.0_rc1.xsd | 9 ++-- .../resources/record_3.0_rc1/work-3.0_rc1.xsd | 47 +++++++++---------- 5 files changed, 37 insertions(+), 47 deletions(-) diff --git a/orcid-model/src/main/resources/record_3.0_rc1/history-3.0_rc1.xsd b/orcid-model/src/main/resources/record_3.0_rc1/history-3.0_rc1.xsd index a1004aaba5b..24a569a9073 100644 --- a/orcid-model/src/main/resources/record_3.0_rc1/history-3.0_rc1.xsd +++ b/orcid-model/src/main/resources/record_3.0_rc1/history-3.0_rc1.xsd @@ -47,8 +47,7 @@ minOccurs="0" maxOccurs="1"> The method used to create the ORCID Record - * API - method - Institution created the record on behalf of the + * API method - Institution created the record on behalf of the individual * Direct/website methods - Individual registered directly at orcid.org @@ -78,8 +77,7 @@ - True if the user's current primary email is - verified + True if the user's current primary email is verified @@ -90,8 +88,7 @@ - The date and time when the ORCID Record set up was - completed. + Only returned on records with a creation method of API, this date is when the user took control of the record and set a password @@ -101,8 +98,7 @@ - The date time when the ORCID Record and iD was - first created. This will be the same as completion-date except on records with an API creation method + The date time when the ORCID record was first created. @@ -155,33 +151,31 @@ - Indicates how the ORCID record and iD were created. + Indicates how the ORCID record was created. - The ORCID Record was created using the ORCID - Member API. + The ORCID Record was created using the ORCID Member API. - The user registered on the /register page. + The user registered on the ORCID website. - The registered on the /oauth/signin. + The user registered as part of the OAuth process. - DEPRECATED use Direct - instead. + DEPRECATED use Direct instead. diff --git a/orcid-model/src/main/resources/record_3.0_rc1/membership-3.0_rc1.xsd b/orcid-model/src/main/resources/record_3.0_rc1/membership-3.0_rc1.xsd index 0038992e484..6f0e4146b31 100644 --- a/orcid-model/src/main/resources/record_3.0_rc1/membership-3.0_rc1.xsd +++ b/orcid-model/src/main/resources/record_3.0_rc1/membership-3.0_rc1.xsd @@ -38,7 +38,7 @@ A membership associated with the researcher. - Membership is defined as Paid or gratis membership of a society or association (i.e. does not include honorary memberships and fellowships as defined under Invited Position and Distinctions) + Membership is defined as paid or gratis membership of a society or association (i.e. does not include honorary memberships and fellowships as defined under Invited Position and Distinctions) * The put-code attribute is returned when reading this element. When updating the item, the put-code attribute must be included to indicate the specific item to be updated. diff --git a/orcid-model/src/main/resources/record_3.0_rc1/search-3.0_rc1.xsd b/orcid-model/src/main/resources/record_3.0_rc1/search-3.0_rc1.xsd index 8ca6e4616de..18a6a479cba 100644 --- a/orcid-model/src/main/resources/record_3.0_rc1/search-3.0_rc1.xsd +++ b/orcid-model/src/main/resources/record_3.0_rc1/search-3.0_rc1.xsd @@ -11,7 +11,7 @@ ORCID (R) Open Source http://orcid.org - Copyright (c) 2012-2014 ORCID, + Copyright (c) 2012-2018 ORCID, Inc. Licensed under an MIT-Style License (MIT) http://orcid.org/open-source-license diff --git a/orcid-model/src/main/resources/record_3.0_rc1/service-3.0_rc1.xsd b/orcid-model/src/main/resources/record_3.0_rc1/service-3.0_rc1.xsd index 311640a306e..bde564c2ea9 100644 --- a/orcid-model/src/main/resources/record_3.0_rc1/service-3.0_rc1.xsd +++ b/orcid-model/src/main/resources/record_3.0_rc1/service-3.0_rc1.xsd @@ -10,7 +10,7 @@ ORCID (R) Open Source http://orcid.org - Copyright (c) 2012-2014 ORCID, + Copyright (c) 2012-2018 ORCID, Inc. Licensed under an MIT-Style License (MIT) http://orcid.org/open-source-license @@ -37,11 +37,8 @@ - A service associated with the researcher or - contributor. - * The visibility attribute (private, limited or public) - can be set at record creation, and indicates who can see this - section of information. + A service associated with the researcher. + Service is defined as significant donations of time, money, or other resources to an organization or community * The put-code attribute is used only when reading this element. When updating the item, the put-code attribute must be included to indicate the specific record to be updated. diff --git a/orcid-model/src/main/resources/record_3.0_rc1/work-3.0_rc1.xsd b/orcid-model/src/main/resources/record_3.0_rc1/work-3.0_rc1.xsd index f4771bdbc95..dffe54df7b6 100644 --- a/orcid-model/src/main/resources/record_3.0_rc1/work-3.0_rc1.xsd +++ b/orcid-model/src/main/resources/record_3.0_rc1/work-3.0_rc1.xsd @@ -10,7 +10,7 @@ ORCID (R) Open Source http://orcid.org - Copyright (c) 2012-2014 ORCID, + Copyright (c) 2012-2018 ORCID, Inc. Licensed under an MIT-Style License (MIT) http://orcid.org/open-source-license @@ -41,10 +41,7 @@ - A work published by the researcher or contributor. - * The visibility attribute (private, limited or public) can be set - at record creation, and indicates who can see this section of - information. + A work is any research output that the researcher produced or contributed to * The put-code attribute is used only when reading this element. When updating the item, the put-code attribute must be included to indicate the specific record to be updated. @@ -67,13 +64,17 @@ - + + + Required. The type of work + + + - Element containing the type and content of the - citation for this work + Required when writing work items. The list of supported identifier types is at https://pub.qa.orcid.org/v2.0/identifiers @@ -81,7 +82,12 @@ + maxOccurs="1"> + + The language used for the metadata provided about the work + + + @@ -112,8 +118,7 @@ The types of works accepted accepted by the ORCID Registry. Please refer to the CASRAI dictionary for definitions of - each work type. - http://dictionary.casrai.org/research-personnel-profile/contributions/outputs + each work type. http://dictionary.casrai.org/research-personnel-profile/contributions/outputs @@ -146,6 +151,7 @@ + @@ -178,7 +184,7 @@ - ORCID iD for the contributor + ORCID iD for the contributor - only add if you have collected an authenticated iD for the contributor - Email of the collaborator or other contributor. - When provided during creation or update, the email address is used - to look up and add the contributor's ORCID iD. + Email of the contributor. This field is not returned when reading a work @@ -269,16 +273,11 @@ The title of the publication or group under which the work was published. - * If a jounal, include the journal title of - the work. + * If a jounal, include the journal title of the work. * If a book chapter, use the book title. - * If a translation - or a - manual, use the series title. - * If a dictionary entry, use the - dictionary title. - * If a conference poster, abstract or paper, use - the conference name. + * If a translation or a manual, use the series title. + * If a dictionary entry, use the dictionary title. + * If a conference poster, abstract or paper, use the conference name.