Codification de l'aide en ligne (Ecran standard ou client)

Vous indiquez l'aide en ligne d'un Ecran, d'une Rubrique ou d'un libellé d'erreur dans les Lignes -GE de l'Ecran considéré.

Pourquoi et quand exécuter cette tâche

Pour documenter un Ecran, une Rubrique ou un libellé d'erreur, vous pouvez déclarer deux types de lignes :
  • Type = C pour la déclaration d'un libellé commentaire,
  • Type = T pour la déclaration d'un appel de Texte.
Vous pouvez appeler un Texte de deux façons :
  • Cliquez sur Ajouter et sélectionnez T dans la zone Type. Cliquez ensuite dans la zone Lien et cliquez sur le bouton affiché alors dans cette zone pour ouvrir un assistant de sélection des Textes disponibles. Vous pouvez sélectionner un Texte en entier ou seulement certains de ses paragraphes. Pour sélectionner des paragraphes, cliquez sur le signe + situé devant un Texte et sélectionnez au moins un paragraphe. Cliquez sur OK et le Texte sélectionné, avec ses paragraphes, s'afficheront alors dans la zone Description.
  • Sélectionnez T dans la zone Type et saisissez le nom d'un Texte directement dans la zone Description en respectant la codification suivante :
    Tableau 1. Positions dans la zone Description
    Positions Contenu
    6 - 11 Texte
    12 - 13 Code du paragraphe sélectionné, ou ** pour tous les paragraphes
Remarque : Vous pouvez affecter des lignes de commentaires à des erreurs explicites manuelles au niveau des Lignes -GE du Dialogue. Ces lignes ne seront pas accessibles à partir du programme standard assurant la fonction d'aide en ligne. dans les transactions générées.
Pour indiquer une documentation sur un Ecran, une Rubrique ou un libellé d'erreur, vous devez respecter le formalisme suivant :
  • Documentation d'un Ecran:
    Les lignes documentaires affectées à un Ecran doivent se trouver dans les Lignes -GE de l'Ecran considéré. Vous devez respecter les positions suivantes dans la zone Description :
    Tableau 2. Positions dans la zone Description
    Positions Contenu
    1 à 5 Blancs
    6 Commentaires
    6-11 Code du Texte appelé sur une ligne de type T
    12-13 Code paragraphe (** pour tous les paragraphes).sur une ligne de type T

    L'aide sur l'Ecran à laquelle l'utilisateur final peut accéder, grâce à la fonction aide en ligne dans les transactions générées, est composée des lignes de type C ou T des Lignes -GE affectées à l'Ecran, puis des lignes de type U, C ou T affectées à un Segment.

  • Documentation d'une Rubrique:
    Les lignes de type C ou T affectées à une Rubrique doivent suivre une ligne de type F se rapportant à cette Rubrique.
    Tableau 3. Positions dans la zone Description
    Positions Contenu
    1 à 3 Blancs
    4 0 (zéro)
    5 Blanc
    6 Commentaires
    6-11 Texte appelé sur une ligne de type T
    12-13 Code paragraphe (** pour tous les paragraphes).sur une ligne de type T

    La documentation d'une Rubrique à laquelle l'utilisateur final peut accéder, grâce à la fonction d'aide en ligne dans les transactions générées, est composée des lignes de type C ou T affectées à la Rubrique, des lignes de description de la Rubrique suivies des libellés d'erreur générés pour cette Rubrique plus éventuellement les libellés documentaires s'y rapportant.

  • Documentation des libellés d'erreur
    • Libellé d'erreur explicite (sauf erreur sur Rubrique) :
      Tableau 4. Positions dans la zone Description
      Positions Contenu
      1 à 4 Numéro de l'erreur à documenter (reste à blanc après une ligne de type U, C ou T se rapportant à l'erreur)
    • Libellé d'erreur automatique et libellé d'erreur explicite sur Rubrique :
      Tableau 5. Positions dans la zone Description
      Positions Contenu
      1 à 3 Numéro de l'erreur à documenter.

      Il reste à blanc après une ligne de type F, U, C ou T se rapportant à la Rubrique à document.r)

      4 Position du libellé documentaire.

      2 4 5 6 7 8 par exemple : commentaires de la ligne après le libellé d'erreur du type indiqué (2 4 5 6 7 8)

      5 Blanc
      6 Commentaires
      6-11 Code du Texte appelé sur une ligne de type T
      12-13 Code paragraphe (** pour tous les paragraphes) sur une ligne de type T.

Que faire ensuite

Vous devez ensuite générer les libellés d'erreur. Pour cela, vous devez créer une instance de Libellé d'erreur et l'associer au Dialogue. L'instance de Libellé d'erreur rassemble les options de génération des libellés d'erreur de ce Dialogue. Vous pouvez alors générer l'instance de Libellé d'erreur.


Vos commentaires