Compass Server 3.0 Developer's Guide

[Contents] [Previous] [Next] [Last]

PART 1
Customizing the End User Search Page

This part of the document discusses how to customize the Compass Server End User page.

Compass Server 3.0 enables the creation of a searchable database of documents and other networked resources on one or more web sites. Users can browse through categories or perform searches on the database by using the Compass Server End User page. Usually users are not aware that they are searching a database; to all intents and purposes they are searching a web site. The following figure shows a sample Compass Server End User page.

Figure P1.1    The End User page

Each time the Compass Server End User page updates, its content changes depending on whether the user is browsing or searching. In general, if the user is browsing a category, the page shows the subcategories in the browsed category. If the user submitted a search query, the page shows the results of the search.

The exact appearance of the End User page is ultimately determined by the currently selected user interface template (UI template).

The Compass Server has a variety of UI templates that you can use to determine the appearance of the Compass Server End User page. For example you could pick a template that presents a page that only allows the user to do simple searches, or you could pick a template that allows the user to browse through categories in addition to doing simple or advanced searches.

As well as using the pre-defined templates, you can create your own templates. The best way to do this is to copy existing templates and modify them to suit your needs. By modifying the templates, you can customize the Compass Server End User page to your exact requirements using HTML or JavaScript. You can make modifications as simple as changing the color of the page's background or as complex as using a completely different format for displaying search results.

Each template is made up of a configuration file and a set of pattern files. Each configuration file lists the pattern files that are assembled together to make up the Compass Server End User page. Each pattern file defines the content of a piece, or component, of the page. To customize the page, you need to edit the configuration file and the pattern files.

This part contains the following chapters:

Chapter 1. Composition of the End User Page

Overview of the sections and modes in the end user page.

Chapter 2. Templates for the End User Page

Overview of the templates used in the end user page.

Chapter 3. Configuration Files for UI Templates

Discussion of the configuration and pattern files used by the templates.

Chapter 4. Pattern Files for UI Templates

All about pattern files.

Chapter 5. Opening the End User Page With Query String URLs

How to invoke the end user page using query string URLs.

Chapter 6. Tutorial: Customizing the End User Page

A step-by-step tutorial to customizing the appearance of the end user page.

Chapter 7. Error Message Files

How to modify the error messages that appear when a request to connect to the Compass Server fails.


[Contents] [Previous] [Next] [Last]

Last Updated: 02/07/98 20:49:00

Any sample code included above is provided for your use on an "AS IS" basis, under the Netscape License Agreement - Terms of Use