Implementing and Using HtDig

Htdig is a tool that provides search functionality for your web site. Htdig includes programs that will search and index your site. It also includes the forms that provide the search interface for your users.

To install and use htdig, perform the following steps:

To install htdig, go to your "Website Add-ons" page at http://forexampledomain/cgi-bin/secure/wsaddons .

Note: When using the examples that are shown on this page, be sure to replace "forexampledomain" with your account's actual domain.

Click Install. During this installation, your site will be indexed for searching.

Confirmation that htdig search is installed will appear.

To access your htdig search page, go to http://forexampledomain/htdig/common/search.html .

If you do not like the look of the search page, it can be customized by editing one or more of the followings files: header.html, footer.html, long.html, nomatch.html, short.html, syntax.html, wrapper.html, and search.html.

These files are located in the /htdig/common directory on your site.

You can also add htdig to your web site by by inserting the following HTML code into an existing web page:

<form method="post" action="/cgi-bin/htsearch" target="_self">
  Match: 
  <select name="method">
    <option value="and">All 
    <option value="or">Any 
    <option value="boolean">Boolean 
  </select>
  Format: 
  <select name="format">
    <option value="builtin-long">Long 
    <option value="builtin-short">Short 
  </select>
  Sort by: 
  <select name="sort">
    <option value="score">Score 
    <option value="time">Time 
    <option value="title">Title 
    <option value="revscore">Reverse Score 
    <option value="revtime">Reverse Time 
    <option value="revtitle">Reverse Title 
  </select>
  <input type="hidden" name="config" value="bsdbr1">
  <input type="hidden" name="restrict" value="">
  <input type="hidden" name="exclude" value="">
  <br>
  Search: 
  <input type="text" size="30" name="words" value="">
  <input type="submit" value="Search" name="submit">
</form>

Whenever web pages are added, removed, or updated, update the htdig index. This will ensure an accurate result when searches are performed. To update htdig, go to http://forexampledomain/cgi-bin/secure/wsaddons .

Click Index.

Your site will be re-indexed with your updated pages. While the htdig index is running, your site will not have search capability.

To remove htdig, go to http://forexampledomain/cgi-bin/secure/wsaddons .

Click Uninstall.

Only the functionality of htdig will be removed. The search page located at http://forexampledomain/htdig/common/search.html will still be present, but will not function correctly.

To completely remove htdig, remove the /htdig directory and all of its contents from your site.