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
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
Présentation
Chaque ligne du tableau représente un lien exploité dans la génération des documentations.
Fermer
Champs
Les champs suivants sont présents dans cet onglet :
Bloc numéro 1
| Ce type, défini dans la table 910, définit le type de documentation pour lequel on définit les liens. |
| [object Object] |
| Ce code définit le code de documentation à laquelle sont rattachés les liens. |
| Un code activité permet :
Ainsi, si le code activité est non actif, l'élément marqué ne sera pas utilisable, et le code associé (s'il y en a) ne sera pas généré ni activable. |
Tableau Liens
|
|
| Ce type de liens fait référence à la table diverse 913. Selon le type de documentation des liens différents sont autorisés. |
| 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é associé au code précédent. |
Fermer
Boutons spécifiques
Les champs suivants sont présents dans la fenêtre ouverte par ce bouton : Bloc numéro 1
Bloc numéro 2
Fermer Ce bouton permet de recopier la définition de la fiche depuis ou vers un autre dossier. |
Barre de menu
Option / Vérification liens
L'option de vérification des liens parcourt les liens existants et avertit si :
- l'objet est inexistant,
- le module est différent de l'objet,
- la documentation est inexistante,
- le code activité est différent de l'objet.
Option / Epuration liens
L'option d'épuration des liens permet de supprimer les liens reliés à :
- une documentation inexistante (code de la documentation d'en-tête n'existe pas),
- un objet (liens appartenant au tableau des liens).