Computer Science 2574 |
Intro to Data Structures & Soft Eng
|
DR. DOC: DOCUMENTATION ON-LINE CATALOG
INTEGRATION PLAN
POINT 1: 10/2/96
VALIDATION PROCEDURES
This portion of the project focuses on validating files to be included in the on-line reference set. The program at this point reads files referenced by a file of type "category" and checks that they meet requirements each for type "documentation" and "category". A report file of results for each file referenced in the set is output for viewing.
Functions implemented:
- GetFiles: Opens a "root" category file (with extension *.gor) and adds the files it references to a "reference set". If a file it references is a category file, that file as well is opened and read for additional files to add to the set.
- Check_cat: Checks the format of a "category" file. If any line is incorrectly formatted, the file is not added to the reference set.
- Check_doc: Checks the format of a "documentation" file. If any line is incorrectly formatted, that file is not added to the reference set.
- Fexists : Checks that a file exists without creating a new one.
POINT 2: 11/6/96
REFERENCE SET MANAGER
The second implementation provides basic operations for managing a reference set created in point 1. The basic operations:
Functions implemented:
- New: Creates a new reference set from a "root" category file. Once the set is created, other operations following would be permitted.
- Open: Opens a reference set which has already been created and saved as a reference set file (*.rfs). Following opening a set, the following operations are able to be performed.
- Save: Allows the user to save the reference set which is open. Writes to a file of the extension *.rfs. This will record any changes/modifications made to the set while open.
- Add: Allows the user to add a file to the currently opened reference set. The file need not be present to add it. But the filenaming convention (*.gor for category-type and *.dr for documentation-type files) must be followed or the file cannot be added.
- Delete: Allows the user to specify a file to remove from the currently opened reference set. If the file is found in the set, it is deleted. The file itself remains unchanged. It is only removed from the set.
- Modify: Three aspects of the file information in the set may be changed: the name of the file, it's label and it's type-code. Only the information referenced in the set is altered, but actual changes to the file are up to the user.
POINT 3: 12/9/96
DOCUMENTATION ON-LINE CATALOG
This is the final program with points 1 & 2 integrated into a menuing system. Additional operations added are:
Functions implemented:
- See Also menu: Creates a list of files referenced by a particular file. If the file is of type "category" the see also list contains all referenced files listed following the description. If the file is of type "documentation" the list is created from the "see also" line (#11) of that file.
- Root: Switches the displayed file on the viewing screen to the root file.
- Back: Switches the file viewed on the viewing screen to the previously viewed file.
- Description: Displays the brief description for a "documentation" file.
- CodeInfo: Displays the code information of a documentation file.
- Index: Displays the entire reference set and allows the user to scroll up and down in the set, to select a new file to view, or to return to the menuing options.