Purpose

This tool mentor describes how to regenerate the index, the search database, and the process overview table, after the Rational Unified Process has been modified in some way.

Overview

  1. Generating a New Search Database
  2. Generating an Index
  3. Generating a Process Overview Table

Read the System Requirements, to see what you need to do before you start using these tools.

1. Generating a New Search Database

When pressing the Search button in the Rational Unified Process online, a search window is opened, and you can search the Rational Unified Process online. If you change the Rational Unified Process online you may have to regenerate the search database. You may have to generate a new search database, i.e. a new file called searchdb.ws, and put in the applet folder.

  1. Locate the folder "devkit/rupuse/search/". (See the Guideline: The File Structure of RUP 5.1, if necessary.) It contains the following files
File Comments
searchexclude.htm keywords that should be excluded from the search database. This is important in order to get a compact database.
searchresponse.txt Configuration file to the search engine.
searchengine.bat To execute on Windows 95/NT.
searchengine.unix To execute on Unix.
searchenginehelper.bat To execute on Windows 95/NT. Will generate a file called toc.htm in the current folder.
searchenginehelper.unix To execute on Unix. Will generate a file called toc.htm in the current folder.
  1. On Windows 95/NT: Execute the "searchenginehelper.bat".
    On Unix: Run the command "source searchenginehelper.unix".
    This step will create a file called "toc.htm" in the current folder.
  2. On Windows 95/NT: Execute the "searchengine.bat".
    On Unix: Run the command "source searchengine.unix".
    This step will create two files "searchdb.ws" and "searchdb.html", and place them in the folder "applet/".
  3. You are ready to browse the Rational Unified Process.
    You can remove the file "toc.htm" that was created in step 2.
    You can also remove the "searchdb.html" that was created in the previous step. These two files serves no purpose.

For detailed information, see the search application documentation.

2. Generating an Index

When you press the Index button, a new window is opened with an index to the Rational Unified Process online. This index has been automatically generated by an application which has extracted keywords from all files in the Rational Unified Process. For more details see the KeyWordIndex application.

  1. Locate the folder "devkit/rupuse/keywordindex/".
Files Comments
keywordconfig.txt The configuration file with parameters to the KeyWordMap.exe.
keywordmap.bat To execute KeyWordmap.exe on Windows 95/NT. 
keywordmap.unix To execute KeyWordmap.exe on Unix.
keywordpostamble.txt Contains HTML code that will be placed last in the resulting index file.
keywordpreamble.txt Contains HTML code that will be placed first in the resulting index file.
keywords.txt Contains internal references within the index.
  1. On Windows 95/NT: Execute the "keywordmap.bat" file.
    On Unix: Run the command "source keywordmap.unix".
    This step will generate three new files "index.htm", "navig.htm", and "contents.htm", and place them in the folder "index" where the Rational Unified Process is installed.
  2. You are ready to browse the Rational Unified Process.

Add Remove or Modify Internal Links

If you want to add, remove or modify the internal links within the index, you edit the file keywords.txt. How to do this, and what syntax to use is described in KeyWordIndex documentation, section Internal Index References File.

Add New Keywords

Adding new keywords in files is described in KeyWordIndex documentation, section Define Keywords in an HTML file.

Customize Index

If you want to customize the index, its layout, etc., see KeyWordIndex documentation, section Configuration File.

3. Generating a Process Overview Table

There is a Process Overview Table in the Rational Unified Process, which contains links to all pages in the Rational Unified Process online. The Process Overview Table is automatically generated by running the SiteMap.bat.

  1. Locate the folder called "devkit/rupuse/sitemap/". It has the following contents:
Files Comments
sitemap.bat To execute SiteMap.exe on Windows 95/NT.
sitemap.unix To execute SiteMap.exe on Unix.
sitemapdef.txt Configuration file with parameters to SiteMap.exe. This file controls the layout of the result.
sitepostamble.txt Contains HTML code that will placed last in the resulting Process Overview Table.
sitepreamble.txt Contains HTML code that will placed first in the resulting Process Overview Table
  1. On Windows 95/NT execute the "sitemap.bat".
    On Unix run the command "source sitemap.unix".
    This step will create a new file "sitemap/sitemap.htm" in the installed Rational Unified Process.
  2. You are ready to browse the Rational Unified Process.

caution.gif (138 bytes) The file "applet/tree.dat" is used as input, by the SiteMap application. If you change the tree.dat file you may have to do corresponding changes in the "sitemapdef.txt" file (controls the layout of the Process Overview Table). For example, if you add a new entry in the tree.dat file, that should be on the top in one of the cells in the generated Process Overview Table, then you have to modify the "sitemapdef.txt". See SiteMap documentation, section "The Layout of the SiteMap". 

To customize the Process Overview Table, its layout, etc., see SiteMap documentation for details.

 

Display Rational Unified Process using frames

 

© Rational Software Corporation 1998 Rational Unified Process 5.1 (build 43)