examples/oai-pmh/conf/explain.xml

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