Bug 10860: In-House Use
[koha.git] / etc / zebradb / explain-authorities.xml
1 <?xml version="1.0" encoding="UTF-8"?>
2
3 <!-- $Id: explain.xml,v 1.14 2006/09/27 13:35:09 marc Exp $ -->
4
5 <!-- this file configures the SRU/SRW explain response -->
6 <!-- see: http://explain.z3950.org/dtd/commentary.html -->
7 <!-- validate this using zeerex-2.0.xsd -->
8 <!-- Extensions see: http://explain.z3950.org/dtd/extensions.html -->
9
10 <explain xmlns="http://explain.z3950.org/dtd/2.0/">
11
12   <!-- try stylesheet url: http://./?stylesheet=docpath/sru2.xsl -->
13   <serverInfo protocol="SRW/SRU/Z39.50">
14
15     <host>__ZEBRA_SRU_HOST__</host>
16
17     <port>9999</port>
18     <!-- <database numRecs="1314" lastUpdate="2006-03-15 09-05-33">
19          Default</database> -->
20     <database>authorities</database>
21         <!--<authentication>
22       <user>kohauser</user>
23       <group>kohagroup</group>
24       <password>zebrastripes</password>
25     </authentication>-->
26   </serverInfo>
27
28   <databaseInfo>
29
30     <title lang="en" primary="true">Koha 3 Authority SRU/SRW/Z39.50 server</title>
31
32     <description lang="en" primary="true">
33       Koha 3 Authority Server
34     </description>
35
36     <author>Joshua Ferraro, LibLime, http://liblime.com,
37             Marc Cromme, Mike Taylor, Index Data Aps, 
38             http://www.indexdata.dk</author>
39
40     <contact>Joshua Ferraro, jmf(at)liblime(dot)com</contact>
41
42     <!--<langUsage codes="en fr">
43         The records are in English and French.
44         </langUsage>  -->
45     <!-- <extend>Partially crawled web data</extend> -->
46    
47     <history>
48       Created for Koha 3
49       http://koha-community.org
50     </history>
51
52     <implementation  identifier="zebra" version="1.4">
53       <title>Index Data YAZ/ZEBRA http://www.indexdata.dk/zebra</title>
54     </implementation>
55     
56     <links> 
57       <!--<link type="www">http://foo.indexdata.dk:80</link>-->
58       <link type="z39.50">http://__ZEBRA_SRU_HOST__:__ZEBRA_SRU_AUTHORITIES_PORT__</link>
59       <link type="srw">http://__ZEBRA_SRU_HOST__:__ZEBRA_SRU_AUTHORITIES_PORT__</link>
60       <link type="sru">http://__ZEBRA_SRU_HOST__:__ZEBRA_SRU_AUTHORITIES_PORT__</link>
61       <!--<link type="oai"></link>
62       <link type="rss"></link>
63       <link type="icon"></link> -->
64     </links>
65     
66   </databaseInfo>
67
68   <!--
69   <metaInfo>
70     <dateModified>2002-03-29 19:00:00</dateModified>
71     <aggregatedFrom> z39.50r://gondolin.hist.liv.ac.uk:210/IR-Explain-1?
72                    id=ghlau-1;esn=F;rs=XML </aggregatedFrom>
73     <dateAggregated>2002-03-30 06:30:00</dateAggregated>
74   </metaInfo>
75   -->
76
77
78   <indexInfo>
79     <set name="cql" identifier="info:srw/cql-context-set/1/cql-v1.1">
80       <title>CQL Standard Set</title>
81     </set>
82     <set name="rec" identifier="info:srw/cql-context-set/2/rec-1.0">
83       <title>Record Standard Set</title>
84     </set>
85     <set name="alvis" identifier="http://indexdata.dk/zebra/xslt/1">
86       <title>Alvis Set</title>
87     </set>
88     <set name="dc" identifier="info:srw/cql-context-set/1/dc-v1.1">
89       <title>Dublin Core Set</title>
90     </set>
91     <set name="bib1" identifier="1.2.840.10003.3.1">
92       <title>BIB-1 Z39.50 Standard Set</title>
93     </set>
94
95
96     <!-- CQL standard index -->
97     <index search="true" scan="true" sort="false">
98       <title lang="en">CQL Server Choice</title>
99       <map><name set="cql">serverChoice</name></map>
100       <map>
101         <attr type="1" set="bib1">text</attr>
102       </map>
103     </index>
104     <index search="true" scan="true" sort="false">
105       <title lang="en">CQL All</title>
106       <map><name set="cql">all</name></map>
107       <map>
108         <attr type="1" set="bib1">text</attr>
109       </map>
110     </index>
111
112     <!-- Record ID index -->
113     <index search="true" scan="true" sort="false">
114       <title lang="en">Record ID</title>
115       <map><name set="rec">id</name></map>
116       <map>
117         <attr type="1" set="bib1">rec:id</attr>
118         <attr type="4" set="bib1">3</attr>
119       </map>
120     </index>
121
122     <!-- Alvis indexes -->
123     <index search="true" scan="true" sort="false">
124       <title lang="en">Alvis Text Relevance Ranked</title>
125       <map><name set="alvis">text</name></map>
126       <map>
127         <attr type="1" set="bib1">text</attr>
128         <attr type="2" set="bib1">102</attr>
129       </map>
130     </index>
131     <index search="true" scan="true" sort="false">
132       <title lang="en">Alvis Anchor Text</title>
133       <map><name set="alvis">anchortext</name></map>
134       <map>
135         <attr type="1" set="bib1">anchortext</attr>
136         <attr type="2" set="bib1">102</attr>
137       </map>
138     </index>
139     <index search="true" scan="true" sort="false">
140       <title lang="en">Alvis Date Modified</title>
141       <map><name set="alvis">date-modified</name></map>
142       <map>
143         <attr type="1" set="bib1">ac:date-modified</attr>
144         <attr type="4" set="bib1">5</attr>
145       </map>
146     </index>
147     <index search="true" scan="true" sort="false">
148       <title lang="en">Alvis Date Checked</title>
149       <map><name set="alvis">date-checked</name></map>
150       <map>
151         <attr type="1" set="bib1">ac:date-checked</attr>
152         <attr type="4" set="bib1">5</attr>
153       </map>
154     </index>
155     <index search="true" scan="true" sort="false">
156       <title lang="en">Alvis Identifier Url</title>
157       <map><name set="alvis">identifier-url</name></map>
158       <map>
159         <attr type="1" set="bib1">ac:identifier-url</attr>
160         <attr type="4" set="bib1">3</attr>
161       </map>
162     </index>
163     <!--<index search="true" scan="true" sort="false">
164       <title lang="en">Alvis Identifier Server</title>
165       <map><name set="alvis">identifier-server</name></map>
166       <map>
167         <attr type="1" set="bib1">ac:identifier-server</attr>
168         <attr type="4" set="bib1">3</attr>
169       </map>
170     </index> -->
171     <index search="true" scan="true" sort="false">
172       <title lang="en">Alvis Topic Class</title>
173       <map><name set="alvis">topic-class</name></map>
174       <map>
175         <attr type="1" set="bib1">an:topic-class</attr>
176       </map>
177     </index>
178     <index search="true" scan="true" sort="false">
179       <title lang="en">Alvis Language</title>
180       <map><name set="alvis">language</name></map>
181       <map>
182         <attr type="1" set="bib1">an:language</attr>
183       </map>
184     </index>
185     <index search="true" scan="true" sort="false">
186       <title lang="en">Alvis NLP Entity Date</title>
187       <map><name set="alvis">entity-date</name></map>
188       <map>
189         <attr type="1" set="bib1">la:entity-date</attr>
190         <attr type="4" set="bib1">3</attr>
191       </map>
192     </index>
193     <index search="true" scan="true" sort="false">
194       <title lang="en">Alvis NLP Entity Disease</title>
195       <map><name set="alvis">entity-disease</name></map>
196       <map>
197         <attr type="1" set="bib1">la:entity-disease</attr>
198         <attr type="4" set="bib1">3</attr>
199       </map>
200     </index>
201     <index search="true" scan="true" sort="false">
202       <title lang="en">Alvis NLP Entity Gene</title>
203       <map><name set="alvis">entity-gene</name></map>
204       <map>
205         <attr type="1" set="bib1">la:entity-gene</attr>
206         <attr type="4" set="bib1">3</attr>
207       </map>
208     </index>
209     <index search="true" scan="true" sort="false">
210       <title lang="en">Alvis NLP Entity Location</title>
211       <map><name set="alvis">entity-location</name></map>
212       <map>
213         <attr type="1" set="bib1">la:entity-location</attr>
214         <attr type="4" set="bib1">3</attr>
215       </map>
216     </index>
217     <!--<index search="true" scan="true" sort="false">
218       <title lang="en">Alvis NLP Entity Mail</title>
219       <map><name set="alvis">entity-mail</name></map>
220       <map>
221         <attr type="1" set="bib1">la:entity-mail</attr>
222         <attr type="4" set="bib1">3</attr>
223       </map>
224     </index>-->
225     <index search="true" scan="true" sort="false">
226       <title lang="en">Alvis NLP Entity Person</title>
227       <map><name set="alvis">entity-person</name></map>
228       <map>
229         <attr type="1" set="bib1">la:entity-person</attr>
230         <attr type="4" set="bib1">3</attr>
231       </map>
232     </index>
233     <!-- <index search="true" scan="true" sort="false">
234       <title lang="en">Alvis NLP Entity Protein</title>
235       <map><name set="alvis">entity-protein</name></map>
236       <map>
237         <attr type="1" set="bib1">la:entity-protein</attr>
238         <attr type="4" set="bib1">3</attr>
239       </map>
240     </index> -->
241     <index search="true" scan="true" sort="false">
242       <title lang="en">Alvis NLP Entity Species</title>
243       <map><name set="alvis">entity-species</name></map>
244       <map>
245         <attr type="1" set="bib1">la:entity-species</attr>
246         <attr type="4" set="bib1">3</attr>
247       </map>
248     </index>
249     <index search="true" scan="true" sort="false">
250       <title lang="en">Alvis NLP Entity URL</title>
251       <map><name set="alvis">entity-url</name></map>
252       <map>
253         <attr type="1" set="bib1">la:entity-url</attr>
254         <attr type="4" set="bib1">3</attr>
255       </map>
256     </index>
257     <index search="true" scan="true" sort="false">
258       <title lang="en">Alvis NLP Entity Organism</title>
259       <map><name set="alvis">entity-organism</name></map>
260       <map>
261         <attr type="1" set="bib1">la:entity-organism</attr>
262         <attr type="4" set="bib1">3</attr>
263       </map>
264     </index>
265     <index search="true" scan="true" sort="false">
266       <title lang="en">Alvis NLP Entity Symptom</title>
267       <map><name set="alvis">entity-symptom</name></map>
268       <map>
269         <attr type="1" set="bib1">la:entity-symptom</attr>
270         <attr type="4" set="bib1">3</attr>
271       </map>
272     </index>
273     <index search="true" scan="true" sort="false">
274       <title lang="en">Alvis NLP Entity Chemical</title>
275       <map><name set="alvis">entity-chemical</name></map>
276       <map>
277         <attr type="1" set="bib1">la:entity-chemical</attr>
278         <attr type="4" set="bib1">3</attr>
279       </map>
280     </index>
281     <index search="true" scan="true" sort="false">
282       <title lang="en">Alvis NLP Entity Drug</title>
283       <map><name set="alvis">entity-drug</name></map>
284       <map>
285         <attr type="1" set="bib1">la:entity-drug</attr>
286         <attr type="4" set="bib1">3</attr>
287       </map>
288     </index>
289     <index search="true" scan="true" sort="false">
290       <title lang="en">Alvis NLP Lemma Canonical </title>
291       <map><name set="alvis">lemma-canonical</name></map>
292       <map>
293         <attr type="1" set="bib1">la:lemma-canonical</attr>
294         <attr type="4" set="bib1">3</attr>
295       </map>
296     </index>
297     <index search="true" scan="true" sort="false">
298       <title lang="en">Alvis NLP Syntactic Noun</title>
299       <map><name set="alvis">syntactic-noun</name></map>
300       <map>
301         <attr type="1" set="bib1">la:syntactic-noun</attr>
302         <attr type="4" set="bib1">3</attr>
303       </map>
304     </index>
305     <index search="true" scan="true" sort="false">
306       <title lang="en">Alvis NLP Syntactic Verb</title>
307       <map><name set="alvis">syntactic-verb</name></map>
308       <map>
309         <attr type="1" set="bib1">la:syntactic-verb</attr>
310         <attr type="4" set="bib1">3</attr>
311       </map>
312     </index>
313     <index search="true" scan="true" sort="false">
314       <title lang="en">Alvis NLP Syntactic Adjective</title>
315       <map><name set="alvis">syntactic-adjective</name></map>
316       <map>
317         <attr type="1" set="bib1">la:syntactic-adjective</attr>
318         <attr type="4" set="bib1">3</attr>
319       </map>
320     </index>
321     <index search="true" scan="true" sort="false">
322       <title lang="en">Alvis NLP Word Form</title>
323       <map><name set="alvis">word-form</name></map>
324       <map>
325         <attr type="1" set="bib1">la:word-form</attr>
326         <attr type="4" set="bib1">3</attr>
327       </map>
328     </index>
329     <!-- <index search="true" scan="true" sort="false">
330       <title lang="en">Alvis NLP Term Form</title>
331       <map><name set="alvis">term-form</name></map>
332       <map>
333         <attr type="1" set="bib1">la:term-form</attr>
334         <attr type="4" set="bib1">3</attr>
335       </map>
336     </index> -->
337     <!-- <index search="true" scan="true" sort="false">
338       <title lang="en">Alvis Wpcats</title>
339       <map><name set="alvis">wpcats</name></map>
340       <map>
341         <attr type="1" set="bib1">wpcats</attr>
342       </map>
343     </index> -->
344
345     <!-- Dublin Core Indexes -->
346     <index search="true" scan="true" sort="false">
347       <title lang="en">DC Title</title>
348       <map><name set="dc">title</name></map>
349       <map>
350         <attr type="1" set="bib1">dc:title</attr>
351       </map>
352     </index>
353     <index search="true" scan="true" sort="false">
354       <title lang="en">DC Creator</title>
355       <map><name set="dc">creator</name></map>
356       <map>
357         <attr type="1" set="bib1">dc:creator</attr>
358       </map>
359     </index>
360     <index search="true" scan="true" sort="false">
361       <title lang="en">DC Subject</title>
362       <map><name set="dc">subject</name></map>
363       <map>
364         <attr type="1" set="bib1">dc:subject</attr>
365       </map>
366     </index>
367     <index search="true" scan="true" sort="false">
368       <title lang="en">DC Description</title>
369       <map><name set="dc">description</name></map>
370       <map>
371         <attr type="1" set="bib1">dc:description</attr>
372       </map>
373     </index>
374     <index search="true" scan="true" sort="false">
375       <title lang="en">DC Publisher</title>
376       <map><name set="dc">publisher</name></map>
377       <map>
378         <attr type="1" set="bib1">dc:publisher</attr>
379       </map>
380     </index>
381     <index search="true" scan="true" sort="false">
382       <title lang="en">DC Contributor</title>
383       <map><name set="dc">contributor</name></map>
384       <map>
385         <attr type="1" set="bib1">dc:contributor</attr>
386       </map>
387     </index>
388     <index search="true" scan="true" sort="false">
389       <title lang="en">DC Date</title>
390       <map><name set="dc">date</name></map>
391       <map>
392         <attr type="1" set="bib1">dc:date</attr>
393       </map>
394     </index>
395     <index search="true" scan="true" sort="false">
396       <title lang="en">DC Type</title>
397       <map><name set="dc">type</name></map>
398       <map>
399         <attr type="1" set="bib1">dc:type</attr>
400       </map>
401     </index>
402     <index search="true" scan="true" sort="false">
403       <title lang="en">DC Format</title>
404       <map><name set="dc">format</name></map>
405       <map>
406         <attr type="1" set="bib1"></attr>
407       </map>
408     </index>
409     <index search="true" scan="true" sort="false">
410       <title lang="en">DC Identifier</title>
411       <map><name set="dc">identifier</name></map>
412       <map>
413         <attr type="1" set="bib1">dc:identifier</attr>
414       </map>
415     </index>
416     <index search="true" scan="true" sort="false">
417       <title lang="en">DC Source</title>
418       <map><name set="dc">source</name></map>
419       <map>
420         <attr type="1" set="bib1">dc:source</attr>
421       </map>
422     </index>
423     <index search="true" scan="true" sort="false">
424       <title lang="en">DC Language</title>
425       <map><name set="dc">language</name></map>
426       <map>
427         <attr type="1" set="bib1">dc:language</attr>
428       </map>
429     </index>
430     <index search="true" scan="true" sort="false">
431       <title lang="en">DC Relation</title>
432       <map><name set="dc">relation</name></map>
433       <map>
434         <attr type="1" set="bib1">dc:relation</attr>
435       </map>
436     </index>
437     <index search="true" scan="true" sort="false">
438       <title lang="en">DC Coverage</title>
439       <map><name set="dc">coverage</name></map>
440       <map>
441         <attr type="1" set="bib1">dc:coverage</attr>
442       </map>
443     </index>
444     <index search="true" scan="true" sort="false">
445       <title lang="en">DC Rights</title>
446       <map><name set="dc">rights</name></map>
447       <map>
448         <attr type="1" set="bib1">dc:rights</attr>
449       </map>
450     </index>
451
452   </indexInfo>
453
454   <!-- Z39.50 stuff ... not allowed in one and the same explain together with 
455        <schemaInfo>, sic ..
456   <recordInfo>
457     <recordSyntax identifier="1.2.840.10003.5.109.10">
458       <elementSet name="F">
459         <title lang="en" primary="true">Full XML Record</title>
460       </elementSet>
461     </recordSyntax>
462   </recordInfo>
463   -->
464
465   <schemaInfo>
466
467     <schema identifier="http://www.loc.gov/zing/srw/dcschema/v1.0/"
468             location="http://www.loc.gov/zing/srw/dc.xsd" 
469             name="dc"
470             retrieve="true">
471       <title lang="en">Dublin Core</title>
472     </schema>
473
474     <schema identifier="http://indexdata.dk/dc-short"
475             location="" 
476             name="dc-short"
477             retrieve="true">
478       <title lang="en">Dublin Core Short Form</title>
479     </schema>
480
481     <!--<schema identifier="http://indexdata.dk/snippet"
482             location="" 
483             name="snippet"
484             retrieve="true">
485       <title lang="en">Snippet - Not Implemented</title>
486     </schema> -->
487
488     <!--<schema identifier="http://indexdata.dk/help"
489             location="" 
490             name="help"
491             retrieve="true">
492       <title lang="en">Help - Not Implemented</title>
493     </schema> -->
494
495     <schema identifier="http://indexdata.dk/pretty"
496             location="" 
497             name="pretty"
498             retrieve="true">
499       <title lang="en">Pretty</title>
500     </schema>
501
502     <schema identifier="http://indexdata.dk/D9.1"
503             location="" 
504             name="D9.1"
505             retrieve="true">
506       <title lang="en">Alvis D9.1 Schema</title>
507     </schema>
508
509     <schema identifier="http://alvis.info/enriched/"
510             location="http://project.alvis.info/alvis_docs/alvis-document.xsd" 
511             name="alvis"
512             retrieve="true">
513       <title lang="en">Alvis Enriched</title>
514     </schema>
515
516     <schema identifier="http://indexdata.dk/zebra/xslt/1"
517             location="" 
518             name="index"
519             retrieve="true">
520       <title lang="en">Zebra Indexing</title>
521     </schema>
522
523   </schemaInfo>
524  
525   <configInfo>
526
527     <!-- searchRetrieve settings -->
528
529     <!-- default context set -->
530     <default type="contextSet">cql</default>
531
532     <default type="index">all</default>
533
534     <!-- default relation -->
535     <default type="relation">=</default>
536
537     <!-- relation supported by the server or index -->
538     <supports type="relation">&lt;</supports> <!-- 2=1 OK -->
539     <supports type="relation">&lt;=</supports> <!-- 2=2 OK -->
540     <supports type="relation">=</supports> <!-- 2=3 OK -->
541     <supports type="relation">&gt;=</supports> <!-- 2=4 OK -->
542     <supports type="relation">&gt;</supports> <!-- 2=5 OK -->
543     <!-- <supports type="relation">&lt;&gt;</supports> --><!-- 2=6 DEAD !!! -->
544     <!-- <supports type="relation">all</supports> --><!-- 2=3 OK -->
545     <!-- <supports type="relation">any</supports> --><!-- 2=3 OK -->
546
547     <!-- relation modifier supported by the server or index -->
548     <!-- <supports type="relationModifier">relevant</supports> --><!-- 2=102 OK, makes no difference .. sic -->
549     <!-- <supports type="relationModifier">phonetic</supports> --> <!-- 2=100 DEAD -->
550     <!-- <supports type="relationModifier">stem</supports> --> <!-- 2=101 DEAD !! -->
551
552     <!-- support proximity (Empty) -->
553     <!-- <supports type="proximity"></supports> --> <!-- DEAD,  title = (house prox/distance=1/unit=word  the) FAILS -->
554
555     <!-- proximity modifier supported by the server or index 
556          (relation, distance, unit, ordering) -->
557     <!-- <supports type="proximityModifier"></supports> -->
558
559     <!-- boolean modifier supported by the server or index -->
560     <!-- <supports type="booleanModifier"></supports> -->
561
562     <!-- masking character supported (* or ?) -->
563     <supports type="maskingCharacter">*</supports>
564     <supports type="maskingCharacter">?</supports>
565
566     <!-- anchoring supported? (^ character) -->
567     <!-- empty terms supported (Empty) -->
568     <supports type="emptyTerm"></supports>
569
570     <!-- sorting settings -->
571
572     <!-- default schema used in sorting, in short name form -->
573     <!-- <default type="sortSchema"></default> -->
574     <!-- MIKE: deprecated -->
575
576     <!-- server support sort -->
577
578     <!-- supported sortmodifier (ascending, missingValue, caseSensitive) -->
579     <!-- <supports type="sortModifier"></supports> -->
580
581     <!-- presentation settings --> 
582
583     <!-- default number of records that a server will return at once  -->
584     <default type="numberOfRecords">0</default>
585
586     <!-- default schema used for retrieved records -->
587     <default type="retrieveSchema">index</default>
588     <!-- default stylesheet URL, or if stylesheets are supported -->
589     <setting type="stylesheet">docpath/sru.xsl</setting>
590
591     <!-- default record packing returned (string or xml) -->
592     <default type="recordPacking">xml</default>
593
594     <!-- maximum number of records that a server will return at once -->
595     <!-- <setting type="maximumRecords">1000</setting> -->
596
597     <!-- support result sets (Empty) -->
598     <!-- <supports type="resultSets"></supports>  --> 
599
600     <!-- XPath retrieval supported -->
601     <!-- <supports type="recordXPath"></supports> -->
602
603     <!-- scan settings -->
604
605     <!-- scan operation supported -->
606     <supports type="scan"></supports>
607
608     <!-- default number of terms to be returned in scan -->
609     <default type="numberOfTerms">20</default>
610
611     <!-- other server settings -->
612
613     <!-- older version of the protocol supported  -->
614     <!-- <supports type="version">1.1</supports> -->
615
616     <!-- number of seconds that a result set will be maintained for -->
617     <setting type="resultSetTTL">0</setting>
618
619     <!-- A type of extraRequestData available in the
620          searchRetrieveRequest. The extra*Data fields are represented as two
621          space separated words, the first the identifier for the extension and
622          the second the individual element name from the extension. If there is
623          only one word, then it is the extension id and all elements from
624          within are supported. -->
625     <!-- <supports type="extraSearchData"></supports> -->
626
627     <!-- A type of extraRequestData available in the explainRequest -->
628     <!-- <supports type="extraExplainData"></supports> -->
629
630     <!-- A type of extraRequestData available in the scanRequest -->
631     <!-- <supports type="extraScanData"></supports> -->
632     <!-- The URI identifier of a supported profile -->
633     <!-- <supports type="profile"></supports> -->
634   </configInfo>
635    
636 </explain>