Code source wiki de Documenter l’aide en ligne

Version 38.1 par Cécile Vinoche le 2025/09/11 15:30

Masquer les derniers auteurs
Cécile Vinoche 5.1 1 (% class="mark small" %)**Version 4.5.54 et ultérieures**
admin admin 1.1 2
Cécile Vinoche 5.1 3 |(% style="width:840px" %)(((
4 (% class="box" %)
5 (((
Cécile Vinoche 21.1 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.
Cécile Vinoche 10.1 7
Cécile Vinoche 13.1 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.
Cécile Vinoche 5.1 9 )))
Cécile Vinoche 3.1 10
Cécile Vinoche 5.1 11 (((
Cécile Vinoche 29.1 12 = À quoi sert l'aide en ligne dans Flora ? =
admin admin 1.1 13
Cécile Vinoche 21.1 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.
Cécile Vinoche 13.1 15
Cécile Vinoche 22.1 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**.
Cécile Vinoche 14.1 17
Cécile Vinoche 21.1 18 >(% class="small" %)Cas d'usage:
Cécile Vinoche 18.1 19
Cécile Vinoche 14.1 20 (((
Cécile Vinoche 17.1 21 >(% class="small" %)Expliquer le contenu attendu dans un champ.
Cécile Vinoche 16.1 22
Cécile Vinoche 17.1 23 (((
24 >(% class="small" %)Formaliser les règles de saisie propres à l’institution.
Cécile Vinoche 16.1 25
Cécile Vinoche 21.1 26 >(% class="small" %)Indiquer à quels processus le champ est lié  (ex. : inventaire, récolement, prêt, dépôt, restauration, etc.).
Cécile Vinoche 16.1 27
Cécile Vinoche 18.1 28 >(% class="small" %)Donner accès à des ressources externes de référence.
Cécile Vinoche 16.1 29
Cécile Vinoche 17.1 30 >(% class="small" %)Harmoniser les pratiques et éviter les erreurs d’interprétation.
Cécile Vinoche 13.1 31 )))
Cécile Vinoche 16.1 32 )))
Cécile Vinoche 13.1 33
Cécile Vinoche 23.1 34 (% class="box successmessage" %)
35 (((
36 **Bonnes pratiques : **
Cécile Vinoche 24.1 37
Cécile Vinoche 25.1 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.
Cécile Vinoche 23.1 48 )))
admin admin 1.1 49
Cécile Vinoche 27.1 50 = Récupérer le nom informatique du champ ou du bloc à documenter =
admin admin 1.1 51
Cécile Vinoche 27.1 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 :
admin admin 1.1 53
Cécile Vinoche 27.1 54 * Survolez le libellé dans une grille de saisie : son nom interne s’affiche en infobulle.
55 * Vous pouvez aussi faire un clic droit sur le libellé et choisir **Afficher informations** pour copier directement le nom interne.
admin admin 1.1 56
Cécile Vinoche 27.1 57 >(% class="small" %)Exemple : dans la table MUS_BIEN, le champ Numéro d’inventaire porte le nom technique **NUM_INVENTAIRE**.
admin admin 1.1 58
Cécile Vinoche 27.1 59 [[//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"]]
admin admin 1.1 60
61
Cécile Vinoche 27.1 62 [[//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"]]
admin admin 1.1 63
64
Cécile Vinoche 27.1 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"]]
admin admin 1.1 66
67
Cécile Vinoche 28.1 68 = Accéder à l'éditeur d'aide en ligne =
Cécile Vinoche 27.1 69
Cécile Vinoche 28.1 70 Pour créer ou modifier une aide, rendez-vous dans l’espace de travail **Administration**, menu **Paramétrage** > **Aide en ligne**.
Cécile Vinoche 27.1 71
Cécile Vinoche 28.1 72 Vous y trouverez la liste des fichiers disponibles, organisés par source et par table.
Cécile Vinoche 27.1 73
Cécile Vinoche 31.1 74 Dépliez la rubrique **Aide à la saisie** pour rechercher les champs et blocs de champs à documenter.
Cécile Vinoche 28.1 75
Cécile Vinoche 29.1 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"]]
Cécile Vinoche 28.1 77
78
Cécile Vinoche 29.1 79 = Rechercher le champ ou le bloc à documenter =
Cécile Vinoche 28.1 80
Cécile Vinoche 31.1 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 :
Cécile Vinoche 28.1 82
Cécile Vinoche 31.1 83 1. **Choisissez la source** (ex. Musées, Bibliothèque, Archives).
84 1. **Sélectionnez la table** dans laquelle se trouve le champ ou le bloc à documenter.
85 1. **Utilisez le raccourci clavier Ctrl + F** pour ouvrir la barre de recherche.
86 1. **Collez le nom interne** que vous avez récupéré (champ ou bloc).
Cécile Vinoche 33.1 87 1. **Cliquez sur l’élément trouvé** pour ouvrir l’éditeur.
Cécile Vinoche 28.1 88
Cécile Vinoche 31.1 89 [[//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"]]
Cécile Vinoche 28.1 90
Cécile Vinoche 27.1 91
Cécile Vinoche 32.1 92 [[//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"]]
admin admin 1.1 93
Cécile Vinoche 32.1 94
Cécile Vinoche 34.1 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"]]
Cécile Vinoche 32.1 96
admin admin 1.1 97
Cécile Vinoche 36.1 98 = Éditer l'aide en ligne =
admin admin 1.1 99
Cécile Vinoche 37.1 100 Une fois le champ ou le bloc trouvé, cliquez sur son nom pour ouvrir l’éditeur HTML.
Cécile Vinoche 34.1 101
Cécile Vinoche 37.1 102 Cet éditeur fonctionne comme un traitement de texte (type Word) et propose de nombreuses options :
Cécile Vinoche 34.1 103
Cécile Vinoche 37.1 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.
Cécile Vinoche 35.1 110
Cécile Vinoche 37.1 111 (% class="box warningmessage" %)
112 (((
113 **Point d’attention : insérer des liens**
114
115 * 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.
116 * Copiez-collez ensuite ce lien dans l’éditeur d’aide en ligne. Il sera reconnu correctement et restera actif.
117 )))
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.
120
Cécile Vinoche 35.1 121 (% class="box successmessage" %)
122 (((
123 **Bonnes pratiques : **
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.
133 )))
134
Cécile Vinoche 38.1 135 >L’exemple ci-dessous illustre le champ **Numéro d’inventaire** avec une aide en ligne enrichie :
136
137 >(((
138 * un **tableau** décrivant les différentes règles d’attribution,
139 * un **lien hypertexte** vers une référence législative,
140 * du **texte courant** explicatif,
141 * et un **texte en rouge** servant à mettre en évidence une information importante.
142 )))
143
144 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.
145
admin admin 1.1 146 (% class="wikigeneratedid" id="H200B200B200B200B200B200B200B200B200B200B200B200B200B200B" %)
Cécile Vinoche 36.1 147 [[image:1757596818102-351.png]]​​​​​​​​​​​​​​
admin admin 1.1 148
Cécile Vinoche 34.1 149
Cécile Vinoche 38.1 150
151
152
Cécile Vinoche 36.1 153 (% id="cke_bm_851S" style="display:none" %)
admin admin 1.1 154
Cécile Vinoche 26.1 155 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 :
156
Cécile Vinoche 27.1 157 * (((
158 [[Firefox>>https://support.mozilla.org/fr/kb/parametres-exceptions-depannage-blocage-popup]]
159 )))
160 * (((
161 [[Safari >>https://support.apple.com/fr-fr/guide/safari/ibrwe2159f50/mac]]
162 )))
163 * (((
164 [[Chrome>>https://support.google.com/chrome/answer/95472?co=GENIE.Platform%3DDesktop&hl=fr]]
165 )))
166 * (((
167 [[Edge>>https://support.microsoft.com/fr-fr/help/17479/windows-internet-explorer-11-change-security-privacy-settings]]
168 )))
Cécile Vinoche 26.1 169
170
Cécile Vinoche 32.1 171
Cécile Vinoche 26.1 172
Cécile Vinoche 6.1 173 )))
174 )))|(% style="width:300px" %)(((
175 (% class="box" %)
176 (((
177 **Sommaire**
Cécile Vinoche 7.1 178
Cécile Vinoche 29.1 179 {{toc depth="1" numbered="true"/}}
Cécile Vinoche 6.1 180 )))
181
182 (% class="box" %)
183 (((
184 **Aller plus loin**
Cécile Vinoche 22.1 185
Cécile Vinoche 28.1 186 * [[Comprendre les sources et les tables dans Flora>>doc:2_Administration.Administration fonctionnelle.Présentation des sources et des tables.WebHome||target="_blank"]]
Cécile Vinoche 27.1 187 * (((
188 [[Saisir dans Flora>>doc:1_Fonctionnalités.5\.C\. Saisie.WebHome||target="_blank"]]
Cécile Vinoche 6.1 189 )))
Cécile Vinoche 27.1 190 )))
Cécile Vinoche 6.1 191
192 (% class="box" %)
193 (((
194 **Icônes principales**
195 )))
196
197 (((
198
199
200
201
202 )))
203 )))
204
205