GSAS: DataCite-metadata.xsd

File DataCite-metadata.xsd, 13.8 KB (added by hmussman@bbn.com, 6 years ago)
Line 
1<?xml version="1.0" encoding="UTF-8"?>
2<!-- Revision history
3     2010-08-26   Complete revision according to new common specification by the metadata work group after review. AJH, DTIC
4         2010-11-17 Revised to current state of kernel review, FZ, TIB
5         2011-01-17 Complete revsion after community review. FZ, TIB
6         2011-03-17 Release of v2.1: added a namespace; mandatory properties got minLength; changes in the definitions of relationTypes
7         IsDocumentedBy/Documents and isCompiledBy/Compiles; changes type of property "Date" from xs:date to xs:string. FZ, TIB
8         2011-06-27 v2.2: namespace: kernel-2.2, additions to controlled lists "resourceType", "contributorType", "relatedIdentifierType", and "descriptionType". Removal of intermediate include-files.
9-->
10<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns="http://datacite.org/schema/kernel-2.2" targetNamespace="http://datacite.org/schema/kernel-2.2" elementFormDefault="qualified" xml:lang="EN">
11        <xs:include schemaLocation="include/datacite-titleType-v2.xsd"/>
12        <xs:include schemaLocation="include/datacite-contributorType-v2.xsd"/>
13        <xs:include schemaLocation="include/datacite-dateType-v2.xsd"/>
14        <xs:include schemaLocation="include/datacite-resourceType-v2.xsd"/>
15        <xs:include schemaLocation="include/datacite-relationType-v2.xsd"/>
16        <xs:include schemaLocation="include/datacite-relatedIdentifierType-v2.xsd"/>
17        <xs:include schemaLocation="include/datacite-descriptionType-v2.xsd"/>
18        <xs:element name="resource">
19                <xs:annotation>
20                        <xs:documentation>
21        Root element of a single record. This wrapper element is for XML implementation only and is not defined in the DataCite DOI standard.
22        Note: This is the case for any wrapper element within this schema!</xs:documentation>
23                        <xs:documentation>No content in this wrapper element.</xs:documentation>
24                </xs:annotation>
25                <xs:complexType>
26                        <xs:sequence>
27                                <!--REQUIRED FIELDS-->
28                                <xs:element name="identifier">
29                                        <xs:annotation>
30                                                <xs:documentation>A persistent identifier that identifies a resource.</xs:documentation>
31                                                <xs:documentation>Currently, only DOI is allowed.</xs:documentation>
32                                        </xs:annotation>
33                                        <xs:complexType>
34                                                <xs:simpleContent>
35                                                        <xs:extension base="doiType">
36                                                                <xs:attribute name="identifierType" use="required" fixed="DOI"/>
37                                                        </xs:extension>
38                                                </xs:simpleContent>
39                                        </xs:complexType>
40                                </xs:element>
41                                <xs:element name="creators">
42                                        <xs:complexType>
43                                                <xs:sequence>
44                                                        <xs:element name="creator" maxOccurs="unbounded">
45                                                                <xs:annotation>
46                                                                        <xs:documentation>The main researchers involved working on the data, or the authors of the publication in priority order. May be a corporate/institutional or personal name.</xs:documentation>
47                                                                        <xs:documentation>Format: Family, Given.</xs:documentation>
48                                                                </xs:annotation>
49                                                                <xs:complexType>
50                                                                        <xs:sequence>
51                                                                                <xs:element name="creatorName">
52                                                                                        <xs:simpleType>
53                                                                                                <xs:restriction base="nonemptycontentStringType"/>
54                                                                                        </xs:simpleType>
55                                                                                </xs:element>
56                                                                                <xs:element name="nameIdentifier" minOccurs="0">
57                                                                                        <xs:complexType>
58                                                                                                <xs:simpleContent>
59                                                                                                        <xs:extension base="nonemptycontentStringType">
60                                                                                                                <xs:attribute name="nameIdentifierScheme" use="required"/>
61                                                                                                        </xs:extension>
62                                                                                                </xs:simpleContent>
63                                                                                        </xs:complexType>
64                                                                                </xs:element>
65                                                                        </xs:sequence>
66                                                                </xs:complexType>
67                                                        </xs:element>
68                                                </xs:sequence>
69                                        </xs:complexType>
70                                </xs:element>
71                                <xs:element name="titles">
72                                        <xs:complexType>
73                                                <xs:sequence>
74                                                        <xs:element name="title" maxOccurs="unbounded">
75                                                                <xs:annotation>
76                                                                        <xs:documentation>A name or title by which a resource is known.</xs:documentation>
77                                                                </xs:annotation>
78                                                                <xs:complexType>
79                                                                        <xs:simpleContent>
80                                                                                <xs:extension base="nonemptycontentStringType">
81                                                                                        <xs:attribute name="titleType" type="titleType" use="optional"/>
82                                                                                </xs:extension>
83                                                                        </xs:simpleContent>
84                                                                </xs:complexType>
85                                                        </xs:element>
86                                                </xs:sequence>
87                                        </xs:complexType>
88                                </xs:element>
89                                <xs:element name="publisher">
90                                        <xs:annotation>
91                                                <xs:documentation>A holder of the data (including archives as appropriate) or institution which submitted the work. Any others may be listed as contributors. This property will be used to formulate the citation, so consider the prominence of the role.</xs:documentation>
92                                                <xs:documentation>Examples: World Data Center for Climate (WDCC); GeoForschungsZentrum Potsdam (GFZ); Geological Institute, University of Tokyo </xs:documentation>
93                                                <xs:documentation>In the case of datasets, "publish" is understood to mean making the data available to the community of researchers.</xs:documentation>
94                                        </xs:annotation>
95                                        <xs:simpleType>
96                                                <xs:restriction base="nonemptycontentStringType"/>
97                                        </xs:simpleType>
98                                </xs:element>
99                                <xs:element name="publicationYear">
100                                        <xs:annotation>
101                                                <xs:documentation>Year when the data is made publicly available. If an embargo period has been in effect, use the date when the embargo period ends.</xs:documentation>
102                                                <xs:documentation>YYYY</xs:documentation>
103                                        </xs:annotation>
104                                        <xs:simpleType>
105                                                <xs:restriction base="yearType"/>
106                                        </xs:simpleType>
107                                </xs:element>
108                                <!--OPTIONAL FIELDS-->
109                                <xs:element name="subjects" minOccurs="0">
110                                        <xs:complexType>
111                                                <xs:sequence>
112                                                        <xs:element name="subject" maxOccurs="unbounded">
113                                                                <xs:annotation>
114                                                                        <xs:documentation>Subject, keywords, classification codes, or key phrases describing the resource.</xs:documentation>
115                                                                </xs:annotation>
116                                                                <xs:complexType>
117                                                                        <xs:simpleContent>
118                                                                                <xs:extension base="xs:string">
119                                                                                        <xs:attribute name="subjectScheme" use="optional"/>
120                                                                                </xs:extension>
121                                                                        </xs:simpleContent>
122                                                                </xs:complexType>
123                                                        </xs:element>
124                                                </xs:sequence>
125                                        </xs:complexType>
126                                </xs:element>
127                                <xs:element name="contributors" minOccurs="0">
128                                        <xs:complexType>
129                                                <xs:sequence>
130                                                        <xs:element name="contributor" maxOccurs="unbounded">
131                                                                <xs:annotation>
132                                                                        <xs:documentation>The institution or person responsible for collecting, creating, or otherwise contributing to the developement of the dataset.</xs:documentation>
133                                                                        <xs:documentation>The personal name format should be: Family, Given.</xs:documentation>
134                                                                </xs:annotation>
135                                                                <xs:complexType mixed="true">
136                                                                        <xs:sequence>
137                                                                                <xs:element name="contributorName">
138                                                                                        <xs:simpleType>
139                                                                                                <xs:restriction base="xs:string">
140                                                                                                        <xs:minLength value="1"/>
141                                                                                                </xs:restriction>
142                                                                                        </xs:simpleType>
143                                                                                </xs:element>
144                                                                                <xs:element name="nameIdentifier" minOccurs="0">
145                                                                                        <xs:complexType>
146                                                                                                <xs:simpleContent>
147                                                                                                        <xs:extension base="xs:string">
148                                                                                                                <xs:attribute name="nameIdentifierScheme" use="required"/>
149                                                                                                        </xs:extension>
150                                                                                                </xs:simpleContent>
151                                                                                        </xs:complexType>
152                                                                                </xs:element>
153                                                                        </xs:sequence>
154                                                                        <xs:attribute name="contributorType" type="contributorType" use="required"/>
155                                                                </xs:complexType>
156                                                        </xs:element>
157                                                </xs:sequence>
158                                        </xs:complexType>
159                                </xs:element>
160                                <xs:element name="dates" minOccurs="0">
161                                        <xs:complexType>
162                                                <xs:sequence>
163                                                        <xs:element name="date" maxOccurs="unbounded">
164                                                                <xs:annotation>
165                                                                        <xs:documentation>Different dates relevant to the work.</xs:documentation>
166                                                                        <xs:documentation>YYYY or YYYY-MM-DD or any other format described in W3CDTF (http://www.w3.org/TR/NOTE-datetime) </xs:documentation>
167                                                                </xs:annotation>
168                                                                <xs:complexType>
169                                                                        <xs:simpleContent>
170                                                                                <xs:extension base="xs:string">
171                                                                                        <xs:attribute name="dateType" type="dateType" use="required"/>
172                                                                                </xs:extension>
173                                                                        </xs:simpleContent>
174                                                                </xs:complexType>
175                                                        </xs:element>
176                                                </xs:sequence>
177                                        </xs:complexType>
178                                </xs:element>
179                                <xs:element name="language" type="xs:language" minOccurs="0">
180                                        <xs:annotation>
181                                                <xs:documentation>Primary language of the resource. Allowed values from: ISO 639-2/B, ISO 639-3</xs:documentation>
182                                        </xs:annotation>
183                                </xs:element>
184                                <xs:element name="resourceType" minOccurs="0">
185                                        <xs:annotation>
186                                                <xs:documentation>The type of a resource. You may enter an additional free text description.</xs:documentation>
187                                        </xs:annotation>
188                                        <xs:complexType mixed="true">
189                                                <xs:annotation>
190                                                        <xs:documentation>Use this attribute to choose the general type of the resource from the controlled list.</xs:documentation>
191                                                </xs:annotation>
192                                                <xs:attribute name="resourceTypeGeneral" type="resourceType" use="required"/>
193                                        </xs:complexType>
194                                </xs:element>
195                                <xs:element name="alternateIdentifiers" minOccurs="0">
196                                        <xs:complexType>
197                                                <xs:sequence>
198                                                        <xs:element name="alternateIdentifier" maxOccurs="unbounded">
199                                                                <xs:annotation>
200                                                                        <xs:documentation>An identifier other than the primary identifier applied to the resource being registered. This may be any alphanumeric string which is unique within its domain of issue. The format is open</xs:documentation>
201                                                                </xs:annotation>
202                                                                <xs:complexType>
203                                                                        <xs:simpleContent>
204                                                                                <xs:extension base="xs:string">
205                                                                                        <xs:attribute name="alternateIdentifierType" use="required"/>
206                                                                                </xs:extension>
207                                                                        </xs:simpleContent>
208                                                                </xs:complexType>
209                                                        </xs:element>
210                                                </xs:sequence>
211                                        </xs:complexType>
212                                </xs:element>
213                                <xs:element name="relatedIdentifiers" minOccurs="0">
214                                        <xs:complexType>
215                                                <xs:sequence>
216                                                        <xs:element name="relatedIdentifier" maxOccurs="unbounded">
217                                                                <xs:annotation>
218                                                                        <xs:documentation>Identifiers of related resources. Use this property to indicate subsets of properties, as appropriate.</xs:documentation>
219                                                                </xs:annotation>
220                                                                <xs:complexType>
221                                                                        <xs:simpleContent>
222                                                                                <xs:extension base="xs:string">
223                                                                                        <xs:attribute name="relatedIdentifierType" type="relatedIdentifierType" use="required"/>
224                                                                                        <xs:attribute name="relationType" type="relationType" use="required"/>
225                                                                                </xs:extension>
226                                                                        </xs:simpleContent>
227                                                                </xs:complexType>
228                                                        </xs:element>
229                                                </xs:sequence>
230                                        </xs:complexType>
231                                </xs:element>
232                                <xs:element name="sizes" minOccurs="0">
233                                        <xs:complexType>
234                                                <xs:sequence>
235                                                        <xs:element name="size" maxOccurs="unbounded">
236                                                                <xs:annotation>
237                                                                        <xs:documentation>Unstructures size information about the resource. </xs:documentation>
238                                                                </xs:annotation>
239                                                        </xs:element>
240                                                </xs:sequence>
241                                        </xs:complexType>
242                                </xs:element>
243                                <xs:element name="formats" minOccurs="0">
244                                        <xs:complexType>
245                                                <xs:sequence>
246                                                        <xs:element name="format" maxOccurs="unbounded">
247                                                                <xs:annotation>
248                                                                        <xs:documentation>Technical format of the resource.</xs:documentation>
249                                                                        <xs:documentation>Use file extension or MIME type where possible.</xs:documentation>
250                                                                </xs:annotation>
251                                                        </xs:element>
252                                                </xs:sequence>
253                                        </xs:complexType>
254                                </xs:element>
255                                <xs:element name="version" type="xs:string" minOccurs="0">
256                                        <xs:annotation>
257                                                <xs:documentation>Version number of the resource. If the primary resource has changed the version number increases.</xs:documentation>
258                                                <xs:documentation>Register a new DOI (or primary identifier) when the version of the resource changes to enable the citation of the exact version of a research dataset (or other resource). May be used in conjunction with properties 11 and 12 (AlternateIdentifier and RelatedIdentifier) to indicate various information updates.</xs:documentation>
259                                        </xs:annotation>
260                                </xs:element>
261                                <xs:element name="rights" minOccurs="0">
262                                        <xs:annotation>
263                                                <xs:documentation>Any rights information for this resource. Provide a rights management statement for the resource or reference a service providing such information. Include embargo information if applicable.
264                                                </xs:documentation>
265                                        </xs:annotation>
266                                </xs:element>
267                                <xs:element name="descriptions" minOccurs="0">
268                                        <xs:complexType>
269                                                <xs:sequence>
270                                                        <xs:element name="description" maxOccurs="unbounded">
271                                                                <xs:complexType mixed="true">
272                                                                        <xs:choice>
273                                                                                <xs:element name="br" minOccurs="0" maxOccurs="unbounded">
274                                                                                        <xs:simpleType>
275                                                                                                <xs:restriction base="xs:string">
276                                                                                                        <xs:length value="0"/>
277                                                                                                </xs:restriction>
278                                                                                        </xs:simpleType>
279                                                                                </xs:element>
280                                                                        </xs:choice>
281                                                                        <xs:attribute name="descriptionType" type="descriptionType" use="required"/>
282                                                                </xs:complexType>
283                                                        </xs:element>
284                                                </xs:sequence>
285                                        </xs:complexType>
286                                </xs:element>
287                        </xs:sequence>
288                        <xs:attribute name="lastMetadataUpdate" type="xs:date" use="optional"/>
289                        <xs:attribute name="metadataVersionNumber" type="xs:integer" use="optional"/>
290                        <!--ADMINISTRATIVE FIELDS-->
291                </xs:complexType>
292        </xs:element>
293        <!-- TYPE DECLARATIONS -->
294        <!-- defines the value for a DOI: DOI must start with "10."  -->
295        <xs:simpleType name="doiType">
296                <xs:restriction base="xs:token">
297                        <xs:pattern value="[1][0][/.].*"/>
298                </xs:restriction>
299        </xs:simpleType>
300        <!-- defines value for mandatory fields -->
301        <xs:simpleType name="nonemptycontentStringType">
302                <xs:restriction base="xs:string">
303                        <xs:minLength value="1"/>
304                </xs:restriction>
305        </xs:simpleType>
306        <xs:attributeGroup name="nameId">
307                <xs:attribute name="nameIdentifier" type="xs:string" use="optional"/>
308                <xs:attribute name="nameIdentifierScheme" type="xs:string" use="optional"/>
309        </xs:attributeGroup>
310        <!-- defines the value for a year -->
311        <xs:simpleType name="yearType">
312                <xs:restriction base="xs:token">
313                        <xs:pattern value="[\d]{4}"/>
314                </xs:restriction>
315        </xs:simpleType>
316</xs:schema>