Process Engineer Toolkit > Directory structure > Rational Unified Process Directory Structure

Topics

Overview To top of page

The directory structure of the installed Rational Unified Process looks like this. Click on it to see a larger picture

Click to see a full-size picture

Microsoft FrontPage® 2000 has been used to develop the Rational Unified Process. FrontPage adds information for its own internal use. The folders that contain FrontPage information are prefixed with an underscores (_). Most ordinary users of the Rational Unified Process do not have to bother with this information. It's presented here to make the picture complete. Someone who is going to customize the Rational Unified Process would probably want an overview of the FrontPage folders.

The top-level folder in a FrontPage Web typically has the following FrontPage specific folders:

  • _borders
  • _derived
  • _fpclass
  • _overlay
  • _private
  • _themes
  • _sharedtemplates
  • _vti_bin
  • _vti_log
  • _vti_pvt
  • _vti_txt

See the section titled "Top-Level Folder" for details.

There are files and folders that make up the Web are in the rest of the top-level. In our case, you'll find the following files:

  • index.htm
  • rop.css
  • spscreen.htm

The following folders contain Rational Unified Process material:

  • applet
  • copyrite
  • devkit
  • examples
  • ext_help
  • images
  • index
  • manuals
  • overview
  • papers
  • prjtmpl
  • process
  • ruptmpl
  • sitemap
  • sodatmpl
  • toolment
  • tour
  • webtmpl
  • wordtmpl

FrontPage creates three folders, with FrontPage-specific information, for each of these folders, See the section titled "Inside Every User-Created Folder" for more details.

Top Level Folder To top of page

The top level folder of a FrontPage Web site usually has the following contents:

Folder/file Description
_borders The pages that contain the shared borders. If you change the border on any other page, you actually changing this page.
_fpclass Java-classes; for example, the hover-buttons.
_private Contains only one file: #haccess.ctl
_sharedtemplates Contains Rational Unified Process templates for creating new Rational Unified Process pages
_vti_bin Contains three files: fpcount.exe, shtml.exe, and #haccess.ctl.
_vti_log In our experiments, this folder has always been empty.
_vti_pvt An important folder from FrontPage's perspective. See the section titled "The '_vti_pvt' folder" for details.
applet Contains all Java code, the top frame with navigation buttons, the left frame with the treebrowser, and the search database. See the 'applet' folder for more details.
copyrite The copyright text.
devkit Contains the files required to generate the index, search database, and Site Map. See the 'devkit' folder for more details.
examples Examples of some artifacts.
ext_help The extended help database.
images Images used in the top-level pages.
index The files that make up the index presented when you press the Index button.
manuals Contains the Introduction online manual, the Ada Programming Guidelines, and the C++ Programming Guidelines.
overview Contains the hump chart diagram in an html file.
papers Contains white papers; that is, information that hasn't been integrated into the Rational Unified Process.
prjtmpl Microsoft Project98® templates.
process This folder contains most html files in the Rational Unified Process. See The 'process' folder for more details.
ruptmpl Zipped FrontPage templates used to develop the Rational Unified Process.
sitemap Contains the sitemap.htm Site Map.
sodatmpl Rational SoDA templates and template instructions.
toolment Tool mentors for the Rational tools.
tour The Web pages in the guided tour.
webtmpl HTML templates.
wordtmpl Microsoft® Word templates.
index.htm The starting page.
rop.css The cascading style sheet that controls the styles on most pages in the process product.
spscreen.htm The page displayed in the main window while the Rational Unified Process is being loaded.

 

The 'applet' Folder To top of page

The 'applet' folder contains the following folders and files:

Folder Description
images contains *.JPG and *.GIF files.
ruptools Contains exactly what is zipped in the search.zip and the treebrowse.zip without licensing software.

 

File Description
browser.htm This page automatically displays if you start the Rational Unified Process (open the file index.htm at the top-level) with an old—versions 3.x and earlier—Web browser.
buttons.htm The top frame with the navigational buttons.
empty.htm A white page that is displayed the very first seconds while the Rational Unified Process is being loaded.
help.htm Help on search. Presented when you press the help button in the search window.
img.zip Contains all images in the 'applet/images' folder. The reason for compressing all images into one file is to speed up the loading of the treebrowser applet. 
orytree.htm The left frame with the treebrowser.
search.cab The java code for the search applet. (Windows)
searchdb.htm The search window.
searchdb.ws The search database.
search.zip The java code for the search applet. (UNIX) 
systeminfo.cab The java code for the systeminfo applet. (Windows)
systeminfo.zip The java code for the systeminfo applet. (UNIX)
tree.zip Contains a text file called 'tree.dat' that defines the outline of the treebrowser in the left frame. Edit the 'tree.dat' file to change the tree.
treebrowse.cab The java code for the treebrowser applet. (Windows)
treebrowse.zip The java code for the treebrowser applet. (UNIX)

