Liens de documentation

Cette fonction permet de créer des liens documentaires utilisés dans le générateur de documentation. Ces liens complètent les informations du dictionnaire pour automatiser notamment des annexes et des pré-requis de la documentation. Une documentation annexe précise, pour chaque type de documentation, quels sont les liens possibles, et quels sont les paragraphes de documentation qu'ils alimentent.

Pré-requis

See also Reportez-vous à la documentation de Mise en oeuvre

Gestion de l'écran

Le bloc d'en-tête contient un type de documentation et un code correspondant. On rattache à ce type un tableau de liens.

Ecran de saisie

Chaque ligne du tableau représente un lien exploité dans la génération des documentations.

Bloc numéro 1

Type de doc (champ TYP)

Ce type, défini dans la table 910, définit le type de documentation pour lequel on définit les liens.

Module (champ MODULE)

Sélectionnez un module pour le paramétrage.

Ce champ vous permet de renseigner si l'écran doit être créé dans la base de données du dossier. Il l'est si le module auquel l'écran est rattaché est actif pour le dossier.
Code (champ COD)

Ce code définit le code de documentation à laquelle sont rattachés les liens.

Code activité (champ CODACT)

Un code activité vous permet de :

  • rendre optionnel un élément du dictionnaire si la valeur associée au code activité est nulle,
  • signer les éléments spécifiques dès lors qu'ils sont marqués par un code commençant par X, Y ou Z,
  • dimensionner un nombre de lignes maximum lorsque le code activité marque des éléments d'un tableau,

Si le code activité est désactivé :

  • l'élément marqué n'est pas utilisable,
  • le code associé n'est pas généré ou activé.

Tableau Liens

Numéro de ligne (champ NUM)
Type (champ TYPLNK)

Ce type de liens fait référence à la table diverse 913. Selon le type de documentation des liens différents sont autorisés.

Clé (champ CLELNK)

La clé de lien est liée au type précédemment saisi. Par exemple, lorsqu'on utilise le type ADP (paramètre), on saisit dans ce champ le code d'un paramètre, ou le nom d'une variable locale. Si on utilise le type ATB (table), on saisit dans ce champ le code d'une table de la base. Dans la plupart des cas, une fenêtre de sélection associée au contexte s'ouvre pour permettre de choisir parmi les codes possibles. On trouvera la liste des liens possibles dans l'annexe de la documentation.
Intitulé (champ INTLNK)

Intitulé associé au code précédent

Boutons spécifiques

Ce bouton permet de recopier la définition de la fiche depuis ou vers un autre dossier.

Bloc numéro 1

champ OBJET
champ CLES

Bloc numéro 2

Depuis le dossier (champ DOSORG)

Indiquez le dossier à partir duquel la fiche va être copiée. Les syntaxes possibles sont décrites dans l'annexe dédiée.
Tous dossiers (champ TOUDOS)

Cette option permet de copier la fiche vers tous les dossiers définis dans le dictionnaire (table ADOSSIER de la solution courante).
Vers le dossier (champ DOSDES)

Indiquez le dossier dans lequel la fiche va être copiée. Les syntaxes possibles sont décrites dans l'annexe dédiée.