Code source wiki de Documenter l’aide en ligne
Version 31.1 par Doriane Bautista le 2025/09/11 14:57
Masquer les derniers auteurs
| author | version | line-number | content |
|---|---|---|---|
| |
5.1 | 1 | (% class="mark small" %)**Version 4.5.54 et ultérieures** |
| |
1.1 | 2 | |
| |
5.1 | 3 | |(% style="width:840px" %)((( |
| 4 | (% class="box" %) | ||
| 5 | ((( | ||
| |
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. |
| |
10.1 | 7 | |
| |
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. |
| |
5.1 | 9 | ))) |
| |
3.1 | 10 | |
| |
5.1 | 11 | ((( |
| |
29.1 | 12 | = À quoi sert l'aide en ligne dans Flora ? = |
| |
1.1 | 13 | |
| |
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. |
| |
13.1 | 15 | |
| |
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**. |
| |
14.1 | 17 | |
| |
21.1 | 18 | >(% class="small" %)Cas d'usage: |
| |
18.1 | 19 | |
| |
14.1 | 20 | ((( |
| |
17.1 | 21 | >(% class="small" %)Expliquer le contenu attendu dans un champ. |
| |
16.1 | 22 | |
| |
17.1 | 23 | ((( |
| 24 | >(% class="small" %)Formaliser les règles de saisie propres à l’institution. | ||
| |
16.1 | 25 | |
| |
21.1 | 26 | >(% class="small" %)Indiquer à quels processus le champ est lié (ex. : inventaire, récolement, prêt, dépôt, restauration, etc.). |
| |
16.1 | 27 | |
| |
18.1 | 28 | >(% class="small" %)Donner accès à des ressources externes de référence. |
| |
16.1 | 29 | |
| |
17.1 | 30 | >(% class="small" %)Harmoniser les pratiques et éviter les erreurs d’interprétation. |
| |
13.1 | 31 | ))) |
| |
16.1 | 32 | ))) |
| |
13.1 | 33 | |
| |
23.1 | 34 | (% class="box successmessage" %) |
| 35 | ((( | ||
| 36 | **Bonnes pratiques : ** | ||
| |
24.1 | 37 | |
| |
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. | ||
| |
23.1 | 48 | ))) |
| |
1.1 | 49 | |
| |
27.1 | 50 | = Récupérer le nom informatique du champ ou du bloc à documenter = |
| |
1.1 | 51 | |
| |
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 : |
| |
1.1 | 53 | |
| |
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. | ||
| |
1.1 | 56 | |
| |
27.1 | 57 | >(% class="small" %)Exemple : dans la table MUS_BIEN, le champ Numéro d’inventaire porte le nom technique **NUM_INVENTAIRE**. |
| |
1.1 | 58 | |
| |
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"]] |
| |
1.1 | 60 | |
| 61 | |||
| |
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"]] |
| |
1.1 | 63 | |
| 64 | |||
| |
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"]] |
| |
1.1 | 66 | |
| 67 | |||
| |
28.1 | 68 | = Accéder à l'éditeur d'aide en ligne = |
| |
27.1 | 69 | |
| |
28.1 | 70 | Pour créer ou modifier une aide, rendez-vous dans l’espace de travail **Administration**, menu **Paramétrage** > **Aide en ligne**. |
| |
27.1 | 71 | |
| |
28.1 | 72 | Vous y trouverez la liste des fichiers disponibles, organisés par source et par table. |
| |
27.1 | 73 | |
| |
31.1 | 74 | Dépliez la rubrique **Aide à la saisie** pour rechercher les champs et blocs de champs à documenter. |
| |
28.1 | 75 | |
| |
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"]] |
| |
28.1 | 77 | |
| 78 | |||
| |
29.1 | 79 | = Rechercher le champ ou le bloc à documenter = |
| |
28.1 | 80 | |
| |
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 : |
| |
28.1 | 82 | |
| |
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). | ||
| 87 | 1. **Sélectionnez l’élément trouvé** pour ouvrir l’éditeur. | ||
| |
28.1 | 88 | |
| |
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"]] |
| |
28.1 | 90 | |
| |
27.1 | 91 | |
| |
6.1 | 92 | [[image:1744364568000-243.png]] |
| |
1.1 | 93 | |
| 94 | (% class="wikigeneratedid" %) | ||
| 95 | Cliquer sur le nom informatique du champ afin d'ouvrir l'éditeur html, puis saisir votre texte et cliquer sur sauvegarder. | ||
| 96 | |||
| 97 | (% class="box infomessage" %) | ||
| 98 | ((( | ||
| 99 | Si vous souhaitez conserver l'aide en ligne du wiki en plus de votre aide spécifique, copier-coller l'aide en ligne déjà disponible dans l'éditeur html avant de le modifier. | ||
| 100 | ))) | ||
| 101 | |||
| 102 | (% class="wikigeneratedid" id="H200B200B200B200B200B200B200B200B200B200B200B200B200B200B" %) | ||
| 103 | [[image:1744364831120-598.png]] | ||
| 104 | |||
| |
27.1 | 105 | (% class="wikigeneratedid" id="HSauvegardervotreaideenlignepersonnalisE9e" %) |
| 106 | Sauvegarder votre aide en ligne personnalisée | ||
| |
1.1 | 107 | |
| 108 | Parmi la foultitude de champs de toutes les tables, il vous sera difficile de savoir **quels sont les champs pour lesquels le musée à un protocole de saisie particulier** | ||
| 109 | |||
| 110 | Lors des changements de version, Flora veillera à ne pas écraser ces personnalisations en les récupérant par comparaison de dates de mise à jour de fichier. | ||
| 111 | |||
| 112 | Mais il serait pratique pour vous de créer un document traitement de texte dans lequel vous copie/collerez les contenus des champs personnalisés de chaque table. | ||
| 113 | |||
| |
1.7 | 114 | Ce document sera la "mémoire" des spécificités de votre protocole de saisie, et pourra d'ailleurs être affiché sur la page d'accueil comme indiqué [[ici>>doc:2_Administration.Administration fonctionnelle.Documents de référence sur page d'aide.WebHome]] |
| |
26.1 | 115 | |
| 116 | |||
| |
27.1 | 117 | (% class="wikigeneratedid" id="HComportementpardE9faut" %) |
| 118 | (% id="cke_bm_851S" style="display:none" %) (%%)Comportement par défaut | ||
| |
26.1 | 119 | |
| 120 | Lors d'un appel au menu "Afficher aide" Flora recherche d'abord le fichier html correspondant sur votre applicatif. Si cette recherche est infructueuse, Flora interroge le wiki dans un second temps. | ||
| 121 | |||
| 122 | Ainsi, les fichiers rédigés par les services du musée sont prioritaires sur ceux de Flora. | ||
| 123 | |||
| 124 | 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 : | ||
| 125 | |||
| |
27.1 | 126 | * ((( |
| 127 | [[Firefox>>https://support.mozilla.org/fr/kb/parametres-exceptions-depannage-blocage-popup]] | ||
| 128 | ))) | ||
| 129 | * ((( | ||
| 130 | [[Safari >>https://support.apple.com/fr-fr/guide/safari/ibrwe2159f50/mac]] | ||
| 131 | ))) | ||
| 132 | * ((( | ||
| 133 | [[Chrome>>https://support.google.com/chrome/answer/95472?co=GENIE.Platform%3DDesktop&hl=fr]] | ||
| 134 | ))) | ||
| 135 | * ((( | ||
| 136 | [[Edge>>https://support.microsoft.com/fr-fr/help/17479/windows-internet-explorer-11-change-security-privacy-settings]] | ||
| 137 | ))) | ||
| |
26.1 | 138 | |
| |
31.1 | 139 | |
| |
26.1 | 140 | |
| 141 | |||
| |
6.1 | 142 | ))) |
| 143 | )))|(% style="width:300px" %)((( | ||
| 144 | (% class="box" %) | ||
| 145 | ((( | ||
| 146 | **Sommaire** | ||
| |
7.1 | 147 | |
| |
29.1 | 148 | {{toc depth="1" numbered="true"/}} |
| |
6.1 | 149 | ))) |
| 150 | |||
| 151 | (% class="box" %) | ||
| 152 | ((( | ||
| 153 | **Aller plus loin** | ||
| |
22.1 | 154 | |
| |
28.1 | 155 | * [[Comprendre les sources et les tables dans Flora>>doc:2_Administration.Administration fonctionnelle.Présentation des sources et des tables.WebHome||target="_blank"]] |
| |
27.1 | 156 | * ((( |
| 157 | [[Saisir dans Flora>>doc:1_Fonctionnalités.5\.C\. Saisie.WebHome||target="_blank"]] | ||
| |
6.1 | 158 | ))) |
| |
27.1 | 159 | ))) |
| |
6.1 | 160 | |
| 161 | (% class="box" %) | ||
| 162 | ((( | ||
| 163 | **Icônes principales** | ||
| 164 | ))) | ||
| 165 | |||
| 166 | ((( | ||
| 167 | |||
| 168 | |||
| 169 | |||
| 170 | |||
| 171 | ))) | ||
| 172 | ))) | ||
| 173 | |||
| 174 |