Modifications pour le document Documenter l’aide en ligne

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

Depuis la version 62.1
modifié par Doriane Bautista
sur 2025/09/11 16:35
Commentaire de modification : Il n'y a aucun commentaire pour cette version
À la version 80.1
modifié par Joséphine Ducruet
sur 2026/02/18 16:34
Commentaire de modification : Il n'y a aucun commentaire pour cette version

Résumé

Détails

Propriétés de la Page
Auteur du document
... ... @@ -1,1 +1,1 @@
1 -XWiki.DBA
1 +XWiki.JDT
Contenu
... ... @@ -1,118 +1,87 @@
1 +**PAGE EN COURS DE REDACTION**
2 +
1 1  (% class="mark small" %)**Version 4.5.54 et ultérieures**
2 2  
3 3  |(% style="width:840px" %)(((
4 4  (% class="box" %)
5 5  (((
6 -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, laide affichée provient du wiki.
8 +L’**aide en ligne** est intégrée directement dans l’**interface de Flora** et accompagne les utilisateurs dans la compréhension des **champs** et des **informations attendues** lors de la saisie.
7 7  
8 -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.
10 +Par défaut, elle renvoie vers la **documentation du wiki**.
11 +Les **administrateurs** ont toutefois la possibilité de la **personnaliser** afin d’y intégrer les **règles**, **procédures** et **pratiques propres à leur institution**.
9 9  )))
10 10  
11 11  (((
12 -= À quoi sert l'aide en ligne dans Flora ? =
15 += L'aide en ligne : un appui à la saisie dans Flora =
13 13  
14 -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.
17 +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.
18 +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.
19 +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.
15 15  
16 -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.
21 +Conctement, laide en ligne permet de :
17 17  
18 -**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**.
23 +* **Expliquer le contenu attendu dans un champ**.
24 +* **Formaliser les règles de saisie propres à l’institution** (abréviations autorisées, vocabulaire contrôlé, conventions d’écriture, etc.).
25 +* **Donner accès à des ressources externes de référence** (textes réglementaires, chartes internes, normes, guides méthodologiques).
26 +* **Harmoniser les pratiques et éviter les erreurs d’interprétation**, notamment dans les équipes élargies ou en cas de renouvellement des agents.
19 19  
20 ->(% class="small" %)Cas d'usage:
28 +Par défaut, **laide 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.
21 21  
22 -(((
23 ->(% class="small" %)Expliquer le contenu attendu dans un champ.
30 +Elle constitue une **base commune de référence pour l’ensemble des utilisateurs**.
24 24  
25 -(((
26 ->(% class="small" %)Formaliser les règles de saisie propres à l’institution.
32 +Toutefois, chaque institution a la possibilité d**’adapter cette aide à ses propres pratiques**.
27 27  
28 ->(% class="small" %)Indiquer à quels processus le champ est lié  (ex. : inventaire, récolement, prêt, dépôt, restauration, etc.).
34 += Personnaliser l'aide en ligne =
29 29  
30 ->(% class="small" %)Donner accès à des ressources externes de référence.
36 +Lorsqu’un musée crée une **aide en ligne personnalisée** pour un champ :
31 31  
32 ->(% class="small" %)Harmoniser les pratiques et éviter les erreurs d’interprétation.
33 -)))
34 -)))
38 +* le contenu standard issu du** wiki est automatiquement masqué**
39 +* seul le **contenu rédigé localement est affiché**
35 35  
36 -(% class="box successmessage" %)
37 -(((
38 -**Bonnes pratiques : **
41 +Si cette personnalisation est supprimée, l’aide du wiki réapparaît automatiquement.
39 39  
40 -**Présentation et lisibilité**
43 +Cette **personnalisation est strictement locale** : elle s’applique uniquement à la base de données de l’institution qui l’a créée.
44 +Elle ne modifie pas le contenu du wiki et n’a aucun impact sur les autres institutions.
41 41  
42 -* Uniformisez la présentation : adoptez une structure homogène pour toutes vos aides (ex. : définition, usage, remarques).
43 -* Soyez clairs et concis : rédigez des explications courtes et immédiatement compréhensibles.
44 -* Employez le vocabulaire métier partagé : utilisez les termes définis dans la charte de saisie de votre institution.
45 -* Ajoutez des exemples concrets : illustrez les valeurs attendues afin d’éviter toute ambiguïté.
46 +== Identifier le nom interne du champ ou du bloc ==
46 46  
47 -**Contenu et corence métier**
48 +Pour retrouver le fichier d’aide correspondant, vous devez d’abord identifier le nom interne du champ ou du bloc de champs.
48 48  
49 -* 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).
50 -* Limitez les redondances : n’intégrez que ce qui est pertinent, sans recopier inutilement l’aide du wiki.
51 -* Documentez aussi les blocs de champs : expliquez leur rôle global en plus des champs qu’ils contiennent.
50 +Pour cela :
52 52  
53 -**Suivi et maintenance**
52 +1. Faites un **clic droit** sur le libellé du champ
53 +1. Choisir **Afficher informations**
54 +1. **Copiez le nom interne **du champ (ligne name)
54 54  
55 -* 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.
56 -* Vérifiez l’accessibilité : testez l’ouverture des pop-up d’aide dans les navigateurs utilisés.
57 -* Mettez à jour régulièrement : adaptez vos contenus lorsque vos procédures internes ou règles métier évoluent.
58 -)))
56 +[[//Clic droit - Afficher informations//>>image:1744363948510-224.png||data-xwiki-image-style-alignment="center" data-xwiki-image-style-border="true"]]
59 59  
60 -= Identifier le nom interne du champ ou du bloc =
61 61  
62 -Pour retrouver le fichier d’aide correspondant, vous devez d’abord identifier le nom interne du champ ou du bloc de champs. Pour cela :
59 +[[//Nom interne du champ//>>image:1744363968204-295.png||data-xwiki-image-style-alignment="center" data-xwiki-image-style-border="true"]]
63 63  
64 -* Survolez le libellé dans une grille de saisie : son nom interne s’affiche en infobulle.
65 -* Vous pouvez aussi faire un clic droit sur le libellé et choisir **Afficher informations** pour copier directement le nom interne.
66 66  
67 ->(% class="small" %)Exemple : dans la table MUS_BIEN, le champ Nuro d’inventaire porte le nom technique **NUM_INVENTAIRE**.
62 +== Accéder à l'éditeur d'aide en ligne ==
68 68  
69 -[[//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"]]
64 +1. Rendez-vous dans l'espace de travail **Administration, menu Paramétrage, Aide en ligne**
65 +1. Dépliez la rubrique** Aide à la saisie**
66 +1. Choisir la source et la table
67 +1. **Utilisez le raccourci clavier Ctrl + F** pour ouvrir la barre de recherche
68 +1. **Collez le nom interne** que vous avez récupéré
69 +1. **Cliquez sur l’élément trouvé** pour ouvrir l’éditeur
70 70  
71 +[[//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"]]
71 71  
72 -[[//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"]]
73 73  
74 +[[//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"]]
74 74  
75 -[[//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"]]
76 76  
77 +[[//Ouverture de l'éditeur//>>image:1757595726608-759.png||data-xwiki-image-style-alignment="center" data-xwiki-image-style-border="true"]]
77 77  
78 -= Ouvrir l’éditeur d’aide en ligne =
79 79  
80 -Pour créer ou modifier une aide, rendez-vous dans l’espace de travail **Administration**, menu **Paramétrage** > **Aide en ligne**.
80 +== Rédiger l'aide en ligne ==
81 81  
82 -Vous y trouverez la liste des fichiers disponibles, organisés par source et par table.
82 +L’éditeur fonctionne comme un traitement de texte (type Word) et vous permet d’appliquer différents outils :
83 83  
84 -Dépliez la rubrique **Aide à la saisie** pour rechercher les champs et blocs de champs à documenter.
85 -
86 -[[//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"]]
87 -
88 -
89 -= Localiser le champ ou le bloc à personnaliser =
90 -
91 -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 :
92 -
93 -1. **Choisissez la source** (ex. Musées, Bibliothèque, Archives).
94 -1. **Sélectionnez la table** dans laquelle se trouve le champ ou le bloc à documenter.
95 -1. **Utilisez le raccourci clavier Ctrl + F** pour ouvrir la barre de recherche.
96 -1. **Collez le nom interne** que vous avez récupéré (champ ou bloc).
97 -1. **Cliquez sur l’élément trouvé** pour ouvrir l’éditeur.
98 -
99 -[[//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"]]
100 -
101 -
102 -[[//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"]]
103 -
104 -
105 -[[//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"]]
106 -
107 -
108 -= Rédiger et mettre en forme votre aide =
109 -
110 -Une fois le champ ou le bloc trouvé, cliquez sur son nom pour ouvrir l’éditeur HTML.
111 -
112 -Vous pouvez saisir directement votre texte ou copier-coller l’aide du wiki avant de l’adapter à vos besoins internes.
113 -
114 -Cet éditeur fonctionne comme un traitement de texte (type Word) et propose de nombreuses options :
115 -
84 +(((
116 116  * **Mise en forme du texte** : gras, italique, souligné, exposant, indice.
117 117  * **Organisation du contenu** : listes à puces, listes numérotées, retrait, alignement.
118 118  * **Styles et formats** : titres, styles prédéfinis, choix de la police et de la taille.
... ... @@ -120,117 +120,49 @@
120 120  * **Éléments enrichis** : caractères spéciaux, symboles.
121 121  * **Outils pratiques** : correcteur orthographique, recherche/remplacement, annuler/rétablir, affichage du code source.
122 122  
123 -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.
124 -
125 -(% class="box warningmessage" %)
92 +(% class="box successmessage" %)
126 126  (((
127 -**Point d’attention : insérer des liens**
94 +**Astuce insérer des liens**
128 128  
129 129  * Pour créer un lien vers un document ou une ressource externe, copiez d’abord l’URL dans un document Word : elle devient un lien bleu cliquable.
130 130  * Copiez-collez ensuite ce lien dans l’éditeur d’aide en ligne. Il sera reconnu correctement et restera actif.
131 131  )))
99 +)))
132 132  
133 -(% class="box successmessage" %)
134 134  (((
135 -**Bonnes pratiques : **
102 +== Sauvegarder la personnalisation ==
136 136  
137 -**Présentation et clarté**
104 +Cliquez sur **Sauvegarder** pour enregistrer vos modifications.
138 138  
139 -* Uniformisez la présentation : adoptez une structure homogène (définition, usage, remarques).
140 -* Soyez clairs et concis : rédigez des explications courtes et directement utiles.
141 -* Employez le vocabulaire métier partagé : utilisez les termes définis dans la charte de saisie de votre institution.
106 +Dès la sauvegarde, l’aide en ligne du wiki disparaît : elle est remplacée par votre aide personnalisée.
142 142  
143 -**Contenu et cohérence**
144 -
145 -* Précisez le contexte : indiquez si le champ ou bloc est lié à un processus particulier (inventaire, récolement, prêt, dépôt, restauration).
146 -* Ajoutez des exemples concrets : illustrez les valeurs attendues pour éviter toute ambiguïté.
147 -* Limitez les redondances : n’intégrez que ce qui est pertinent, sans recopier inutilement l’aide du wiki.
148 -* Documentez aussi les blocs de champs : expliquez leur rôle global en plus des champs qu’ils contiennent.
149 -
150 -**Suivi et maintenance**
151 -
152 -* 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
153 -)))
154 -
155 ->(% class="small" %)L’exemple ci-dessous illustre le champ **Numéro d’inventaire** avec une aide en ligne enrichie :
156 -
157 ->(% class="small" %)un **tableau** décrivant les différentes règles d’attribution,
158 -
108 +(% class="box successmessage" %)
159 159  (((
160 ->(% class="small" %)un **lien hypertexte** vers une référence législative,
110 +== Astuce – Conserver l’aide du wiki tout en la personnalisant ==
161 161  
162 -(((
163 ->(% class="small" %)du **texte courant** explicatif,
112 +Si vous souhaitez adapter l’aide en ligne sans perdre le contenu rédigé sur le wiki, il est recommandé de :
164 164  
165 ->(% class="small" %)et un **texte en rouge** servant à mettre en évidence une information importante.
166 -)))
167 -)))
114 +1. Ouvrir l’aide en ligne par défaut (issue du wiki)
115 +1. Copier son contenu
116 +1. Le coller dans l’éditeur d’aide personnalisée
117 +1. Modifier uniquement les éléments nécessaires
168 168  
169 ->(% class="small" %)Cet exemple montre comment exploiter les fonctionnalités de l’éditeur (mise en forme, insertion de tableaux, ajout de liens et de couleurs) pour rendre l’aide plus claire et adaptée aux besoins de l’institution.
119 +Cette méthode vous permet de conserver la base commune tout en l’enrichissant selon vos pratiques institutionnelles.
170 170  
171 -[[//Saisie et mise en forme des données//>>image:1757596818102-351.png||data-xwiki-image-style-alignment="center" data-xwiki-image-style-border="true"]]
172 -
173 -(% class="wikigeneratedid" id="H200B200B200B200B200B200B200B200B200B200B200B200B200B200B" %)
174 -​​​​​​​​​​​​​​
175 -
176 -[[//Sauvegarde de l'aide en ligne//>>image:1757597668258-471.png||data-xwiki-image-style-alignment="center" data-xwiki-image-style-border="true"]]
177 -
178 -
179 -= Contrôler le rendu dans Flora =
180 -
181 -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.
182 -
183 -Faites un clic droit sur le libellé du champ ou du bloc > **Afficher aide. **
184 -
185 -L’ouverture de l’aide, qu’il s’agisse d’un fichier html local ou d’une page du wiki, se fait toujours dans une fenêtre **pop-up**.
186 -
187 -(% class="box warningmessage" %)
188 -(((
189 -Si la fenêtre ne s’ouvre pas, vérifiez que votre navigateur (**[[Firefox>>https://support.mozilla.org/fr/kb/parametres-exceptions-depannage-blocage-popup||rel="noopener noreferrer" target="_blank"]]**, **[[Safari>>https://support.apple.com/fr-fr/guide/safari/ibrwe2159f50/mac||rel="noopener noreferrer" target="_blank"]]**, **[[Google Chrome>>https://support.google.com/chrome/answer/95472?co=GENIE.Platform%3DDesktop&hl=fr||rel="noopener noreferrer" target="_blank"]]** ou**[[ Edge>>https://support.microsoft.com/fr-fr/windows/modifier-les-param%C3%A8tres-de-s%C3%A9curit%C3%A9-et-de-confidentialit%C3%A9-pour-internet-explorer-11-9528b011-664c-b771-d757-43a2b78b2afe||rel="noopener noreferrer" target="_blank"]]**) autorise les pop-ups pour Flora.
121 +**Important :**
122 +Si vous avez activé une personnalisation sans avoir copié le texte initial et que l’aide du wiki n’est plus visible dans l’interface, vous pouvez toujours la retrouver directement sur le wiki, dans la rubrique //Aide en ligne sur les champs//.
123 +Vous pourrez alors en récupérer le contenu et le réintégrer dans votre aide personnalisée.
190 190  )))
191 191  
192 -[[//Résultat : affichage de l'aide personnalisée - champ** Numéro d'inventaire**//>>image:1757597985000-452.png||data-xwiki-image-style-alignment="center" data-xwiki-image-style-border="true"]]
193 -
194 -
195 -(% id="cke_bm_851S" style="display:none" %)
196 -
197 -= Rétablir l’aide par défaut du wiki =
198 -
199 -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 :
200 -
201 -1. **Repérez le nom interne** du champ ou du bloc à partir de la grille de saisie.
202 -1. **Accédez à l’éditeur d’aides en ligne** : Administration > Paramétrage > Aide en ligne.
203 -1. **Dépliez la rubrique « Aide à la saisie »** pour afficher la liste des champs.
204 -1. **Choisissez la source** (ex. Musées, Bibliothèque, Archives).
205 -1. **Sélectionnez la table** dans laquelle se trouve le champ ou le bloc.
206 -1. **Recherchez le champ ou le bloc** avec le raccourci clavier Ctrl + F, puis cliquez sur son nom.
207 -1. **Ouvrez l’éditeur HTML** associé au champ ou au bloc.
208 -1. **Cliquez sur Delete** pour supprimer l’aide personnalisée.
209 -
210 -**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.
211 -
212 -[[//Repérage nom interne du champ - survol//>>image:1757599364051-795.png||data-xwiki-image-style-alignment="center" data-xwiki-image-style-border="true"]]
213 -
214 -
215 -[[//Choix de **la source** et de la** table**//>>image:1757599467798-396.png||data-xwiki-image-style-alignment="center" data-xwiki-image-style-border="true"]]
216 -
217 -
218 -[[//Recherche de l'aide en ligne à supprimer avec le nom interne du champ//>>image:1757599482084-563.png||data-xwiki-image-style-alignment="center" data-xwiki-image-style-border="true"]]
219 -
220 -
221 -[[//Suppression de l'aide en ligne personnalisée//>>image:1757599570577-172.png||data-xwiki-image-style-alignment="center" data-xwiki-image-style-border="true"]]
222 -
223 -
224 -[[//Résultat : l'aide en ligne du wiki réapparait//>>image:1757600036454-769.png||data-xwiki-image-style-alignment="center" data-xwiki-image-style-border="true"]]
225 -
226 226  
227 227  )))
128 +)))
228 228  )))|(% style="width:300px" %)(((
229 229  (% class="box" %)
230 230  (((
231 231  **Sommaire**
232 232  
233 -{{toc depth="1" numbered="true"/}}
134 +{{toc depth="2" numbered="true"/}}
234 234  )))
235 235  
236 236  (% class="box" %)
... ... @@ -238,18 +238,10 @@
238 238  **Aller plus loin**
239 239  
240 240  * [[Comprendre les sources et les tables dans Flora>>doc:2_Administration.Administration fonctionnelle.Présentation des sources et des tables.WebHome||target="_blank"]]
241 -* [[Insérer un document interne pour accueil>>doc:2_Administration.Administration fonctionnelle.Documents de référence sur page d'aide.WebHome||target="_blank"]]
242 242  * (((
243 243  [[Saisir dans Flora>>doc:1_Fonctionnalités.5\.C\. Saisie.WebHome||target="_blank"]]
244 244  )))
245 245  )))
246 -
247 -(% class="box" %)
248 -(((
249 -**Icônes principales**
250 -
251 -* [[image:1757600253202-543.png||height="45" width="45"]] Paramétrages
252 252  )))
253 -)))
254 254  
255 255