Development > Data and parameters > Documentation > Field documentation 

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

Presentation

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.

Close

 

Fields

The following fields are present on this tab :

Characteristics

Define the language in which a text is expressed.

This code identifies the created records in a unique manner.

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

 

Link

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

Close

 

Reports

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

 ADOCFLD : Field help

This can be changed using a different setup.

Specific Buttons

The following fields are included on the window opened through this button :

Block number 1

  • field OBJET

 

  • field CLES

 

Block number 2

  • From folder (field DOSORG)

Indicate the folder from which the record is going be copied. The possible syntaxes are described in the dedicated appendix.

  • All folders (field TOUDOS)

This option is used to copy the record to all the folders defined in the dictionary (ADOSSIER table from the current solution).

  • To folder (field DOSDES)

Indicate the folder in which the record is going be copied. The possible syntaxes are described in the dedicated appendix.

Close

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

Menu Bar

Actions / Option / Copy documentation

Is used to copy the help to another folder in a more global way than the corresponding button. A range can be entered here to perform mass copies. The different syntaxes to define a folder are specified in an attached documentation.

Actions / Option / Translation priority

Is used to define an order of priority in the translation of documentations.

Verifications / Option / Delete doc in all languages

Is used to delete the field documentation in all existing languages. A confirmation window is generated if the response is positive. The operation cannot be undone.

Verifications / Option / Help not used

Is used to launch a global search in the screen dictionary in order to find the field helps that no screen uses. The list is displayed in the form of a log file.

Verifications / Option / Missing help

Is used to launch a global search in the screen dictionary in order to find the fields for which there is no help key word, or for which the referenced key word does not correspond to an existing field help. The list is displayed in the form of a log file.

Verifications / Option / Purging of unused helps

Option / Where-used

Is used to view, in a selection window, the screens in which the current field help is used.

Error messages

The only error messages are the generic ones.

Tables used

SEEREFERTTO Refer to documentation Implementation