next up previous contents
Next: Element on a configuration page Up: How it all works Previous: Bytecompiling

Help for the elements

Writting help for the element is a very important task, when modules are created. Without good help, the modules are worthless!

Help may be created to each element, with the -help switch, or with the Help function. The Help function takes as its first argument the name of the widget, which help shall be added to, and the help text as the rest of it's argument. It might look like this:

Help foreColor \
  "By pressing this button you can change the foreground color of" \
  "the window decorations when the window is inactive. This also" \
  "affects the icon foreground for monochrome icons (bitmaps) and" \
  "the icon title foreground."

The Menu, ListBox, ComboBox and Radio widgets may also specify help for the entries. This can either be done with -entryhelp switch or with the command EntryHelp. The EntryHelp command takes as it's first argument, the widget, as it's second the entry and as the rest, the help text.



Jesper Kjær Pedersen <blackie@imada.ou.dk>
Wed Oct 2 13:29:53 MET DST 1996