Langage de définition de panneaux d'aide.(*PNLGRP)

BoTTom |    Changer de couleur
 
   U I M       User Interface Manager
 
               Gestionnaire d'Interface Utilisateur.
 
   Langage de définition de panneaux d'aide basé sur la notion
    d'étiquette (TAG), comme tout SGML , dont HTML est l'héritier. 

     Toute étiquette devant commencer par " : " (deux points)                     et se terminer  par " . " (un point)      Tout ce qui n'est pas étiquette est considéré comme du texte à afficher.      La commande CRTPNLGRP permet de créer un panneau d'aide à partir     d'un source UIM.(fichier source par dft = QPNLSRC)      Les panneaux d'aide peuvent être associés à des DSPF                                                 des Commandes utilisateur                                                des index de recherche                                                     (*SCHIDX, un peu obsolète)

Le langage UIM permet aussi de faire des menus

|    Changer de couleur
 
   U I M     Structure générale d'un source UIM
 
   * commentaire
-->:PNLGRP. <-----------------------------début et fin de panel-------------
!    ...                                                                   !
! -:IMPORT PNLGRP='panel' NAME='AIDE01' (pour :IMHELP)        <--niveau--  !
! !  ...                                                        général !  !
! !:ISCHSYN ROOT='racine1'.equivalent1 equivalent2 equivalent3 ...      !  !
! !:ISCHSYN ...                                                         !  !
! -  ...                                                      <----------  !
! -:HELP NAME='nom-aide'.texte-aide. <-début et fin d'aide--               !
! !:XH3.texte-aide-étendue. (aide étendue via F2)          !               !
! !:ISCH ROOTS='racine1'.   (mot-clé pour cette aide)      !               !
! !    ...                                                 !               !
! !    ...                                                 !               !
! !:IMHELP NAME='AIDE01'.   (importation)                  !               !
! !    ...                                                 !               !
! -:EHELP. <------------------------------------------------               !
!    ...                                                                   !
!    ...                                                                   !
!-->EPNLGRP. <--------------------------------------------------------------


|    Changer de couleur

 
    Définition des symboles UIM.                                     

UIM connait un certain nombre de symboles à remplacer à l'éxécution

Symbole remplacé par.
-------- --------------
&amp. ET commercial (&)

&colon. deux point (:)

&cont. continuation d'un texte ligne suivante

&period. point (.)

&slr. Slash (/)

&msg.(id,msgf,bib) texte du message

    msgf et bib sont optionnels dans le symbole &msg.s'ils ne sont pas
     indiqués, UIM cherchera le parametre SUBMSGF du tag :PNLGRP
.

Remarque : ces symboles peuvent être en minuscule ou MAJUSCULE.


|    Changer de couleur

 
    Regardons ensemble les principales étiquettes reconnues par UIM.
 
    :PNLGRP.   première étiquette du source
    :EPNLGRP.  derniere étiquette du source
 
   entre ces deux délimitateurs des aides commencant par
 
    :HELP NAME = 'nom-aide'.texte-de-l'aide. (WIDTH= ) (DEPTH= )
       ...
    :EHELP.  (sans paramètres)
 
     le nom de l'aide peut faire 32 caracteres,peut contenir un "/"
                      doit être construit de la maniere suivante dans
                       le cas d'une commande 'CCCCCC/PPPPP'
                                         ou   CCCCCC est le nom de la cde
                                                     PPPPPP le paramètre.
 
     WIDTH permet d'imposer une largeur de fenetre,DEPTH une hauteur
 
     :XH3. indique le texte à afficher avec l'aide étendue.
 


|    Changer de couleur

 
:P.   indique le début d'un paragraphe.chaque paragraphe est encadré
      (en haut et en bas) d'une ligne blanche.A l'intérieur d'un paragraphe
      UIM gère la présentation sans tenir compte du formatage dans le
      source.
:PC. indique le continuation d'un paragraphe.                     :PNLGRP.  :HELP NAME = 'UIM/F2' .Aide étendue.  :XH3. Voici le texte de l'aide étendue.  :P.   Les aides que vous voyez actuellement sont enregistrées dans un panneau  d'aide qui s'appelle UIM.  :P. ce texte est affiché quand vous appuyez sur F2 (AIDE ETENDUE).  :EHELP.     :HELP NAME = 'UIM/H1' WIDTH=32 DEPTH=9 .Paragraphes.  :XH3. Exemple de paragraphe.  :P.   Voici un premier paragraphe.  :P. En voici un deuxieme.  :EHELP. 

Résultat


Aide étendue (F2)


|    Changer de couleur
 
   UIM permet de gérer des listes.
 
   :PARML. = Liste de paramètres (utile pour les commandes)
 
   :PT.    = définition de terme.
             :PK. (def). définition d'un mot réservé(def= valeur par défaut)
             :PV.        définition d'une valeur possible.
 
             terminé par :EPK. ou :EPV.
 
   :PD.    = texte explicatif du terme.
 
             Les termes sont en haute intensité
 
                 les mots réservés en majuscule.
                 les valeurs en minuscules
 
                 la valeur par défaut est soulignée
 
   :EPARML.  Indique la fin d'une liste de paramètres.
 


