Code source wiki de Documenter l’aide en ligne
Version 68.1 par Doriane Bautista le 2025/09/11 16:46
Afficher les derniers auteurs
| author | version | line-number | content |
|---|---|---|---|
| 1 | (% class="mark small" %)**Version 4.5.54 et ultérieures** | ||
| 2 | |||
| 3 | |(% style="width:840px" %)((( | ||
| 4 | (% class="box" %) | ||
| 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, l’aide affichée provient du wiki. | ||
| 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. | ||
| 9 | ))) | ||
| 10 | |||
| 11 | ((( | ||
| 12 | = À quoi sert l'aide en ligne dans Flora ? = | ||
| 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. | ||
| 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 | |||
| 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**. | ||
| 19 | |||
| 20 | >(% class="small" %)Cas d'usage: | ||
| 21 | |||
| 22 | ((( | ||
| 23 | >(% class="small" %)Expliquer le contenu attendu dans un champ. | ||
| 24 | |||
| 25 | ((( | ||
| 26 | >(% class="small" %)Formaliser les règles de saisie propres à l’institution. | ||
| 27 | |||
| 28 | >(% class="small" %)Indiquer à quels processus le champ est lié (ex. : inventaire, récolement, prêt, dépôt, restauration, etc.). | ||
| 29 | |||
| 30 | >(% class="small" %)Donner accès à des ressources externes de référence. | ||
| 31 | |||
| 32 | >(% class="small" %)Harmoniser les pratiques et éviter les erreurs d’interprétation. | ||
| 33 | ))) | ||
| 34 | ))) | ||
| 35 | |||
| 36 | (% class="box successmessage" %) | ||
| 37 | ((( | ||
| 38 | **Bonnes pratiques : ** | ||
| 39 | |||
| 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. | ||
| 58 | ))) | ||
| 59 | |||
| 60 | = Identifier le nom interne du champ ou du bloc = | ||
| 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 : | ||
| 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 | |||
| 67 | >(% class="small" %)Exemple : dans la table MUS_BIEN, le champ Numéro d’inventaire porte le nom technique **NUM_INVENTAIRE**. | ||
| 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"]] | ||
| 70 | |||
| 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 | |||
| 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 | |||
| 77 | |||
| 78 | = Ouvrir l’éditeur d’aide en ligne = | ||
| 79 | |||
| 80 | Pour créer ou modifier une aide, rendez-vous dans l’espace de travail **Administration**, menu **Paramétrage** > **Aide en ligne**. | ||
| 81 | |||
| 82 | Vous y trouverez la liste des fichiers disponibles, organisés par source et par table. | ||
| 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 | ((( | ||
| 113 | 1. **Saisir le contenu** | ||
| 114 | |||
| 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. | ||
| 117 | |||
| 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 | |||
| 150 | (% class="box warningmessage" %) | ||
| 151 | ((( | ||
| 152 | **Point d’attention : insérer des liens** | ||
| 153 | |||
| 154 | * 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. | ||
| 155 | * Copiez-collez ensuite ce lien dans l’éditeur d’aide en ligne. Il sera reconnu correctement et restera actif. | ||
| 156 | ))) | ||
| 157 | |||
| 158 | ((( | ||
| 159 | (% start="3" %) | ||
| 160 | 1. **Sauvegarder la personnalisation** | ||
| 161 | |||
| 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 | |||
| 167 | (% class="box successmessage" %) | ||
| 168 | ((( | ||
| 169 | **Bonnes pratiques : ** | ||
| 170 | |||
| 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. | ||
| 172 | ))) | ||
| 173 | |||
| 174 | >(% class="small" %)L’exemple ci-dessous illustre le champ **Numéro d’inventaire** avec une aide en ligne enrichie : | ||
| 175 | |||
| 176 | >(% class="small" %)un **tableau** décrivant les différentes règles d’attribution, | ||
| 177 | |||
| 178 | ((( | ||
| 179 | >(% class="small" %)un **lien hypertexte** vers une référence législative, | ||
| 180 | |||
| 181 | ((( | ||
| 182 | >(% class="small" %)du **texte courant** explicatif, | ||
| 183 | |||
| 184 | >(% class="small" %)et un **texte en rouge** servant à mettre en évidence une information importante. | ||
| 185 | ))) | ||
| 186 | ))) | ||
| 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. | ||
| 209 | ))) | ||
| 210 | |||
| 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"]] | ||
| 212 | |||
| 213 | |||
| 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 | |||
| 245 | |||
| 246 | ))) | ||
| 247 | )))|(% style="width:300px" %)((( | ||
| 248 | (% class="box" %) | ||
| 249 | ((( | ||
| 250 | **Sommaire** | ||
| 251 | |||
| 252 | {{toc depth="1" numbered="true"/}} | ||
| 253 | ))) | ||
| 254 | |||
| 255 | (% class="box" %) | ||
| 256 | ((( | ||
| 257 | **Aller plus loin** | ||
| 258 | |||
| 259 | * [[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"]] | ||
| 261 | * ((( | ||
| 262 | [[Saisir dans Flora>>doc:1_Fonctionnalités.5\.C\. Saisie.WebHome||target="_blank"]] | ||
| 263 | ))) | ||
| 264 | ))) | ||
| 265 | |||
| 266 | (% class="box" %) | ||
| 267 | ((( | ||
| 268 | **Icônes principales** | ||
| 269 | |||
| 270 | * [[image:1757600253202-543.png||height="45" width="45"]] Paramétrages | ||
| 271 | ))) | ||
| 272 | ))) | ||
| 273 | |||
| 274 |