Développement > Dictionnaire données > Documentation > Documentation sur champs
Documentation sur champs
Cette fonction permet de saisir l'aide associée à chaque champ du progiciel, stockée dans la base de données sous la forme de textes html. Cette aide est caractérisée par un mot-clé et un code langue. On rattache le mot-clé au champ des écrans via la rubrique correspondante dans le dictionnaire des écrans.
Cette aide est ensuite générée sur disque grâce à une fonction d'extraction dédiée. Elle est placée dans un sous-répertoire nommé FLD. Mais chaque aide sur champ est également intégrée dans l'aide fonctionnelle, si l'écran qui porte le champ documenté est associé à un paragraphe de cette aide.
Il est à noter qu'une fonction de mise à jour des mots-clés d'aide d'un écran est directement accessible par zoom depuis le code écran défini dans les paragraphes de l'aide fonctionnelle.
Pré-requis
Reportez-vous à la documentation de Mise en oeuvre
Gestion de l'écran
Ecran de saisie
Présentation
Outre le code langue et le code du document, on retrouve dans cet écran un bloc où l'on peut saisir le texte de l'aide, via un éditeur HTML, dont l'utilisation est détaillée dans une documentation annexe.
Fermer
Champs
Les champs suivants sont présents dans cet onglet :
Caractéristiques
| Définit la langue dans laquelle un texte est exprimé. |
| Ce code identifie de façon unique la fiche en cours. |
| Module d'appartenance du paragraphe de la documentation. |
| Lorsque cette case est cochée, l'aide est considérée comme générique, c'est à dire réutilisable de façon très large dans des écrans autres que celui pour lequel elle a été faite au départ. Une fonction dédiée de sélection permet de sélectionner les aides génériques. |
|
|
|
|
Lien
|
|
Texte d'aide
| Ce champ permet de saisir le texte de l'aide sur champ tel qu'il apparaîtra lors de l'appel de l'aide, et tel qu'il sera inséré dans la documentation fonctionnelle qui référence l'écran où cette aide est utilisée. |
Fermer
Etats
Par défaut, les états suivants sont associés à la fonction :
ADOCFLD : Aides sur champ
Mais ceci peut être modifié par paramétrage.
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 / Actions / Copie documentation
Permet de copier l'aide vers un autre dossier, de façon plus globale que le bouton correspondant. On peut ici donner des bornes pour faire des copies en masse. Les syntaxes possibles pour définir un dossier sont définies dans une documentation annexe.
Option / Actions / Priorisation traduction
Permet de définir un ordre de priorité dans la traduction des documentations.
Option / Actions / Suppression doc toutes langues
Permet de supprimer la documentation sur champ dans toutes les langues existantes. Une fenêtre de confirmation apparait, si la réponse est positive, l'opération est irréversible.
Option / Vérifications / Aides non utilisées
Permet de lancer une recherche globale dans le dictionnaire des écrans, afin de retrouver les aides sur champ qui ne sont utilisées dans aucun écran. La liste apparaît sous forme de fichier trace.
Option / Vérifications / Aides manquantes
Permet de lancer une recherche globale dans le dictionnaire des écrans, afin de retrouver les champs sur lesquels il n'y a pas de mot-clé d'aide, ou sur lesquels le mot-clé référencé ne correspond pas à une aide sur champ existante. La liste apparaît sous forme de fichier trace.
Option / Vérifications / Epuration aides non utilisées
Option / Cas d'emploi
Permet de visualiser, dans une fenêtre de sélection, les écrans où l'aide sur champ courante est utilisée.