Computer Science 2574 |
Intro to Data Structures & Soft Eng
|
DOCUMENTATION ON-LINE CATALOG:
An Interactive Code-Library Documentation Access Tool
Virginia Tech, Backsburg, Virginia
12/9/96
CS1704: Introduction to Data Structures
Final Project: DR. DOC - Documentation On-line Catalog
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
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.
Note: This program will not run in the MS-Windows environment
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 :
Displays information about the program <author, title, version>
Provides a brief explanation of program usage. A quick reference window of sorts.
Allows creation of a new reference set, starting with a "root" file of type "category". The file must have a .gor extension to be a valid root file. All files are verified for correct formatting. Any files not meeting the above specified formats will NOT be added to the set. Once the set is created, it may be viewed and modified with the following options.
Opens an already existing reference set. The file is denoted with a .rfs extension. You must specify the full pathname to the reference set including extension (.rfs) when opening a set. Once the set is opened, it can be operated upon with the following options.
Allows to save a currently open reference set. If the set is a newly created set (never before saved), it will be saved by convention using the root filename (except with the .rfs extension). Otherwise, the set is saved with the same name as the existing set.
Allows saving of a reference set by a new name. Names must have the .rfs extension.
Closes a reference set that is currently open. NOTE: This operation does not save the set for you. You must save any necessary changes prior to closing the set.
Quits the program DOC. NOTE again: the set will not be automatically saved. If you want to save the changes, answer "NO" to the prompt and you can then save your changes.
Reverses or undoes the last operation. (Not implemented.)
Performs the operation that was undone by the "UNDO" operation. (Not implemented.)
Adds a file to the currently opened reference set. A file need not be present in the current working directory to be added. However, the filename must meet the requirements for a documentation or category file. The filename will be the default "label" and the type-code assigned will be based on the extension of the file (C - .gor and D - .dr).
Deletes the currently displayed file from the reference set. It also deletes all files that are referenced by that file, if it is not referenced by other files in the current set.
Allows modification to the name of the currently displayed file in the reference set. This does NOT alter the filename itself. Only the information contained in the reference set. If you change a file's name in the set via the Modify operation, be sure to change the actual filename outside of the program as well.
Allows modification to the label of the currently displayed file in the reference set.
Allows modification of the current type-code for the currently displayed file in the reference set. The options available are C (category *.gor) or D (documentation *.dr)
Displays a brief description for a documentation file.
Displays the code information for a documentation file. Information displayed is as follows:
Displays the root file description for the currently open reference set.
Displays the previously displayed file to the display window.
Displays the contents of the currently opened reference set. Allows navigation through the contents using the up and down arrow keys and selection of a highlighted file label by pressing the <ENTER> key. Escape from index-mode by pressing the <DELETE> key.
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: