Aller au contenu

Modifications pour le document Documenter l’aide en ligne

Modifié par Joséphine Ducruet le 2026/02/18 16:34
Depuis la version 69.1
modifié par Doriane Bautista
sur 2025/09/15 13:28
Commentaire de modification : Il n'y a aucun commentaire pour cette version
À la version 76.1
modifié par Joséphine Ducruet
sur 2026/02/18 16:26
Commentaire de modification : Il n'y a aucun commentaire pour cette version

Résumé

Détails

Propriétés de la Page
Auteur du document
... ... @@ -1,1 +1,1 @@
1 -XWiki.DBA
1 +XWiki.JDT
Contenu
... ... @@ -1,3 +1,5 @@
1 +**PAGE EN COURS DE REDACTION**
2 +
1 1  (% class="mark small" %)**Version 4.5.54 et ultérieures**
2 2  
3 3  |(% style="width:840px" %)(((
... ... @@ -9,155 +9,93 @@
9 9  )))
10 10  
11 11  (((
12 -= À quoi sert l'aide en ligne dans Flora ? =
14 += L'aide en ligne : un appui à la saisie dans Flora =
13 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 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 +L’aide en ligne **accompagne les utilisateurs** dans la compréhension et l’utilisation des champs présents dans les différentes tables de Flora.
18 +Elle contribue à garantir une saisie homogène, cohérente et conforme aux pratiques définies par votre institution. Elle complète les documents de référence internes et les procédures métiers du musée.
19 +Son objectif est de traduire concrètement ces règles directement dans l’interface de Flora, au plus près des champs utilisés par les équipes au quotidien.
17 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**.
21 +Concrètement, l’aide en ligne permet de :
19 19  
20 ->(% class="small" %)Cas d'usage:
23 +* **Expliquer le contenu attendu dans un champ**.
24 +* **Formaliser les règles de saisie propres à l’institution** (abréviations autorisées, vocabulaire contrôlé, conventions d’écriture, etc.).
25 +* **Donner accès à des ressources externes de référence** (textes réglementaires, chartes internes, normes, guides méthodologiques).
26 +* **Harmoniser les pratiques et éviter les erreurs d’interprétation**, notamment dans les équipes élargies ou en cas de renouvellement des agents.
21 21  
22 -(((
23 ->(% class="small" %)Expliquer le contenu attendu dans un champ.
28 +Par défaut, **l’aide en ligne est redirigée vers l’aide disponible sur le wiki officiel**. Cette documentation est actuellement en cours de rédaction et d’enrichissement par l’équipe de Flora Software.
24 24  
25 -(((
26 ->(% class="small" %)Formaliser les règles de saisie propres à l’institution.
30 +Elle constitue une **base commune de référence pour l’ensemble des utilisateurs**.
27 27  
28 ->(% class="small" %)Indiquer à quels processus le champ est lié  (ex. : inventaire, récolement, prêt, dépôt, restauration, etc.).
32 +Toutefois, chaque institution a la possibilité d**’adapter cette aide à ses propres pratiques**.
29 29  
30 ->(% class="small" %)Donner accès à des ressources externes de référence.
34 += Personnaliser l'aide en ligne =
31 31  
32 ->(% class="small" %)Harmoniser les pratiques et éviter les erreurs d’interprétation.
33 -)))
34 -)))
36 +Lorsqu’un musée crée une **aide en ligne personnalisée** pour un champ :
35 35  
36 -(% class="box successmessage" %)
37 -(((
38 -**Bonnes pratiques : **
38 +* le contenu standard issu du** wiki est automatiquement masqué**
39 +* seul le **contenu rédigé localement est affiché**
39 39  
40 -**Présentation et lisibilité**
41 +Si cette personnalisation est supprimée, l’aide du wiki réapparaît automatiquement.
41 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é.
43 +Cette **personnalisation est strictement locale** : elle s’applique uniquement à la base de données de l’institution qui l’a créée.
44 +Elle ne modifie pas le contenu du wiki et n’a aucun impact sur les autres institutions.
46 46  
47 -**Contenu et cohérence métier**
46 +== Identifier le nom interne du champ ou du bloc ==
48 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.
48 +Pour retrouver le fichier d’aide correspondant, vous devez d’abord identifier le nom interne du champ ou du bloc de champs.
52 52  
53 -**Suivi et maintenance**
50 +Pour cela :
54 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 -)))
52 +1. Faites un **clic droit** sur le libellé du champ
53 +1. Choisir **Afficher informations**
54 +1. **Copiez le nom interne **du champ (ligne name)
59 59  
60 -= Identifier le nom interne du champ ou du bloc =
56 +[[//Clic droit - Afficher informations//>>image:1744363948510-224.png||data-xwiki-image-style-alignment="center" data-xwiki-image-style-border="true"]]
61 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 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.
59 +[[//Nom interne du champ//>>image:1744363968204-295.png||data-xwiki-image-style-alignment="center" data-xwiki-image-style-border="true"]]
66 66  
67 ->(% class="small" %)Exemple : dans la table MUS_BIEN, le champ Numéro d’inventaire porte le nom technique **NUM_INVENTAIRE**.
68 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"]]
62 +== Accéder à l'éditeur d'aide en ligne ==
70 70  
64 +1. Rendez-vous dans l'espace de travail **Administration, menu Paramétrage, Aide en ligne**
65 +1. Dépliez la rubrique** Aide à la saisie**
66 +1. Choisir la source et la table
67 +1. **Utilisez le raccourci clavier Ctrl + F** pour ouvrir la barre de recherche
68 +1. **Collez le nom interne** que vous avez récupéré
69 +1. **Cliquez sur l’élément trouvé** pour ouvrir l’éditeur
71 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"]]
71 +[[//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"]]
73 73  
74 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"]]
74 +[[//Afficher la barre de recherche avec **CTRL+F** pour rechercher le champ//>>image:1757595571069-539.png||data-xwiki-image-style-alignment="center" data-xwiki-image-style-border="true"]]
76 76  
77 77  
78 -= Ouvrir l’éditeur d’aide en ligne =
77 +[[//Ouverture de l'éditeur//>>image:1757595726608-759.png||data-xwiki-image-style-alignment="center" data-xwiki-image-style-border="true"]]
79 79  
80 -Pour créer ou modifier une aide, rendez-vous dans l’espace de travail **Administration**, menu **Paramétrage** > **Aide en ligne**.
81 81  
82 -Vous y trouverez la liste des fichiers disponibles, organisés par source et par table.
80 +== Rédiger l'aide en ligne ==
83 83  
84 -Dépliez la rubrique **Aide à la saisie** pour rechercher les champs et blocs de champs à documenter.
82 +L’éditeur fonctionne comme un traitement de texte (type Word) et vous permet d’appliquer différents outils :
85 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 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.
85 +* **Mise en forme du texte** : gras, italique, souligné, exposant, indice.
86 +* **Organisation du contenu** : listes à puces, listes numérotées, retrait, alignement.
87 +* **Styles et formats** : titres, styles prédéfinis, choix de la police et de la taille.
88 +* **Tableaux et images** : insertion et gestion de tableaux, ajout d’images.
89 +* **Éléments enrichis** : caractères spéciaux, symboles.
90 +* **Outils pratiques** : correcteur orthographique, recherche/remplacement, annuler/rétablir, affichage du code source.
134 134  )))
135 -)))
136 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 150  (% class="box warningmessage" %)
151 151  (((
152 -**Point d’attention : insérer des liens**
153 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 156  )))
157 157  
98 +
158 158  (((
159 -(% start="3" %)
160 -1. **Sauvegarder la personnalisation**
100 +== **Sauvegarder la personnalisation** ==
161 161  
162 162  * Cliquez sur **Sauvegarder** pour enregistrer vos modifications.
163 163  * Dès la sauvegarde, l’aide en ligne du wiki disparaît : elle est remplacée par votre aide personnalisée.
... ... @@ -169,6 +169,7 @@
169 169  **Bonnes pratiques : **
170 170  
171 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.
112 +* Mettez à jour régulièrement : adaptez vos contenus lorsque vos procédures internes ou règles métier évoluent.
172 172  )))
173 173  
174 174  >(% class="small" %)L’exemple ci-dessous illustre le champ **Numéro d’inventaire** avec une aide en ligne enrichie :
... ... @@ -189,8 +189,6 @@
189 189  
190 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 191  
192 -(% class="wikigeneratedid" id="H200B200B200B200B200B200B200B200B200B200B200B200B200B200B" %)
193 -​​​​​​​​​​​​​​
194 194  
195 195  [[//Sauvegarder l'aide en ligne//>>image:1757597668258-471.png||data-xwiki-image-style-alignment="center" data-xwiki-image-style-border="true"]]
196 196