Apex Search Engine Information

This Search Engine is not a product of Rational Software and therefore any difficulties resulting from the use of this Search Engine are not covered by any support agreement held between the user and Rational Software. This Search Engine was created by students at the University of Technology Sydney , Australia.

 
DISCLAIMER
THE MATERIAL AND/OR SOFTWARE IS PROVIDED ‘AS IS’. RATIONAL AND ITS THIRD PARTY LICENSORS DISCLAIM ALL WARRANTIES EXPRESS OR IMPLIED INCLUDING, WITHOUT LIMITATION, THE WARRANTY OF MERCHANTABILITY, NON-INFRINGEMENT, TITLE OR FITNESS FOR A PARTICULAR PURPOSE OR ARISING OUT OF THE COURSE OF DEALING, USAGE OR TRADE PRACTICE, CONTENT OF THE MATERIAL OR SOFTWARE. RATIONAL MAKES NO WARRANTIES OR REPRESENTATIONS REGARDING THE ACCURACY OR COMPLETENESS OF THE MATERIAL AND/OR SOFTWARE PROVIDED OR THAT IT WILL MEET LICENSEE’S REQUIREMENTS OR THAT THE MATERIAL AND/OR SOFTWARE WILL BE ERROR FREE. IN NO EVENT SHALL RATIONAL OR ITS LICENSORS BE LIABLE TO LICENSEE OR A THIRD PARTY FOR ANY INDIRECT, DIRECT, NEGLIGENCE, SPECIAL, OR CONSEQUENTIAL DAMAGES INCLUDING LOST PROFITS, LOST DATA AND THE LIKE ARISING OUT OF OR IN CONNECTION WITH THIS RECEIPT OF MATERIAL AND/OR SOFTWARE EVEN IF RATIONAL HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.

Using the Apex Search Engine

This document describes the usage and installation of the Apex Search Engine:


Usage

The Apex Search Engine has two parts, a "Master Index Search" and an "Advanced Search".
The Master Index Search allows you to quickly search only the Master Index, this enables you to avoid trying to find an item by traversing each letter of the alphabet and instantly brings up a list of every link that Apex has related to your search word. This search is very quick and does not have any advanced features. The results are show with the index line for which the Master Index has a reference and then the link. (Note: more than one link may be given for a given Master Index reference).

The Advanced Search is what you use if you have had no luck with the above search. This searches the entire documentation and reports back a list of documents which contain your search criteria. The advanced search has advanced features such as case sensitivity and "AND/OR" capability. The results are returned with the document URL and some surrounding context (only the first context is shown in the event of multiple hits).


Installing the search utilities on your system

(1) Copy the "html_search" directory and the enclosed files to the release dir.
      i.e. releases/apex.x.x.x/html_search
       
    (2) Change permissions on the html_search dir
     
      chmod 755 html_search

    (3) Change the permissions of the files as follows
     

      chmod 744 *.html
      chmod 755 *.cgi
      chmod 755 *.pl


    (4) Install nsperl in the subdir perl
     

      (available from http://people.netscape.com/kristian/nsPerl/)

      Note: If you choose to use another perl or another perl location you will need
      to change the perl pointed to in the cgi scripts header.


    (5) Create the "index.dat" file (from which the master index search works)
     

      vi indexextract.pl

      set the $basedir to locate the master_index dir

      e.g.

      $basedir = "/usr2/rational/releases/apex.3.2.0b/doc/html/multi/master_index/";

      run the script ./indexextract.pl

    (6) If you don't already have a WebServer then follow the WebServer instructions
    below. Once the WebServer is running all that is left to configure is the file
    location variables within the search.cgi. Set these to match your system
     

      e.g.
      $basedir = '/usr2/rational/releases/apex.3.2.0b/doc/html/all';
      $baseurl = 'http://localhost:8080/usr2/rational/releases/apex.3.2.0b/doc/html/all/';
      @files = ('*/*.html');
      $search_url = 'http://usr2/rational/releases/apex.3.2.0b/doc/html/multi/reference/WELCOME_TO.html';


Installing a WebServer on your local system

The Apex Search engine requires a WebServer to be running on your
machine to enable the search CGI scripts to run from your WebBrowser.

If you do not have a WebServer you can install Apache (www.apache.org).

Follow the instructions in the "INSTALL" documentation, which comes
with the Apache download. This search engine has been verified with the
following configuration.

On installation...
 

 --prefix=$APEX_HOME/apache_1.3.9 ($APEX_HOME is the releases/apex.x.x.x/ dir)


Within the httpd.conf
 

 ScriptAlias /cgi-bin/ "/usr2/rational/releases/apex.3.2.0b/html_search/"

 Options Indexes FollowSymLinks ExecCGI #search for ExecCGI to find this option

 AddHandler cgi-script .cgi_1.


Within the apache_1.3.9/htdocs dir link a dir which pints to your apex root dir
 

 ln -s /usr2 usr2


About

This Search Engine was created by the following people - This was as a result of a project for the University of Technology Sydney, Australia, Internet Programming subject within the School of Computing Sciences.