Skip to Content

Documenter l’aide en ligne

Version 34.1 par Doriane Bautista le 2025/09/11 15:02

Version 4.5.54 et ultérieures

Dans Flora, chaque champ ou bloc de champ est accompagné d’une aide en ligne accessible directement depuis une grille de saisie. Par défaut, l’aide affichée provient du wiki.

Elle peut toutefois être personnalisée : chaque institution a la possibilité de rédiger sa propre aide en ligne afin d’adapter les consignes à ses besoins internes et à sa charte de saisie.

À quoi sert l'aide en ligne dans Flora ?

L’aide en ligne accompagne les utilisateurs dans la compréhension et l’usage des champs et blocs de champs présents dans toutes les tables de Flora. Elle permet d’assurer une saisie cohérente et conforme aux pratiques définies par l’institution.

Lorsqu’un musée crée une aide en ligne personnalisée, celle du wiki disparaît au profit du contenu local. Si la personnalisation est ensuite supprimée, l’aide du wiki réapparaît automatiquement. Cette personnalisation n’a d’effet que dans la base de données de l’institution qui l’a rédigée : elle ne modifie en rien les contenus du wiki et n’impacte pas les autres musées.

Cas d'usage: 

Expliquer le contenu attendu dans un champ.

Formaliser les règles de saisie propres à l’institution.

Indiquer à quels processus le champ est lié  (ex. : inventaire, récolement, prêt, dépôt, restauration, etc.).

Donner accès à des ressources externes de référence. 

Harmoniser les pratiques et éviter les erreurs d’interprétation.

Bonnes pratiques : 

  • Uniformisez la présentation : adoptez une structure homogène pour toutes vos aides (ex. : définition, usage, remarques).
  • Soyez clairs et concis : rédigez des explications courtes et immédiatement compréhensibles.
  • Employez le vocabulaire métier partagé : utilisez les termes définis dans la charte de saisie de votre institution.
  • Précisez le contexte d’utilisation : indiquez si le champ ou le bloc est lié à un processus particulier (inventaire, récolement, prêt, dépôt, restauration).
  • Ajoutez des exemples concrets : illustrez les valeurs attendues afin d’éviter les ambiguïtés.
  • Limitez les redondances : ne recopiez pas intégralement l’aide du wiki, mais complétez-la ou adaptez-la selon vos besoins.
  • Documentez aussi les blocs de champs : expliquez leur rôle global en plus des champs qu’ils contiennent.
  • Conservez une mémoire interne : gardez une copie (Word, tableur, etc.) de vos aides personnalisées pour en assurer le suivi et la maintenance lors des mises à jour Flora.
  • Vérifiez l’accessibilité : testez l’ouverture des pop-up d’aide dans les navigateurs utilisés.
  • Mettez à jour régulièrement : adaptez vos contenus lorsque vos procédures internes ou règles métier évoluent.

Récupérer le nom informatique du champ ou du bloc à documenter

Pour retrouver le fichier d’aide correspondant, vous devez d’abord identifier le nom interne du champ ou du bloc de champs. Pour cela : 

  • Survolez le libellé dans une grille de saisie : son nom interne s’affiche en infobulle.
  • Vous pouvez aussi faire un clic droit sur le libellé et choisir Afficher informations pour copier directement le nom interne. 

Exemple : dans la table MUS_BIEN, le champ Numéro d’inventaire porte le nom technique NUM_INVENTAIRE.

1744363912649-947.png

Ex. Biens : survol d'un libellé et affichage du nom interne en infobulle

1744363948510-224.png

Ex. Biens : clic droit sur le champ - Afficher informations

1744363968204-295.png

Résultat : Nom interne du champ indiqué sur la première ligne

Accéder à l'éditeur d'aide en ligne

Pour créer ou modifier une aide, rendez-vous dans l’espace de travail Administration, menu Paramétrage > Aide en ligne.

Vous y trouverez la liste des fichiers disponibles, organisés par source et par table.

Dépliez la rubrique Aide à la saisie pour rechercher les champs et blocs de champs à documenter. 

1757594385587-551.png

Espace de travail Administration > menu Paramétrage > Aide en ligne > rubrique Aide à la saisie

Rechercher le champ ou le bloc à documenter

Une fois dans le module d’édition des aides en ligne, vous devez localiser précisément le champ ou le bloc concerné avant de pouvoir le personnaliser. Procédez étape par étape :

  1. Choisissez la source (ex. Musées, Bibliothèque, Archives).
  2. Sélectionnez la table dans laquelle se trouve le champ ou le bloc à documenter.
  3. Utilisez le raccourci clavier Ctrl + F pour ouvrir la barre de recherche.
  4. Collez le nom interne que vous avez récupéré (champ ou bloc).
  5. Cliquez sur l’élément trouvé pour ouvrir l’éditeur.
1757595391112-778.png

Choix de la source Musée et de la table Biens et ensembles

1757595571069-539.png

Recherche CTRL+F et clic sur le nom interne du champ NUM_INVENTAIRE

1757595726608-759.png

Résultat : l'éditeur d'aide en ligne apparait 

1757595731097-598.png​​​​​​​​​​​​​​

Sauvegarder votre aide en ligne personnalisée

Parmi la foultitude de champs de toutes les tables, il vous sera difficile de savoir quels sont les champs pour lesquels le musée à un protocole de saisie particulier

Lors des changements de version, Flora veillera à ne pas écraser ces personnalisations en les récupérant par comparaison de dates de mise à jour de fichier.

Mais il serait pratique pour vous de créer un document traitement de texte dans lequel vous copie/collerez les contenus des champs personnalisés de chaque table.

Ce document sera la "mémoire" des spécificités de votre protocole de saisie, et pourra d'ailleurs être affiché sur la page d'accueil comme indiqué ici

Comportement par défaut

Lors d'un appel au menu "Afficher aide" Flora recherche d'abord le fichier html correspondant sur votre applicatif. Si cette recherche est infructueuse, Flora interroge le wiki dans un second temps.

Ainsi, les fichiers rédigés par les services du musée sont prioritaires sur ceux de Flora.

Que ce soit les pages html ou celle du wiki leur ouverture de fait au sein d'une pop-up. Si vous ne voyez pas de fenêtre s'ouvrir lors d'un appel au menu "Afficher aide", pensez à vérifier les autorisations accordées à Flora par votre navigateur. Voici des liens d'information sur ce sujet :