Compass Server 3.0 Developer's Guide

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

Chapter 1
Composition of the 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 1.1    The End User page

The Compass Server End User page has two basic modes of appearance: browse mode and search-results mode.

The mode is determined by how the user reached the page, not what the user can do in the page. (This is a very important, if somewhat subtle, distinction.)

The browse mode and search-results mode often share aspects of their appearance. Often pages using either browse or search-results mode allow the user to both search and browse.

Each mode in turn is made up of several component parts. Each mode has a top and bottom component, which determine the appearance of the top and bottom of the pages. Each mode has additional components that provide the content for the rest of the sections in the page.

Components in Browse Mode Pages

The top (first) component in a browse mode page is the browse-top component, and the bottom (last) component is the browse-bottom component.

As mentioned already, the Compass Server End User page uses browse mode whenever the user clicks a category. A browse mode page usually lists the subcategories in the selected category, and also any documents in that category.

The list of subcategories has three components: the top of the list (such as a heading or introduction), the entries in the list, and the bottom of the list (such as a closing remark or a link to the next page.) These components are known as the category-browse-top, category-browse-hit, and category-browse-bottom components.

Similarly the list of documents in the category has three components: the top of the list, the entries in the list, and the bottom of the list. These are known as the document-browse-top, document-browse-hit, and document-browse-bottom components.

Figure 1.2    Components in a browse mode page

Components in Search-Results Pages

The top (first) component in a search-results mode page is the search-top component, and the bottom (last) component is the search-bottom component.

The Compass End User page uses search-results mode to display the results of a search. The search-results mode page usually displays a list of categories that matched the search criteria and a list of documents that matched the search criteria.

The list of categories has three components: the top of the list (such as a heading or introduction), the entries in the list, and the bottom of the list (such as a closing remark or a link to the next page.) These components are known as the category-match-top, category-match-hit, and category-match-bottom components.

Similarly the list of documents that match the search criteria has three components: the top of the list, the entries in the list, and the bottom of the list. These are known as the document-search-top, document-search-hit, and document-search-bottom components.

Figure 1.3    Components in a search-results mode page

Summary of the Components in Each Mode

Table 1.1 lists the components used by browse mode and search-results mode pages.

Table 1.1. Components in Browse and Search-results Mode
Browse Mode Search-Results Mode
When is this mode used? When the user first visits the Compass Server End User page, and also whenever the user clicks a category.

To display the results of a search submitted by the user.

What does this mode usually show? A list of subcategories in a category, and a list of documents in the category.

A list of categories that match the search criteria and a list of documents that match the search criteria.

What components does this mode use? browse-top

category-browse-top

category-browse-hit (one for each category)

category-browse-bottom

document-browse-top

document-browse-hit (one for each document)

document-browse-bottom

browse-bottom

search-results-top

category-match-top

category-match-hit (one for each category)

category-match-bottom

document-match-top

document-match-hit (one for each document)

document-match-bottom

search-bottom


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

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

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