What You Should Already Know

Where to Find Information About HTML, JavaScript, and Java

Document Conventions

Part 1 Customizing the End User Search Page

Components in Browse Mode Pages

Components in Search-Results Pages

Summary of the Components in Each Mode

Saving and Applying Changes to UI Templates

Creating a New Template

Selecting a New UI Template

Loading Updated Template Files

Variables in Configuration Files

Assigning Pattern Files to Components

Determining the Order of Search Results

Determining What the Compass End User Page Lets the User Do

Specifying Which Attributes Can Be Viewed in Hit Components

Specifying Defaults for Basic Parameters

Determining Which Images to Use to Indicate Rankings

Determining What Colors to Use for Documents and Categories

What is a Pattern File?

Using Variables

SOIF Attributes

List of Variables

Pattern File Summary

browse-mode-top and search-results-mode-top

category-browse-top and category-search-results-top

category-browse-hit and category-search-results-hit

category-browse-bottom and category-search-results-bottom

document-browse-top and document-search-results-top

document-browse-hit and document-search-results-hit

document-browse-bottom and document-search-results-bottom

browse-bottom and search-results-bottom

Attributes for Query String URLs

Using Forms to Submit Searches

Optional Advanced Search Interfaces

Getting Ready for Development

Copying a Configuration File

Changing the Background and Adding a Heading to Browse Pages

Testing the Change

Changing the Background and Adding a Heading to Search Results Pages

Modifying the List of Subcategories in a Browsed Category

Modifying the List of Documents in a Browsed Category

Modifying the List of Matching Categories

Modifying the List of Matching Documents

Changing the End of The Page

Finishing Up

Part 2 Customizing Robot Behavior

What is a Robot?

How The Robot Works

Files that Define Robot Behavior

Setting Robot Process Parameters

The Filtering Process

Stages in the Filter Process

Filter Syntax

Filter Directives

Writing or Modifying a Filter

User-Modifiable Parameters in Process.conf

Sample process.conf File

How To Write Completion Scripts

Monitoring the cmdHook Execution

Preparing Your Completion Script to Appear in the Administration Interface

Sources and Destinations

Sources Available at the Setup Stage

Sources Available at the MetaData Filtering Stage

Sources Available at the Enumeration, Generation, and Shutdown Stages

Enable Parameter

Setup Functions

Filtering Functions

Filtering Support Functions

Enumeration Functions

Generation Functions

Shutdown Functions

What is the Robot Plug-in API?

The Robot Application Function Header Files

Header File Hierarchy

Header File Contents

Writing Robot Application Functions

RAF Prototype

Writing Functions for Specific Directives

Passing Parameters to Robot Application Functions

Working with Parameter Blocks

Getting Information About the Resource Being Processed

Returning a Response Status Code

Reporting Errors to the Robot Log File

RAF Definition Example

Compiling and Linking your Code

Loading Your Shared Object

Using your New Robot Application Functions

Part 3 Using C to Send Requests to the Compass Server

What's In the RDM SDK?

Chapter Summary

What is SOIF?

Using the SOIF API

An Introductory Example

Getting the Compass Server Database Contents as a SOIFStream

SOIF API

Alphabetical Function List

SOIF Structure

Attribute-Value Pair Routines

Multi-valued Attribute Routines

SOIF Stream Routines for Parsing and Printing SOIFs

Filtering SOIF Objects

Memory Buffer Management

What is RDM?

RDM Format Syntax

RDM Body

About the RDM API

Example of Submitting a Query

Running the Example

API Reference

Finding the RDM Version

Creating and Freeing RDM Structures

RDMHeader

RDMQuery

Other RDM Structures

Part 4 Using Java to Access the Compass Server Database

The Compass Server Java SDK

Downloading and Installing the Compass Server Java SDK

Running the Demo Applications

Using Java To Access the Compass Server Database

Creating a Search Object

Executing A Query

Getting the Results of a Query

Working Through An Example Search Application

Using Java To Add Entries to the Compass Server Database

Last Updated: 02/07/98 20:48:57

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