Rational Developer for System z, Version 7.6

Codification de l'aide en ligne

Vous indiquez l'aide en ligne d'un Ecran, d'une Rubrique ou d'un libellé d'erreur dans la section Lignes -GE de l'onglet Lignes -G 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 :
  • Saisir un T dans la zone Type, cliquer au clavier sur Entrée, puis cliquer à nouveau dans la zone Type. Le bouton Modifier de la zone Texte référencé se dégrise alors. Cliquez dessus pour afficher la boîte de sélection contenant les Textes présents dans le Référentiel courant. Cliquez sur le signe + situé devant un Texte pour afficher ses paragraphes. Sélectionnez l'un d'eux et cliquez sur OK. Le Texte et le paragraphe sélectionnés s'afficheront alors dans la zone Description.
  • Ou saisir un T dans la zone Type et saisir le code Texte directement dans la zone Description en respectant la codification suivante :
    Position 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...).

    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és 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 :
    Position Contenu
    1 à 5 Blancs
    6 Commentaires
    Sur une ligne de type T :
    6-11 Code du Texte appelé
    12-13 Code paragraphe (** pour tous les paragraphes).

    L'aide sur l'Ecran à laquelle l'utilisateur final peut accéder, grâce à la fonction Aide en Ligne (HELP) 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.

    Positions dans la zone Description :
    Position Contenu
    1 à 3 Blancs
    4 0 (zero)
    5 Blanc
    6 Commentaires
    Sur une ligne de type T :
    6-11 Code du Texte appelé
    12-13 Code paragraphe (** pour tous les paragraphes).

    La documentation d'une Rubrique à laquelle l'utilisateur final peut accéder, grâce à la fonction Aide en Ligne (ou HELP) 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 LIBELLES D'ERREUR
    • LIBELLE D'ERREUR EXPLICITE (sauf erreur sur Rubrique) :
      Positions dans la zone Description :
      Position 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)
    • LIBELLE D'ERREUR AUTOMATIQUE ET LIBELLE D'ERREUR EXPLICITE SUR RUBRIQUE :
      Positions dans la zone Description :
      Position 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
      Sur une ligne de type T :
      6-11 Code du Texte appelé
      12-13 Code paragraphe (** pour tous les paragraphes).
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)