IBM®
Skip to main content
    United States change      Terms of use
 
 
Select a scope:    
     Home      Products      Services & industry solutions      Support & downloads      My account     
alphaWorks  >  Eclipse technology  >  

IBM User Interface Help System Built on Eclipse

A software system designed for the development and delivery of a GUI-based, online help system or a Web-based "information center" that can be run locally or over a network.


Date Posted: March 21, 2006
OverviewRequirements Download FAQs Forum Reviews

Update: April 21, 2006

A Linux version is now available (tested on Intel hardware running RedHat and SuSE Linux distributions).

What is IBM User Interface Help System built on Eclipse?

This Eclipse-based application is designed to help Java™ developers create online help systems that can be easily browsed and searched and that can run on many different operating systems or across a network. A Java developer can use this technology to create a help system that can be launched from a Help menu or Help button in the application. The created help system can be used to create a "Documentation CD" of browsable and searchable content. The help system can also be run on a server so that the content can be accessed by client machines and so that it is viewable and searchable in the client browsers.

This technology runs on Windows® and Linux®.

How does it work?

The IBM User Interface Help System Built on Eclipse was created from a subset of plug-ins from the Eclipse Platform. The plug-ins are packaged together in order to provide for a Web-based online help system that can be run off a CD, on a local machine, or in a client-server network. The help system code is a collection of Java Server Pages and servlets, along with an embedded Web application server, a search engine, and the Eclipse run-time environment. After the documentation modules are included in the appropriate directory and the user starts the application, the user interface of the Web application is loaded in the browser. At that point, the user can navigate through the table of contents, view topics, and search the documentation.

About the technology author(s):
The IBM User Interface Help System Built on Eclipse is the result of a project developed by the User Assistance Project Development Team (UA PDT) at IBM's Software Development Lab in China. This team focuses on providing tools and systems for delivering information within software applications and products.

This package is built on Eclipse technology, which was developed by Eclipse.org and the Eclipse open-source community. The Eclipse open-source community focuses on projects that provide an extensible development platform and application frameworks for building software.

Download now Download now

Related technologies

For platform(s):
Linux, Windows 2000, Windows XP

For topics:
Eclipse, Java technology, user interface, utilities


 

    About IBM Privacy Contact