Compass Server 3.0 Developer's Guide
Total Page:16
File Type:pdf, Size:1020Kb
World Wide Web security URLmerchant systemChat community system server navigator TCP/IP HTML Publishing Personal Compass Server 3.0 Developer’s Guide Inter ww Proxy SSL Mozilla IStore Publishing Internet secure sockets layer mail encryption HTMLhttp://www comp.syselectronic commerce JavaScript directory server news certificate Proxy Netscape Communications Corporation (“Netscape”) and its licensors retain all ownership rights to the software programs offered by Netscape (referred to herein as “Software”) and related documentation. Use of the Software and related documentation is governed by the license agreement accompanying the Software and applicable copyright law. Your right to copy this documentation is limited by copyright law. Making unauthorized copies, adaptations, or compilation works is prohibited and constitutes a punishable violation of the law. Netscape may revise this documentation from time to time without notice. THIS DOCUMENTATION IS PROVIDED “AS IS” WITHOUT WARRANTY OF ANY KIND. IN NO EVENT SHALL NETSCAPE BE LIABLE FOR ANY LOSS OF PROFITS, LOSS OF BUSINESS, LOSS OF USE OR DATA, INTERRUPTION OF BUSINESS, OR FOR INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES OF ANY KIND, ARISING FROM ANY ERROR IN THIS DOCUMENTATION. The Software and documentation are copyright © 1997 Netscape Communications Corporation. All rights reserved. The Software includes encryption software from RSA Data Security, Inc. Copyright © 1994, 1995 RSA Data Security, Inc. All rights reserved. Portions of the Software include technology used under license from Verity, Inc. and are copyrighted. All rights reserved. The Harvest software portion of the Software was developed by the Internet Research Task Force Research Group on Resource Discovery (IRTF-RD). Copyright © 1994-1995 Mic Bowman of Transarc Corporation, Peter Danzig of the University of Southern California, Darren R. Hardy of the University of Colorado at Boulder, Udi Manber of the University of Arizona, Michael F. Schwartz of the University of Colorado at Boulder, Duane Wessels of the University of Colorado at Boulder. All rights reserved. Netscape, Netscape Navigator, Netscape ONE, and the Netscape N logo are registered trademarks of Netscape Communications Corporation in the United States and other countries. Other Netscape logos, product names, and service names are also trademarks of Netscape Communications Corporation, which may be registered in other countries. Other product and brand names are trademarks of their respective owners. The downloading, export, or reexport of the Software or any underlying information or technology must be in full compliance with all United States and other applicable laws and regulations as further described in the license agreement accompanying the Software. Any provision of Netscape Software to the U.S. Government is with restricted rights as described in the license agreement accompanying Netscape Software. Recycled and Recyclable Paper Netscape Compass Server 3.0 ©Netscape Communications Corporation 1995-1998 All Rights Reserved Printed in USA 99 98 97 10 9 8 7 6 5 4 3 2 1 Netscape Communications Corporation, 501 East Middlefield Road, Mountain View, CA 94043 Compass Server 3.0 Developer’s Guide Contents About This Book .............................................................................................vii What You Should Already Know ..................................................................viii Where to Find Information About HTML, JavaScript, and Java ................... ix Document Conventions ................................................................................... x Part 1 Customizing the End User Search Page Chapter 1 Composition of the End User Page ....................................15 Components in Browse Mode Pages .............................................................17 Components in Search-Results Pages ............................................................18 Summary of the Components in Each Mode .................................................21 Chapter 2 Templates for the End User Page .......................................22 Saving and Applying Changes to UI Templates ............................................23 Creating a New Template ..........................................................................23 Selecting a New UI Template ....................................................................24 Loading Updated Template Files ...............................................................24 Compass Server 3.0 Developer’s Guide i Chapter 3 Configuration Files for UI Templates .............................. 26 Variables in Configuration Files ..................................................................... 27 Assigning Pattern Files to Components ......................................................... 27 Determining the Order of Search Results ..................................................... 30 Determining What the Compass End User Page Lets the User Do ............. 30 Specifying Which Attributes Can Be Viewed in Hit Components ............... 31 Specifying Defaults for Basic Parameters ...................................................... 34 Determining Which Images to Use to Indicate Rankings ............................ 35 Determining What Colors to Use for Documents and Categories ............... 36 Chapter 4 Pattern Files for UI Templates ............................................ 38 What is a Pattern File? .................................................................................... 38 Using Variables ............................................................................................... 39 SOIF Attributes ............................................................................................... 40 List of Variables .............................................................................................. 41 Pattern File Summary ..................................................................................... 49 browse-mode-top and search-results-mode-top ...................................... 49 category-browse-top and category-search-results-top ............................. 50 category-browse-hit and category-search-results-hit ................................ 51 category-browse-bottom and category-search-results-bottom ................ 52 document-browse-top and document-search-results-top ........................ 52 document-browse-hit and document-search-results-hit .......................... 53 document-browse-bottom and document-search-results-bottom ........... 55 browse-bottom and search-results-bottom ............................................... 55 ii Compass Server 3.0 Developer’s Guide Chapter 5 Opening the End User Page With Query String URLs 56 Attributes for Query String URLs ................................................................... 56 Using Forms to Submit Searches ................................................................... 58 Optional Advanced Search Interfaces ...........................................................60 Chapter 6 Tutorial: Customizing the End User Page ....................... 63 Getting Ready for Development .................................................................... 64 Copying a Configuration File ......................................................................... 65 Changing the Background and Adding a Heading to Browse Pages .......... 65 Testing the Change ......................................................................................... 66 Changing the Background and Adding a Heading to Search Results Pages 66 Modifying the List of Subcategories in a Browsed Category ....................... 67 Modifying the List of Documents in a Browsed Category ........................... 72 Modifying the List of Matching Categories .................................................... 73 Modifying the List of Matching Documents .................................................. 73 Changing the End of The Page ...................................................................... 79 Finishing Up ....................................................................................................80 Chapter 7 Error Message Files .................................................................81 Part 2 Customizing Robot Behavior Chapter 8 How Netscape Compass Server Robots Work ............... 85 What is a Robot? ............................................................................................. 85 How The Robot Works .............................................................................. 85 Files that Define Robot Behavior .............................................................. 87 Setting Robot Process Parameters .................................................................. 87 The Filtering Process ...................................................................................... 88 Stages in the Filter Process ........................................................................ 89 Filter Syntax ................................................................................................ 90 Filter Directives .......................................................................................... 91 Writing or Modifying a Filter ..................................................................... 92 Compass Server 3.0 Developer’s Guide iii Chapter 9 Defining Parameters in Process.conf .............................. 95 User-Modifiable Parameters in Process.conf ................................................