|    Changer de couleur
 
 :HELP NAME = 'UIM/H2'.Liste de paramètres.
 :XH3.Exemple de liste de paramètres.
 :P.
 Voici une liste de paramètres.
 
 :PARML. 
 :PT.:PK def. *LIBL :EPK. 
 :PD. 
 La liste de bibliothèque (mot réservé par défaut)
 :PT.:PK. *CURLIB :EPK. 
 :PD. 
 La bibliothèque en cours (mot réservé possible)
 :PT.:PV. nom-bibli :EPV. 
 :PD. 
 Un nom de bibliothèque (valeur possible)
 :EPARML. 
 
 :PC.continuation du paragraphe.
 :EHELP.
 
 


|    Changer de couleur

 
   UIM gestion de listes.
 
   :OL.    = Liste ordonnée(les éléments de la liste sont numérotés par UIM)
 
   :LI.    = un élément de la liste.
 
   :EOL.   = Fin de la liste numérotée.
 
 
 :HELP NAME = 'UIM/H3'.Liste ordonnée.
 :XH3.Exemple de liste ordonnée.
 :P.
 Voici une liste ordonnée.
 :OL. 
 :LI. Premiere ligne
 :LI. Deuxieme ligne
 :LI. et enfin la troisieme
 :EOL. 
 :P.c'est le système qui numérote.
 :EHELP.
 


|    Changer de couleur

   UIM gestion de listes (suite).
 
   Les listes ordonnées peuvent être imbriquées
       le marquage se fera alors avec une notion de lettre a,b,c,...
 
 
 :HELP NAME = 'UIM/H4'.Listes ordonnées imbriquées.
 :XH3.Exemple listes ordonnées imbriquées.
 :P.
 Voici deux listes ordonnées imbriquées.
 :OL. 
 :LI. Premiere ligne
 :LI. Deuxieme ligne
 :OL. 
 :LI. première sous partie
 :LI. deuxieme sous partie
 :EOL. 
 :LI. et enfin la troisieme
 :EOL. 
 :P.c'est toujours le système qui numérote.
 :EHELP.
 


|    Changer de couleur

   UIM gestion de listes (suite).
 
   :UL.    = Liste non ordonnée.
             (les éléments sont marqués ("o")  par le système mais
              non numérotés)
   :EUL.   = Fin de liste non ordonnée.
 
 :HELP NAME = 'UIM/H5'.Listes non ordonnées imbriquées.
 :XH3.Exemple listes non ordonnées.
 :P.
 Voici deux listes non ordonnées imbriquées.
 :UL. 
 :LI.première ligne
 :LI.deuxieme ligne
 :UL. 
 :LI.première sous partie
 :LI.deuxieme sous partie
 :EUL. 
 :LI.et enfin la troisieme
 :EUL. 
 :EHELP.
 


|    Changer de couleur

   UIM gestion de listes (suite).
 
   :SL.    = Liste simple.
             (éléments non marqués, non numérotés)
 
   :ESL.   = Fin de liste simple.
 
 :HELP NAME = 'UIM/H6'.Liste simple.
 :XH3.Exemple de liste simple.
 :P.
 Voici une liste simple (sans marquage)
 :SL. 
 :LI.1er élément
 :LI.2eme élément
 :LI.3eme élément
 :ESL. 
 :EHELP.
 
 
 
 
 