The 'process' Folder To top of page

The 'process' folder contains the following folders and files:

Folder Description
activity All activity descriptions, including overviews.
artifact All artifact descriptions, including overviews.
images Images use at the top-level.
itrwkfls Sample iteration plan pages.
modguide All guideline pages, organized in subfolders.
reports All reports.
workers All role descriptions.
workflow Descriptions of workflows for all disciplines.
workguid All work guidelines pages.

 

File Description
glossary.htm The Rational Unified Process glossary of terms.
navtools.htm Describes how to navigate the Rational Unified Process.
ovu_proc.htm The Home page, which is the very first page presented. 
referenc.htm References to other literature.
about.htm Information about the Rational Unified Process.

 

The 'devkit' Folder To top of page

The folder 'devkit' contains the files and documentation of those tools used to develop the Rational Unified Process.

Folder

Description
devkit/ 
 
     ruptools/ 
 
          applet/ Where the documentation and code for the left-frame treebrowser is found.
          application/ 
 
               treebrowse/ 
 
                    doc/ Documentation for the treebrowser applet and treebrowse.zip.
                    application/  
               keywordindex/  
                    doc/ Documentation for the KeyWordIndex application.
                    project/
                         bin/ Contains KeyWordIndex.exe.
               search/
                    doc/ Documentation for the Search application.
                    project/
                         bin/ Contains searchEngine.exe and searchEngineHelper.exe.
               sitemap/
                    doc/ Documentation for the SiteMap application.
                    project/
                         bin/ Contains sitemap.exe.
          doc/ Documentation for all tools.
     rupuse/ The subfolders contain the files that were used to generate the Rational Unified Process. If you need to regenerate anything, use these files and modify them, if necessary. Instructions on how to use these are found in the Toolkit: Preparing for Publication.
          keywordindex/ Files to generate the index.
          search/ Files to generate the search database.
          sitemap/ Files to generate the Site Map.

The folder 'devkit' contains the following files. 

File

Description
rup.jar

The ruptools compressed.
snjawt11.dll

Used by the ruptools.
snjrt11.dll Used by the ruptools.
snjzip11.dll Used by the ruptools.

 

 

The '_vti_pvt' Folder To top of page

The '_vti_pvt' folder contains the following files:

File Description
_x_todo.htm The header of a "To Do list" in .htm format.
_x_todoh.htm The header of a completed To Do list in .htm format.
access Unknown contents.
botinfs Microsoft FrontPage® components used to be called webbots; probably related to components.
bots Unknown contents. See botinfs.
deptodoc.btr Unknown contents; perhaps a page-specification.
diskweb Empty; probably used to indicate a disk Web rather than local webs.
doctodep.btr Unknown contents; related to deptodoc.btr in some unknown way.
frontpg.lck Empty; probably used to track sharing violations.
linkinfo Information regarding broken links.
service Web settings for the whole Web site.
service.lck Empty; edited every time you edit a file and probably used to keep track of sharing violations.
services Empty; except for a \.
structure This contains the structure of the Navigator view.
writeto FrontPage administrative information.

Inside Every User-Created Folder To top of page

Inside each every user-created folder, Microsoft® FrontPage® adds the following three hidden folders:

  • _derived pictures from the theme
  • _overlay pictures from the theme
  • _vti_cnfdummy pages containing administrative information about each file.

What Does Microsoft FrontPage Do? To top of page

For the curious users, here are some examples of what FrontPage does when you do changes to files.

A) If you change the Web-settings, the following files are changed:

  • deptodoc.btr
  • doctodep.btr
  • service
  • service.lck

B) If you change any html-file within the FrontPage site, the following files are changed:

  • The shadow file in the _vti_cnf folder.
  • deptodoc.btr
  • doctodep.btr
  • service.lck
  • linkinfo

C) If you change the file's links to another file, then the other file's shadow file in the _vti_cnf folder will be updated.

D) If you open any file, FrontPage will open the service.lck file.

Copyright  © 1987 - 2001 Rational Software Corporation


Display Rational Unified Process using frames

Rational Unified Process