more comment cleanup

ORCID · Jul 11, 2018 · cd9055e · cd9055e
1 parent 2cff8cf
commit cd9055e
Show file tree

Hide file tree

Showing 5 changed files with 37 additions and 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
@@ -47,8 +47,7 @@
 					minOccurs="0" maxOccurs="1">
 					<xs:annotation>
 						<xs:documentation>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 @@
 				<xs:element name="verified-primary-email" type="xs:boolean"
 					minOccurs="1" maxOccurs="1">
 					<xs:annotation>
-						<xs:documentation>True if the user's current primary email is
-							verified
+						<xs:documentation>True if the user's current primary email is verified
 						</xs:documentation>
 					</xs:annotation>
 				</xs:element>
@@ -90,8 +88,7 @@
 
 	<xs:complexType name="completion-date">
 		<xs:annotation>
-			<xs:documentation>The date and time when the ORCID Record set up was
-				completed.
+			<xs:documentation>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
 			</xs:documentation>
 		</xs:annotation>
 		<xs:simpleContent>
@@ -101,8 +98,7 @@
 
 	<xs:complexType name="submission-date">
 		<xs:annotation>
-			<xs:documentation>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
+			<xs:documentation>The date time when the ORCID record was first created.
 			</xs:documentation>
 		</xs:annotation>
 		<xs:simpleContent>
@@ -155,33 +151,31 @@
 
 	<xs:simpleType name="creation-method">
 		<xs:annotation>
-			<xs:documentation>Indicates how the ORCID record and iD were created.
+			<xs:documentation>Indicates how the ORCID record was created.
 			</xs:documentation>
 		</xs:annotation>
 		<xs:restriction base="common:non-empty-string">
 			<xs:enumeration value="API">
 				<xs:annotation>
-					<xs:documentation>The ORCID Record was created using the ORCID
-						Member API.
+					<xs:documentation>The ORCID Record was created using the ORCID Member API.
 					</xs:documentation>
 				</xs:annotation>
 			</xs:enumeration>
 			<xs:enumeration value="Direct">
 				<xs:annotation>
-					<xs:documentation>The user registered on the /register page.
+					<xs:documentation>The user registered on the ORCID website.
 					</xs:documentation>
 				</xs:annotation>
 			</xs:enumeration>
 			<xs:enumeration value="Member-referred">
 				<xs:annotation>
-					<xs:documentation>The registered on the /oauth/signin.
+					<xs:documentation>The user registered as part of the OAuth process.
 					</xs:documentation>
 				</xs:annotation>
 			</xs:enumeration>
 			<xs:enumeration value="website">
 				<xs:annotation>
-					<xs:documentation>DEPRECATED use Direct
-						instead.
+					<xs:documentation>DEPRECATED use Direct instead.
 					</xs:documentation>
 				</xs:annotation>
 			</xs:enumeration>

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
@@ -38,7 +38,7 @@
 	<xs:element name="membership" type="common:affiliation">
 		<xs:annotation>
 			<xs:documentation>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
@@ -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
@@ -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 @@
 
 	<xs:element name="service" type="common:affiliation">
 		<xs:annotation>
-			<xs:documentation>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.
+			<xs:documentation>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
@@ -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 @@
 	<xs:element name="work">
 		<xs:complexType>
 			<xs:annotation>
-				<xs:documentation>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.
+				<xs:documentation>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,21 +64,30 @@
 								</xs:documentation>
 							</xs:annotation>
 						</xs:element>
-						<xs:element name="type" type="work:work-type" />
+						<xs:element name="type" type="work:work-type">
+							<xs:annotation>
+								<xs:documentation>Required. The type of work
+								</xs:documentation>
+							</xs:annotation>
+						</xs:element>
 						<xs:element ref="common:publication-date" minOccurs="0" />
 						<xs:element ref="common:external-ids"
 							minOccurs="0">
 							<xs:annotation>
-								<xs:documentation>Element containing the type and content of the
-									citation for this work
+								<xs:documentation>Required when writing work items. The list of supported identifier types is at https://pub.qa.orcid.org/v2.0/identifiers
 								</xs:documentation>
 							</xs:annotation>
 						</xs:element>
 						<xs:element name="url" type="common:url" minOccurs="0" />
 						<xs:element name="contributors" type="work:work-contributors"
 							minOccurs="0" />
 						<xs:element ref="common:language-code" minOccurs="0"
-							maxOccurs="1" />
+							maxOccurs="1">
+							<xs:annotation>
+								<xs:documentation>The language used for the metadata provided about the work
+								</xs:documentation>
+							</xs:annotation>
+						</xs:element>
 						<xs:element ref="common:country" minOccurs="0" />
 					</xs:sequence>
 				</xs:extension>
@@ -112,8 +118,7 @@
 		<xs:annotation>
 			<xs:documentation>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
 			</xs:documentation>
 		</xs:annotation>
 		<xs:restriction base="xs:string">
@@ -146,6 +151,7 @@
 			<xs:enumeration value="report" />
 			<xs:enumeration value="research-technique" />
 			<xs:enumeration value="research-tool" />
+			<xs:enumeration value="software" />
 			<xs:enumeration value="spin-off-company" />
 			<xs:enumeration value="standards-and-policy" />
 			<xs:enumeration value="supervised-student-publication" />
@@ -178,7 +184,7 @@
 			<xs:element ref="common:contributor-orcid" minOccurs="0"
 				maxOccurs="1">
 				<xs:annotation>
-					<xs:documentation>ORCID iD for the contributor</xs:documentation>
+					<xs:documentation>ORCID iD for the contributor - only add if you have collected an authenticated iD for the contributor</xs:documentation>
 				</xs:annotation>
 			</xs:element>
 			<xs:element name="credit-name" type="common:credit-name"
@@ -191,9 +197,7 @@
 	</xs:complexType>
 	<xs:complexType name="contributor-email">
 		<xs:annotation>
-			<xs:documentation>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.
+			<xs:documentation>Email of the contributor. This field is not returned when reading a work
 			</xs:documentation>
 		</xs:annotation>
 
@@ -269,16 +273,11 @@
 		<xs:annotation>
 			<xs:documentation>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.
 			</xs:documentation>
 		</xs:annotation>
 		<xs:restriction base="xs:string">