|    Changer de couleur

   UIM gestion de listes (suite).
 
   :LP.    = Partie d'une liste
             (suite d'un élément)
 
             Sans TAG de fin.
 
 :HELP NAME = 'UIM/H7'.Partie d'une liste
 :XH3.Exemple partie d'une liste.
 :P.
 Voici une liste ordonnée avec une sous partie.
 :OL.
 :LI.première ligne
 :LI.deuxieme ligne
 :LP. suite de la deuxieme ligne.
 :LI.et enfin la troisieme
 :EOL.
 :EHELP.
 
 
 
 


|    Changer de couleur

   UIM définition de termes (gestion automatique d'entetes)
 
   :DL.   = Liste de définitions
 
   :DTHD. = Entete du terme
 
   :DDHD. = Entete de la définition
 
   :DT. un terme
   :DD. sa définition
   :DT. autre terme
   :DD. sa définition
        etc...
 
   :EDL.  = fin de liste
 
 
 
 
 
 
 

 


|    Changer de couleur

   UIM définition de termes (gestion automatique d'entetes)
 
 
 
 :HELP NAME = 'UIM/H8'.Entetes.
 :XH3.Exemple de gestion automatique d'entetes.
 :P.
 Voici un exemple avec des entetes.
 :DL. 
 :DTHD. Agence.
 :DDHD. Région couverte.
 :DT. NANTES
 :DD. Région ouest
 :DT. LYON
 :DD. Sud-est
 :DT. PARIS
 :DD. La capitale
 :EDL. 
 :EHELP.
 
 
 


|    Changer de couleur

   UIM gestion des entetes
 
   :Hn.   = définition d'une entete.
 
   :XHn.  = définition d'une entete (affichée uniquement sur l'aide
                                     étendue (via F2). )
 
   OU n peut prendre les valeurs suivantes:
 
        1                       Texte centré (Haute intensité + soulignement)
 
        2   Cadré à gauche (Haute intensité + soulignement)
 
        3  Cadré à gauche (Haute intensité)
 
        4  Cadré à gauche (soulignement)
 
 :HELP NAME = 'UIM/HD'.Texte premier niveau
 :XH3. Ce texte n'est affiché que sur l'aide étendue.
 :P.
 Appuyez sur F2 pour voir le texte associé à l'aide étendue.
 :EHELP.


Aide étendue


|    Changer de couleur

   UIM gestion des attributs.
 
   :HPn.   = définition d'un attribut d'affichage et d'impression.
 
   :EHPn.  = fin d'attribut.
 
   OU n peut prendre les valeurs suivantes:
 
        n  !    Affichage                   !    Impression
      -----!--------------------------------!-------------------------------
        0  !  normal                        !  normal
        1  !  Souligné                      !  Souligné 
        2  !  Haute intensité               !  Caracteres gras 
        3  !  Haute intensité +soulignement !  Caracteres gras +soulignement
        4  !   idem :HP0 (normal)           !   idem :HP0 (normal)
        5  !  :HP0 + inversion video        !  :HP0 + soulignement 
        6  !  :HP1 + inversion video        !  :HP1 
        7  !  :HP2 + inversion video (= ND) !  :HP2 + soulignement 
        8  !   idem :HP7                    !   idem :HP7 
        9  !  :HP0 + inversion video        !  :HP0 + soulignement 
 
 


|    Changer de couleur
   UIM gestion automatique d'attributs.
 
   :CIT.  = définition d'une citation (automatiquement soulignée)
 
   :ECIT. = Fin de la citation.
 
 
 
 
 :HELP NAME = 'UIM/H9'.Citation.
 :XH3.Exemple de citation.
 :P.
 Voici un exemple de citation.
 :P.
 Pour de plus amples explications voir :CIT. Programming display and help
 :ECIT. dans la salle machine.
 :EHELP.
 
 
 
 
 


|    Changer de couleur

   UIM gestion automatique d'attributs.
 
   :FIG.   = définition d'une figure (automatiquement encadrée par deux
                                     lignes soulignées)
   :FIGCAP.= Texte associé à la figure
 
   :EFIG. = Fin de la figure.
 
 
 :HELP NAME = 'UIM/HA'.Figure  .
 :XH3.Exemple de figure.
 :P.
 Voici un exemple de figure.
 :FIG. 
                     j'écris ce que je veux
        ou je veux.
 :FIGCAP. Voilà une figure.
 :EFIG. 
 :EHELP.
 
 
 


|    Changer de couleur

   UIM Exemples
 
   :XMP.   = définition d'un exemple(lignes non formatées, décalées de
                                     quatres positions vers la droite)
   :EXMP. = Fin de l'exemple.
 
 
 
 
 :HELP NAME = 'UIM/HB'.Exemple .
 :XH3.Exemple d'exemple UIM.
 :P.
 Voici un exemple d'exemple.
 :XMP. 
                     j'écris ce que je veux
     ou je veux.
     (les lignes sont décalées de 4 positions vers la droite)
 :EXMP. 
 :EHELP.
 
 
 


|    Changer de couleur

   UIM Lignes non formattées.
 
   :LINES.  = Début de lignes non formatées(affichées telles que saisies)
 
   :ELINES. = Fin de l'exemple.
 
 
 
 
 :HELP NAME = 'UIM/HL'.Lignes .
 :XH3.Exemple de lignes non formattées.
 :P.
 Voici un exemple de lignes non formattées par UIM.
 :LINES. 
                     j'écris ce que je veux
     ou je veux.
    (les lignes restent telles que saisies dans le source)
 :ELINES. 
 :EHELP.
 
 
 


|    Changer de couleur

   UIM Notes
 
   :NT.    = définition d'une remarque automatiquement precédée de
             Remarque: (en france) en haute intensité.
 
   :ENT.   = Fin de la note.
 
 
 
 :HELP NAME = 'UIM/HC'.Note.
 :XH3.Exemple de note.
 :P.
 Voici un exemple de note.
 :NT. voila une note automatiquement précédée de REMARQUE.
 :ENT. 
 :EHELP.
 
 
 
 
 
 


|    Changer de couleur

   UIM Copie d'aide.
 
   :IMHELP NAME = 'HHHHHH'
 
    permet de demander l'exécution d'une autre aide dont le
    nom est HHHHH (si cet aide n'appartient pas au même PNLGRP il
    faudra utiliser au préalable le TAG :IMPORT.)
 
 :HELP NAME = 'UIM/HE' .Aide à copier
 :XH3.Texte affiché en cas de copie.
 :P.
 Cette ligne fait partie de l'aide copiée.
 :EHELP.
 
 :HELP NAME = 'UIM/HF'.Aide contenant une copie.
 :XH3.Exemple de copie d'aide.
 :P.
 L'aide copiée est en dessous cette ligne.
 :IMHELP NAME='UIM/HE'. 
 :P.
 Retour à l'aide d'origine.
 :EHELP.


