Changeset 4677 for FederatedSearch/schema/Endpoint-Description.xsd
- Timestamp:
- 03/12/14 17:08:50 (10 years ago)
- File:
-
- 1 edited
Legend:
- Unmodified
- Added
- Removed
-
FederatedSearch/schema/Endpoint-Description.xsd
r4534 r4677 1 1 <?xml version="1.0" encoding="UTF-8"?> 2 2 <xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema" 3 xmlns:h="http://www.w3.org/1999/xhtml" 3 4 xmlns:vc="http://www.w3.org/2007/XMLSchema-versioning" 4 xmlns:ed="http://clarin.eu/fcs/1.0/endpoint-description" elementFormDefault="qualified" 5 xmlns:h="http://www.w3.org/1999/xhtml" 6 xml:lang="en" vc:minVersion="1.0" vc:maxVersion="1.1" 7 targetNamespace="http://clarin.eu/fcs/1.0/endpoint-description"> 8 <xs:import namespace="http://www.w3.org/XML/1998/namespace" schemaLocation="http://www.w3.org/2001/xml.xsd" /> 5 xmlns:ed="http://clarin.eu/fcs/endpoint-description" 6 xml:lang="en" 7 vc:minVersion="1.0" vc:maxVersion="1.1" 8 elementFormDefault="qualified" 9 targetNamespace="http://clarin.eu/fcs/endpoint-description"> 10 <xs:import namespace="http://www.w3.org/XML/1998/namespace" 11 schemaLocation="http://www.w3.org/2001/xml.xsd" /> 9 12 10 13 <xs:annotation> … … 44 47 <xs:complexType> 45 48 <xs:sequence> 46 <!-- Profile --> 47 <xs:element name="Profile"> 48 <xs:annotation> 49 <xs:documentation> 50 <h:p> The CLARIN-FCS profile, that is supported 51 by an Endpoint. </h:p> 52 </xs:documentation> 53 </xs:annotation> 54 <xs:simpleType> 55 <xs:restriction base="xs:string"> 56 <xs:enumeration value="basic"> 49 <!-- Capabilities --> 50 <xs:element name="Capabilities"> 51 <xs:annotation> 52 <xs:documentation> 53 <h:p>A list of Capabilities, that are supported by this Endpoint.</h:p> 54 </xs:documentation> 55 </xs:annotation> 56 <xs:complexType> 57 <xs:sequence> 58 <xs:element name="Capability" maxOccurs="unbounded"> 57 59 <xs:annotation> 58 60 <xs:documentation> 59 <h:p> The Endpoint supports the 60 <h:em>basic</h:em> 61 CLARIN-FCS profile. </h:p> 61 A Capability, encoded by an URI, that is supported by this Endpoint. 62 For valid URIs, consult the CLARIN-FCS specification. 62 63 </xs:documentation> 63 64 </xs:annotation> 64 </xs:enumeration> 65 <!-- 'extended' is not yet defined --> 66 <!-- 67 <xs:enumeration value="extended"> 68 <xs:annotation> 69 <xs:documentation> 70 <h:p> The Endpoint supports the 71 <h:em>extended</h:em> 72 CLARIN-FCS profile. </h:p> 73 </xs:documentation> 74 </xs:annotation> 75 </xs:enumeration> 76 --> 77 </xs:restriction> 78 </xs:simpleType> 79 </xs:element> 80 65 <xs:simpleType> 66 <xs:restriction base="xs:anyURI"> 67 <xs:pattern value="http://clarin.eu/fcs/capability/\w([\.\-]{0,1}\w)*" /> 68 </xs:restriction> 69 </xs:simpleType> 70 </xs:element> 71 </xs:sequence> 72 </xs:complexType> 73 </xs:element> 74 75 <!-- SupportedDataViews --> 81 76 <xs:element name="SupportedDataViews"> 82 77 <xs:annotation> … … 91 86 <xs:annotation> 92 87 <xs:documentation> 93 The MIME type of a supported Data View.88 The MIME type of a supported Data View. 94 89 </xs:documentation> 95 90 </xs:annotation> 96 <xs:simpleType> 97 <xs:restriction base="xs:string"> 98 <xs:pattern value="\w+/\w([\.\-]{0,1}\w)*(\+\w+){0,1}"/> 99 </xs:restriction> 100 </xs:simpleType> 91 <xs:complexType> 92 <xs:simpleContent> 93 <xs:extension base="ed:mimetypeString"> 94 <xs:attribute name="id" type="xs:ID" use="required" /> 95 </xs:extension> 96 </xs:simpleContent> 97 </xs:complexType> 101 98 </xs:element> 102 99 </xs:sequence> 103 100 </xs:complexType> 104 101 </xs:element> 105 <!-- Collections --> 106 <xs:element ref="ed:Collections"> 107 <xs:annotation> 108 <xs:documentation> 109 <h:p> 110 A list of top-level collections, that are available 102 103 <!-- Resources --> 104 <xs:element ref="ed:Resources"> 105 <xs:annotation> 106 <xs:documentation> 107 <h:p> 108 A list of top-level resources, that are available 111 109 at an Endpoint. An Endpoint MUST 112 declare at least one top-level collection. 113 </h:p> 114 </xs:documentation> 115 </xs:annotation> 116 </xs:element> 110 declare at least one top-level resource. 111 </h:p> 112 </xs:documentation> 113 </xs:annotation> 114 </xs:element> 115 116 <!-- extension point --> 117 <xs:any namespace="##other" processContents="skip" minOccurs="0" maxOccurs="unbounded"> 118 <xs:annotation> 119 <xs:documentation> 120 <h:p> 121 Extension point to allow Endpoints to embed custom data in the Endpoint Description. 122 CLARIN-FCS clients SHOULD ignore any data they do not understand. 123 </h:p> 124 </xs:documentation> 125 </xs:annotation> 126 </xs:any> 117 127 </xs:sequence> 128 <xs:attribute name="version" type="xs:nonNegativeInteger" use="required"> 129 <xs:annotation> 130 <xs:documentation> 131 <h:p> 132 Version used for Endpoint Description. Endpoints MUST use the value "1". 133 </h:p> 134 </xs:documentation> 135 </xs:annotation> 136 </xs:attribute> 118 137 </xs:complexType> 119 138 </xs:element> 120 139 121 <xs:element name=" Collections">140 <xs:element name="Resources"> 122 141 <xs:annotation> 123 142 <xs:documentation> 124 143 <h:p> 125 A list of collections, that are available144 A list of resources, that are available 126 145 at an Endpoint. An Endpoint MUST 127 declare at least one collection.146 declare at least one resource. 128 147 </h:p> 129 148 </xs:documentation> … … 131 150 <xs:complexType> 132 151 <xs:sequence> 133 <xs:element ref="ed: Collection" maxOccurs="unbounded"/>152 <xs:element ref="ed:Resource" maxOccurs="unbounded"/> 134 153 </xs:sequence> 135 154 </xs:complexType> 136 155 </xs:element> 137 156 138 <xs:element name=" Collection">157 <xs:element name="Resource"> 139 158 <xs:annotation> 140 159 <xs:documentation> 141 160 <h:p> 142 Detailed description of a collectionthat is available at an143 Endpoint. A collectionis a searchable161 Detailed description of a resource that is available at an 162 Endpoint. A resource is a searchable 144 163 entity at an Endpoint, e.g. a single corpus. 145 164 </h:p> … … 152 171 <xs:documentation> 153 172 <h:p> 154 A human readable title for the corpus. An English version is173 A human readable title for the resource. An English version is 155 174 mandatory. 156 175 </h:p> … … 158 177 </xs:annotation> 159 178 </xs:element> 179 160 180 <xs:element name="Description" type="ed:i18nString" minOccurs="0" maxOccurs="unbounded"> 161 181 <xs:annotation> 162 182 <xs:documentation> 163 183 <h:p> 164 An optional human-readable description of the collection. Is should184 An optional human-readable description of the resource. Is should 165 185 be at most one sentence. If supplied, an English version is 166 186 mandatory. … … 169 189 </xs:annotation> 170 190 </xs:element> 191 171 192 <xs:element name="LandingPageURI" type="xs:anyURI" minOccurs="0"> 172 193 <xs:annotation> 173 194 <xs:documentation> 174 195 <h:p> 175 A link to a website for this collection, e.g. a landing page for a corpus. 176 </h:p> 177 </xs:documentation> 178 </xs:annotation> 179 </xs:element> 196 A link to a website for the resource, e.g. a landing page for a corpus. 197 </h:p> 198 </xs:documentation> 199 </xs:annotation> 200 </xs:element> 201 180 202 <xs:element name="Languages"> 181 203 <xs:annotation> 182 204 <xs:documentation> 183 205 <h:p> 184 The (relevant) languages available <h:em>within</h:em> the collection.206 The (relevant) languages available <h:em>within</h:em> the resource. 185 207 </h:p> 186 208 </xs:documentation> … … 194 216 A ISO 639-3 three letter language code. This 195 217 element should be repeated for all languages 196 (relevant) available <h:em>within</h:em> the collection.218 (relevant) available <h:em>within</h:em> the resource. 197 219 </p> 198 220 </xs:documentation> … … 207 229 </xs:complexType> 208 230 </xs:element> 209 <xs:element ref="ed:Collections" minOccurs="0"> 210 <xs:annotation> 211 <xs:documentation> 212 <h:p> 213 If a collection has searchable sub-collections 231 232 <xs:element ref="ed:Resources" minOccurs="0"> 233 <xs:annotation> 234 <xs:documentation> 235 <h:p> 236 If a resource has searchable sub-resources 214 237 the Endpoint MUST supply additional finer grained 215 collection elements. A sub-collection is a 216 searchable entity within a collection, e.g. a sub-corpus. 217 </h:p> 218 </xs:documentation> 219 </xs:annotation> 220 </xs:element> 238 <Resource> elements. A sub-resource is a 239 searchable entity within a resource, e.g. a sub-corpus. 240 </h:p> 241 </xs:documentation> 242 </xs:annotation> 243 </xs:element> 244 245 <!-- extension point --> 246 <xs:any namespace="##other" processContents="skip" minOccurs="0" maxOccurs="unbounded"> 247 <xs:annotation> 248 <xs:documentation> 249 <h:p> 250 Extension point to allow Endpoints to embed custom data in the Endpoint Description 251 for a specific resource. CLARIN-FCS clients SHOULD ignore any data they do not understand. 252 </h:p> 253 </xs:documentation> 254 </xs:annotation> 255 </xs:any> 221 256 </xs:sequence> 222 257 <xs:attribute name="pid" type="xs:anyURI" use="required"> … … 224 259 <xs:documentation> 225 260 <h:p> 226 The persistent identifier of this collection. This261 The persistent identifier of this resource. This 227 262 value MUST be the same as the <h:code>MdSelfLink</h:code> 228 263 of the CMDI record describing the collection. … … 234 269 </xs:element> 235 270 271 <xs:simpleType name="mimetypeString"> 272 <xs:restriction base="xs:string"> 273 <xs:pattern value="\w+/\w([\.\-]{0,1}\w)*(\+\w+){0,1}" /> 274 </xs:restriction> 275 </xs:simpleType> 276 236 277 <xs:complexType name="i18nString"> 237 278 <xs:simpleContent>
Note: See TracChangeset
for help on using the changeset viewer.