next up previous 63
Next: The MESSAGE Specification
Up: ADAM Interface Module Reference Manual
Previous: Example


The HELPLIB Specification

This specification may be used to specify a `top level' for all subsequent HELPKEY fields until another HELPLIB specification is found. The specification may appear anywhere in an Interface File.

The field is of the form:

HELPLIB help_top_level_spec
where help_top_level_spec is a character string to be inserted (with an intervening space) in front of any string specified in subsequent HELPKEY fields as the Interface File is parsed - it may be a blank character constant to nullify the effect of an earlier HELPLIB field.

Thus, assuming that the help file for the program DISP is DISP_DIR:DISP and that help text for each parameter is held in subtopic parameter-name of subtopic PARAMETERS of topic DISP, then the Interface File for program DISP could be:

INTERFACE DISP
# Specify the top level of help
   HELPLIB 'DISP_DIR:DISP DISP PARAMETERS'
   PARAMETER IMAGE
         .
      HELPKEY 'IMAGE'
         .
   ENDPARAMETER

# Specify top level help for use with default helpkey
   HELPLIB DISP_DIR:DISP
   PARAMETER DISPLAY
         .
      HELPKEY *
         .
   ENDPARAMETER

# Just as an example, use the blank specifier
   HELPLIB ''
   PARAMETER LIMITS
         .
      HELPKEY 'DISP_DIR:DISP DISP PARAMETERS LIMITS'
         .
   ENDPARAMETER
      .
ENDINTERFACE
Note that the use of multiple HELPLIB fields here is purely to show the effects - there would normally be only one HELPLIB specification in an Interface File.



next up previous 63
Next: The MESSAGE Specification
Up: ADAM Interface Module Reference Manual
Previous: Example

ADAM Interface Module Reference Manual
Starlink User Note 115
A J Chipperfield, B D Kelly, S L Wright
3 September 2002
E-mail:ussc@star.rl.ac.uk

Copyright © 2002 Council for the Central Laboratory of the Research Councils