/
ddiprofile.xsd
211 lines (204 loc) · 12.5 KB
/
ddiprofile.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
<?xml version="1.0" encoding="UTF-8"?>
<!--
Copyright (c) 2014 DDI Alliance, DDI 3.2 release, 2014-01-15
This file is part of DDI 3.2 XML Schema.
DDI 3.2 XML Schema is free software: you can redistribute it and/or modify
it under the terms of the GNU Lesser General Public License as published by the
Free Software Foundation, either version 3 of the License, or (at your
option) any later version.
DDI 3.2 XML Schema is distributed in the hope that it will be useful, but
WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License
for more details.
You should have received a copy of the GNU Lesser General Public License along
with DDI 3.2 XML Schema. If not, see <http://www.gnu.org/licenses/>.
-->
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns="ddi:ddiprofile:3_2" xmlns:r="ddi:reusable:3_2" targetNamespace="ddi:ddiprofile:3_2" elementFormDefault="qualified" attributeFormDefault="unqualified">
<xs:import namespace="ddi:reusable:3_2" schemaLocation="reusable.xsd"/>
<xs:element name="DDIProfile" type="DDIProfileType">
<xs:annotation>
<xs:documentation>Describes the subset of valid DDI objects used by an agency for a specified purpose.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:complexType name="DDIProfileType">
<xs:annotation>
<xs:documentation>Describes the subset of valid DDI objects used by an agency for a specified purpose. This may be the required and supported objects for a specific system, a profile for deposit in an archive, requirements at different points of production, etc. In addition to the standard name, label, and description the DDI Profile describes the intended application of the profile, its purpose, the version of XPath used in describing the supported objects, the DDI namespace (major and minor version numbers), a mapping of schema to prefixes (if different from the standard DDI model), a set of instructions for use of the profile, and a listing of used and unsupported objects. These objects may be constrained (i.e., change from optional to required), provided a fixed value, or provided a local name.</xs:documentation>
</xs:annotation>
<xs:complexContent>
<xs:extension base="r:MaintainableType">
<xs:sequence>
<xs:element ref="DDIProfileName" minOccurs="0" maxOccurs="unbounded">
<xs:annotation>
<xs:documentation>A name for the profile. May be expressed in multiple languages. Repeat the element to express names with different content, for example different names for different systems.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element ref="r:Label" minOccurs="0" maxOccurs="unbounded">
<xs:annotation>
<xs:documentation>A display label for the profile. May be expressed in multiple languages. Repeat for labels with different content, for example, labels with differing length limitations.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element ref="r:Description" minOccurs="0">
<xs:annotation>
<xs:documentation>A description of the content and purpose of the profile. May be expressed in multiple languages and supports the use of structured content.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element ref="ApplicationOfProfile" minOccurs="0" maxOccurs="unbounded">
<xs:annotation>
<xs:documentation>A brief description of the intended applications of the profile. Supports the use of an external controlled vocabulary.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element ref="r:Purpose" minOccurs="0">
<xs:annotation>
<xs:documentation>Purpose describes the purpose of creating the profile such as describing the coverage of a distribution software system.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="XPathVersion" type="xs:decimal" default="1.0">
<xs:annotation>
<xs:documentation>Provides the version of XPath used. Values are 1.0, 2.0 at this time.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="DDINamespace" type="xs:decimal" minOccurs="0">
<xs:annotation>
<xs:documentation>Provides the version of DDI schemas used. Values are 2.5, 3.0, 3.1, etc. Note that only the Major.Minor portion of the version number is used.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element ref="XMLPrefixMap" minOccurs="0" maxOccurs="unbounded">
<xs:annotation>
<xs:documentation>If you are not using the standard DDI prefix or the full DDI name then provide mapping. For each XML namespace used in the profile's XPath expressions, the XML namespaces must have their prefix specified using this element.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element ref="Instructions" minOccurs="0">
<xs:annotation>
<xs:documentation>Instructions for use of the profile. Supports multiple language versions of the same content as well as optional formatting of the content.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:choice minOccurs="0" maxOccurs="unbounded">
<xs:element ref="Used">
<xs:annotation>
<xs:documentation>Indicates an element in the DDI which is used by the profile expressed as an XPath. Note that including a complex element will include all of its component parts.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element ref="NotUsed">
<xs:annotation>
<xs:documentation>Indicates an element in the DDI which is not used by the profile expressed as an XPath. You cannot list anything which is required in the DDI schemas, as this would produce invalid XML instances.</xs:documentation>
</xs:annotation>
</xs:element>
</xs:choice>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
<xs:element name="DDIProfileName" type="r:NameType">
<xs:annotation>
<xs:documentation>Name of the DDI Profile using the DDI Name structure.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="XMLPrefixMap" type="XMLPrefixMapType">
<xs:annotation>
<xs:documentation>Maps a specified prefix to a namespace.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="Instructions" type="r:StructuredStringType">
<xs:annotation>
<xs:documentation>Instructions provided using a StructuredString to support multiple language versions of the same content as well as optional formatting of the content.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="AlternateName" type="r:InternationalStringType">
<xs:annotation>
<xs:documentation>An alternate name for the object expressed using an International String to support multiple language versions of the same content.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="ApplicationOfProfile" type="r:CodeValueType">
<xs:annotation>
<xs:documentation>Allows for the use of a controlled vocabulary to designate intended applications of the profile.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:complexType name="XMLPrefixMapType">
<xs:annotation>
<xs:documentation>Maps a specified prefix to a namespace. For each XML namespace used in the profile's XPath expressions, the XML namespaces must have their prefix specified using this element.</xs:documentation>
</xs:annotation>
<xs:sequence>
<xs:element name="XMLPrefix" type="xs:string">
<xs:annotation>
<xs:documentation>Specify the exact prefix used.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="XMLNamespace" type="xs:string">
<xs:annotation>
<xs:documentation>Specify the namespace which the prefix represents.</xs:documentation>
</xs:annotation>
</xs:element>
</xs:sequence>
</xs:complexType>
<xs:complexType name="UsedType">
<xs:annotation>
<xs:documentation>Specifies a DDI object and all its sub-objects supported by the DDIProfile. May specify an alternate local name and description of an object, instructions for its use, and set limits on its allowed usage.</xs:documentation>
</xs:annotation>
<xs:sequence>
<xs:element ref="AlternateName" minOccurs="0">
<xs:annotation>
<xs:documentation>Provides an alternate name for the element, for presentation purposes (not for use in the XML instance). It may be supplied in several language-versions.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element ref="r:Description" minOccurs="0">
<xs:annotation>
<xs:documentation>A description of the content and purpose of the object. May be expressed in multiple languages and supports the use of structured content.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element ref="Instructions" minOccurs="0">
<xs:annotation>
<xs:documentation>Instructions for the use of the object within the context of the profile. May be expressed in multiple languages and supports the use of structured content.</xs:documentation>
</xs:annotation>
</xs:element>
</xs:sequence>
<xs:attribute name="isRequired" type="xs:boolean" default="false">
<xs:annotation>
<xs:documentation>If true indicates that an element described as optional in DDI is required by the profile.</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="xpath" type="xs:string" use="required">
<xs:annotation>
<xs:documentation>Contains an XPath which points to an element or attribute in DDI instances which is used by the profile. All subelements of a used element are assumed to be supported unless explicitly addressed by the profile. The number of supported repetitions may be included in the XPath expression.</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="defaultValue" type="xs:string" use="optional">
<xs:annotation>
<xs:documentation>This field provides a default value for the specified element or attribute if it holds simple content, and the value must be a valid one per the DDI schemas. This assumes that the value is not specified in the DDI instance itself, which would override the default. The value should also be provided as part of the XPath expression supplied for the field.</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="limitMaxOccurs" type="xs:string" use="optional">
<xs:annotation>
<xs:documentation>This field allows for limiting the maximum occurrences of this field. If the number is greater than the maxOccurs value in DDI it will be ignored and the DDI specification will remain in use.</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="fixedValue" type="xs:boolean" default="false">
<xs:annotation>
<xs:documentation>This field, if set to true, provides an indication that the default value supplied in the fixedValue attribute is the only one which is allowed for the profile - other values will be overridden with the default (a warning should be issued to the creator of the instance); the value must be a valid one per the DDI schemas.</xs:documentation>
</xs:annotation>
</xs:attribute>
</xs:complexType>
<xs:complexType name="NotUsedType">
<xs:annotation>
<xs:documentation>Identifies DDI objects expressed as an XPath that are not supported by the system or agency using this profile.</xs:documentation>
</xs:annotation>
<xs:simpleContent>
<xs:extension base="xs:string">
<xs:attribute name="xpath" type="xs:string" use="required">
<xs:annotation>
<xs:documentation>Contains an XPath which points to an element or attribute in DDI instances which is not used by the profile. All subelements of an unused element are assumed to be included unless explicitly addressed by the profile. The number of supported repetitions may be included in the XPath expression.</xs:documentation>
</xs:annotation>
</xs:attribute>
</xs:extension>
</xs:simpleContent>
</xs:complexType>
<xs:element name="Used" type="UsedType">
<xs:annotation>
<xs:documentation>Specifies a DDI object and all its sub-objects supported by the DDIProfile.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="NotUsed" type="NotUsedType">
<xs:annotation>
<xs:documentation>Identifies DDI objects expressed as an XPath that are not supported by the system or agency using this profile.</xs:documentation>
</xs:annotation>
</xs:element>
</xs:schema>