|    Changer de couleur

   UIM Copie d'aide.  avec :IMPORT
          dans panel UIMIMPORT  :HELP NAME = 'UIM/IMP'.Aide importée. :XH3.Voici le texte étendu de l'aide importée. :P. Les aides peuvent être importées venant d'une autre *PNLGRP :P.ceci ce fait via &colon.IMPORT apres &colon.PNLGRP et avant le premier &colon.HELP. :NT.le lien est fait à l'exécution. :ENT. :EHELP.
          autre panel groupe (UIM)  :PNLGRP. :IMPORT pnlgrp='UIMIMPORT' name='UIM/IMP'.   .... :HELP NAME = 'UIM/HM'.Importation. :XH3.Exemple d'aide importée. :ISCH ROOTS='import'.Exemple d'importation. :P.Voici un exemple d'aide importée L'aide copiée est en dessous cette ligne. :IMHELP NAME='UIM/IMP'. :P.Retour a l'aide d'origine. :EHELP.


|    Changer de couleur

   UIM Hypertexte.
 
       L'hypertexte permet d'associer une aide complementaire
         à un mot de module d'aide.
 
       Ce mot sera précédé d'une zone de saisie.l'utilisateur pourra
        alors saisir un caractère (n'importe lequel) pour visualiser
        l'aide associée à ce mot.
 
    :LINK PERFORM = 'DSPHELP HHHHHHH ppppppp'.
 
          ou HHHHHH est le nom du module d'aide
 
             pppppp est le nom du PNLGRP (facultatif si c'est le même)
 
    suivi du mot concerné, puis
 
 
    :ELINK.  TAG de fin.
 
 
 


|    Changer de couleur
 
 :HELP NAME = 'UIM/HG' .Hypertexte (définition).
 :XH3.Définition de l'HYPERTEXTE.
 :P.
 L'hypertexte est une aide associée à un mot d'un panneau d'aide.
 :P.
 Une aide de l'aide en quelque sorte.
 :NT.La touche F6 est active
 :ENT.
 :EHELP.
 
 :HELP NAME = 'UIM/HH'.Hypertexte (utilisation).
 :XH3.Utilisation de l'HYPERTEXTE.
 :P.
 Voici un exemple d'utilisation de l'
 :LINK PERFORM='DSPHELP UIM/HG'. 
 hypertexte
 :ELINK. 
 avec UIM.
 :NT.Tapez un caractere dans la zone de saisie puis appuyez sur <ENTREE>
 :ENT.
 :EHELP.

Hypertexte




|    Changer de couleur

 
Le lien avec l'hypertexte peut être conditionné
 
   LINKWHEN 'condition'
 
Il est possible d'associer plusieurs conditions à un "LINK".
 
SYNTAXE COMPLETE:
 
   :LINK PERFORM='DSPHELP aide panel'
         (UNLESSx='conditionx' THENDOx='DSPHELP aide1 panel'
          (UNLESSy='conditiony' THENDOy='DSPHELP aide2 panel') )
         (LINKWHEN='conditionz').
 
   Le "LINK" n'est exécuté que si 'conditionz' est VRAIE
 
   si conditiony est vraie THENDOy est exécuté
   sinon si conditionx est vraie THENDOx est exécuté
         dans tous les autres cas le PERFORM initial est exécuté.
 
 
 


|    Changer de couleur
 
Les conditions utilisables
 
    1/ Tester l'existence et les droits sur un objet
 
       'CHKOBJ("OBJET","TYPE"(,"DROITS"))'
 
          si QRPG existe 'CHKOBJ("QRPG","*LIB")
 
          si l'utilisateur a le droit de modifier le fichier CLIENTP1
                         'CHKOBJ("CLIENTP1","*FILE","*CHANGE")'
 
    2/ Tester la classe de l'utilisateur
 
       'CHKUSRCLS("user-classe")'
                   !
                   !--> *SECOFR Officier de sécurité
                        *SECADM (ou *SECOFR)
                        *PGMR   (ou *SECADM ou *SECOFR)
                        *SYSOPR (ou *PGMR ou *SECADM ou *SECOFR)
                        *USER   (ou un des précédents = tout le monde)
 





|    Changer de couleur

   
L'api QUHDSPH permet d'afficher un ou plusieurs panneaux d'aide

Voyez notre exemple DSPHELPG ET la commande que nous avons mis en "frontal" de ce RPG


|    Changer de couleur

   UIM Index de recherche
 
       Il est possible de prévoir des entrées d'index de recherche dans
         un panneau d'aide.
 
    :ISCH ROOTS='paragraphe'.Exemple de paragraphe.
 
          ou "paragraphe" est le mot "clé" associé à cet aide
 
             "Exemple de ..." le texte affiché par le pgm de recherche
                              dans l'index (cde STRSCHIDX)
 
    quelques exemples:
 
 :HELP NAME = 'UIM/H2'.Liste de paramètres.
 :XH3.Exemple de liste de paramètres.
 :ISCH ROOTS='liste paramètre'.Exemple liste de parametres.
    .....
 :HELP NAME = 'UIM/H4'.Listes ordonnées imbriquées.
 :XH3.Exemple listes ordonées imbriquées.
 :ISCH ROOTS='liste imbriquee'.Exemple listes imbriquées.
  .....


|    Changer de couleur
   UIM Index de recherche
 
       Il est en général conseillé d'associer à chaque mot "clé"
        une liste de synonymes afin de faciliter la recherche
        des utilisateurs
 
      :ISCHSYN ROOT'mot-clé'.synonyme1 synonyme2 synonyme3 etc...
 
      Ces définitions de synonymes se placent en général en début de source
       mais elles peuvent être placées dans un pannel groupe spécifique
       qui sera associé au même index de recherche.
 
      Puis il faut associer le panneau d'aide à l'index par la cde CL
                                                        ADDSCHIDXE.
 
 :PNLGRP
 :ISCHSYN ROOT='liste'.liste OL UL SL LI LP list listes
 :ISCHSYN ROOT='parametre'.parametre paramètres mot clé mot-clé keyword
 :ISCHSYN ROOT='ordonnée'.ordonnée ordonnées ordonner
 :ISCHSYN ROOT='ordonnée'.numérotée numérotées numeroter numérotation
 :ISCHSYN ROOT='imbriquee'.imbriquée imbriquées imbriquation imbriquer
 


|    Changer de couleur

 
ATTENTION
 
 
          le lien entre l'index et le panel groupe est fait
          lors de l'exécution de la commande ADDSCHIDXE.
 
SI vous modifiez les entrées (:ISCH) ou les synonymes (:ISCHSYN)
   il faut refaire ce lien:
 
                           RMVSCHIDXE
                     puis  ADDSCHIDXE
 
  Depuis la V2R30 on peut organiser les sujets en ordre hiérarchique. 
 
     sujet 1
       sujet 11     --> sujet 11 est sous-rubrique de sujet 1
         sujet 11a
         sujet 11b      --> sujet 11a et 11b sont sous rubriques de sujet 11
       sujet 12
         sujet 12a      etc ...
     sujet 2


|    Changer de couleur
Ma mise en oeuvre est la suivante :
 
 :HELP NAME = 'UIM/S1' .Sujet 1
 :ISCH ROOTS='sujet1'.Sujet de niveau 1
 :ISCHSUBT topics='UIM/S11'
           topics='UIM/S12'.
 :P.aide du sujet de niveau 1
 :EHELP.
 :HELP NAME = 'UIM/S11' .Sujet 1-1.
 :ISCH ROOTS='sujet 1'.Sujet de niveau 11.
 :ISCHSUBT topics='UIM/S11a'
           topics='UIM/S11b'.
 :P.aide du sujet de niveau 1 sous rubrique 1.
 :EHELP.
 :HELP NAME = 'UIM/S12' .Sujet 1-2.
 :ISCH ROOTS='sujet 12'.Sujet de niveau 12.
 :P.aide du sujet de niveau 1 sous rubrique 2
 :EHELP.
 :HELP NAME = 'UIM/S11a' .Sujet 1-1/a.
 :ISCH ROOTS='sujet 11 a'.Sujet de niveau 11/a.
 :P.aide du sujet de niveau 1 sous rubrique 1/a
 :EHELP.


|    Changer de couleur
 :HELP NAME = 'UIM/S11b' .Sujet 1-1/b.
 :ISCH ROOTS='sujet 11 b'.Sujet de niveau 11/b.
 :P.aide du sujet de niveau 1 sous rubrique 1/b
 :EHELP.
 :HELP NAME = 'UIM/S2' .Sujet 2.
 :ISCH ROOTS='sujet 2'.Sujet de niveau 2.
 :P.aide du sujet de niveau 2
 :EHELP.
 
 Un panneau ne peut pas être indiqué plusieurs fois en tant que sous
  rubrique d'un même panneau :     :ISCHSUBT topics='H1'
                                             topics='H1' est interdit
 
Mais un panneau peut être sous rubrique de plusieurs panneaux différents
 
La seule limite est le niveau d'imbriquation limité à 16 !!
 
Tous les panneaux n'étant pas référencés en tant que sous rubrique sont
 considérés de premier niveau (un index sans sous rubrique ne contient que
 des panneaux de premier niveau = index avant V2R30)
 
Vous allez visualiser un index contenant les panneaux ci-dessus :


|    Changer de couleur
                                  Index d'aide 
 
 Indiquez vos options et appuyez sur ENTREE (+ indique des sous-rubriques) 
   5=Afficher rubrique   6=Imprimer rubrique   7=Détailler rubrique 
   8=Condenser rubrique 
 
 Opt   Rubrique 
       Index avec sous rubriques (V2R30)                                        
       + Sujet de niveau 1.                                                     
         Sujet de niveau 2.                                                     
 
 
 
 
 
 
 
 ou entrez les termes à rechercher et appuyez sur ENTREE (le signe * indique 
   les rubriques contenant les termes recherchés). 
                                                                               
 F3=Fin d'aide          F5=Toutes les rubriques   F6=Rubriques principales 
 F11=Cacher structure   F12=Annuler   F18=Autres index   F24=Autres touches 


|    Changer de couleur
                                  Index d'aide 
 
 Indiquez vos options et appuyez sur ENTREE (+ indique des sous-rubriques) 
   5=Afficher rubrique   6=Imprimer rubrique   7=Détailler rubrique 
   8=Condenser rubrique 
 
 Opt   Rubrique 
       Index avec sous rubriques (V2R30)                                        
  7    + Sujet de niveau 1.                                                     
         Sujet de niveau 2.                                                     
 
 
 
 
 
 
 
 ou entrez les termes à rechercher et appuyez sur ENTREE (le signe * indique 
   les rubriques contenant les termes recherchés). 
                                                                               
 F3=Fin d'aide          F5=Toutes les rubriques   F6=Rubriques principales 
 F11=Cacher structure   F12=Annuler   F18=Autres index   F24=Autres touches 


|    Changer de couleur
                                  Index d'aide 
 
 Indiquez vos options et appuyez sur ENTREE (+ indique des sous-rubriques) 
   5=Afficher rubrique   6=Imprimer rubrique   7=Détailler rubrique 
   8=Condenser rubrique 
 
 Opt   Rubrique 
       Index avec sous rubriques (V2R30)                                        
         Sujet de niveau 1.                                                     
  7      + Sujet de niveau 11.                                                  
           Sujet de niveau 12.                                                  
         Sujet de niveau 2.                                                     
 
 
 
 
                                                                            Fin 
 ou entrez les termes à rechercher et appuyez sur ENTREE (le signe * indique 
   les rubriques contenant les termes recherchés). 
                                                                               
 F3=Fin d'aide          F5=Toutes les rubriques   F6=Rubriques principales 
 F11=Cacher structure   F12=Annuler   F18=Autres index   F24=Autres touches 


|    Changer de couleur
                                  Index d'aide 
 
 Indiquez vos options et appuyez sur ENTREE (+ indique des sous-rubriques) 
   5=Afficher rubrique   6=Imprimer rubrique   7=Détailler rubrique 
   8=Condenser rubrique 
 
 Opt   Rubrique 
       Index avec sous rubriques (V2R30)                                        
  8      Sujet de niveau 1.                                                     
           Sujet de niveau 11.                                                  
             Sujet de niveau 11/a.                                              
             Sujet de niveau 11/b.                                              
           Sujet de niveau 12.                                                  
         Sujet de niveau 2.                                                     
 
 
                                                                            Fin 
 ou entrez les termes à rechercher et appuyez sur ENTREE (le signe * indique 
   les rubriques contenant les termes recherchés). 
                                                                               
 F3=Fin d'aide          F5=Toutes les rubriques   F6=Rubriques principales 
 F11=Cacher structure   F12=Annuler   F18=Autres index   F24=Autres touches 


|    Changer de couleur
Quelques copies d'écran




|    Changer de couleur

Une aide peut être associée à une Aire dans un DSPF

:PNLGRP.
:HELP NAME = 'TITRE'.Interrogation producteurs.
:XH3.Interrogation producteurs.
:P.Interrogation fichier producteurs.
:EHELP.
:HELP NAME = 'GENERAL'.Interrogation producteurs.
:XH3.Interrogation producteurs.
:P.Cet écran affiche une liste de producteurs après saisie de différents critères.
   (Région et/ou Appellation)
:EHELP.
:HELP NAME = 'REGION'.Saisie d'une région.
:XH3.Interrogation producteurs, region.
:P.Saisissez un nom ou une partie d'un nom de région.
   (comme LOIRE ou SUD)
:EHELP.
:HELP NAME = 'APPELLATION'.Saisie d'une appellation.
:XH3.Interrogation producteurs, appellation.
:P.Saisissez un nom ou une partie d'un nom d'appellation.
   (comme LAYON ou MADIRAN)
:EHELP.
:EPNLGRP. 


Dans le DSPF


HELP : active la touche Aide

ALTHELP(CA01) : F1 remplace la touche AIDE

HLPTITLE : Titre général

Dans les formats :

  • H en colonne 17 (comme le R)
  • HLPPNLGRP indique l'aide et le groupe de panneaux
  • HLPARA, la partie d'écran concernée :
    • l1c1 l2 c2 , aire délimitée par angle supérieur gauche et angle inférieur droit
    • *FLD un-nom, aire délimitée par une zone de saisie
    • *RCD, aire délimitée par la totalité du format (à l'exception des zones d'aide définies avant)


vue de la fenêtre propriétés , sous RDI



Résultat


|    Changer de couleur

Une aide peut être associée à une Commande

Il doit y avoir un panneau portant le nom de la commande


puis un panneau par paramètre nommé : 'COMMANDE/PARM'


:HELP NAME = 'DSPHELP'.Affiche un panneau d'aide.
:P.La commande DSPHELP permet d'afficher un ou plusieurs panneaux d'aide.
:EHELP.
:HELP NAME = 'DSPHELP/AIDE'.Panneau d'aide.
:XH3.AIDE.
:P.Indiquez un ou plusieurs (25 maxi) pannel-groupe (*PNLGRP)
avec le nom du panneau d'aide à afficher.
:EHELP.
:HELP NAME = 'DSPHELP/RANGE'.Plage à afficher
:XH3.RANGE.
:P.Indiquez la plage d'aide à afficher.
:NT.les autres panneaux ne seront affichés que par F2.
:ENT.
:EHELP.
:HELP NAME = 'DSPHELP/TITRE'.Titre.
:XH3.TITRE
:P.Titre de l'aide
:EHELP.
:HELP NAME = 'DSPHELP/SCHIDX'.Index d'aide.
:XH3.SCHIDX
:P.Index d'aide à afficher par F11
:EHELP.
:HELP NAME = 'DSPHELP/PLEINECRAN'.Fenêtre ou plein écran.
:XH3.PLEINECRAN
:P.Afficher l'aide en fenêtre ou plein écran ?
:EHELP.
:HELP NAME = 'DSPHELP/CURSEUR'.Position curseur.
:XH3.CURSEUR
:P.Indiquer la position curseur.
:EHELP.
:HELP NAME = 'DSPHELP/FENETRE'.Aire concernée.
:XH3.FENETRE
:P.Indiquer l'aire de l'écran (la fenêtre) concernée.
:NT.Dans la mesure du possible, elle ne sera pas recouverte.
:ENT.
:EHELP.
:EPNLGRP.


les structures avec :PARML (liste de paramètres) prennent tout leur sens

Rappel :

:PT. explication d'un terme

PK : mot réservé (def = valeur par défaut)

par exemple :
PT.:PK def *LIBL:EPK
:PD chercher dans *LIBL

PV : une valeur

par exemple :
PT.:PV un nom:EPV
:PD utiliser cette biblothèque

exemple complet

:PARML.
:PT.:PK def.*NO :EPK.
:PD.
afficher en fenêtre.
:PT.:PK.*YES:EPK.
:PD.
afficher plein écran.
:EPARML.


Sur notre commande DSPHELP, voyez l'aide complète

Compilez avec HLPPNLGRP(DSPHELP) HLPID(*CMD)

voici le résultat


Suite


|    Changer de couleur

UIM permet aussi de faire des menus


Structure générale d'un menu

:PNLGRP.
:COPYR.
 <texte du copyright.>
:VAR  NAME=ZMENU.
.*
.* -----------------------------------------------------------------
.* Définition des touches de fonctions du menu
.* -----------------------------------------------------------------
:KEYL  NAME=menukeys
 HELP=keyl.
 :KEYI     KEY=F1
 HELP=helpf1
 ACTION=HELP.
  .../...
:EKEYL. .* .* ----------------------------------------------------------------- .* Définition du menu .* ----------------------------------------------------------------- :PANEL NAME=xmpmenu HELP='menu/help' KEYL=menukeys ENTER='MSG CPD9817 QCPFMSG' PANELID=ZMENU TOPSEP=SYSNAM. titre du menu .* .* ------------------------------------- .* Définir l'espace du menu .* ------------------------------------- :MENU DEPTH='*' SCROLL=NO BOTSEP=SPACE. :TOPINST.Sélectionnez une des options suivantes: :MENUI OPTION=1 ACTION='CMD xxxx' HELP='menu/option1'. Texte de l'option .../... :EMENU. :CMDLINE SIZE=LONG. Selection ou commande .* :EPANEL. .* .* ----------------------------------------------------------------- .* Définition des aides pour le menu, touches de fonctions .* ----------------------------------------------------------------- :HELP NAME=keyl. Aide pour les touches de fonction :XH3.Touches de fonction :EHELP. .* ------------------------------------------------------------------ * .* Aide des options * .* -------------------------------------------------------------------* :HELP NAME='menu/option1'. Option 1 - Aide :XH3.Option 1. :P. aide de l'option 1 :EHELP. .../...
:EPNLGRP.

 


|    Changer de couleur

Par exemple



Source du menu

:PNLGRP.
.* -----------------------------------------------------------------
.* Copyright affiché pour le premier affichage
.* -----------------------------------------------------------------
:COPYR.
 <texte du copyright Volubis/2018.>
.*
.* -----------------------------------------------------------------
.* UIM Z-variable utilisé pour identifier le panel de groupe
.* -----------------------------------------------------------------
:VAR      NAME=ZMENU.
.*
.* -----------------------------------------------------------------
.* Définition des touches de fonctions du menu
.* -----------------------------------------------------------------
:KEYL     NAME=menukeys
 HELP=keyl.
 :KEYI     KEY=F1
 HELP=helpf1
 ACTION=HELP.
 :KEYI     KEY=F3
 HELP=exit
 ACTION='EXIT SET'
 VARUPD=NO.
 F3=Exit
 :KEYI     KEY=F4
 HELP=prompt
 ACTION=PROMPT.
 F4=Invite
 :KEYI     KEY=F9
 HELP=retrieve
 ACTION=RETRIEVE.
 F9=Rappel
 :KEYI     KEY=F12
 HELP=cancel
 ACTION='CANCEL SET'
 VARUPD=NO.
 F12=annuler.
 :KEYI     KEY=ENTER
 HELP=enter
 ACTION=ENTER.
 :KEYI     KEY=HELP
 HELP=help
 ACTION=HELP.
 :KEYI     KEY=HOME
 HELP=home
 ACTION=HOME.
 :KEYI     KEY=PAGEDOWN
 HELP=pagedown
 ACTION=PAGEDOWN.
 :KEYI     KEY=PAGEUP
 HELP=pageup
 ACTION=PAGEUP.
 :KEYI     KEY=PRINT
 HELP=print
 ACTION=PRINT.
 :EKEYL.
.*
.* -----------------------------------------------------------------
.* Définition du menu
.* -----------------------------------------------------------------
:PANEL    NAME=xmpmenu
 HELP='menu/help'
 KEYL=menukeys
 ENTER='MSG CPD9817 QCPFMSG'
 PANELID=ZMENU
 TOPSEP=SYSNAM.
 Menu UIM d'exemple
 .*
 .* -------------------------------------
 .* Definir l'espace du menu
 .* -------------------------------------
 :MENU     DEPTH='*'
 SCROLL=NO
 BOTSEP=SPACE.
 :TOPINST.Sélectionnez une des options suivantes:
 .* ------------------------------------------------------------------ *
 .*                                                                    *
 .* Action effectuée par chaque  OPTION                                *
 .*                                                                    *
 .* -------------------------------------------------------------------*
 :MENUI    OPTION=1
 ACTION='CMD WRKACTJOB'
 HELP='menu/option1'.
 Travaux actifs
 :MENUI    OPTION=2
 ACTION='CMD WRKSPLF'
 HELP='menu/option2'.
 Vos spools
 :MENUI    OPTION=3
 ACTION='CMD ?WRKMSG'
 HELP='menu/option3'.
 Vos messages
 :MENUI    OPTION=4
 ACTION='CMD CALL QEZSNDMG'
 HELP='menu/option4'.
 Envoi de message par assistant.
 :MENUI    OPTION=5
 ACTION='MENU MAJOR'
 HELP='menu/option5'.
 Menu d'accès à toutes les commandes
.*
:EMENU.
.*
.* ----------------------------------------------------------------- *
.* permet d'utiliser une ligne de commande grand format              *
.* ----------------------------------------------------------------- *
:CMDLINE  SIZE=LONG.
Selection ou commande
.*
:EPANEL.
.*
.* -----------------------------------------------------------------
.* Définition des aides pour le menu, touches de fonctions
.* -----------------------------------------------------------------
 :HELP     NAME=keyl.
  Aide pour les touches de fonction 
  :XH3.Touches de fonction
 :EHELP.
.*
 :HELP     NAME=helpf1.
  :PARML.
  :PT.F1=Aide
  :PD.
  Informations complémentaires sur l'utilisation de cet écran ou sur les
  zones de cet écran.
  :EPARML.
 :EHELP.
 .*
 :HELP     NAME=exit.
  :PARML.
  :PT.F3=Exit
  :PD.
  Arrêt de la tâche en cours d'exécution et retour à la tâche précédente.
  :EPARML.
 :EHELP.
 .*
 :HELP     NAME=prompt.
  :PARML. 
  :PT.F4=Invite
  :PD.
  Permet d'utiliser l'invite ou la sélection de commande.
  :EPARML.
 :EHELP.
 .*
 :HELP     NAME=retrieve.
  :PARML.
  :PT.F9=Rappel
  :PD.
  Affiche la dernière commande que vous avez entré avec les paramètres
  que vous avez choisi. Si vous appuyez a nouveau sur la touche vous
  aurez la commande précédente et ainsi de suite.
  :EPARML.
 :EHELP.
 .*
 :HELP     NAME=cancel.
  :PARML. 
  :PT.F12=Retour
  :PD.
  Retourne a l'écran précédent.
  :EPARML.
 :EHELP.
 .*
 :HELP     NAME=enter.
  :PARML.
  :PT.ENTRER
  :PD.
  Permet de valider une saisie.
  :EPARML.
 :EHELP.
 .*
 :HELP     NAME=help.
  :PARML. 
  :PT.Help
  :PD.
  Permet d'afficher l'aide concernant le menu ou une option du menu.
  :EPARML.
 :EHELP.
 .*
 :HELP     NAME=home.
  :PARML.
  :PT.Home
  :PD.
  Pour avoir ce menu comme menu initial placer le dans votre profil
  dans le paramètre INLMNU(  ).
  :EPARML.
 :EHELP.
 .*
 :HELP     NAME=print.
  :PARML. 
  :PT.Print
  :PD.
  Imprime les informations affichées sur l'écran.
  :EPARML.
 :EHELP.
 .*
 :HELP     NAME='menu/help'.
  Aide du menu.
  :P.
  Aide sur l'utilisation du menu.
  :XH3.
  Comment utiliser ce menu:
  :P.
  Pour sélectionner une option entrez le numéro de l'option et appuyez
  sur entrer.
  :P.
  Pour lancer une commande Tapez la commande et appuyer sur entrer, si
  vous désirez l'invite, appuyer sur la touche de fonction F4 (Invite).
  Vous pouvez de l'aide par la touche de fonction F1 ou HELP .
  vous pouvez rappeler une commande en appuyante sur F9 (Rappel).
 :EHELP.
 .* ------------------------------------------------------------------ *
 .* Aide des options                                                   *
 .* -------------------------------------------------------------------*
 :HELP     NAME='menu/option1'.
  Option 1 - Aide 
  :XH3.Option 1.
  :P.
  Commande WRKACTJPOB, montre tous les travaux actifs
 :EHELP.
 :HELP     NAME='menu/option2'.
  Option 2 - Aide 
  :XH3.Option 2.
  :P.
  Voir vos spools.
 :EHELP.
 :HELP     NAME='menu/option3'.
  Option 3 - Aide
  :XH3.Option 3.
  :P.
  Voir vos messages.
 :EHELP.
 :HELP     NAME='menu/option4'.
  Option 4 - Aide
  :XH3.Option 4.
  :P.
  API d'assitant pour envoyer des messages.
 :EHELP.
 :HELP     NAME='menu/option5'.
  Option 5 - Aide 
  :XH3.Option 5.
  :P.
  Menu MAJOR , permet de d'accèder à toutes les commandes
 :EHELP.
 :EPNLGRP. 




©AF400