Sample Cheshire Configuration

Follows a sample configuration file for Cheshire that includes all the different options, while still remaining a valid configuration. It is designed for an email database and is based on the configuration for Quickstep.

<dbconfig>
  <dbenv> /home/cheshire/cheshire/default </dbenv>
  <filedef type=SGML>
    <filetag> quickstep </filetag>
    <filename> /home/cheshire/cheshire/quickstep/data </filename>
    <filecont id=1 min=1 max=1> /home/cheshire/cheshire/quickstep/data/folder1.sgml </filecont>

    <explain>
      <titlestring language=ENG> Quickstep Mail Archive </titlestring>
      <description language=ENG> An archive of email messages using the Cheshire Quickstep system. </description>
      <disclaimers> Some of the email messages may contain explicit content </disclaimers>
      <news> We have upgraded to Quickstep Version 1.0.0 </news>
      <hours> Any time </hours>
      <besttime> Any time </besttime>
      <lastupdate> February 2001 </lastupdate>
      <updateinterval> <value> 12 </value> <units> hours </units> </updateinterval>
      <coverage> Complete </coverage>
      <proprietary> No </proprietary>
      <copyrighttext> All messages are owned by their respective authors </copyrighttext>
      <producercontactinfo>
        <contact_name> Robert Sanderson </hours>
        <contact_address> Special Collections and Archives, University of Liverpool, England </hours>
        <contact_email> azaroth@liv.ac.uk </hours>
      </producercontactinfo>
    </explain>

    <filedtd> /home/cheshire/cheshire/quickstep/dtd.wrapper </filedtd>
    <sgmlcat> /home/cheshire/cheshire/quickstep/catalog </sgmlcat>
    <assocfil> /home/cheshire/cheshire/quickstep/quickstep.assoc </assocfil>
    <history> /home/cheshire/cheshire/quickstep/quickstep.history </history>

    <indexes>

      <indexdef access=btree extract=keyword normal=stem>         <indexname> /home/cheshire/cheshire/quickstep/indexes/subject.index </indexname>
        <indextag> subject </indextag>
        <indexmap> <use> 4 </use> <posit> 3 </posit> <struct> 6 </struct> </indexmap>
        <stoplist> /home/cheshire/cheshire/quickstep/stoplist </stoplist>
        <indexkey>
          <tagspec>
            <ftag> ^subject$ </ftag>
          </tagspec>
        </indexkey>
      </indexdef>

      <indexdef access=btree extract=exactkey normal=none>         <indexname> /home/cheshire/cheshire/quickstep/indexes/xauthor.index </indexname>
        <indextag> xauthor </indextag>
        <indexmap> <use> 1003 </use> <posit> 3 </posit> <struct> 1 </struct> </indexmap>
        <stoplist> /home/cheshire/cheshire/quickstep/authorstoplist </stoplist>
        <indexkey>
          <tagspec>
            <ftag> ^from$ </ftag>
          </tagspec>
        </indexkey>
      </indexdef>

      <indexdef access=btree extract=date normal=unix_time>         <indexname> /home/cheshire/cheshire/quickstep/indexes/date.index </indexname>
        <indextag> date </indextag>
        <indexmap> <use> 30 </use> <posit> 3 </posit> <struct> 6 </struct> </indexmap>
        <stoplist> /home/cheshire/cheshire/quickstep/stoplist </stoplist>
        <indexkey>
          <tagspec>
            <ftag> ^fromdate$ </ftag>
          </tagspec>
        </indexkey>
      </indexdef>

    </indexes>

<-- Components for such a simple DTD are a waste -->

    <components>
      <componentdef>
        <componentname> /home/cheshire/cheshire/quickstep/component_db1 </componentname>
        <componentnorm> none </componentnorm>
        <componentstarttag>
          <tagspec>
            <ftag> ^headers$ </ftag>
          </tagspec>
        </componentstarttag>

        <componentindexes>

        <-- Index Definitions for 'Headers' Component go here -->

        </componentindexes>
      </componentdef>
    </components>

<-- For fun, We're going to cluster Authors and Subjects together -->

    <clusters>
      <clusterdef>
        <clustertag> authsubj_cluster </clustertag>
        <cluskey>
          <tagspec>
            <ftag> ^author$ </ftag>
          </tagspec>
        </cluskey>
        <stoplist> authorstoplist </stoplist>

        <clusmap>
          <from>
            <tagspec>
              <ftag> ^subject$ </ftag>
            </tagspec>
          </from>
          <to>
            <tagspec>
              <ftag> topic </ftag>
            </tagspec>
          </to>
        </clusmap>

      </clusterdef>
    </clusters>

    <dispoptions> KEEP_ALL </dispoptions>

    <displays>
      <displaydef name="TPGRS" OID="1.2.840.10003.5.105">
        <convert function ="TAGSET-G">

          <clusmap>
            <from>
              <tagspec>
                <ftag> #DOCID# </ftag>
              </tagspec>
            </from>
            <to>
              <tagspec>
                <ftag> 5 </ftag>
              </tagspec>
            </to>
            <from>
              <tagspec>
                <ftag> ^subject$ </ftag>
              </tagspec>
            </from>
            <to>
              <tagspec>
                <ftag> 1 </ftag>
              </tagspec>
            </to>
          </clusmap>

        </convert>
      </displaydef>

      <displaydef name="HTML" OID="1.2.840.10003.5.109.3">
        <convert function ="/home/cheshire/cheshire/quickstep/tohtml.tcl">
        </convert>
      </displaydef>

    </displays>

  </filedef>
</dbconfig>