Manual for LocalSearch 1.0

Problems or suggestions : ulrikm@yahoo.com
Please please please send me a mail if you are using this product
- I would like to keep track of how many people are using it.

Visit my website for updates : http://www.oocities.org/ulrikm


Intranet: please read Runningthe program on an intranet after Requirements.

Contents:
    Intro
    Requirements
    Setting the Browser
    Setting the Paths
    Runningthe program on an intranet
    Runningthe program on a home computer
    Other options
    Problems


To Top
Intro:

LocalSearch is a search engine mainly designed for intranets, but canalso be used to search files on your home computer.
It searches through all ".txt" and ".html" / ".htm" documents in thedirectories you specify as "Paths" and all subdirectories.
I use it myself to search the Java documentation and shared files onour intranet - so that I e.g. can run a search for all documents containingthe words "Applet" and "Web" or "Winzip".

To do this I specify "C:\Programming\Java\jdk\docs\"and //DKIK-MONITOR/SHARED/ as Paths and "C:\ProgramFiles\netscape\Program\netscape.exe" as the Browser. Theprogram will then use netscape
to display the documents when you double-click on it's name.

When searching, the program will go through all ".txt" and ".html" /".htm" documents in subdirectories to "C:\Programming\Java\jdk\docs\"and "//DKIK-MONITOR/SHARED/". You can add as many Pathsas you like

When you run the setup program all files will be placed in "C:\UMSoft\LocalSearch\".
Info on how to search is available as "Help" in the program.


To Top
Requirements:

Windows 95/98/NT operating system.
Java Runtime Environment - download it here: http://java.sun.com/products/jdk/1.1/jre/index.html
     For installation instructions on jre pleaseread the setup-jre.txt in C:\UMSoft\LocalSearch (or the
    "classes" directory in the uzippedinstallation package if you have not run "setup.bat" yet)
 
 


ToTop


Setting the Browser

The path in "browser.txt" is only there asan example - put in your own.

The Browser is the program you use to display the documents. It willbeused when you double-click on
a file on the generated list.
I think that the default path to netscape is "C:\Program Files\netscape\Program\netscape.exe".
To tell the program what Browser to use, just insert a line describingthe path in "browser.txt".

The Browser does not necessarily have to be an internet browser - itcan be any program that is able to display
".txt" and ".html" / ".htm" documents - e.g. Word, Notepad, Wordpad,etc.
 
 


ToTop
Setting the Paths

The paths in "paths.txt" are only there asan example - put in your own.
The Paths are the directories where the search will start. Theprogram will search through all files in subdirectories as well.
E.g. if you are using it for a home computer and want to be able tosearch all ".txt" and ".html" / ".htm" documents on drive C, you just add"C:\" on its own line in "paths.txt".

On an intranet you reference the directory "ADirectory" on "AComputer"this way:
"//AComputer/ADirectory/"

A paths.txt file where both directories above must be searched lookslike this:

//AComputer/ADirectory/
C:\

NB! Paths must end on "/" or "\"
 
 


ToTop
Running the program on an Intranet

You will need to install the program on all computers on the networkthat will use LocalSearch.
You should make the following changes to the setup files beforeinstallation:

Errors are reported to "errors.txt".
In order to easily make changes to the paths or the help.txtfile or view the errors.txt logfile, you could specify
a "main directory". Just put the path to the directory in "maindir.txt"(in the "classes" directory
in the unzipped setup package).
E.g.
//MAIN_COMPUTER/LocalSearch/

If you don't, the main directory will be the local folder on the clientcomputer where
you install the program. NB! Please remember that all computers musthave FULL access to
the main directory - otherwise writing an errors.txt file willfail.

All that needs to be in the main directory is the "paths.txt"file and the "help.txt" file - "errors.txt" will be created
if errors occur. If you have alot of errors you should delete the errors.txtfile every now and then in order
not to slow down the program.
 
 


ToTop
Running the program on a Home Computer

The Setup program will place the files in C:\UMSoft\LocalSeach.If the JRE has been set up properly and the browser and path has been set,you just double click the LocalSearch.bat icon. You might want tocreate shortcuts to this file - just right-click and drag the file whereyou want the shortcuts placed.

Errors are reported to "errors.txt".
 
 


To Top
Other info:

Errors are reported:
    -if the path is not valid (A_Computer may be offline)
    -if a file is too big to load : It should alwaysbe able to load files smaller than 1.7 Mega byte (1.700.000 characters).
    -if an unspecified Input error occurs

To uninstall, just deletethe C:\UMSoft\LocalSearch directory and any shortcuts youhave created.
You can delete C:\UMSoft as well if you don't haveany other UMSoft programs on your computer.

When the user presses the "Help"button the help.txt file is displayed. You can modify this file if youdon't find
the information provided adequate.

Sources for the program isin C:\UMSoft\LocalSearch\src.
Documentation for the sourcesare in C:\UMSoft\LocalSearch\src\documentation.
 
 


To Top
Problems/Feedback

Please mail me if there are problems or you have any suggestions:ulrikm@yahoo.com
Thanks for using LocalSearch