Modifications pour le document Documenter l’aide en ligne

Modifié par Joséphine Ducruet le 2026/02/18 16:34

Gérer
- Copier
Actions
- Exporter
- Aperçu avant impression
Affichage

From 58.1 to 57.1 From 76.1 to 75.1

Depuis la version 75.1

modifié par Joséphine Ducruet
sur 2026/02/18 16:23

Commentaire de modification : Il n'y a aucun commentaire pour cette version

À la version 58.1

modifié par Doriane Bautista
sur 2025/09/11 16:25

Commentaire de modification : Il n'y a aucun commentaire pour cette version

Source
Rendu

Résumé

Propriétés de la Page (2 modifications, 0 ajouts, 0 suppressions)

Détails

Propriétés de la Page

Auteur du document

@@ -1,1 +1,1 @@
--XWiki.JDT
++XWiki.DBA

Contenu

@@ -1,5 +3,3 @@
--**PAGE EN COURS DE REDACTION**
--
  (% class="mark small" %)**Version 4.5.54 et ultérieures**
  |(% style="width:840px" %)(((
@@ -7,114 +7,115 @@
  (((
  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** créer sa propre aide en ligne** afin d’adapter les consignes à ses besoins internes et à sa charte de saisie.
++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.
  )))
  (((
--= L'aide en ligne : un appui à la saisie dans Flora =
++= À 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.
--L’aide en ligne **accompagne les utilisateurs** dans la compréhension et l’utilisation des champs présents dans les différentes tables de Flora.
--Elle contribue à garantir une saisie homogène, cohérente et conforme aux pratiques définies par votre institution. Elle complète les documents de référence internes et les procédures métiers du musée.
--Son objectif est de traduire concrètement ces règles directement dans l’interface de Flora, au plus près des champs utilisés par les équipes au quotidien.
++Elle vient en appui des documents de référence internes comme la **charte de saisie**, la **charte de nommage** ou les **processus métiers** propres au musée. Elle permet ainsi de traduire concrètement ces règles dans l’interface de Flora, au plus près des champs utilisés par les équipes.
--Concrètement, l’aide en ligne permet de :
++**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**.
--* **Expliquer le contenu attendu dans un champ**.
--* **Formaliser les règles de saisie propres à l’institution** (abréviations autorisées, vocabulaire contrôlé, conventions d’écriture, etc.).
--* **Donner accès à des ressources externes de référence** (textes réglementaires, chartes internes, normes, guides méthodologiques).
--* **Harmoniser les pratiques et éviter les erreurs d’interprétation**, notamment dans les équipes élargies ou en cas de renouvellement des agents.
++>(% class="small" %)Cas d'usage:
--Par défaut, **l’aide en ligne est redirigée vers l’aide disponible sur le wiki officiel**. Cette documentation est actuellement en cours de rédaction et d’enrichissement par l’équipe de Flora Software.
++(((
++>(% class="small" %)Expliquer le contenu attendu dans un champ.
--Elle constitue une **base commune de référence pour l’ensemble des utilisateurs**.
++(((
++>(% class="small" %)Formaliser les règles de saisie propres à l’institution.
--Toutefois, chaque institution a la possibilité d**’adapter cette aide à ses propres pratiques**.
++>(% class="small" %)Indiquer à quels processus le champ est lié  (ex. : inventaire, récolement, prêt, dépôt, restauration, etc.).
--= Personnaliser l'aide en ligne =
++>(% class="small" %)Donner accès à des ressources externes de référence.
--Lorsqu’un musée crée une **aide en ligne personnalisée** pour un champ :
++>(% class="small" %)Harmoniser les pratiques et éviter les erreurs d’interprétation.
++)))
++)))
--* le contenu standard issu du** wiki est automatiquement masqué**
--* seul le **contenu rédigé localement est affiché**
++(% class="box successmessage" %)
++(((
++**Bonnes pratiques : **
--Si cette personnalisation est supprimée, l’aide du wiki réapparaît automatiquement.
++* **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.
++)))
--Cette **personnalisation est strictement locale** : elle s’applique uniquement à la base de données de l’institution qui l’a créée.
--Elle ne modifie pas le contenu du wiki et n’a aucun impact sur les autres institutions.
++= Repérer le nom interne 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 :
--== Identifier le nom interne du champ ou du bloc ==
++* 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.
--Pour retrouver le fichier d’aide correspondant, vous devez d’abord identifier le nom interne du champ ou du bloc de champs.
++>(% class="small" %)Exemple : dans la table MUS_BIEN, le champ Numéro d’inventaire porte le nom technique **NUM_INVENTAIRE**.
--Pour cela :
++[[//Ex. Biens : survol d'un libellé et affichage du nom interne en infobulle//>>image:1744363912649-947.png||data-xwiki-image-style-alignment="center" data-xwiki-image-style-border="true"]]
--1. Faites un **clic droit** sur le libellé du champ
--1. Choisir **Afficher informations**
--1. **Copiez le nom interne **du champ (ligne name)
--[[//Clic droit - Afficher informations//>>image:1744363948510-224.png||data-xwiki-image-style-alignment="center" data-xwiki-image-style-border="true"]]
++[[//Ex. Biens : clic droit sur le champ - Afficher informations//>>image:1744363948510-224.png||data-xwiki-image-style-alignment="center" data-xwiki-image-style-border="true"]]
--[[//Nom interne du champ//>>image:1744363968204-295.png||data-xwiki-image-style-alignment="center" data-xwiki-image-style-border="true"]]
++[[//Résultat : Nom interne du champ indiqué sur la première ligne//>>image:1744363968204-295.png||data-xwiki-image-style-alignment="center" data-xwiki-image-style-border="true"]]
--== Accéder à l'éditeur d'aide en ligne ==
++= Accéder à l'éditeur d'aide en ligne =
--1. Rendez-vous dans l'espace de travail **Administration, menu Paramétrage, Aide en ligne**
--1. Dépliez la rubrique** Aide à la saisie**
--1. Choisir la source et la table
--1. **Utilisez le raccourci clavier Ctrl + F** pour ouvrir la barre de recherche
--1. **Collez le nom interne** que vous avez récupéré
--1. **Cliquez sur l’élément trouvé** pour ouvrir l’éditeur
++Pour créer ou modifier une aide, rendez-vous dans l’espace de travail **Administration**, menu **Paramétrage** > **Aide en ligne**.
--[[//Choix de la source Musée et de la table Biens et ensembles//>>image:1757595391112-778.png||data-xwiki-image-style-alignment="center" data-xwiki-image-style-border="true"]]
++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.
--[[//Afficher la barre de recherche avec **CTRL+F** pour rechercher le champ//>>image:1757595571069-539.png||data-xwiki-image-style-alignment="center" data-xwiki-image-style-border="true"]]
++[[//Espace de travail **Administration **~> menu **Paramétrage** ~> **Aide en ligne** ~> rubrique** Aide à la saisie**//>>image:1757594385587-551.png||data-xwiki-image-style-alignment="center" data-xwiki-image-style-border="true"]]
--[[//Ouverture de l'éditeur//>>image:1757595726608-759.png||data-xwiki-image-style-alignment="center" data-xwiki-image-style-border="true"]]
++= 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 :
--== Rédiger et mettre en forme votre aide ==
++1. **Choisissez la source** (ex. Musées, Bibliothèque, Archives).
++1. **Sélectionnez la table** dans laquelle se trouve le champ ou le bloc à documenter.
++1. **Utilisez le raccourci clavier Ctrl + F** pour ouvrir la barre de recherche.
++1. **Collez le nom interne** que vous avez récupéré (champ ou bloc).
++1. **Cliquez sur l’élément trouvé** pour ouvrir l’éditeur.
--Une fois le champ ou le bloc trouvé, cliquez sur son nom pour ouvrir l’éditeur HTML.
++[[//Choix de la **source Musée** et de la **table Biens et ensembles**//>>image:1757595391112-778.png||data-xwiki-image-style-alignment="center" data-xwiki-image-style-border="true"]]
--(((
--1. **Saisir le contenu**
--* Tapez directement votre texte dans l’éditeur.
--* Vous pouvez aussi copier-coller l’aide issue du wiki et l’adapter à vos besoins internes.
++[[//Recherche **CTRL+F** et clic sur le nom interne du champ **NUM_INVENTAIRE**//>>image:1757595571069-539.png||data-xwiki-image-style-alignment="center" data-xwiki-image-style-border="true"]]
--(% class="box successmessage" %)
--(((
--**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 : indiquez si le champ ou bloc est lié à un processus particulier (inventaire, récolement, prêt, dépôt, restauration).
--* Ajoutez des exemples concrets : illustrez les valeurs attendues pour éviter toute ambiguïté.
--* Limitez les redondances : n’intégrez que ce qui est pertinent, sans recopier inutilement l’aide du wiki.
--* Documentez aussi les blocs de champs : expliquez leur rôle global en plus des champs qu’ils contiennent.
--)))
--)))
++[[//Résultat : l'éditeur d'aide en ligne apparait //>>image:1757595726608-759.png||data-xwiki-image-style-alignment="center" data-xwiki-image-style-border="true"]]
--(((
--(% start="2" %)
--1. **Mettre en forme l’aide**
--* L’éditeur fonctionne comme un traitement de texte (type Word) et vous permet d’appliquer différents outils :
--** **Mise en forme du texte** : gras, italique, souligné, exposant, indice.
--** **Organisation du contenu** : listes à puces, listes numérotées, retrait, alignement.
--** **Styles et formats** : titres, styles prédéfinis, choix de la police et de la taille.
--** **Tableaux et images** : insertion et gestion de tableaux, ajout d’images.
--** **Éléments enrichis** : caractères spéciaux, symboles.
--** **Outils pratiques** : correcteur orthographique, recherche/remplacement, annuler/rétablir, affichage du code source.
--)))
++= Éditer l'aide en ligne =
++Une fois le champ ou le bloc trouvé, cliquez sur son nom pour ouvrir l’éditeur HTML.
++
++Vous pouvez saisir directement votre texte ou copier-coller l’aide du wiki avant de l’adapter à vos besoins internes.
++
++Cet éditeur fonctionne comme un traitement de texte (type Word) et propose de nombreuses options :
++
++* **Mise en forme du texte** : gras, italique, souligné, exposant, indice.
++* **Organisation du contenu** : listes à puces, listes numérotées, retrait, alignement.
++* **Styles et formats** : titres, styles prédéfinis, choix de la police et de la taille.
++* **Tableaux et images** : insertion et gestion de tableaux, ajout d’images.
++* **Éléments enrichis** : caractères spéciaux, symboles.
++* **Outils pratiques** : correcteur orthographique, recherche/remplacement, annuler/rétablir, affichage du code source.
++
++Une fois votre saisie terminée, cliquez sur **Sauvegarder** pour enregistrer votre personnalisation. **Dès la sauvegarde, l’aide en ligne par défaut issue du wiki est remplacée par votre aide personnalisée** : celle-ci ne s’affichera que dans votre base de données institutionnelle et n’aura aucun impact sur le wiki ni sur les autres musées.
++
  (% class="box warningmessage" %)
  (((
  **Point d’attention : insérer des liens**
@@ -123,21 +123,18 @@
  * Copiez-collez ensuite ce lien dans l’éditeur d’aide en ligne. Il sera reconnu correctement et restera actif.
  )))
--(((
--(% start="3" %)
--1. **Sauvegarder la personnalisation**
--
--* Cliquez sur **Sauvegarder** pour enregistrer vos modifications.
--* Dès la sauvegarde, l’aide en ligne du wiki disparaît : elle est remplacée par votre aide personnalisée.
--* Cette personnalisation ne s’applique que dans votre base institutionnelle et n’a aucun impact sur le wiki ni sur les autres musées.
--)))
--
  (% class="box successmessage" %)
  (((
  **Bonnes pratiques : **
--* 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.
--* Mettez à jour régulièrement : adaptez vos contenus lorsque vos procédures internes ou règles métier évoluent.
++* **Uniformisez la présentation** : adoptez une structure homogène (définition, usage, remarques).
++* **Soyez clairs et concis** : rédigez des explications courtes et directement utiles.
++* **Employez le vocabulaire métier partagé** : utilisez les termes définis dans la charte de saisie de votre institution.
++* **Précisez le contexte** : indiquez si le champ ou bloc est lié à un processus particulier (inventaire, récolement, prêt, dépôt, restauration).
++* **Ajoutez des exemples concrets** : illustrez les valeurs attendues pour éviter toute ambiguïté.
++* **Limitez les redondances** : n’intégrez que ce qui est pertinent, sans recopier inutilement l’aide du wiki.
++* **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.
  )))
  >(% class="small" %)L’exemple ci-dessous illustre le champ **Numéro d’inventaire** avec une aide en ligne enrichie :
@@ -158,11 +158,13 @@
  [[//Saisie et mise en forme des données//>>image:1757596818102-351.png||data-xwiki-image-style-alignment="center" data-xwiki-image-style-border="true"]]
++(% class="wikigeneratedid" id="H200B200B200B200B200B200B200B200B200B200B200B200B200B200B" %)
++
--[[//Sauvegarder l'aide en ligne//>>image:1757597668258-471.png||data-xwiki-image-style-alignment="center" data-xwiki-image-style-border="true"]]
++[[//Sauvegarde de l'aide en ligne//>>image:1757597668258-471.png||data-xwiki-image-style-alignment="center" data-xwiki-image-style-border="true"]]
--= Contrôler le rendu dans Flora =
++= Consulter le résultat =
  Une fois votre aide personnalisée sauvegardée, il est essentiel de** vérifier son affichage** dans les grilles de saisie. Cette étape vous permet de **contrôler que le contenu rédigé apparaît bien en contexte** et qu’il remplace correctement, le cas échéant, l’aide du wiki.
@@ -180,7 +180,7 @@
  (% id="cke_bm_851S" style="display:none" %)
--= Rétablir l’aide par défaut du wiki =
++= Revenir à l'aide en ligne du wiki =
  Si vous ne souhaitez plus conserver une aide en ligne personnalisée et préférez retrouver l’aide générique fournie par le wiki, procédez comme suit :
@@ -195,7 +195,7 @@
  **Résultat :** l’aide en ligne personnalisée disparaît et l’aide générique du wiki réapparaît automatiquement pour ce champ ou ce bloc.
--[[//Repérage nom interne du champ - une infobulle apparait avec le survol du champ//>>image:1757599364051-795.png||data-xwiki-image-style-alignment="center" data-xwiki-image-style-border="true"]]
++[[//Repérage nom interne du champ - survol//>>image:1757599364051-795.png||data-xwiki-image-style-alignment="center" data-xwiki-image-style-border="true"]]
  [[//Choix de **la source** et de la** table**//>>image:1757599467798-396.png||data-xwiki-image-style-alignment="center" data-xwiki-image-style-border="true"]]