added example explain record
[metaproxy-moved-to-github.git] / etc / explain.xml
1 <?xml version="1.0" encoding="UTF-8"?>
2
3 <!-- $Id: explain.xml,v 1.1 2007-01-08 10:17:45 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   <serverInfo protocol="SRU">
13     <host>foo.indexdata.dk</host>
14     <port>80</port>
15     <database>Default</database>
16   </serverInfo>
17
18   <databaseInfo>
19     <title lang="en" primary="true">Metaproxy example SRU explain record</title
20     <description lang="en" primary="true">
21       Some description of this service
22     </description>
23     <author>Marc Cromme, Index Data Aps, http://www.indexdata.com</author>
24     <contact>Marc Cromme, marc(at)indexdata(dot)com</contact>
25     <history>Implemented for Talis LTD</history>
26   </databaseInfo>
27
28   <indexInfo>
29     <set name="cql" identifier="info:srw/cql-context-set/1/cql-v1.1">
30       <title>CQL Standard Set</title>
31     </set>
32     <set name="rec" identifier="info:srw/cql-context-set/2/rec-1.0">
33       <title>Record Standard Set</title>
34     </set>
35     <set name="dc" identifier="info:srw/cql-context-set/1/dc-v1.1">
36       <title>Dublin Core Set</title>
37     </set>
38     <set name="bib1" identifier="1.2.840.10003.3.1">
39       <title>BIB-1 Z39.50 Standard Set</title>
40     </set>
41
42     <!-- CQL standard index -->
43     <index search="true" scan="true" sort="false">
44       <title lang="en">CQL Server Choice</title>
45       <map><name set="cql">serverChoice</name></map>
46       <map>
47         <attr type="1" set="bib1">1010</attr>
48       </map>
49     </index>
50     <index search="true" scan="true" sort="false">
51       <title lang="en">CQL All</title>
52       <map><name set="cql">all</name></map>
53       <map>
54         <attr type="1" set="bib1">1010</attr>
55       </map>
56     </index>
57
58     <!-- Record ID index -->
59     <index search="true" scan="true" sort="false">
60       <title lang="en">Record ID</title>
61       <map><name set="rec">id</name></map>
62       <map>
63         <attr type="1" set="bib1">12</attr>
64         <attr type="4" set="bib1">3</attr>
65       </map>
66     </index>
67
68     <!-- Dublin Core Indexes -->
69     <index search="true" scan="true" sort="false">
70       <title lang="en">DC Title</title>
71       <map><name set="dc">title</name></map>
72       <map>
73         <attr type="1" set="bib1">4</attr>
74       </map>
75     </index>
76     <index search="true" scan="true" sort="false">
77       <title lang="en">DC Creator</title>
78       <map><name set="dc">creator</name></map>
79       <map>
80         <attr type="1" set="bib1">1003</attr>
81       </map>
82     </index>
83     <index search="true" scan="true" sort="false">
84       <title lang="en">DC Subject</title>
85       <map><name set="dc">subject</name></map>
86       <map>
87         <attr type="1" set="bib1">47</attr>
88       </map>
89     </index>
90     <index search="true" scan="true" sort="false">
91       <title lang="en">DC Description</title>
92       <map><name set="dc">description</name></map>
93       <map>
94         <attr type="1" set="bib1">62</attr>
95       </map>
96     </index>
97     <index search="true" scan="true" sort="false">
98       <title lang="en">DC Publisher</title>
99       <map><name set="dc">publisher</name></map>
100       <map>
101         <attr type="1" set="bib1">1018</attr>
102       </map>
103     </index>
104     <index search="true" scan="true" sort="false">
105       <title lang="en">DC Contributor</title>
106       <map><name set="dc">contributor</name></map>
107       <map>
108         <attr type="1" set="bib1">1003</attr>
109       </map>
110     </index>
111     <index search="true" scan="true" sort="false">
112       <title lang="en">DC Date</title>
113       <map><name set="dc">date</name></map>
114       <map>
115         <attr type="1" set="bib1">30</attr>
116       </map>
117     </index>
118     <index search="true" scan="true" sort="false">
119       <title lang="en">DC Type</title>
120       <map><name set="dc">type</name></map>
121       <map>
122         <attr type="1" set="bib1">1034</attr>
123       </map>
124     </index>
125     <index search="true" scan="true" sort="false">
126       <title lang="en">DC Format</title>
127       <map><name set="dc">format</name></map>
128       <map>
129         <attr type="1" set="bib1">1013</attr>
130       </map>
131     </index>
132     <index search="true" scan="true" sort="false">
133       <title lang="en">DC Identifier</title>
134       <map><name set="dc">identifier</name></map>
135       <map>
136         <attr type="1" set="bib1">7</attr>
137       </map>
138     </index>
139     <index search="true" scan="true" sort="false">
140       <title lang="en">DC Source</title>
141       <map><name set="dc">source</name></map>
142       <map>
143         <attr type="1" set="bib1">1019</attr>
144       </map>
145     </index>
146     <!--
147     <index search="true" scan="true" sort="false">
148       <title lang="en">DC Language</title>
149       <map><name set="dc">language</name></map>
150       <map>
151         <attr type="1" set="bib1">54</attr>
152       </map>
153     </index>
154     <index search="true" scan="true" sort="false">
155       <title lang="en">DC Relation</title>
156       <map><name set="dc">relation</name></map>
157       <map>
158         <attr type="1" set="bib1">1026</attr>
159       </map>
160     </index>
161     <index search="true" scan="true" sort="false">
162       <title lang="en">DC Coverage</title>
163       <map><name set="dc">coverage</name></map>
164       <map>
165         <attr type="1" set="bib1">58</attr>
166       </map>
167     </index>
168     <index search="true" scan="true" sort="false">
169       <title lang="en">DC Rights</title>
170       <map><name set="dc">rights</name></map>
171       <map>
172         <attr type="1" set="bib1">dc:rights</attr>
173       </map>
174     </index>
175     -->
176   </indexInfo>
177
178   <schemaInfo>
179     <schema identifier="http://www.loc.gov/zing/srw/dcschema/v1.0/"
180             location="http://www.loc.gov/zing/srw/dc.xsd" 
181             name="dc"
182             retrieve="true">
183       <title lang="en">Dublin Core</title>
184     </schema>
185     <!--
186     <schema identifier="http://indexdata.dk/dc-short"
187             location="" 
188             name="dc-short"
189             retrieve="true">
190       <title lang="en">Dublin Core Short Form</title>
191     </schema>
192     -->
193   </schemaInfo>
194
195  
196   <configInfo>
197
198     <!-- searchRetrieve settings -->
199     <default type="contextSet">cql</default>
200     <default type="index">all</default>
201     <default type="relation">=</default>
202     <supports type="relation">&lt;</supports> <!-- 2=1 OK -->
203     <supports type="relation">&lt;=</supports> <!-- 2=2 OK -->
204     <supports type="relation">=</supports> <!-- 2=3 OK -->
205     <supports type="relation">&gt;=</supports> <!-- 2=4 OK -->
206     <supports type="relation">&gt;</supports> <!-- 2=5 OK -->
207     <!--<supports type="relationModifier">relevant</supports> --><!-- 2=102 -->
208     <!--<supports type="relationModifier">phonetic</supports> --><!-- 2=100 -->
209     <!--<supports type="relationModifier">stem</supports> --><!-- 2=101  -->
210
211     <!-- <supports type="proximity"></supports> --> 
212           <!-- title = (house prox/distance=1/unit=word  the) -->
213     <!-- proximity modifier supported by the server or index 
214          (relation, distance, unit, ordering) -->
215     <!-- <supports type="proximityModifier"></supports> -->
216     <!-- boolean modifier supported by the server or index -->
217     <!-- <supports type="booleanModifier"></supports> -->
218     <supports type="maskingCharacter">*</supports>
219     <supports type="maskingCharacter">?</supports>
220     <supports type="emptyTerm"></supports>
221
222     <!-- sorting settings -->
223     <!-- <supports type="sort"></supports> -->
224     <!-- supported sortmodifier (ascending, missingValue, caseSensitive) -->
225     <!-- <supports type="sortModifier"></supports> -->
226
227     <!-- presentation settings --> 
228     <default type="numberOfRecords">0</default>
229     <default type="retrieveSchema">dc</default>
230     <default type="recordPacking">xml</default>
231
232     <setting type="stylesheet">docpath/sru.xsl</setting>
233     <!-- <setting type="maximumRecords">1000</setting> -->
234     <!-- <supports type="resultSets"></supports>  --> 
235
236     <!-- scan settings -->
237
238     <!-- scan operation supported -->
239     <supports type="scan"></supports>
240     <default type="numberOfTerms">20</default>
241
242     <!-- other server settings -->
243     <!-- <supports type="version">1.1</supports> -->
244     <setting type="resultSetTTL">0</setting>
245     <!-- <supports type="extraSearchData"></supports> -->
246     <!-- <supports type="extraExplainData"></supports> -->
247     <!-- <supports type="profile"></supports> -->
248   </configInfo>
249    
250 </explain>