Rational Developer for System z, Version 7.5

Specifying help messages

You specify help messages for the help function in the -GE Lines section of the -G Lines tab.

Two line types can be described:
  • Type = C for a comment.
  • Type = T for a text call.
To call a text, you must respect the following positions in the Description field:
Positions Contents
6 - 11 Code of called Text
12 - 13 Code of the selected paragraph, or ’**’ to select all paragraphs
Notes:
  • Text processing

    The Text calls for the documentation are aligned according to a standard print layout.

    All the Text calls are justified (except if the non-justification ’$$’ parameter was used). The ’$n’ print windows indicated in the text are respected. If they are not specified, the default print window (’$0’) is used.

    All the text processing possibilities are functional (underlining, negative indentation, etc.).

    Line skips are specified in the text, but limited to a three-line skip maximum (line skips greater than three become three-line skips); page skips become three-line skips. By default, the skips are one line, except for print windows $0 and $1, where they are two lines.

    Thus, the same text can be a part of the ’on-line’ documentation and an application user manual.

  • Dialog-related errors

    You can assign comment lines to explicit manual errors on the -GE Lines associated with the Dialog. These lines will not be accessible, from the standard HELP function program, in the generated transactions.

There are two types of help: Screen-related documentation or documentation on a Data Element:
  • SCREEN-RELATED DOCUMENTATION
    You must respect the following positions in the Description field:
    Positions Contents
    1 to 5 Blanks
    6 Comment
    On a ’T’-type line
    6-11 Code of the called text line
    12-1 Paragraph code (’**’ for all paragraphs).

    The Screen help which the end-user can call through the Help function in the generated transactions is constituted of the C or Ttype lines indicated in the -GE lines of the Screen, then of the U, C or T lines of the Segment.

  • DOCUMENTATION OF A DATA ELEMENT

    Data Element C or T-type lines must follow an F-type line which refers to the same Data Element.

    You must respect the following positions in the Description field:
    Positions Contents
    1 to 3 Blanks
    4 0 (zero)
    5 Blank
    6 Code of the called text line
    12-1 Comments, or on a T-type line, the code of the called Text, followed by the paragraph code (** for all paragraphs)

    The Data Element help which the end-user can call through the Help function in the generated transactions is constituted of C- or T-type General Documentation lines assigned to the Data Element, Data Element description lines (blank-type), error messages generated for the given Data Element, and, if appropriate, their related documentation lines.

  • DOCUMENTATION LINES OF ERROR MESSAGES
    • EXPLICIT ERROR MESSAGES (EXCEPT ERRORS ON DATA ELEMENT)
      You must respect the following positions in the Description field:
      Positions Contents
      1 to 4 Error code (blank if after a U,C or T-type line relating to the error)
    • ERROR WITH AN AUTOMATIC MESSAGE OR ERROR ON DATA ELEMENT
      You must respect the following positions in the Description field:
      Positions Contents
      1 to 3 Error code (blank if after a F, U,C or T-type line)
      4 Position of the documentary message: ’2 4 5 6 7 8 ...’ comments on the line after the error message of the indicated type (2 4 5 6 7 8 ...)
      5 Blank
      6 Comments, or on a T-type line, the code of the called Text, followed by the paragraph code (** for all paragraphs)
Related concepts
Help function
Related reference
-GE Lines section

Terms of use | Feedback

This information center is powered by Eclipse technology. (http://www.eclipse.org)