-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathopenSearch.html
590 lines (555 loc) · 16.7 KB
/
openSearch.html
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
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>Documentation</title>
</head>
<body>
<h1>Documentation</h1>
<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><ul class="link">
<li>rel:self = <a href="http://alps.io/opensearch/opensearch/" rel="self">http://alps.io/opensearch/opensearch/</a>
</li>
<li>rel:help = <a href="http://www.opensearch.org/Specifications/OpenSearch/1.1" rel="help">http://www.opensearch.org/Specifications/OpenSearch/1.1</a>
</li>
</ul>
<div class="descriptor">
<h4 class="id" id="OpenSearchDescription">OpenSearchDescription</h4>
<doc format="html">
<p>
The root node of the OpenSearch description document.
</p>
</doc><ul class="attributes">
<li>id : OpenSearchDescription</li>
<li>type : semantic</li>
<li>rt : http://alps.io/schema.org/Text</li>
</ul>
</div>
<div class="descriptor">
<h4 class="id" id="ShortName">ShortName</h4>
<doc format="html">
<p>
Contains a brief human-readable title that identifies this
search engine.
</p>
</doc><ul class="attributes">
<li>id : ShortName</li>
<li>type : semantic</li>
<li>rt : http://alps.io/schema.org/Text</li>
</ul>
</div>
<div class="descriptor">
<h4 class="id" id="Description">Description</h4>
<doc format="html">
<p>
Contains a human-readable text description of the search engine.
</p>
</doc><ul class="attributes">
<li>id : Description</li>
<li>type : semantic</li>
<li>rt : http://alps.io/schema.org/Text</li>
</ul>
</div>
<div class="descriptor">
<h4 class="id" id="Url">Url</h4>
<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><ul class="attributes">
<li>id : Url</li>
<li>type : safe</li>
<li>Contains: <div class="descriptor">
<h4 class="id" id=""></h4>
<ul class="attributes"><li>href : <a href="#template">#template</a>
</li></ul>
</div>
<div class="descriptor">
<h4 class="id" id=""></h4>
<ul class="attributes"><li>href : <a href="#rel">#rel</a>
</li></ul>
</div>
<div class="descriptor">
<h4 class="id" id=""></h4>
<ul class="attributes"><li>href : <a href="#indexOffset">#indexOffset</a>
</li></ul>
</div>
<div class="descriptor">
<h4 class="id" id=""></h4>
<ul class="attributes"><li>href : <a href="#pageOffset">#pageOffset</a>
</li></ul>
</div>
</li>
</ul>
</div>
<div class="descriptor">
<h4 class="id" id="template">template</h4>
<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><ul class="attributes">
<li>id : template</li>
<li>type : semantic</li>
<li>Contains: <div class="descriptor">
<h4 class="id" id=""></h4>
<ul class="attributes"><li>href : <a href="#searchTerms">#searchTerms</a>
</li></ul>
</div>
<div class="descriptor">
<h4 class="id" id=""></h4>
<ul class="attributes"><li>href : <a href="#count">#count</a>
</li></ul>
</div>
<div class="descriptor">
<h4 class="id" id="startIndex">startIndex</h4>
<ul class="attributes">
<li>id : startIndex</li>
<li>href : <a href="#indexOffset">#indexOffset</a>
</li>
</ul>
</div>
<div class="descriptor">
<h4 class="id" id="startPage">startPage</h4>
<ul class="attributes">
<li>id : startPage</li>
<li>href : <a href="#pageOffset">#pageOffset</a>
</li>
</ul>
</div>
<div class="descriptor">
<h4 class="id" id="language">language</h4>
<ul class="attributes">
<li>id : language</li>
<li>href : <a href="#Language">#Language</a>
</li>
</ul>
</div>
<div class="descriptor">
<h4 class="id" id="TemplateInputEncoding">TemplateInputEncoding</h4>
<ul class="attributes">
<li>id : TemplateInputEncoding</li>
<li>name : inputEncoding</li>
<li>href : <a href="#InputEncoding">#InputEncoding</a>
</li>
</ul>
</div>
<div class="descriptor">
<h4 class="id" id="TemplateOutputEncoding">TemplateOutputEncoding</h4>
<ul class="attributes">
<li>id : TemplateOutputEncoding</li>
<li>name : outputEncoding</li>i
<li>href : <a href="OutputEncoding">OutputEncoding</a>
</li>
</ul>
</div>
</li>
</ul>
</div>
<div class="descriptor">
<h4 class="id" id="searchTerms">searchTerms</h4>
<doc format="html">
<p>
The keyword or keywords desired by the search client.
</p>
</doc><ul class="attributes">
<li>id : searchTerms</li>
<li>type : semantic</li>
</ul>
</div>
<div class="descriptor">
<h4 class="id" id="count">count</h4>
<doc format="html">
<p>
The number of search results per page desired by the search
client.
</p>
</doc><ul class="attributes">
<li>id : count</li>
<li>type : semantic</li>
</ul>
</div>
<div class="descriptor">
<h4 class="id" id="type">type</h4>
<doc format="html">
<p>
The MIME type of the resource being described.
</p>
</doc><ul class="attributes">
<li>id : type</li>
<li>type : semantic</li>
<li>rt : http://alps.io/schema.org/Text</li>
</ul>
</div>
<div class="descriptor">
<h4 class="id" id="rel">rel</h4>
<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><ul class="attributes">
<li>id : rel</li>
<li>type : semantic</li>
<li>rt : http://alps.io/schema.org/Text</li>
</ul>
</div>
<div class="descriptor">
<h4 class="id" id="indexOffset">indexOffset</h4>
<doc format="html">
<p>
The index number of the first search result.
</p>
</doc><ul class="attributes">
<li>id : indexOffset</li>
<li>type : semantic</li>
</ul>
</div>
<div class="descriptor">
<h4 class="id" id="pageOffset">pageOffset</h4>
<doc format="html">
<p>
The page number of the first set of search results.
</p>
</doc><ul class="attributes">
<li>id : pageOffset</li>
<li>type : semantic</li>
</ul>
</div>
<div class="descriptor">
<h4 class="id" id="Contact">Contact</h4>
<doc format="html">
<p>
Contains an email address at which the maintainer of the
description document can be reached.
</p>
</doc><ul class="attributes">
<li>id : Contact</li>
<li>type : semantic</li>
<li>rt : <a href="http://alps.io/schema.org/Person#email">http://alps.io/schema.org/Person#email</a>
</li>
</ul>
</div>
<div class="descriptor">
<h4 class="id" id="Tags">Tags</h4>
<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><ul class="attributes">
<li>id : Tags</li>
<li>type : semantic</li>
<li>rt : http://alps.io/schema.org/Text</li>
</ul>
</div>
<div class="descriptor">
<h4 class="id" id="LongName">LongName</h4>
<doc format="html">
<p>
Contains an extended human-readable title that identifies this
search engine.
</p>
</doc><ul class="attributes">
<li>id : LongName</li>
<li>type : semantic</li>
<li>rt : http://alps.io/schema.org/Text</li>
</ul>
</div>
<div class="descriptor">
<h4 class="id" id="Image">Image</h4>
<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><ul class="attributes">
<li>id : Image</li>
<li>type : safe</li>
<li>Contains: <div class="descriptor">
<h4 class="id" id=""></h4>
<ul class="attributes"><li>href : <a href="#height">#height</a>
</li></ul>
</div>
<div class="descriptor">
<h4 class="id" id=""></h4>
<ul class="attributes"><li>href : <a href="#width">#width</a>
</li></ul>
</div>
<div class="descriptor">
<h4 class="id" id=""></h4>
<ul class="attributes"><li>href : <a href="#type">#type</a>
</li></ul>
</div>
</li>
</ul>
</div>
<div class="descriptor">
<h4 class="id" id="height">height</h4>
<doc format="html">
<p>
Contains the height, in pixels, of this image.
</p>
</doc><ul class="attributes">
<li>id : height</li>
<li>type : semantic</li>
</ul>
</div>
<div class="descriptor">
<h4 class="id" id="width">width</h4>
<doc format="html">
<p>
Contains the width, in pixels, of this image.
</p>
</doc><ul class="attributes">
<li>id : width</li>
<li>type : semantic</li>
</ul>
</div>
<div class="descriptor">
<h4 class="id" id="Query">Query</h4>
<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><ul class="attributes">
<li>id : Query</li>
<li>type : semantic</li>
<li>Contains: <div class="descriptor">
<h4 class="id" id=""></h4>
<ul class="attributes"><li>href : <a href="#role">#role</a>
</li></ul>
</div>
<div class="descriptor">
<h4 class="id" id=""></h4>
<ul class="attributes"><li>href : <a href="#title">#title</a>
</li></ul>
</div>
<div class="descriptor">
<h4 class="id" id=""></h4>
<ul class="attributes"><li>href : <a href="#totalResults">#totalResults</a>
</li></ul>
</div>
<div class="descriptor">
<h4 class="id" id=""></h4>
<ul class="attributes"><li>href : <a href="#searchTerms">#searchTerms</a>
</li></ul>
</div>
<div class="descriptor">
<h4 class="id" id=""></h4>
<ul class="attributes"><li>href : <a href="#count">#count</a>
</li></ul>
</div>
<div class="descriptor">
<h4 class="id" id="startIndex">startIndex</h4>
<ul class="attributes">
<li>id : startIndex</li>
<li>href : <a href="#indexOffset">#indexOffset</a>
</li>
</ul>
</div>
<div class="descriptor">
<h4 class="id" id="startPage">startPage</h4>
<ul class="attributes">
<li>id : startPage</li>
<li>href : <a href="#pageOffset">#pageOffset</a>
</li>
</ul>
</div>
<div class="descriptor">
<h4 class="id" id="language">language</h4>
<ul class="attributes">
<li>id : language</li>
<li>href : <a href="#Language">#Language</a>
</li>
</ul>
</div>
<div class="descriptor">
<h4 class="id" id="QueryInputEncoding">QueryInputEncoding</h4>
<ul class="attributes">
<li>id : QueryInputEncoding</li>
<li>name : inputEncoding</li>
<li>href : <a href="#InputEncoding">#InputEncoding</a>
</li>
</ul>
</div>
<div class="descriptor">
<h4 class="id" id="QueryOutputEncoding">QueryOutputEncoding</h4>
<ul class="attributes">
<li>id : QueryOutputEncoding</li>
<li>name : outputEndcoding</li>i
<li>href : <a href="OutputEncoding">OutputEncoding</a>
</li>
</ul>
</div>
</li>
</ul>
</div>
<div class="descriptor">
<h4 class="id" id="role">role</h4>
<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><ul class="attributes">
<li>id : role</li>
<li>type : semantic</li>
</ul>
</div>
<div class="descriptor">
<h4 class="id" id="title">title</h4>
<doc format="html">
<p>
Contains a human-readable plain text string describing the
search request.
</p>
</doc><ul class="attributes">
<li>id : title</li>
<li>type : semantic</li>
<li>rt : http://alps.io/schema.org/Text</li>
</ul>
</div>
<div class="descriptor">
<h4 class="id" id="totalResults">totalResults</h4>
<doc format="html">
<p>
Contains the expected number of results to be found if the
search request were made.
</p>
</doc><ul class="attributes">
<li>id : totalResults</li>
<li>type : semantic</li>
</ul>
</div>
<div class="descriptor">
<h4 class="id" id="itemsPerPage">itemsPerPage</h4>
<doc format="html">
<p>
The number of search results returned per page.
</p>
</doc><ul class="attributes">
<li>id : itemsPerPage</li>
<li>type : semantic</li>
</ul>
</div>
<div class="descriptor">
<h4 class="id" id="Developer">Developer</h4>
<doc format="html">
<p>
Contains the human-readable name or identifier of the creator
or maintainer of the description document.
</p>
</doc><ul class="attributes">
<li>id : Developer</li>
<li>type : semantic</li>
<li>rt : http://alps.io/schema.org/Text</li>
</ul>
</div>
<div class="descriptor">
<h4 class="id" id="Attribution">Attribution</h4>
<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><ul class="attributes">
<li>id : Attribution</li>
<li>type : semantic</li>
<li>rt : http://alps.io/schema.org/Text</li>
</ul>
</div>
<div class="descriptor">
<h4 class="id" id="SyndicationRight">SyndicationRight</h4>
<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><ul class="attributes">
<li>id : SyndicationRight</li>
<li>type : semantic</li>
</ul>
</div>
<div class="descriptor">
<h4 class="id" id="AdultContent">AdultContent</h4>
<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><ul class="attributes">
<li>id : AdultContent</li>
<li>type : semantic</li>
</ul>
</div>
<div class="descriptor">
<h4 class="id" id="Language">Language</h4>
<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><ul class="attributes">
<li>id : Language</li>
<li>type : semantic</li>
</ul>
</div>
<div class="descriptor">
<h4 class="id" id="InputEncoding">InputEncoding</h4>
<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><ul class="attributes">
<li>id : InputEncoding</li>
<li>type : semantic</li>
</ul>
</div>
<div class="descriptor">
<h4 class="id" id="OutputEncoding">OutputEncoding</h4>
<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><ul class="attributes">
<li>id : OutputEncoding</li>
<li>type : semantic</li>
</ul>
</div>
</body>
</html>