Skip to Content

Modifications pour le document Documenter l’aide en ligne

Modifié par Doriane Bautista le 2025/09/17 16:01
Depuis la version 37.1
modifié par Doriane Bautista
sur 2025/09/11 15:27
Commentaire de modification : Il n'y a aucun commentaire pour cette version
À la version 68.1
modifié par Doriane Bautista
sur 2025/09/11 16:46
Commentaire de modification : Il n'y a aucun commentaire pour cette version

Résumé

Détails

Propriétés de la Page
Contenu
... ... @@ -5,7 +5,7 @@
5 5  (((
6 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, l’aide affichée provient du wiki.
7 7  
8 -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.
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.
9 9  )))
10 10  
11 11  (((
... ... @@ -13,6 +13,8 @@
13 13  
14 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.
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.
17 +
16 16  **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**.
17 17  
18 18  >(% class="small" %)Cas d'usage:
... ... @@ -35,19 +35,27 @@
35 35  (((
36 36  **Bonnes pratiques : **
37 37  
38 -* **Uniformisez la présentation** : adoptez une structure homogène pour toutes vos aides (ex. : définition, usage, remarques).
39 -* **Soyez clairs et concis** : rédigez des explications courtes et immédiatement compréhensibles.
40 -* **Employez le vocabulaire métier partagé** : utilisez les termes définis dans la charte de saisie de votre institution.
41 -* **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).
42 -* **Ajoutez des exemples concrets** : illustrez les valeurs attendues afin d’éviter les ambiguïtés.
43 -* **Limitez les redondances** : ne recopiez pas intégralement l’aide du wiki, mais complétez-la ou adaptez-la selon vos besoins.
44 -* **Documentez aussi les blocs de champs** : expliquez leur rôle global en plus des champs qu’ils contiennent.
45 -* **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.
46 -* **Vérifiez l’accessibilité** : testez l’ouverture des pop-up d’aide dans les navigateurs utilisés.
47 -* **Mettez à jour régulièrement** : adaptez vos contenus lorsque vos procédures internes ou règles métier évoluent.
40 +**Présentation et lisibilité**
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 +
47 +**Contenu et cohérence métier**
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.
52 +
53 +**Suivi et maintenance**
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.
48 48  )))
49 49  
50 -= Récupérer le nom informatique du champ ou du bloc à documenter =
60 += Identifier le nom interne du champ ou du bloc =
51 51  
52 52  Pour retrouver le fichier d’aide correspondant, vous devez d’abord identifier le nom interne du champ ou du bloc de champs. Pour cela :
53 53  
... ... @@ -65,7 +65,7 @@
65 65  [[//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"]]
66 66  
67 67  
68 -= Accéder à l'éditeur d'aide en ligne =
78 += Ouvrir l’éditeur d’aide en ligne =
69 69  
70 70  Pour créer ou modifier une aide, rendez-vous dans l’espace de travail **Administration**, menu **Paramétrage** > **Aide en ligne**.
71 71  
... ... @@ -76,7 +76,7 @@
76 76  [[//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"]]
77 77  
78 78  
79 -= Rechercher le champ ou le bloc à documenter =
89 += Localiser le champ ou le bloc à personnaliser =
80 80  
81 81  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 :
82 82  
... ... @@ -95,19 +95,48 @@
95 95  [[//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"]]
96 96  
97 97  
98 -= Éditer l'aide en ligne =
108 += Rédiger et mettre en forme votre aide =
99 99  
100 100  Une fois le champ ou le bloc trouvé, cliquez sur son nom pour ouvrir l’éditeur HTML.
101 101  
102 -Cet éditeur fonctionne comme un traitement de texte (type Word) et propose de nombreuses options :
112 +(((
113 +1. **Saisir le contenu**
103 103  
104 -* **Mise en forme du texte** : gras, italique, souligné, exposant, indice.
105 -* **Organisation du contenu** : listes à puces, listes numérotées, retrait, alignement.
106 -* **Styles et formats** : titres, styles prédéfinis, choix de la police et de la taille.
107 -* **Tableaux et images** : insertion et gestion de tableaux, ajout d’images.
108 -* **Éléments enrichis** : caractères spéciaux, symboles.
109 -* **Outils pratiques** : correcteur orthographique, recherche/remplacement, annuler/rétablir, affichage du code source.
115 +* Tapez directement votre texte dans l’éditeur.
116 +* Vous pouvez aussi copier-coller l’aide issue du wiki et l’adapter à vos besoins internes.
110 110  
118 +(% class="box successmessage" %)
119 +(((
120 +**Bonnes pratiques : **
121 +
122 +**Présentation et clarté**
123 +
124 +* Uniformisez la présentation : adoptez une structure homogène (définition, usage, remarques).
125 +* Soyez clairs et concis : rédigez des explications courtes et directement utiles.
126 +* Employez le vocabulaire métier partagé : utilisez les termes définis dans la charte de saisie de votre institution.
127 +
128 +**Contenu et cohérence**
129 +
130 +* Précisez le contexte : indiquez si le champ ou bloc est lié à un processus particulier (inventaire, récolement, prêt, dépôt, restauration).
131 +* Ajoutez des exemples concrets : illustrez les valeurs attendues pour éviter toute ambiguïté.
132 +* Limitez les redondances : n’intégrez que ce qui est pertinent, sans recopier inutilement l’aide du wiki.
133 +* Documentez aussi les blocs de champs : expliquez leur rôle global en plus des champs qu’ils contiennent.
134 +)))
135 +)))
136 +
137 +(((
138 +(% start="2" %)
139 +1. **Mettre en forme l’aide**
140 +
141 +* L’éditeur fonctionne comme un traitement de texte (type Word) et vous permet d’appliquer différents outils :
142 +** **Mise en forme du texte** : gras, italique, souligné, exposant, indice.
143 +** **Organisation du contenu** : listes à puces, listes numérotées, retrait, alignement.
144 +** **Styles et formats** : titres, styles prédéfinis, choix de la police et de la taille.
145 +** **Tableaux et images** : insertion et gestion de tableaux, ajout d’images.
146 +** **Éléments enrichis** : caractères spéciaux, symboles.
147 +** **Outils pratiques** : correcteur orthographique, recherche/remplacement, annuler/rétablir, affichage du code source.
148 +)))
149 +
111 111  (% class="box warningmessage" %)
112 112  (((
113 113  **Point d’attention : insérer des liens**
... ... @@ -116,45 +116,93 @@
116 116  * Copiez-collez ensuite ce lien dans l’éditeur d’aide en ligne. Il sera reconnu correctement et restera actif.
117 117  )))
118 118  
119 -Vous pouvez saisir directement votre texte ou copier-coller l’aide du wiki avant de l’adapter à vos besoins internes. Une fois vos modifications terminées, cliquez sur **Sauvegarder** pour enregistrer votre personnalisation.
158 +(((
159 +(% start="3" %)
160 +1. **Sauvegarder la personnalisation**
120 120  
162 +* Cliquez sur **Sauvegarder** pour enregistrer vos modifications.
163 +* Dès la sauvegarde, l’aide en ligne du wiki disparaît : elle est remplacée par votre aide personnalisée.
164 +* Cette personnalisation ne s’applique que dans votre base institutionnelle et n’a aucun impact sur le wiki ni sur les autres musées.
165 +)))
166 +
121 121  (% class="box successmessage" %)
122 122  (((
123 123  **Bonnes pratiques : **
124 124  
125 -* **Uniformisez la présentation** : adoptez une structure homogène (définition, usage, remarques).
126 -* **Soyez clairs et concis** : rédigez des explications courtes et directement utiles.
127 -* **Employez le vocabulaire métier partagé** : utilisez les termes définis dans la charte de saisie de votre institution.
128 -* **Précisez le contexte** : indiquez si le champ ou bloc est lié à un processus particulier (inventaire, récolement, prêt, dépôt, restauration).
129 -* **Ajoutez des exemples concrets** : illustrez les valeurs attendues pour éviter toute ambiguïté.
130 -* **Limitez les redondances** : n’intégrez que ce qui est pertinent, sans recopier inutilement l’aide du wiki.
131 -* **Documentez aussi les blocs de champs** : expliquez leur rôle global en plus des champs qu’ils contiennent.
132 -* **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.
171 +* 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.
133 133  )))
134 134  
135 -(% class="wikigeneratedid" id="H200B200B200B200B200B200B200B200B200B200B200B200B200B200B" %)
136 -[[image:1757596818102-351.png]]​​​​​​​​​​​​​​
174 +>(% class="small" %)L’exemple ci-dessous illustre le champ **Numéro d’inventaire** avec une aide en ligne enrichie :
137 137  
176 +>(% class="small" %)un **tableau** décrivant les différentes règles d’attribution,
138 138  
139 -(% id="cke_bm_851S" style="display:none" %)
178 +(((
179 +>(% class="small" %)un **lien hypertexte** vers une référence législative,
140 140  
141 -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 :
181 +(((
182 +>(% class="small" %)du **texte courant** explicatif,
142 142  
143 -* (((
144 -[[Firefox>>https://support.mozilla.org/fr/kb/parametres-exceptions-depannage-blocage-popup]]
184 +>(% class="small" %)et un **texte en rouge** servant à mettre en évidence une information importante.
145 145  )))
146 -* (((
147 -[[Safari >>https://support.apple.com/fr-fr/guide/safari/ibrwe2159f50/mac]]
148 148  )))
149 -* (((
150 -[[Chrome>>https://support.google.com/chrome/answer/95472?co=GENIE.Platform%3DDesktop&hl=fr]]
187 +
188 +>(% 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.
189 +
190 +[[//Saisie et mise en forme des données//>>image:1757596818102-351.png||data-xwiki-image-style-alignment="center" data-xwiki-image-style-border="true"]]
191 +
192 +(% class="wikigeneratedid" id="H200B200B200B200B200B200B200B200B200B200B200B200B200B200B" %)
193 +​​​​​​​​​​​​​​
194 +
195 +[[//Sauvegarder l'aide en ligne//>>image:1757597668258-471.png||data-xwiki-image-style-alignment="center" data-xwiki-image-style-border="true"]]
196 +
197 +
198 += Contrôler le rendu dans Flora =
199 +
200 +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.
201 +
202 +Faites un clic droit sur le libellé du champ ou du bloc > **Afficher aide. **
203 +
204 +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**.
205 +
206 +(% class="box warningmessage" %)
207 +(((
208 +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.
151 151  )))
152 -* (((
153 -[[Edge>>https://support.microsoft.com/fr-fr/help/17479/windows-internet-explorer-11-change-security-privacy-settings]]
154 -)))
155 155  
211 +[[//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"]]
156 156  
157 157  
214 +(% id="cke_bm_851S" style="display:none" %)
215 +
216 += Rétablir l’aide par défaut du wiki =
217 +
218 +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 :
219 +
220 +1. **Repérez le nom interne** du champ ou du bloc à partir de la grille de saisie.
221 +1. **Accédez à l’éditeur d’aides en ligne** : Administration > Paramétrage > Aide en ligne.
222 +1. **Dépliez la rubrique « Aide à la saisie »** pour afficher la liste des champs.
223 +1. **Choisissez la source** (ex. Musées, Bibliothèque, Archives).
224 +1. **Sélectionnez la table** dans laquelle se trouve le champ ou le bloc.
225 +1. **Recherchez le champ ou le bloc** avec le raccourci clavier Ctrl + F, puis cliquez sur son nom.
226 +1. **Ouvrez l’éditeur HTML** associé au champ ou au bloc.
227 +1. **Cliquez sur Delete** pour supprimer l’aide personnalisée.
228 +
229 +**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.
230 +
231 +[[//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"]]
232 +
233 +
234 +[[//Choix de **la source** et de la** table**//>>image:1757599467798-396.png||data-xwiki-image-style-alignment="center" data-xwiki-image-style-border="true"]]
235 +
236 +
237 +[[//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"]]
238 +
239 +
240 +[[//Suppression de l'aide en ligne personnalisée//>>image:1757599570577-172.png||data-xwiki-image-style-alignment="center" data-xwiki-image-style-border="true"]]
241 +
242 +
243 +[[//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"]]
244 +
158 158  
159 159  )))
160 160  )))|(% style="width:300px" %)(((
... ... @@ -170,6 +170,7 @@
170 170  **Aller plus loin**
171 171  
172 172  * [[Comprendre les sources et les tables dans Flora>>doc:2_Administration.Administration fonctionnelle.Présentation des sources et des tables.WebHome||target="_blank"]]
260 +* [[Insérer un document interne pour accueil>>doc:2_Administration.Administration fonctionnelle.Documents de référence sur page d'aide.WebHome||target="_blank"]]
173 173  * (((
174 174  [[Saisir dans Flora>>doc:1_Fonctionnalités.5\.C\. Saisie.WebHome||target="_blank"]]
175 175  )))
... ... @@ -178,13 +178,8 @@
178 178  (% class="box" %)
179 179  (((
180 180  **Icônes principales**
181 -)))
182 182  
183 -(((
184 -
185 -
186 -
187 -
270 +* [[image:1757600253202-543.png||height="45" width="45"]] Paramétrages
188 188  )))
189 189  )))
190 190  
1757597613394-216.png
Auteur
... ... @@ -1,0 +1,1 @@
1 +XWiki.DBA
Taille
... ... @@ -1,0 +1,1 @@
1 +135.0 KB
Contenu
1757597668258-471.png
Auteur
... ... @@ -1,0 +1,1 @@
1 +XWiki.DBA
Taille
... ... @@ -1,0 +1,1 @@
1 +138.2 KB
Contenu
1757597985000-452.png
Auteur
... ... @@ -1,0 +1,1 @@
1 +XWiki.DBA
Taille
... ... @@ -1,0 +1,1 @@
1 +193.0 KB
Contenu
1757599364051-795.png
Auteur
... ... @@ -1,0 +1,1 @@
1 +XWiki.DBA
Taille
... ... @@ -1,0 +1,1 @@
1 +148.4 KB
Contenu
1757599402906-988.png
Auteur
... ... @@ -1,0 +1,1 @@
1 +XWiki.DBA
Taille
... ... @@ -1,0 +1,1 @@
1 +98.9 KB
Contenu
1757599437795-401.png
Auteur
... ... @@ -1,0 +1,1 @@
1 +XWiki.DBA
Taille
... ... @@ -1,0 +1,1 @@
1 +112.8 KB
Contenu
1757599467798-396.png
Auteur
... ... @@ -1,0 +1,1 @@
1 +XWiki.DBA
Taille
... ... @@ -1,0 +1,1 @@
1 +115.5 KB
Contenu
1757599482084-563.png
Auteur
... ... @@ -1,0 +1,1 @@
1 +XWiki.DBA
Taille
... ... @@ -1,0 +1,1 @@
1 +129.8 KB
Contenu
1757599570577-172.png
Auteur
... ... @@ -1,0 +1,1 @@
1 +XWiki.DBA
Taille
... ... @@ -1,0 +1,1 @@
1 +75.3 KB
Contenu
1757599808499-510.png
Auteur
... ... @@ -1,0 +1,1 @@
1 +XWiki.DBA
Taille
... ... @@ -1,0 +1,1 @@
1 +11.4 KB
Contenu
1757600036454-769.png
Auteur
... ... @@ -1,0 +1,1 @@
1 +XWiki.DBA
Taille
... ... @@ -1,0 +1,1 @@
1 +199.0 KB
Contenu
1757600253202-543.png
Auteur
... ... @@ -1,0 +1,1 @@
1 +XWiki.DBA
Taille
... ... @@ -1,0 +1,1 @@
1 +6.3 KB
Contenu