Eclipse Community Forums
Forum Search:

Search      Help    Register    Login    Home
Home » Eclipse Projects » Platform - User Assistance (UA) » Format of Help contexts XML file
Format of Help contexts XML file [message #610595] Wed, 12 March 2008 16:47
Eric Rizzo is currently offline Eric Rizzo
Messages: 2234
Registered: July 2009
Senior Member
I've found that the Help system is very sensitive about the format of
the contexts XML file and I'd like to know if this is something that has
already been documented or discussed (before I go and enter a
bug/enhancement request).
The problems seem to only crop up when using custom Help context IDs in
TrayDialogs. If the <description> node is missing or empty, the tray
dialog help fails in various ways.

Example 1 - a contexts file that is missing <description> altogether
produces NPE when trying to open the Help tray.

Example 2 - a contexts file that has empty <description> nodes (as in
either <description /> or <description></description> ) causes the tray
help to respond with the built-in message that no help topics are
defined for the context ID.

It seems that both of these tend to violate the Principle of Least
Surprise or the Leniency Principle ("be lenient in what you accept and
strict in what you emit"). I mean, without the benefit of a DTD or
schema to dictate the format, is it unreasonable for the code to have a
little more leniency?

Eric
Previous Topic:Not removing xml tag in the serach results
Next Topic:eclipse 3.2 system help
Goto Forum:
  


Current Time: Fri Aug 29 10:20:48 EDT 2014

Powered by FUDForum. Page generated in 0.10467 seconds