Rational Developer for System z, Version 7.6

Aide en Ligne

La fonctionnalité Aide en Ligne (ou Help) permet à un utilisateur de l'application de se débrancher à tout moment sur un écran d'information.

Fonctionnalité de l'aide en ligne

Cette information peut être de deux niveaux :
  • Soit un mode d'emploi général de l'Ecran,
  • Soit une documentation précise sur une zone saisissable de l'Ecran (valeurs possibles, par exemple).

Le débranchement se fait par positionnement de curseur et touche fonction, ou par positionnement d'un caractère spécifique dans la zone 'Choix' (CH) pour la documentation Ecran, ou dans la zone voulue.

L'ensemble de la documentation de l'Ecran et des Rubriques de l'Ecran forme un tout. Sur l'écran Aide, une zone choix permet de :
  • Revenir au début (documentation générale)
  • Continuer. Si la documentation générale est terminée, on passe à la première Rubrique, puis la deuxième, etc.
  • Arrêter l'affichage d'information et revenir à l'écran de travail initial.

Il faut juste définir l'Ecran Aide en ligne, il est inutile de le décrire ; sa forme est figée et ne peut être modifiée par l'utilisateur.

Le code de cet Ecran sera xxHELP, où xx est le code du Dialogue; on indiquera aussi le nom externe (PACHELP par défaut). Il faut ensuite le générer dans la variante de matériel concerné.

Contenu de l'aide en ligne

Les textes documentaires sont eux aussi générés à la demande dans le fichier séquentiel des libellés d'erreur.

Celui-ci servira à créer les fichiers libellés d'erreur des applications, par éclatement sous forme d'un fichier indexé ou d'une base de données suivant le matériel.

C'est à partir de ce dernier que le programme Aide en Ligne affiche la documentation.

La documentation Ecran provient des Lignes -GE de l'onglet Lignes -G de l'Ecran.

La documentation Rubrique provient :
  • De la Description de la Rubrique (onglet Lignes -D),
  • Des lignes de descriptions ou appels de Textes concernant la Rubrique : lignes de type C ou T consécutives à la ligne de type F,
  • Des libellés d'erreur standard (type 2 à 5),
  • Des libellés d'erreur utilisateur de type alphabétique (A à Z),
  • Des libellés d'erreur utilisateur de type numérique (6 à 9).
  • Des lignes de descriptions ou appels de Textes (Lignes -GE) concernant les erreurs liées à la Rubrique :
    • Les erreurs utilisateur : Lignes de type C ou T consécutives à une ligne de type U,
    • Les erreurs standard ou utilisateur : Lignes de type C ou T portant le code de l'erreur.
Note: Pour une meilleure présentation de l'écran Aide en Ligne il est préférable d'éviter les types alphabétiques pour définir des libellés utilisateur, puisque les numériques sont groupés avec les libellés standard.

Conditions d'utilisation | Commentaires en retour

Ce centre de documentation utilise la technologie Eclipse. (http://www.eclipse.org)