ð 

AppleShare IP Sherlock Plugin Read Me


CONTENTS

What Is The Sherlock Plugin?
How Do I Install The Sherlock Plugin?
How Do I Search My Web Site?
How Do I Customize The Output Of The Sherlock Plugin?


What Is the Sherlock Plugin?

The Sherlock Plugin is a Web server plug-in that allows Web browsers to do a find-by-content search of your Web site.

How Do I Install The Sherlock Plugin?

To install the Sherlock Plugin, place it in your serverÕs ÒPlug-insÓ folder and start your Web server.

How Do I Search My Web Site?

Before your Web site can be searched, you need to index the volume where your Web site resides.  You index a volume by using the ÒSherlockÓ application that comes with Mac OS 8.5 and later.

Once you have indexed your Web site's volume, you can use a Web browser to search your Web site for documents containing a given word.  To do this, you would enter the URL Òhttp://YourServer/.sherlockÓ.  You will see a search form with a ÒSearchÓ button and a text edit field.  Type the word you wish to search for, and then click the ÒSearchÓ button to start the search.  The Sherlock Web plugin will return a list of links to file names that contain the word you searched for.  Only items to which you have read or read/write access privileges will be returned.

You can also conduct a search by using the ÒSherlock.htmlÓ file.  Place this file in the folder of your choice and access it the normal way with URL Òhttp://YourServer/YourFolder/Sherlock.htmlÓ.  You can customize the ÒSherlock.htmlÓ file to suit your own needs.  There is a hidden field with the name "maxhits" which set the maximum number of hits that will be returned by the Sherlock plugin.  By default it's value is 100.  You may set it to any value from 1 to 100.  You may also rename the file as you wish.

Note: The Sherlock application does not resolve alias files when indexing documents.  Therefore, when you conduct a search, alias file names will not be returned even though they might otherwise resolve to a document that contains the word for which you are searching.

How Do I Customize The Output Of The Sherlock Plugin?

You can customize the output of the Sherlock plugin by editing the ÒSherlockOutput.htmlÓ file.  If a ÒSherlockOutput.htmlÓ file is found in the same folder as the ÒSherlock.htmlÓ file, the results of a search will be written into the ÒSherlockOutput.htmlÓ file beginning at the location of the <sherlockout> tag.  If there is no ÒSherlockOutput.htmlÓ file in the same folder as the ÒSherlock.htmlÓ file, then the plugin will look for a ÒSherlockOutput.htmlÓ file in the Web siteÕs root folder.  If found, that file will be used to display the output.  If no ÒSherlockOutput.htmlÓ file is found, the Sherlock plugin will return the results of a search as a simple list of links to the Web client.




© 1999 Apple Computer, Inc. All rights reserved. Apple, the Apple logo, AppleShare, Mac, Macintosh, Sherlock and MacOS are trademarks of Apple Computer, Inc., registered in the United States and other countries.  PowerPC is a trademark of International Business Machines Corporation, used under license therefrom.  All other product names are trademarks or registered trademarks of their respective holders.