Browse Prior Art Database

Associating documentation with a repository folder

IP.com Disclosure Number: IPCOM000013068D
Original Publication Date: 2002-Feb-15
Included in the Prior Art Database: 2003-Jun-12
Document File: 2 page(s) / 64K

Publishing Venue

IBM

Abstract

A program is disclosed that has a file-based repository to store the "things" that the user is building by running the program (eg files/documents/software components). This repository can be sub-divided in folders. These folders are typically used to organize the "things" in the repository into logical groups, such as groups of "things" that are used together, or groups of "things" that perform a similar function. Therefore each folder has a meaning/purpose. The problem is, how should developers document the meaning/purpose of each folder so that other developers who are sharing the repository can find the "things", or make use of the folders in a consistent manner? This idea is a tool to display the documentation for any particular folder when it is selected in the repository. When the folder is selected, the tool looks for a file with a certain name located inside the folder. This is displayed as the documentation for the folder. Figure 1 is a screen shot of the WebSphere Application Builder for Components* tool that has this behaviour. The folder called "ibm" has been selected and its description is displayed in the central pane. 1 Fig. 1

This text was extracted from a PDF file.
At least one non-text object (such as an image or picture) has been suppressed.
This is the abbreviated version, containing approximately 100% of the total text.

Page 1 of 2

Associating documentation with a repository folder

A program is disclosed that has a file-based repository to store the "things" that the user is building by running the program (eg files/documents/software components). This repository can be sub-divided in folders. These folders are typically used to organize the "things" in the repository into logical groups, such as groups of "things" that are used together, or groups of "things" that perform a similar function. Therefore each folder has a meaning/purpose. The problem is, how should developers document the meaning/purpose of each folder so that other developers who are sharing the repository can find the "things", or make use of the folders in a consistent manner?

    This idea is a tool to display the documentation for any particular folder when it is selected in the repository. When the folder is selected, the tool looks for a file with a certain name located inside the folder. This is displayed as the documentation for the folder. Figure 1 is a screen shot of the WebSphere Application Builder for Components* tool that has this behaviour. The folder called "ibm" has been selected and its description is displayed in the central pane.

1

Page 2 of 2

Fig. 1

*WebSphere is a registered trademark of International Business Machines Corporation.

2

[This page contains 59 pictures or other non-text objects]