Main -> Documentation -> WebZ System Administration -> WebZ and Vocabulary-Assisted Searching -> Configuring a Database for Vocabulary-Assisted Searching Without a thesaurus Database

Configuring a Database for Vocabulary-Assisted Searching Without a Thesaurus Database

 

Introduction

This topic is a step-by-step procedure that explains how to configure a database to enable vocabulary-assisted searching without a thesaurus database. See Scenario 3 in both Vocabulary-Assisted Searching Process Flow and Vocabulary-Assisted Searching in the WebZ Out-of-the-Box Interface for detailed information about the process flow and screens involved in this activity, respectively.

Note: Throughout this procedure, <WebZ_root> refers to the location of your SiteSearch environment.

 

Procedure Summary

This procedure covers the following activities:

  • Editing the database's configuration file to enable vocabulary assisted-searching
  • Ensuring that vocabulary-assisted searching is enabled in your interface style files
  • Ensuring that your interface display gadgets configuration files contain a gadget for displaying term lists
  • Ensuring that your interface style files contain references to the appropriate gadgets, images, and HTML pages for vocabulary-assisted searching
  • Editing formatting configuration file for displaying term lists, as needed.

 

Procedure Steps

1.  Edit the database configuration file to configure it for vocabulary-assisted searching:

  1. Add a new section to the file as follows:
  2. [TermFinder]
    TermListSearchIndex = indexname
    SampleSize = n
    TermFinderSearchIndex = indexname
    UseAdjacencyInTFSearch = true OR false

    where:

  1. Add a line in the [formats] section for the formatting configuration file that contains a display specification for formatting the term list. The example below references FSMarcRTLFormat.ini, which can probably be used with minor modifications for most FirstSearch databases:
    termlist = format/obiv1/FSMarcRTLFormat.ini
    

    Another formatting configuration file that works well for many other citation and catalog-type databases is <WebZ_root>/format/obiv1/MarcRTLFormat.ini. See Term List Formatting Configuration Files for more information.

2.  Check your interface style files to make sure that the search screen (<WebZ_root>/htdocs/obiv1/html/search.html in the WebZ Out-of-the-Box Interface (OBI), version 1) allows patrons to access the Term Finder screen.

For example, if you use the SearchTabbar gadget (ORG.oclc.gadgets.SearchTabbar) to add tabs to the search screen, add the following line to the [TabBar] section of the interface style file:

termfinder = database
3.. Ensure that your interface style files contain references to the gadgets, images, and HTML pages you are using to display the term finder, and term list screens. Click here for more information.

4.  Ensure that your interface display gadgets configuration file(s) (<WebZ_root>/ini/interface/obiv1/frameDisplayGadgets.ini and noframeDisplayGadgets.ini in the OBI, version 1) contain references to the display gadgets used for the term list.

In the OBI, version 1, this gadget is ORG.oclc.gadgets.TermListDisplay and its section in the interface display gadgets configuration files is as follows:

[TermListDisplay]
gadget = ORG.oclc.gadgets.TermListDisplay
fmt = termlist
dataWrapper = termlistHtml
tempdb = true

The dataWrapper specification for the [termlistHtml] section referenced in [TermListDisplay] is:

[termListHtml]
sectionheader <tr><td colspan="3" valign="middle" align="left">\n
sectiontrailer = </td></tr>\n
rowstart = <tr>\n<td valign="middle"align="left"> \                
&StyleTable.fonts.smallRecordText;
betweenrows = </font></td>\n</tr>\n<tr>\n \
<td colspan="2" align="left"> &nbsp;</td>\n<td> betweencolumns = </td>\n<td align="left"> \
&StyleTable.fonts.defaultRecordText; rowend = </td>\n</tr>\n lineBreak = \n<br> ThesaurusUsedForBeforeLabel = <table>\n<tr>\n<td valign="top"> \ \n&StyleTable.fonts.smallRecordText;<i> ThesaurusUsedForAfterLabel = : </i></td>\n<td> \
&StyleTable.fonts.smallRecordText; ThesaurusUsedForSeparator = ;&nbsp; ThesaurusUsedForTrailer = </font></td>\n</tr>\n</table>/n

For more information about the role of interface display gadget files in formatting, see Display Formatting Configuration Files.

5.  Modify the formatting configuration file for displaying the term list. You should generally only have to modify the field specifications so that they refer to the correct fields and/or subfields. See Term List Formatting Configuration Files for information about this file and Formatting Specifications for more general information about WebZ's rules-based formatting.


See Also

Vocabulary-Assisted Searching Process Flow
Database Configuration Files
Interface Style Configuration Files - Sections and Variables


[Main][Documentation][Support][Technical Reference][Community][Glossary][Search]

Last Modified: