This repository has been archived by the owner on Jul 2, 2019. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 0
/
relations.xsd
457 lines (434 loc) · 22.7 KB
/
relations.xsd
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
<?xml version="1.0" encoding="UTF-8"?>
<xsd:schema xmlns:xsd="http://www.w3.org/2001/XMLSchema"
targetNamespace="http://www.crossref.org/relations.xsd"
xmlns="http://www.crossref.org/relations.xsd">
<xsd:annotation>
<xsd:documentation> Version: 2
This schema provides for creating relationships between items represented by crossref DOIs and other items that may
be defined by a DOI (crossref or other RA) or by some other identifier. New relation types will be added as they're needed.
Please contact [email protected] to request additions or changes.
Certain relationship types are covered elsewhere in the main deposit schema due primarily to specific processing or
the need to logically group those relations alongside other relevant metadata. For example cited-by relations are
created by the deposit of a citation_list. Crossmark->Updates addresses relationships between DOIs where a primary
item is updated, revised, hasErratum, withdrawn ... etc. When constructing relations please be sure to use the
the most appropriate metadata structure.
Relationships between DOIs in crossref are established bidirectionally between those DOIs making it unnecessary to
deposit relationship metadata for both DOIs.
Example:
DOI A metadata contains 'hasTranslation' with a target of DOI B will automatically
make this claim visible in metadata for B.
Seen from the perspective of B: A claims it hasTranslation of which B is the target of the claim.
Change history:
10/3/14 CSK removed reg-agency attribute. This is not necessary, can be derived from the DOI
10/3/14 CSK split into inter and intra relation elements
10/3/14 CSK pulled in common crossref schema for description element and language attributes
12/21/16 CSK added comments to each relation type indicating the appropriate inverse relation type
3/6/17 PDF added accession as identifier-type
1/9/19 PDF new version for Grant ID schema
====== C O N V E N T I O N ==============================================================================================
Relationships between two objects have an implicit directionality that in natural language terms dictate which object is the actor
and which is acted-upon. This directionality is semantically based on the relationship name. Crossref's model makes
no attempt to automatically 'understand' this semantic.
The identifier parent to the PROGRAM element is considered the claimant of the relationship (e.g. the entity that
establishes the relationship).
yes: 10.1234/abcd references 10.5678/efgh => 10.1234/abcd claims that it references 10.5678/efgh
yes: 10.1234/abcd referencedBy 10.5678/efgh => 10.1234/abcd claims that it is referenced by 10.5678/efgh
==========================================================================================================================
</xsd:documentation>
</xsd:annotation>
<xsd:import namespace="http://www.w3.org/XML/1998/namespace" schemaLocation="http://www.w3.org/2009/01/xml.xsd"/>
<xsd:element name="program">
<xsd:annotation>
<xsd:documentation>Accommodates deposit of relationship claims between items.</xsd:documentation>
</xsd:annotation>
<xsd:complexType>
<xsd:sequence>
<xsd:element ref="related_item" minOccurs="0" maxOccurs="unbounded"/>
</xsd:sequence>
<xsd:attribute name="name" type="xsd:string" fixed="relations"/>
</xsd:complexType>
</xsd:element>
<xsd:element name="related_item">
<xsd:complexType>
<xsd:sequence>
<xsd:annotation>
<xsd:documentation>
Description of the relationship to the target item or of the target item itself
</xsd:documentation>
</xsd:annotation>
<xsd:element ref="description" minOccurs="0" maxOccurs="1"/>
<xsd:choice>
<xsd:element ref="inter_work_relation" minOccurs="1" maxOccurs="1"/>
<xsd:element ref="intra_work_relation" minOccurs="1" maxOccurs="1"/>
</xsd:choice>
</xsd:sequence>
</xsd:complexType>
</xsd:element>
<xsd:element name="inter_work_relation">
<xsd:complexType mixed="true">
<xsd:attribute name="relationship-type" use="required">
<xsd:annotation>
<xsd:documentation> Used to describe relations between items that are not the same work.
</xsd:documentation>
</xsd:annotation>
<xsd:simpleType>
<xsd:restriction base="xsd:string">
<!-- Crossref -->
<xsd:enumeration value="isDerivedFrom"/>
<!-- hasDeverivtion -->
<xsd:enumeration value="hasDerivation"/>
<!-- isDerivedFrom -->
<xsd:enumeration value="isReviewOf"/>
<!-- hasReview -->
<xsd:enumeration value="hasReview"/>
<!-- isReviewOf -->
<xsd:enumeration value="isCommentOn"/>
<!-- hasComment -->
<xsd:enumeration value="hasComment"/>
<!-- isCommentOn -->
<xsd:enumeration value="isReplyTo"/>
<!-- hasReply -->
<xsd:enumeration value="hasReply"/>
<!-- isReplyTo -->
<xsd:enumeration value="basedOnData"/>
<!-- isDataBasisFor -->
<xsd:enumeration value="isDataBasisFor"/>
<!-- basedOnData -->
<xsd:enumeration value="hasRelatedMaterial"/>
<!-- isRelatedMaterial -->
<xsd:enumeration value="isRelatedMaterial"/>
<!-- hasRelatedMaterial -->
<!-- Common with DataCite -->
<xsd:enumeration value="isCompiledBy"/>
<!-- compiles -->
<xsd:enumeration value="compiles"/>
<!-- isCompiledBy -->
<xsd:enumeration value="isDocumentedBy"/>
<!-- documents -->
<xsd:enumeration value="documents"/>
<!-- isDocumentedBy -->
<xsd:enumeration value="isSupplementTo"/>
<!-- isSupplememtedBy -->
<xsd:enumeration value="isSupplementedBy"/>
<!-- isSupplementTo -->
<xsd:enumeration value="isContinuedBy"/>
<!-- continues -->
<xsd:enumeration value="continues"/>
<!-- isContinuedBy -->
<!-- From Dublin core -->
<xsd:enumeration value="isPartOf"/>
<!-- hasPart -->
<xsd:enumeration value="hasPart"/>
<!-- isPartOf -->
<xsd:enumeration value="references"/>
<!-- isReferencedBy -->
<xsd:enumeration value="isReferencedBy"/>
<!-- references -->
<xsd:enumeration value="isBasedOn"/>
<!-- isBasisFor -->
<xsd:enumeration value="isBasisFor"/>
<!-- isBasedOn -->
<xsd:enumeration value="requires"/>
<!-- isRequiredBy -->
<xsd:enumeration value="isRequiredBy"/>
<!-- requires -->
</xsd:restriction>
</xsd:simpleType>
</xsd:attribute>
<xsd:attributeGroup ref="relations_type.atts"/>
</xsd:complexType>
</xsd:element>
<xsd:element name="intra_work_relation">
<xsd:complexType mixed="true">
<xsd:attribute name="relationship-type" use="required">
<xsd:annotation>
<xsd:documentation>Used to define relations between items that are essentially the same work but may differ in
format, language, revision ... etc. Assigning different identifers to exactly the same item
available in one place or as copies in multiple places can be problematic and should be avoided.
</xsd:documentation>
</xsd:annotation>
<xsd:simpleType>
<xsd:restriction base="xsd:string">
<!-- Crossref -->
<xsd:enumeration value="isTranslationOf"/>
<!-- hasTranslation -->
<xsd:enumeration value="hasTranslation"/>
<!-- isTranslationOf -->
<xsd:enumeration value="isPreprintOf"/>
<!-- hasPreprint -->
<xsd:enumeration value="hasPreprint"/>
<!-- isPreprintOf -->
<xsd:enumeration value="isManuscriptOf"/>
<!-- hasManuscript -->
<xsd:enumeration value="hasManuscript"/>
<!-- isManuscriptOf -->
<xsd:enumeration value="isExpressionOf"/>
<!-- hasExpression -->
<xsd:enumeration value="hasExpression"/>
<!-- isExpressionOf -->
<xsd:enumeration value="isManifestationOf"/>
<!-- hasManifestation -->
<xsd:enumeration value="hasManifestation"/>
<!-- isManifestationOf -->
<xsd:enumeration value="isReplacedBy"/>
<!-- replaces -->
<xsd:enumeration value="replaces"/>
<!-- isReplacedBy -->
<xsd:enumeration value="isSameAs"/>
<!-- isSameAs -->
<!-- Common with DataCite -->
<xsd:enumeration value="isIdenticalTo"/>
<!-- isIdenticalTo -->
<xsd:enumeration value="isVariantFormOf"/>
<!-- isOriginalFormOf -->
<xsd:enumeration value="isOriginalFormOf"/>
<!-- isVariantFormOf -->
<!-- From Dublin core -->
<xsd:enumeration value="isVersionOf"/>
<!-- hasVersion -->
<xsd:enumeration value="hasVersion"/>
<!-- isVersionOf -->
<xsd:enumeration value="isFormatOf"/>
<!-- hasFormat -->
<xsd:enumeration value="hasFormat"/>
<!-- isFormatOf -->
</xsd:restriction>
</xsd:simpleType>
</xsd:attribute>
<xsd:attributeGroup ref="relations_type.atts"/>
</xsd:complexType>
</xsd:element>
<xsd:element name="description">
<xsd:complexType>
<xsd:attributeGroup ref="language.atts"/>
</xsd:complexType>
</xsd:element>
<xsd:attributeGroup name="language.atts">
<xsd:annotation>
<xsd:documentation>Language attributes are based on ISO 639</xsd:documentation>
</xsd:annotation>
<xsd:attribute name="language" use="optional">
<xsd:simpleType>
<xsd:restriction base="xsd:NMTOKEN">
<xsd:enumeration value="aa"/>
<xsd:enumeration value="ab"/>
<xsd:enumeration value="ae"/>
<xsd:enumeration value="af"/>
<xsd:enumeration value="ak"/>
<xsd:enumeration value="am"/>
<xsd:enumeration value="an"/>
<xsd:enumeration value="ar"/>
<xsd:enumeration value="as"/>
<xsd:enumeration value="av"/>
<xsd:enumeration value="ay"/>
<xsd:enumeration value="az"/>
<xsd:enumeration value="ba"/>
<xsd:enumeration value="be"/>
<xsd:enumeration value="bg"/>
<xsd:enumeration value="bh"/>
<xsd:enumeration value="bi"/>
<xsd:enumeration value="bm"/>
<xsd:enumeration value="bn"/>
<xsd:enumeration value="bo"/>
<xsd:enumeration value="br"/>
<xsd:enumeration value="bs"/>
<xsd:enumeration value="ca"/>
<xsd:enumeration value="ce"/>
<xsd:enumeration value="ch"/>
<xsd:enumeration value="co"/>
<xsd:enumeration value="cr"/>
<xsd:enumeration value="cs"/>
<xsd:enumeration value="cu"/>
<xsd:enumeration value="cv"/>
<xsd:enumeration value="cy"/>
<xsd:enumeration value="da"/>
<xsd:enumeration value="de"/>
<xsd:enumeration value="dv"/>
<xsd:enumeration value="dz"/>
<xsd:enumeration value="ee"/>
<xsd:enumeration value="el"/>
<xsd:enumeration value="en"/>
<xsd:enumeration value="eo"/>
<xsd:enumeration value="es"/>
<xsd:enumeration value="et"/>
<xsd:enumeration value="eu"/>
<xsd:enumeration value="fa"/>
<xsd:enumeration value="ff"/>
<xsd:enumeration value="fi"/>
<xsd:enumeration value="fj"/>
<xsd:enumeration value="fo"/>
<xsd:enumeration value="fr"/>
<xsd:enumeration value="fy"/>
<xsd:enumeration value="ga"/>
<xsd:enumeration value="gd"/>
<xsd:enumeration value="gl"/>
<xsd:enumeration value="gn"/>
<xsd:enumeration value="gu"/>
<xsd:enumeration value="gv"/>
<xsd:enumeration value="ha"/>
<xsd:enumeration value="he"/>
<xsd:enumeration value="hi"/>
<xsd:enumeration value="ho"/>
<xsd:enumeration value="hr"/>
<xsd:enumeration value="ht"/>
<xsd:enumeration value="hu"/>
<xsd:enumeration value="hy"/>
<xsd:enumeration value="hz"/>
<xsd:enumeration value="ia"/>
<xsd:enumeration value="id"/>
<xsd:enumeration value="ie"/>
<xsd:enumeration value="ig"/>
<xsd:enumeration value="ii"/>
<xsd:enumeration value="ik"/>
<xsd:enumeration value="io"/>
<xsd:enumeration value="is"/>
<xsd:enumeration value="it"/>
<xsd:enumeration value="iu"/>
<xsd:enumeration value="ja"/>
<xsd:enumeration value="jw"/>
<xsd:enumeration value="ka"/>
<xsd:enumeration value="kg"/>
<xsd:enumeration value="ki"/>
<xsd:enumeration value="kj"/>
<xsd:enumeration value="kk"/>
<xsd:enumeration value="kl"/>
<xsd:enumeration value="km"/>
<xsd:enumeration value="kn"/>
<xsd:enumeration value="ko"/>
<xsd:enumeration value="kr"/>
<xsd:enumeration value="ks"/>
<xsd:enumeration value="ku"/>
<xsd:enumeration value="kv"/>
<xsd:enumeration value="kw"/>
<xsd:enumeration value="ky"/>
<xsd:enumeration value="la"/>
<xsd:enumeration value="lb"/>
<xsd:enumeration value="lg"/>
<xsd:enumeration value="li"/>
<xsd:enumeration value="ln"/>
<xsd:enumeration value="lo"/>
<xsd:enumeration value="lt"/>
<xsd:enumeration value="lu"/>
<xsd:enumeration value="lv"/>
<xsd:enumeration value="mg"/>
<xsd:enumeration value="mu"/>
<xsd:enumeration value="mi"/>
<xsd:enumeration value="mk"/>
<xsd:enumeration value="ml"/>
<xsd:enumeration value="mn"/>
<xsd:enumeration value="mr"/>
<xsd:enumeration value="ms"/>
<xsd:enumeration value="mt"/>
<xsd:enumeration value="my"/>
<xsd:enumeration value="na"/>
<xsd:enumeration value="nb"/>
<xsd:enumeration value="nd"/>
<xsd:enumeration value="ne"/>
<xsd:enumeration value="ng"/>
<xsd:enumeration value="nl"/>
<xsd:enumeration value="nn"/>
<xsd:enumeration value="no"/>
<xsd:enumeration value="nr"/>
<xsd:enumeration value="nv"/>
<xsd:enumeration value="ny"/>
<xsd:enumeration value="oc"/>
<xsd:enumeration value="oj"/>
<xsd:enumeration value="om"/>
<xsd:enumeration value="or"/>
<xsd:enumeration value="os"/>
<xsd:enumeration value="pa"/>
<xsd:enumeration value="pi"/>
<xsd:enumeration value="pl"/>
<xsd:enumeration value="ps"/>
<xsd:enumeration value="pt"/>
<xsd:enumeration value="qu"/>
<xsd:enumeration value="rm"/>
<xsd:enumeration value="rn"/>
<xsd:enumeration value="ro"/>
<xsd:enumeration value="ru"/>
<xsd:enumeration value="rw"/>
<xsd:enumeration value="sa"/>
<xsd:enumeration value="sc"/>
<xsd:enumeration value="sd"/>
<xsd:enumeration value="se"/>
<xsd:enumeration value="sg"/>
<xsd:enumeration value="si"/>
<xsd:enumeration value="sk"/>
<xsd:enumeration value="sl"/>
<xsd:enumeration value="sm"/>
<xsd:enumeration value="sn"/>
<xsd:enumeration value="so"/>
<xsd:enumeration value="sq"/>
<xsd:enumeration value="sr"/>
<xsd:enumeration value="ss"/>
<xsd:enumeration value="st"/>
<xsd:enumeration value="su"/>
<xsd:enumeration value="sv"/>
<xsd:enumeration value="sw"/>
<xsd:enumeration value="ta"/>
<xsd:enumeration value="te"/>
<xsd:enumeration value="tg"/>
<xsd:enumeration value="th"/>
<xsd:enumeration value="ti"/>
<xsd:enumeration value="tk"/>
<xsd:enumeration value="tl"/>
<xsd:enumeration value="tn"/>
<xsd:enumeration value="to"/>
<xsd:enumeration value="tr"/>
<xsd:enumeration value="ts"/>
<xsd:enumeration value="tt"/>
<xsd:enumeration value="tw"/>
<xsd:enumeration value="ty"/>
<xsd:enumeration value="ug"/>
<xsd:enumeration value="uk"/>
<xsd:enumeration value="ur"/>
<xsd:enumeration value="uz"/>
<xsd:enumeration value="ve"/>
<xsd:enumeration value="vi"/>
<xsd:enumeration value="vo"/>
<xsd:enumeration value="wa"/>
<xsd:enumeration value="wo"/>
<xsd:enumeration value="xh"/>
<xsd:enumeration value="yi"/>
<xsd:enumeration value="yo"/>
<xsd:enumeration value="za"/>
<xsd:enumeration value="zh"/>
</xsd:restriction>
</xsd:simpleType>
</xsd:attribute>
</xsd:attributeGroup>
<!-- =========================================================== -->
<xsd:attributeGroup name="relations_type.atts">
<xsd:attribute name="identifier-type" use="required">
<xsd:simpleType>
<xsd:restriction base="xsd:string">
<xsd:enumeration value="doi"/>
<xsd:enumeration value="issn"/>
<xsd:enumeration value="isbn"/>
<xsd:enumeration value="uri"/>
<xsd:enumeration value="pmid"/>
<xsd:enumeration value="pmcid"/>
<xsd:enumeration value="purl"/>
<xsd:enumeration value="arxiv"/>
<xsd:enumeration value="ark"/>
<xsd:enumeration value="handle"/>
<xsd:enumeration value="uuid"/>
<xsd:enumeration value="ecli"/>
<xsd:enumeration value="accession"/>
<xsd:enumeration value="other"/>
</xsd:restriction>
</xsd:simpleType>
</xsd:attribute>
<xsd:attribute name="namespace">
<xsd:annotation>
<xsd:documentation>An identifier systems may require a namespace that is needed in addition to the identifer value to provide uniqueness.</xsd:documentation>
</xsd:annotation>
<xsd:simpleType>
<xsd:restriction base="xsd:string">
<xsd:maxLength value="1024"/>
<xsd:minLength value="4"/>
</xsd:restriction>
</xsd:simpleType>
</xsd:attribute>
</xsd:attributeGroup>
</xsd:schema>