Code source wiki de Documenter l’aide en ligne

Version 73.1 par Joséphine Ducruet le 2026/02/11 14:47

Afficher les derniers auteurs
1 **PAGE EN COURS DE REDACTION**
2
3 (% class="mark small" %)**Version 4.5.54 et ultérieures**
4
5 |(% style="width:840px" %)(((
6 (% class="box" %)
7 (((
8 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.
9
10 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.
11 )))
12
13 (((
14 = À quoi sert l'aide en ligne dans Flora ? =
15
16 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
18 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.
19
20 **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**.
21
22 >(% class="small" %)Cas d'usage:
23
24 (((
25 >(% class="small" %)Expliquer le contenu attendu dans un champ.
26
27 (((
28 >(% class="small" %)Formaliser les règles de saisie propres à l’institution.
29
30 >(% class="small" %)Indiquer à quels processus le champ est lié  (ex. : inventaire, récolement, prêt, dépôt, restauration, etc.).
31
32 >(% class="small" %)Donner accès à des ressources externes de référence.
33
34 >(% class="small" %)Harmoniser les pratiques et éviter les erreurs d’interprétation.
35 )))
36 )))
37
38 = Identifier le nom interne du champ ou du bloc =
39
40 Pour retrouver le fichier d’aide correspondant, vous devez d’abord identifier le nom interne du champ ou du bloc de champs. Pour cela :
41
42 * Survolez le libellé dans une grille de saisie : son nom interne s’affiche en infobulle.
43 * Vous pouvez aussi faire un clic droit sur le libellé et choisir **Afficher informations** pour copier directement le nom interne.
44
45 >(% class="small" %)Exemple : dans la table MUS_BIEN, le champ Numéro d’inventaire porte le nom technique **NUM_INVENTAIRE**.
46
47 [[//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"]]
48
49
50 [[//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"]]
51
52
53 [[//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"]]
54
55
56 = Ouvrir l’éditeur d’aide en ligne =
57
58 Pour créer ou modifier une aide, rendez-vous dans l’espace de travail **Administration**, menu **Paramétrage** > **Aide en ligne**.
59
60 Vous y trouverez la liste des fichiers disponibles, organisés par source et par table.
61
62 Dépliez la rubrique **Aide à la saisie** pour rechercher les champs et blocs de champs à documenter.
63
64 [[//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"]]
65
66
67 = Localiser le champ ou le bloc à personnaliser =
68
69 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 :
70
71 1. **Choisissez la source** (ex. Musées, Bibliothèque, Archives).
72 1. **Sélectionnez la table** dans laquelle se trouve le champ ou le bloc à documenter.
73 1. **Utilisez le raccourci clavier Ctrl + F** pour ouvrir la barre de recherche.
74 1. **Collez le nom interne** que vous avez récupéré (champ ou bloc).
75 1. **Cliquez sur l’élément trouvé** pour ouvrir l’éditeur.
76
77 [[//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"]]
78
79
80 [[//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"]]
81
82
83 [[//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"]]
84
85
86 = Rédiger et mettre en forme votre aide =
87
88 Une fois le champ ou le bloc trouvé, cliquez sur son nom pour ouvrir l’éditeur HTML.
89
90 (((
91 1. **Saisir le contenu**
92
93 * Tapez directement votre texte dans l’éditeur.
94 * Vous pouvez aussi copier-coller l’aide issue du wiki et l’adapter à vos besoins internes.
95
96 (% class="box successmessage" %)
97 (((
98 **Bonnes pratiques : **
99
100 * Uniformisez la présentation : adoptez une structure homogène pour toutes vos aides (ex. : définition, usage, remarques).
101 * Soyez clairs et concis : rédigez des explications courtes et immédiatement compréhensibles.
102 * Employez le vocabulaire métier partagé : utilisez les termes définis dans la charte de saisie de votre institution.
103 * Précisez le contexte : indiquez si le champ ou bloc est lié à un processus particulier (inventaire, récolement, prêt, dépôt, restauration).
104 * Ajoutez des exemples concrets : illustrez les valeurs attendues pour éviter toute ambiguïté.
105 * Limitez les redondances : n’intégrez que ce qui est pertinent, sans recopier inutilement l’aide du wiki.
106 * Documentez aussi les blocs de champs : expliquez leur rôle global en plus des champs qu’ils contiennent.
107 )))
108 )))
109
110 (((
111 (% start="2" %)
112 1. **Mettre en forme l’aide**
113
114 * L’éditeur fonctionne comme un traitement de texte (type Word) et vous permet d’appliquer différents outils :
115 ** **Mise en forme du texte** : gras, italique, souligné, exposant, indice.
116 ** **Organisation du contenu** : listes à puces, listes numérotées, retrait, alignement.
117 ** **Styles et formats** : titres, styles prédéfinis, choix de la police et de la taille.
118 ** **Tableaux et images** : insertion et gestion de tableaux, ajout d’images.
119 ** **Éléments enrichis** : caractères spéciaux, symboles.
120 ** **Outils pratiques** : correcteur orthographique, recherche/remplacement, annuler/rétablir, affichage du code source.
121 )))
122
123 (% class="box warningmessage" %)
124 (((
125 **Point d’attention : insérer des liens**
126
127 * 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.
128 * Copiez-collez ensuite ce lien dans l’éditeur d’aide en ligne. Il sera reconnu correctement et restera actif.
129 )))
130
131 (((
132 (% start="3" %)
133 1. **Sauvegarder la personnalisation**
134
135 * Cliquez sur **Sauvegarder** pour enregistrer vos modifications.
136 * Dès la sauvegarde, l’aide en ligne du wiki disparaît : elle est remplacée par votre aide personnalisée.
137 * Cette personnalisation ne s’applique que dans votre base institutionnelle et n’a aucun impact sur le wiki ni sur les autres musées.
138 )))
139
140 (% class="box successmessage" %)
141 (((
142 **Bonnes pratiques : **
143
144 * 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.
145 * Mettez à jour régulièrement : adaptez vos contenus lorsque vos procédures internes ou règles métier évoluent.
146 )))
147
148 >(% class="small" %)L’exemple ci-dessous illustre le champ **Numéro d’inventaire** avec une aide en ligne enrichie :
149
150 >(% class="small" %)un **tableau** décrivant les différentes règles d’attribution,
151
152 (((
153 >(% class="small" %)un **lien hypertexte** vers une référence législative,
154
155 (((
156 >(% class="small" %)du **texte courant** explicatif,
157
158 >(% class="small" %)et un **texte en rouge** servant à mettre en évidence une information importante.
159 )))
160 )))
161
162 >(% 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.
163
164 [[//Saisie et mise en forme des données//>>image:1757596818102-351.png||data-xwiki-image-style-alignment="center" data-xwiki-image-style-border="true"]]
165
166 (% class="wikigeneratedid" id="H200B200B200B200B200B200B200B200B200B200B200B200B200B200B" %)
167 ​​​​​​​
168
169 [[//Sauvegarder l'aide en ligne//>>image:1757597668258-471.png||data-xwiki-image-style-alignment="center" data-xwiki-image-style-border="true"]]
170
171
172 = Contrôler le rendu dans Flora =
173
174 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.
175
176 Faites un clic droit sur le libellé du champ ou du bloc > **Afficher aide. **
177
178 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**.
179
180 (% class="box warningmessage" %)
181 (((
182 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.
183 )))
184
185 [[//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"]]
186
187
188 (% id="cke_bm_851S" style="display:none" %)
189
190 = Rétablir l’aide par défaut du wiki =
191
192 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 :
193
194 1. **Repérez le nom interne** du champ ou du bloc à partir de la grille de saisie.
195 1. **Accédez à l’éditeur d’aides en ligne** : Administration > Paramétrage > Aide en ligne.
196 1. **Dépliez la rubrique « Aide à la saisie »** pour afficher la liste des champs.
197 1. **Choisissez la source** (ex. Musées, Bibliothèque, Archives).
198 1. **Sélectionnez la table** dans laquelle se trouve le champ ou le bloc.
199 1. **Recherchez le champ ou le bloc** avec le raccourci clavier Ctrl + F, puis cliquez sur son nom.
200 1. **Ouvrez l’éditeur HTML** associé au champ ou au bloc.
201 1. **Cliquez sur Delete** pour supprimer l’aide personnalisée.
202
203 **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.
204
205 [[//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"]]
206
207
208 [[//Choix de **la source** et de la** table**//>>image:1757599467798-396.png||data-xwiki-image-style-alignment="center" data-xwiki-image-style-border="true"]]
209
210
211 [[//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"]]
212
213
214 [[//Suppression de l'aide en ligne personnalisée//>>image:1757599570577-172.png||data-xwiki-image-style-alignment="center" data-xwiki-image-style-border="true"]]
215
216
217 [[//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"]]
218
219
220 )))
221 )))|(% style="width:300px" %)(((
222 (% class="box" %)
223 (((
224 **Sommaire**
225
226 {{toc depth="1" numbered="true"/}}
227 )))
228
229 (% class="box" %)
230 (((
231 **Aller plus loin**
232
233 * [[Comprendre les sources et les tables dans Flora>>doc:2_Administration.Administration fonctionnelle.Présentation des sources et des tables.WebHome||target="_blank"]]
234 * [[Insérer un document interne pour accueil>>doc:2_Administration.Administration fonctionnelle.Documents de référence sur page d'aide.WebHome||target="_blank"]]
235 * (((
236 [[Saisir dans Flora>>doc:1_Fonctionnalités.5\.C\. Saisie.WebHome||target="_blank"]]
237 )))
238 )))
239
240 (% class="box" %)
241 (((
242 **Icônes principales**
243
244 * [[image:1757600253202-543.png||height="45" width="45"]] Paramétrages
245 )))
246 )))
247
248