examples/oai-pmh/conf/explain.xml

   1 <?xml version="1.0" encoding="UTF-8"?>
   2
   3
   4 <!-- this file configures the SRU/SRW explain response -->
   5 <!-- see: http://explain.z3950.org/dtd/commentary.html -->
   6 <!-- validate this using zeerex-2.0.xsd -->
   7 <!-- Extensions see: http://explain.z3950.org/dtd/extensions.html -->
   8
   9 <explain xmlns="http://explain.z3950.org/dtd/2.0/">
  10
  11   <serverInfo protocol="SRW/SRU/Z39.50">
  12
  13     <host>localhost</host>
  14
  15     <port>9999</port>
  16
  17     <!-- <database numRecs="1314" lastUpdate="2006-03-15 09-05-33">
  18          Default</database> -->
  19     <database>Default</database>
  20
  21     <!--
  22         <authentication>
  23         <user>azaroth</user>
  24         <group>agroup</group>
  25         <password>squirrelfish</password>
  26         </authentication>
  27     -->
  28   </serverInfo>
  29
  30   <databaseInfo>
  31
  32     <title lang="en" primary="true">OAI record SRU/SRW/Z39.50 server</title>
  33
  34     <description lang="en" primary="true">
  35       OAI harvested article and preprint metadata records
  36     </description>
  37
  38     <author>
  39       Marc Cromme, © Index Data Aps,
  40       http://www.indexdata.dk
  41     </author>
  42
  43     <contact>Marc Cromme, marc(at)indexdata(dot)com</contact>
  44
  45     <!--<langUsage codes="en fr">
  46         The records are in English and French.
  47         </langUsage>  -->
  48
  49     <history>
  50       Part of the open source Zebra information retrieval database
  51       example configurations, see http://www.indexdata.com/zebra
  52     </history>
  53
  54     <implementation  identifier="zebra" version="2.0">
  55       <title>Index Data YAZ/ZEBRA http://www.indexdata.dk/zebra</title>
  56     </implementation>
  57
  58     <links>
  59       <link type="z39.50">http://localhost:9999</link>
  60       <link type="srw">http://localhost:9999</link>
  61       <link type="sru">http://localhost:9999</link>
  62     </links>
  63
  64   </databaseInfo>
  65
  66   <!--
  67   <metaInfo>
  68     <dateModified>2002-03-29 19:00:00</dateModified>
  69     <aggregatedFrom> z39.50r://gondolin.hist.liv.ac.uk:210/IR-Explain-1?
  70                    id=ghlau-1;esn=F;rs=XML </aggregatedFrom>
  71     <dateAggregated>2002-03-30 06:30:00</dateAggregated>
  72   </metaInfo>
  73   -->
  74
  75
  76   <indexInfo>
  77     <set name="cql" identifier="info:srw/cql-context-set/1/cql-v1.1">
  78       <title>CQL Standard Set</title>
  79     </set>
  80     <set name="rec" identifier="info:srw/cql-context-set/2/rec-1.0">
  81       <title>Record Standard Set</title>
  82     </set>
  83     <set name="oai" identifier="info:srw/cql-context-set/1/oai-v1.1">
  84       <title>Open Archive Metadata Set</title>
  85     </set>
  86     <set name="dc" identifier="info:srw/cql-context-set/1/dc-v1.1">
  87       <title>Dublin Core Set</title>
  88     </set>
  89
  90     <!-- CQL standard index -->
  91     <index search="true" scan="true" sort="false">
  92       <title lang="en">CQL Server Choice</title>
  93       <map><name set="cql">serverChoice</name></map>
  94       <map>
  95         <attr type="1" set="bib1">any</attr>
  96       </map>
  97     </index>
  98     <index search="true" scan="true" sort="false">
  99       <title lang="en">CQL All</title>
 100       <map><name set="cql">all</name></map>
 101       <map>
 102         <attr type="1" set="bib1">any</attr>
 103       </map>
 104     </index>
 105
 106     <!-- Record ID index -->
 107     <index search="true" scan="true" sort="false">
 108       <title lang="en">Record ID</title>
 109       <map><name set="rec">id</name></map>
 110       <map>
 111         <attr type="1" set="bib1">oai_identifier</attr>
 112         <attr type="4" set="bib1">3</attr>
 113       </map>
 114     </index>
 115
 116     <!-- Open Archive Metadata indexes -->
 117     <index search="true" scan="true" sort="false">
 118       <title lang="en">OAI Identifier</title>
 119       <map><name set="oai">identifier</name></map>
 120       <map>
 121         <attr type="1" set="bib1">oai_identifier</attr>
 122         <attr type="4" set="bib1">3</attr>
 123       </map>
 124     </index>
 125     <index search="true" scan="true" sort="false">
 126       <title lang="en">OAI Datestamp</title>
 127       <map><name set="oai">date</name></map>
 128       <map>
 129         <attr type="1" set="bib1">oai_datestamp</attr>
 130         <attr type="4" set="bib1">3</attr>
 131       </map>
 132     </index>
 133     <index search="true" scan="true" sort="false">
 134       <title lang="en">OAI Set Specification</title>
 135       <map><name set="oai">set</name></map>
 136       <map>
 137         <attr type="1" set="bib1">oai_setspec</attr>
 138         <attr type="4" set="bib1">3</attr>
 139       </map>
 140     </index>
 141
 142     <!-- Dublin Core Indexes -->
 143     <index search="true" scan="true" sort="false">
 144       <title lang="en">DC Title</title>
 145       <map><name set="dc">title</name></map>
 146       <map>
 147         <attr type="1" set="bib1">dc_title</attr>
 148       </map>
 149     </index>
 150     <index search="true" scan="true" sort="false">
 151       <title lang="en">DC Creator</title>
 152       <map><name set="dc">creator</name></map>
 153       <map>
 154         <attr type="1" set="bib1">dc_creator</attr>
 155       </map>
 156     </index>
 157     <index search="true" scan="true" sort="false">
 158       <title lang="en">DC Subject</title>
 159       <map><name set="dc">subject</name></map>
 160       <map>
 161         <attr type="1" set="bib1">dc_subject</attr>
 162         <!-- <attr type="6" set="bib1">3</attr> -->
 163       </map>
 164     </index>
 165     <index search="true" scan="true" sort="false">
 166       <title lang="en">DC Description</title>
 167       <map><name set="dc">description</name></map>
 168       <map>
 169         <attr type="1" set="bib1">dc_description</attr>
 170       </map>
 171     </index>
 172     <index search="true" scan="true" sort="false">
 173       <title lang="en">DC Publisher</title>
 174       <map><name set="dc">publisher</name></map>
 175       <map>
 176         <attr type="1" set="bib1">dc_publisher</attr>
 177         <!-- <attr type="6" set="bib1">3</attr> -->
 178       </map>
 179     </index>
 180     <index search="true" scan="true" sort="false">
 181       <title lang="en">DC Contributor</title>
 182       <map><name set="dc">contributor</name></map>
 183       <map>
 184         <attr type="1" set="bib1">dc_contributor</attr>
 185       </map>
 186     </index>
 187     <index search="true" scan="true" sort="false">
 188       <title lang="en">DC Date</title>
 189       <map><name set="dc">date</name></map>
 190       <map>
 191         <attr type="1" set="bib1">dc_date</attr>
 192         <attr type="4" set="bib1">3</attr>
 193       </map>
 194     </index>
 195     <!--
 196     <index search="true" scan="true" sort="false">
 197       <title lang="en">DC Type</title>
 198       <map><name set="dc">type</name></map>
 199       <map>
 200         <attr type="1" set="bib1">dc_type</attr>
 201       </map>
 202     </index>
 203     -->
 204     <index search="true" scan="true" sort="false">
 205       <title lang="en">DC Format</title>
 206       <map><name set="dc">format</name></map>
 207       <map>
 208         <attr type="1" set="bib1"></attr>
 209         <attr type="4" set="bib1">3</attr>
 210       </map>
 211     </index>
 212     <index search="true" scan="true" sort="false">
 213       <title lang="en">DC Identifier</title>
 214       <map><name set="dc">identifier</name></map>
 215       <map>
 216         <attr type="1" set="bib1">dc_identifier</attr>
 217         <attr type="4" set="bib1">3</attr>
 218       </map>
 219     </index>
 220     <index search="true" scan="true" sort="false">
 221       <title lang="en">DC Source</title>
 222       <map><name set="dc">source</name></map>
 223       <map>
 224         <attr type="1" set="bib1">dc_source</attr>
 225         <attr type="4" set="bib1">3</attr>
 226       </map>
 227     </index>
 228     <index search="true" scan="true" sort="false">
 229       <title lang="en">DC Language</title>
 230       <map><name set="dc">language</name></map>
 231       <map>
 232         <attr type="1" set="bib1">dc_language</attr>
 233       </map>
 234     </index>
 235     <index search="true" scan="true" sort="false">
 236       <title lang="en">DC Relation</title>
 237       <map><name set="dc">relation</name></map>
 238       <map>
 239         <attr type="1" set="bib1">dc_relation</attr>
 240         <attr type="4" set="bib1">3</attr>
 241       </map>
 242     </index>
 243     <index search="true" scan="true" sort="false">
 244       <title lang="en">DC Source</title>
 245       <map><name set="dc">source</name></map>
 246       <map>
 247         <attr type="1" set="bib1">dc_source</attr>
 248         <attr type="4" set="bib1">3</attr>
 249       </map>
 250     </index>
 251     <!--
 252     <index search="true" scan="true" sort="false">
 253       <title lang="en">DC Coverage</title>
 254       <map><name set="dc">coverage</name></map>
 255       <map>
 256         <attr type="1" set="bib1">dc_coverage</attr>
 257       </map>
 258     </index>
 259     -->
 260     <index search="true" scan="true" sort="false">
 261       <title lang="en">DC Rights</title>
 262       <map><name set="dc">rights</name></map>
 263       <map>
 264         <attr type="1" set="bib1">dc_rights</attr>
 265         <!-- <attr type="6" set="bib1">3</attr> -->
 266       </map>
 267     </index>
 268
 269   </indexInfo>
 270
 271   <schemaInfo>
 272
 273     <schema identifier="http://www.loc.gov/zing/srw/dcschema/v1.0/"
 274             location="http://www.loc.gov/zing/srw/dc.xsd"
 275             name="dc"
 276             retrieve="true">
 277       <title lang="en">Dublin Core</title>
 278     </schema>
 279
 280     <schema identifier="http://indexdata.dk/dc-short"
 281             location=""
 282             name="zebra::data"
 283             retrieve="true">
 284       <title lang="en">Open Archives Initiative</title>
 285     </schema>
 286
 287     <schema identifier="http://indexdata.dk/zebra/xslt/retrieve"
 288             location=""
 289             name="zebra::meta"
 290             retrieve="true">
 291       <title lang="en">Zebra Meta</title>
 292     </schema>
 293
 294   </schemaInfo>
 295
 296
 297   <configInfo>
 298
 299     <!-- default context set -->
 300     <default type="contextSet">cql</default>
 301
 302     <default type="index">all</default>
 303
 304     <!-- default relation -->
 305     <default type="relation">=</default>
 306     <supports type="relation">&lt;</supports> <!-- 2=1 OK -->
 307     <supports type="relation">&lt;=</supports> <!-- 2=2 OK -->
 308     <supports type="relation">=</supports> <!-- 2=3 OK -->
 309     <supports type="relation">&gt;=</supports> <!-- 2=4 OK -->
 310     <supports type="relation">&gt;</supports> <!-- 2=5 OK -->
 311     <!-- <supports type="relation">&lt;&gt;</supports> --><!-- 2=6 DEAD !!! -->
 312     <!-- <supports type="relation">all</supports> --><!-- 2=3 OK -->
 313     <!-- <supports type="relation">any</supports> --><!-- 2=3 OK -->
 314
 315     <supports type="relationModifier">relevant</supports><!-- -->
 316     <supports type="relationModifier">phrase</supports><!-- -->
 317
 318
 319
 320
 321     <!-- masking character supported (* or ?) -->
 322     <supports type="maskingCharacter">*</supports>
 323     <supports type="maskingCharacter">?</supports>
 324
 325     <!-- zebra happily accepts empty terms, if escaped in quotes -->
 326     <supports type="emptyTerm"></supports>
 327
 328     <!-- presentation settings -->
 329
 330     <!-- default number of records that a server will return at once  -->
 331     <default type="numberOfRecords">0</default>
 332
 333     <!-- default schema used for retrieved records -->
 334     <default type="retrieveSchema">oai</default>
 335
 336     <!-- default record packing returned (string or xml) -->
 337     <default type="recordPacking">xml</default>
 338
 339     <!-- maximum number of records that a server will return at once -->
 340     <!-- <setting type="maximumRecords">1000</setting> -->
 341
 342     <!-- support result sets (Empty) -->
 343     <!-- <supports type="resultSets"></supports>  -->
 344
 345
 346     <!-- scan settings -->
 347
 348     <!-- scan operation supported -->
 349     <supports type="scan"></supports>
 350
 351     <!-- default number of terms to be returned in scan -->
 352     <default type="numberOfTerms">20</default>
 353
 354     <!-- number of seconds that a result set will be maintained for -->
 355     <setting type="resultSetTTL">0</setting>
 356
 357   </configInfo>
 358
 359 </explain>