Rational Developer for System z, Version 7.6

Specifying help messages

You specify help on a Screen, a Data Element or an error message in the -GE Lines section of the Screen -G Lines tab.

About this task
To document a Screen, a Data Element or an error message, vous can indicate two types of line:
  • Type = C for a comment.
  • Type = T for a text call.
To call a Text, you can:
  • Either enter a T in the Type field, press Enter, and then click in the Type field again. The Change button of the Referenced Text field becomes available. Click on it to open the selection box which displays the Texts already present in the current location. Click the + sign in front of a Text to be able to see its paragraphs. Select one and click OK. The selected Text and paragraph will be inserted in the Description field.
  • Or enter a T in the Type field and specify the Text code directly in the Description field with the following format:
    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 options are functional (underlining, negative indentation, etc.).

    Line skips are specified in the Text, but limited to a three-line skip (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.

    The same Text can then be used in the 'on-line' documentation and in the user manual of the application.

  • 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.

To indicate an online help on a Data Element, a Screen or an error message, you must respect the following coding:
  • DOCUMENTATION OF A SCREEN
    The documentary lines must be entered on the -GE Lines of the Screen. 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
    12-13 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 T 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 that Data Element.

    You must respect the following positions in the Description field:
    Positions Contents
    1 to 3 Blanks
    4 0 (zero)
    5 Blank
    6 Comment
    On a T-type line
    6-11 Code of the called text
    12-13 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 the C- or T-type lines assigned to the Data Element, the Data Element description lines (blank-type), the error messages generated for the given Data Element, and, if appropriate, their related documentation lines.

  • DOCUMENTATION 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 Comment
      On a T-type line
      6-11 Code of the called text
      12-13 Paragraph code (** for all paragraphs).
What to do next
You need to generate the error message file.

Terms of use | Feedback

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