Computer Science 2574
Intro to Data Structures & Soft Eng

DOCUMENTATION ON-LINE CATALOG:
An Interactive Code-Library Documentation Access Tool

DR. DOC USER'S MANUAL

Virginia Tech, Backsburg, Virginia
12/9/96
CS1704: Introduction to Data Structures
Final Project: DR. DOC - Documentation On-line Catalog


PROGRAM OVERVIEW:

Documentation On-line Catalog (DOC) is an interactive code library documentation access tool. DOC will provide facilities for viewing, selection, traversing, and indexing documentation information. The reference set, category, and documentation file formats that DOC will operate on are illustrated below.

DOC works with files of 3 types: category, documentation, and reference set.

CATEGORY (.gor) format
lines contents notes
1 brief description
2-14 full description if shorter, section will be terminated with a period (.) in the first column
The rest of the file will be of the following format:
columns contents comments
1 C or D label file type entry code
5-15 label label for file
20-80 file name filename entry with .dr or .gor extension. May be relative or absolute.

DOCUMENTATION (.dr) format
line contents comments
1 name function name
3 syntax function heading
5 include required include files
7 parameters brief parameter description
9 return return value description
11 see also related functions
The remaining lines will be a description followed by example usage section. The section will must be separated by a period (.) in the first column of a line.

The reference set file contains the information for a previously created and stored reference set. It contains any changes that have been performed on the set - deletions, addition, modifications. Files in the set are stored in alphabetical order with the following information:

Category-type file-label filename reference-count

(C/D) 11 characters *.gor / *.dr reference count to that file


SYSTEM REQUIREMENTS:

You will need a PC with MS-DOS and a 3.5" floppy drive to run DOC.

The following files will be needed to run this application:

DOC was compiled in Microsoft Visual C++ v.1.52 for 16-bit MS-DOS applications.


USING THIS PROGRAM:

  1. Insert the 3.5" floppy into the floppy drive A or B.
  2. At the DOS prompt, type:
  3. <DRIVE>:\doc.exe.
  4. Where <DRIVE> is the appropriate drive letter. This will launch the program

Note: This program will not run in the MS-Windows environment


MENUS

DOC uses a menuing system similar to others for DOS applications, but it does not allow the use of a mouse. At the top of the main screen is a menubar with options

PROG | FILE | EDIT | VIEW | SEE ALSO

To activate a menu, enter the first letter of any of these main options. A menu window will appear with an option highlighted.


HOW TO NAVIGATE :

  1. To select one of the listed option, use the up or down arrow keys to move to that option.
  2. Press the <ENTER> key to select it.
  3. To escape from the menu window, press the <DELETE> key.


AVAILABLE OPERATIONS


PROG


FILE


EDIT


VIEW


SEE ALSO


IMPLEMENTATION/CREDITS:

This program implements the curses windowing library ported from the UNIX-based library for use in applications on the PC. Help received for this project was provided by several sources: