|Format of Help contexts XML file [message #610595]
||Wed, 12 March 2008 16:47
| Eric Rizzo
Registered: July 2009
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
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?
Powered by FUDForum
. Page generated in 0.02284 seconds