Code source wiki de Documenter l’aide en ligne

Version 37.1 par Doriane Bautista le 2025/09/11 15:27

Afficher les derniers auteurs
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** rédiger 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 **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
18 >(% class="small" %)Cas d'usage:
19
20 (((
21 >(% class="small" %)Expliquer le contenu attendu dans un champ.
22
23 (((
24 >(% class="small" %)Formaliser les règles de saisie propres à l’institution.
25
26 >(% class="small" %)Indiquer à quels processus le champ est lié  (ex. : inventaire, récolement, prêt, dépôt, restauration, etc.).
27
28 >(% class="small" %)Donner accès à des ressources externes de référence.
29
30 >(% class="small" %)Harmoniser les pratiques et éviter les erreurs d’interprétation.
31 )))
32 )))
33
34 (% class="box successmessage" %)
35 (((
36 **Bonnes pratiques : **
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.
48 )))
49
50 = Récupérer le nom informatique du champ ou du bloc à documenter =
51
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
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.
56
57 >(% class="small" %)Exemple : dans la table MUS_BIEN, le champ Numéro d’inventaire porte le nom technique **NUM_INVENTAIRE**.
58
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"]]
60
61
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"]]
63
64
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
67
68 = Accéder à l'éditeur d'aide en ligne =
69
70 Pour créer ou modifier une aide, rendez-vous dans l’espace de travail **Administration**, menu **Paramétrage** > **Aide en ligne**.
71
72 Vous y trouverez la liste des fichiers disponibles, organisés par source et par table.
73
74 Dépliez la rubrique **Aide à la saisie** pour rechercher les champs et blocs de champs à documenter.
75
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
78
79 = Rechercher le champ ou le bloc à documenter =
80
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
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. **Cliquez sur l’élément trouvé** pour ouvrir l’éditeur.
88
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"]]
90
91
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"]]
93
94
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
97
98 = Éditer l'aide en ligne =
99
100 Une fois le champ ou le bloc trouvé, cliquez sur son nom pour ouvrir l’éditeur HTML.
101
102 Cet éditeur fonctionne comme un traitement de texte (type Word) et propose de nombreuses options :
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.
110
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
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
135 (% class="wikigeneratedid" id="H200B200B200B200B200B200B200B200B200B200B200B200B200B200B" %)
136 [[image:1757596818102-351.png]]​​​​​​​​​​​​​​
137
138
139 (% id="cke_bm_851S" style="display:none" %)
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 :
142
143 * (((
144 [[Firefox>>https://support.mozilla.org/fr/kb/parametres-exceptions-depannage-blocage-popup]]
145 )))
146 * (((
147 [[Safari >>https://support.apple.com/fr-fr/guide/safari/ibrwe2159f50/mac]]
148 )))
149 * (((
150 [[Chrome>>https://support.google.com/chrome/answer/95472?co=GENIE.Platform%3DDesktop&hl=fr]]
151 )))
152 * (((
153 [[Edge>>https://support.microsoft.com/fr-fr/help/17479/windows-internet-explorer-11-change-security-privacy-settings]]
154 )))
155
156
157
158
159 )))
160 )))|(% style="width:300px" %)(((
161 (% class="box" %)
162 (((
163 **Sommaire**
164
165 {{toc depth="1" numbered="true"/}}
166 )))
167
168 (% class="box" %)
169 (((
170 **Aller plus loin**
171
172 * [[Comprendre les sources et les tables dans Flora>>doc:2_Administration.Administration fonctionnelle.Présentation des sources et des tables.WebHome||target="_blank"]]
173 * (((
174 [[Saisir dans Flora>>doc:1_Fonctionnalités.5\.C\. Saisie.WebHome||target="_blank"]]
175 )))
176 )))
177
178 (% class="box" %)
179 (((
180 **Icônes principales**
181 )))
182
183 (((
184
185
186
187
188 )))
189 )))
190
191