Rational Programming Patterns

Codification de l'aide en ligne (Ecrans standard ou clients TUI)

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.
Pour appeler un Texte, vous pouvez :
  • Cliquer sur le bouton Ajouter et sélectionner 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.
  • Ou sélectionner un T dans la zone Type et saisir le code Texte directement dans la zone Description en respectant la codification suivante :
    Tableau 1. Positions dans la zone Description
    Positions Contenu
    6 - 11 Code du Texte appelé.
    12 - 13 Code du paragraphe sélectionné, ou ** pour sélectionner tous les paragraphes
Notes :
  • Traitement de texte

    Les Textes appelés sont alignés sur une maquette d'édition standard.

    Les Textes appelés sont justifiés s'ils contiennent une commande de le forme $n. S'ils ne comportent pas de commande de justification, ils s'affichent tel quel. Attention, si un texte non justifié suit un texte contenant un $n, il sera également justifié sauf s'il contient une commande de la forme $$n en en-tête.

    Toutes les possibilités de traitement de texte seront exploitées (soulignement, indentation négative par exemple).

    Les sauts de lignes sont ceux du Texte, mais limités à un saut de 3 maximum (les sauts plus grands sont ramenés à 3); les sauts de page sont ramenés à un saut de 3.

    Ainsi le même Texte peut faire partie de la documentation en ligne et du manuel utilisateur de l'application.

  • Erreurs générales Dialogue

    Vous pouvez affecter des lignes de commentaires à des erreurs explicites manuelles au niveau des Lignes -GE associées au Dialogue. Ces lignes ne seront pas accessibles, à partir du programme standard assurant la fonction 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 Code du 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 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 (reste à blanc après une ligne de type F, U, C ou T se rapportant à la Rubrique à documenter)
      4 Position du libellé documentaire : 2 4 5 6 7 8... commentaires de la ligne après le libellé d'erreur de 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 le fichier des libellés d'erreur.

Conditions d'utilisation | Commentaires en retour

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