Proposal for New Help system based on JDIC HTML

The idea is to develop a Help system possibly based on JDIC HTML or Flying Saurcer: The 100% Java XHTML Renderer but as it goes for the second one - we're not sure.

The Graphical User Interface, on which I think very intensively, will be based totally on LG3D^? API. On the left side there'll be a list of topics for the particular application and on the right an explanation for the this topic.

It will probably include support for many languages.

There'll be proposed some standard for preparing help files, for example:
- Those files should be placed in a folder, which name will be i.e. HELP, MANUAL etc.
- Developer of particular application will be delivered with CSS file, which will be the base for properly prepared help files.

User will have capability of searching after single words or the whole phrases. After finding the interesting information, system will display it on the right side of the application, in the other case it'll display the message informing about unsuccesful searching the help document.

Deliverables

• Project documentation : source code, general description, design hints etc.
• Help System Interface: Presentation and user interfaces components of the Help System
• Help System Core: classes responsible for functionality of the Help System

Approximate schedule

• Get familiar with LG3D^? (2 weeks)
• Design of GUI (1 week)
• Implementation of GUI (1-2 weeks)
• Design of functionality (1 week)
• Implementation of the Help System core (2 weeks)
• Testing (1 week)
• Documentation (1 week)
• Unscheduled (1 week) for tracking bugs and in case if something goes wrong or takes more time than planned

Updates

• 10th of May, 2006
  
  We decided to use Flying Saucer: The 100% Java XHTML Renderer instead of JDIC HTML. The main reason is that JDIC isn't platform independant.

Background

Experience

• Student practice in RCOST (Research Center on Software Technologies) in Benevento, Italy (4 months)

Skills

• C/C++, Java, Internet technologies like XML and HTML
• Database Management Systems: Access, Oracle
• Linux, Windows