-
Notifications
You must be signed in to change notification settings - Fork 2
/
Copy pathopenSearch.xml
324 lines (293 loc) · 11.1 KB
/
openSearch.xml
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
<alps>
<link rel="self" href="http://alps.io/opensearch/opensearch" />
<link rel="help"
href="http://www.opensearch.org/Specifications/OpenSearch/1.1" />
<doc format="html">
This is the ALPS rendering of the
<a href="http://www.opensearch.org/Specifications/OpenSearch/1.1">Open Search</a>
specification.
</doc>
<descriptor id="OpenSearchDescription" type="semantic"
rt="http://alps.io/schema.org/Text">
<doc format="html">
<p>
The root node of the OpenSearch description document.
</p>
</doc>
</descriptor>
<descriptor id="ShortName" type="semantic"
rt="http://alps.io/schema.org/Text">
<doc format="html">
<p>
Contains a brief human-readable title that identifies this
search engine.
</p>
</doc>
</descriptor>
<descriptor id="Description" type="semantic"
rt="http://alps.io/schema.org/Text">
<doc format="html">
<p>
Contains a human-readable text description of the search engine.
</p>
</doc>
</descriptor>
<!-- this is the descriptor that performs the search -->
<descriptor id="Url" type="safe">
<doc format="html">
<p>
Describes an interface by which a client can make requests for
an external resource, such as search results, search
suggestions, or additional description documents.
</p>
</doc>
<descriptor href="#template" />
<descripto href="#type" />
<descriptor href="#rel" />
<descriptor href="#indexOffset" />
<descriptor href="#pageOffset" />
</descriptor>
<descriptor id="template" type="semantic">
<doc format="html">
<p>
The OpenSearch URL template format can be used to represent
a parameterized form of the URL by which a search engine is
queried.
</p>
</doc>
<descriptor href="#searchTerms" />
<descriptor href="#count" />
<descriptor id="startIndex" href="#indexOffset" />
<descriptor id="startPage" href="#pageOffset" />
<descriptor id="language" href="#Language" />
<descriptor id="TemplateInputEncoding" name="inputEncoding" href="#InputEncoding" />
<descriptor id="TemplateOutputEncoding" name="outputEncoding" href="OutputEncoding" />
</descriptor>
<descriptor id="searchTerms" type="semantic">
<doc format="html">
<p>
The keyword or keywords desired by the search client.
</p>
</doc>
</descriptor>
<descriptor id="count" type="semantic">
<doc format="html">
<p>
The number of search results per page desired by the search
client.
</p>
</doc>
</descriptor>
<descriptor id="type" type="semantic" rt="http://alps.io/schema.org/Text">
<doc format="html">
<p>
The MIME type of the resource being described.
</p>
</doc>
</descriptor>
<descriptor id="rel" type="semantic" rt="http://alps.io/schema.org/Text">
<doc format="html">
<p>
The role of the resource being described in relation to the
description document. Only those tokens listed here have
meaning defined in this specification: results, suggestions,
self, collection.
</p>
</doc>
</descriptor>
<descriptor id="indexOffset" type="semantic">
<doc format="html">
<p>
The index number of the first search result.
</p>
</doc>
</descriptor>
<descriptor id="pageOffset" type="semantic">
<doc format="html">
<p>
The page number of the first set of search results.
</p>
</doc>
</descriptor>
<descriptor id="Contact" type="semantic"
rt="http://alps.io/schema.org/Person#email">
<doc format="html">
<p>
Contains an email address at which the maintainer of the
description document can be reached.
</p>
</doc>
</descriptor>
<descriptor id="Tags" type="semantic" rt="http://alps.io/schema.org/Text">
<doc format="html">
<p>
Contains a set of words that are used as keywords to identify
and categorize this search content. Tags must be a single word
and are delimited by the space character (' ').
</p>
</doc>
</descriptor>
<descriptor id="LongName" type="semantic"
rt="http://alps.io/schema.org/Text">
<doc format="html">
<p>
Contains an extended human-readable title that identifies this
search engine.
</p>
</doc>
</descriptor>
<descriptor id="Image" type="safe">
<doc format="html">
<p>
Contains a URL that identifies the location of an image that
can be used in association with this search content.
</p>
</doc>
<descriptor href="#height" />
<descriptor href="#width" />
<descriptor href="#type" />
</descriptor>
<descriptor id="height" type="semantic">
<doc format="html">
<p>
Contains the height, in pixels, of this image.
</p>
</doc>
</descriptor>
<descriptor id="width" type="semantic">
<doc format="html">
<p>
Contains the width, in pixels, of this image.
</p>
</doc>
</descriptor>
<descriptor id="Query" type="semantic">
<doc format="html">
<p>
Defines a search query that can be performed by search clients.
Please see the OpenSearch Query element specification for more
information.
</p>
</doc>
<descriptor href="#role" />
<descriptor href="#title" />
<descriptor href="#totalResults" />
<descriptor href="#searchTerms" />
<descriptor href="#count" />
<descriptor id="startIndex" href="#indexOffset" />
<descriptor id="startPage" href="#pageOffset" />
<descriptor id="language" href="#Language" />
<descriptor id="QueryInputEncoding" name="inputEncoding" href="#InputEncoding" />
<descriptor id="QueryOutputEncoding" name="outputEndcoding" href="OutputEncoding" />
</descriptor>
<descriptor id="role" type="semantic">
<doc format="html">
<p>
Contains a string identifying how the search client should
interpret the search request defined by this Query element.
The following role values are identified with the OpenSearch
1.1 namespace. The list is exhaustive; only the role values
listed below may appear in the OpenSearch 1.1 namespace:
request, example, related, correction, subset, superset.
</p>
</doc>
</descriptor>
<descriptor id="title" type="semantic" rt="http://alps.io/schema.org/Text">
<doc format="html">
<p>
Contains a human-readable plain text string describing the
search request.
</p>
</doc>
</descriptor>
<descriptor id="totalResults" type="semantic">
<doc format="html">
<p>
Contains the expected number of results to be found if the
search request were made.
</p>
</doc>
</descriptor>
<descriptor id="itemsPerPage" type="semantic">
<doc format="html">
<p>
The number of search results returned per page.
</p>
</doc>
</descriptor>
<descriptor id="Developer" type="semantic"
rt="http://alps.io/schema.org/Text">
<doc format="html">
<p>
Contains the human-readable name or identifier of the creator
or maintainer of the description document.
</p>
</doc>
</descriptor>
<descriptor id="Attribution" type="semantic"
rt="http://alps.io/schema.org/Text">
<doc format="html">
<p>
Contains a list of all sources or entities that should be
credited for the content contained in the search feed.
</p>
</doc>
</descriptor>
<descriptor id="SyndicationRight" type="semantic">
<doc format="html">
<p>
Contains a value that indicates the degree to which the search
results provided by this search engine can be queried,
displayed, and redistributed. The value must be one of the
following strings (case insensitive): open, limited, private,
closed.
</p>
</doc>
</descriptor>
<descriptor id="AdultContent" type="semantic">
<doc format="html">
<p>
Contains a boolean value that should be set to true if the
search results may contain material intended only for adults.
</p>
</doc>
</descriptor>
<descriptor id="Language" type="semantic">
<doc format="html">
<p>
Contains a string that indicates that the search engine
supports search results in the specified language. The value
must conform to the
<a href="http://www.w3.org/TR/2004/REC-xml-20040204/#sec-lang-tag">
XML 1.0 Language Identification</a>, as specified by
<a href="http://tools.ietf.org/html/rfc5646">RFC5646></a>
</p>
</doc>
</descriptor>
<descriptor id="InputEncoding" type="semantic">
<doc format="html">
<p>
Contains a string that indicates that the search engine
supports search requests encoded with the specified character
encoding. The value must conform to the
<a href="http://www.w3.org/TR/2004/REC-xml-20040204/#charencoding">
XML 1.0 Character Encodings</a>, as specified by the
<a href="http://www.iana.org/assignments/character-sets">
IANA Character Set Assignments</a>.
</p>
</doc>
</descriptor>
<descriptor id="OutputEncoding" type="semantic">
<doc format="html">
<p>
Contains a string that indicates that the search engine
supports search responses encoded with the specified character
encoding. The value must conform to the
<a href="http://www.w3.org/TR/2004/REC-xml-20040204/#charencoding">
XML 1.0 Character Encodings</a>, as specified by the
<a href="http://www.iana.org/assignments/character-sets">
IANA Character Set Assignments</a>.
</p>
</doc>
</descriptor>
</alps>