This function is used to enter the help associated with each software field. This help is stored in the database in the form of html texts. This help is characterized by a key word and a language code. The key word is linked to the screen fields using the corresponding section in the screen dictionary.

This help is then generated on the disk thanks to a dedicated extraction function. It is located in a sub-directory named FLD. But each field help is also integrated into the functional help if the screen displaying the documented field is associated to a paragraph of this help.

Note that a function updating the help key words of a screen can be accessed directly by a zoom from the screen code defined in the paragraphs of the functional help.

Prerequisites

SEEREFERTTO Refer to documentation Implementation

Screen management

Entry screen

Aside from the language code and the document code, there is a section in this screen where it is possible to enter the help text using an HTML editor. Its use is described in an attached documentation.

Characteristics

Language (field LAN)

Define the language in which a text is expressed.
Key word (field MOTCLE)

This code identifies the current record in a unique way.
Module (field MODULE)

Module to which the documentation parameterization belongs.
General help (field GEN)

When this box is checked, the help is considered as generic, that is to say it can be used widely in screens other that that for which it was defined at the start.

A dedicated selection function is used to select the generic helps.
Translation priority (field PRIO)
Owning group (field CREGRP)

This field is used to display the Group creating the given documentation.

It is only available in the environments in which this notion has been implemented. This applies to the environments in which the user parameter GRPDEV exists.

NOTE: The group is displayed in Red when the user group is different from the creating group found in table AOBJGRPDEV

Link

Linked h. (field LNKHLP)
field LNKORD

Help text

field TEXTE

This field is used to enter the field help text as it will appear during a call to the help and how it will be inserted in the functional documentation that references the screen where this help is used.

Reports

By default, the following reports are associated with this function :

  ADOCFLD : Field help

This can be changed using a different setup.

Specific Buttons

This button is used to copy the record definition from or to another folder.

Block number 1

field OBJET
field CLES

Block number 2

From folder (field DOSORG)

Use this field to define the folder from which the record will be copied. The possible syntaxes are described in the Dedicated appendix.
All folders (field TOUDOS)

Use this option to copy the record to all the folders defined in the dictionary (ADOSSIER table of the current solution).
To folder (field DOSDES)

Use this field to define the folder to which the record will be copied. The possible syntaxes are described in the Dedicated appendix.