Cheshire Configuration - Explain

[Back to the Main File ] [ Up to the contents ] [ On to Indexes ]

Explain is the tag which wraps around the explain information. This information is made available via the Z39.50 server on requests for information about the database. Many other Z39.50 servers do not support this Explain syntax, however the Cheshire client (among others) makes good use of it, so including it will be of use.

This is the title for the database, as opposed to the name by which it is searched. An example might be:
<titlestring> The Cheshire Mailing List Archives </titlestring>

A description of the database. Blank lines and line breaks will typically be kept by the client, and plain text URLs converted into appropriate hyperlinks.
This database contains the archives of the Cheshire Mailing list. The records are emails sent to the list over its existence.

Disclaimers is similar to description, but holds any disclaimers that might be necessary to display that relate to the database.

Similarly, the news field holds news about the database.

Hours contains a message about when the database is available.

This field contains a message concerning when the best time to access the database is.

This field is used for recording when the last update occured to the database.

Slightly more complex, the updateinterval field contains information concerning how often the database is updated. However this is stored in two sub fields:
  value: This contains a number
  units: This contains the name of the unit used.

So, for example, to say three months:
<updateinterval> <value> 3 </value> <units> months </units>

This field is to record if the database is complete or not. For example, an archive of an email list would be complete if it contained all the emails ever sent to the list.
<coverage> Complete </coverage>

This field should contain either YES or NO, and signifies whether the database records used are proprietary or not. A publically available DTD would not be proprietary, while an in house one would be.
<proprietary> NO </proprietary>

This contains text to be displayed concerning the copyright of the database and its records.
<copyrighttext> All records are owned by their respective authors </copyrighttext>

This field contains information about how to get in contact with the producer of the database. It contains five possible subtags:
  contact_name:The name of the producer
  contact_description:A description of the producer
  contact_address:A physical address to send things to
  contact_phone:The phone number of the producer
  contact_email:An email address to send messages to

<contact_name> Robert Sanderson </contact_name>
<contact_description> Grad Student Researcher </contact_description> <contact_address> Special Collections and Archives, Liverpool University</contact_address>
<contact_phone> (+44) (0)151 794 3142 </contact_phone>
<contact_email> </contact_email>

Similar to the above, this field contains information about the suppliers of the data if different from the producer of the database. The information is contained in the same subfields.