Browse Prior Art Database

Surfacing Eclipse GUI-based User Assistance in a Command Line

IP.com Disclosure Number: IPCOM000109245D
Original Publication Date: 2005-Mar-23
Included in the Prior Art Database: 2005-Mar-23
Document File: 2 page(s) / 32K

Publishing Venue

IBM

Abstract

Applications that use the Eclipse help application as a means of delivering user assistance have no text equivalent and therefore applications that are command line in nature, rather than graphical user interface in nature, are forced to use a GUI external to the organic command line application. This invention is a solution to that problem.

This text was extracted from a PDF file.
This is the abbreviated version, containing approximately 53% of the total text.

Page 1 of 2

Surfacing Eclipse GUI-based User Assistance in a Command Line

At present, in applications that use the Eclipse help application as a means of delivering user assistance have no text equivalent. Thus, applications that are command line (CLI) in nature rather than graphical user interface (GUI) in nature are forced to use a GUI external to the organic command line application. The user should not be forced to use a GUI if they are already using a command line interface to access this important user assistance information.

The solution that has been developed is to use a plug-in command for the existing TPC CLIs that allows the user to see the text based messages. This command requires that a filter be executed against the existing Eclipse-based user assistance files, outputting each module in it's own file so that it can be accessed via the CLI. The CLI will then format the information and present it to the user.

For example, a typical flow would be the following:

Step 1: Error messages are identified and specified in an xml file with the following format:

<!--Start of Message-->
<Message ID="AWN009040I">

<MsgText>[AWN009040I]Command completed successfully.</MsgText>

<Explanation>

     <p>The command completed successfully.</p>
</Explanation>
<Action>

             <p>No further action is necessary.</p>
</Action>
</Message>
<!--End of Message-->

Step 2: The xml file is interpreted and output to both the GUI infocenter format and the CLI message text files with the name msg_<ERROR_ID>.txt, e.g. msg_AWN009040I.txt. The file...