Skip to Content

Modifications pour le document Documenter l’aide en ligne

Modifié par Doriane Bautista le 2025/09/17 16:01
Depuis la version 39.1
modifié par Doriane Bautista
sur 2025/09/11 15:30
Commentaire de modification : Il n'y a aucun commentaire pour cette version
À la version 24.1
modifié par Doriane Bautista
sur 2025/09/11 14:25
Commentaire de modification : Il n'y a aucun commentaire pour cette version

Résumé

Détails

Propriétés de la Page
Contenu
... ... @@ -9,7 +9,7 @@
9 9  )))
10 10  
11 11  (((
12 -= À quoi sert l'aide en ligne dans Flora ? =
12 += A quoi sert l'aide en ligne dans Flora ? =
13 13  
14 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  
... ... @@ -35,152 +35,95 @@
35 35  (((
36 36  **Bonnes pratiques : **
37 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.
38 +* **Être concis et clair** : rédiger des explications courtes, directement utiles à la saisie.
39 +* **Utiliser le vocabulaire métier partagé** : employer les termes définis dans la charte de saisie de l’institution.
40 +* **Préciser le contexte** : indiquer si le champ intervient dans un processus spécifique (inventaire, récolement, prêt, dépôt, restauration).
41 +* **Ajouter des exemples concrets** : illustrer les valeurs attendues pour éviter toute ambiguïté.
42 +* **Uniformiser la présentation** : structurer les textes de la même manière pour tous les champs (définition, usage, remarques).
43 +* **Limiter la redondance** : éviter de copier-coller l’intégralité de l’aide du wiki, ne garder que ce qui est réellement utile ou adapté localement.
44 +* **Documenter les blocs de champs** : expliquer le rôle global du bloc en plus du détail des champs si nécessaire.
45 +* **Préserver une mémoire interne** : conserver une copie (Word, tableur, etc.) des aides personnalisées pour suivre l’évolution des consignes et faciliter la maintenance lors des mises à jour Flora.
46 +* **Vérifier l’accessibilité** : tester l’affichage de la pop-up dans les navigateurs utilisés et vérifier que les aides apparaissent correctement.
47 +* **Actualiser régulièrement** : mettre à jour les contenus quand les procédures internes ou les règles métier évoluent.
48 48  )))
49 49  
50 -= Récupérer le nom informatique du champ ou du bloc à documenter =
50 +== Comportement par défaut ==
51 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 :
52 +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.
53 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.
54 +Ainsi, les fichiers rédigés par les services du musée sont prioritaires sur ceux de Flora.
56 56  
57 ->(% class="small" %)Exemple : dans la table MUS_BIEN, le champ Numéro d’inventaire porte le nom technique **NUM_INVENTAIRE**.
56 +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 :
58 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"]]
58 +* [[Firefox>>https://support.mozilla.org/fr/kb/parametres-exceptions-depannage-blocage-popup]]
59 +* [[Safari >>https://support.apple.com/fr-fr/guide/safari/ibrwe2159f50/mac]]
60 +* [[Chrome>>https://support.google.com/chrome/answer/95472?co=GENIE.Platform%3DDesktop&hl=fr]]
61 +* [[Edge>>https://support.microsoft.com/fr-fr/help/17479/windows-internet-explorer-11-change-security-privacy-settings]]
60 60  
63 +== Gestion locale des pages html d'aide ==
61 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"]]
65 +L'accès à ces pages, en modification, suppression ou création, se fait avec un compte autorisé, dans l'espace de travail "Administration", Menu "Paramétrage Aides en ligne" :
63 63  
64 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"]]
68 +[[image:1744363736609-747.png]]
66 66  
67 67  
68 -= Accéder à l'éditeur d'aide en ligne =
71 +== Connaître le nom d'un champ Flora ==
69 69  
70 -Pour créer ou modifier une aide, rendez-vous dans l’espace de travail **Administration**, menu **Paramétrage** > **Aide en ligne**.
73 +Pour retrouver le fichier d'aide en ligne à renseigner, il faut connaitre le nom informatique du champ concerné.. Par exemple, en musée, le champ "numéro d'inventaire" de la table des biens (MUS_BIEN) se nomme NUM_INVENTAIRE.
71 71  
72 -Vous y trouverez la liste des fichiers disponibles, organisés par source et par table.
75 +[[image:1744363912649-947.png]]
73 73  
74 -Dépliez la rubrique **Aide à la saisie** pour rechercher les champs et blocs de champs à documenter.
77 +Afin de connaître ce nom, il suffit d'aller sur une grille de saisie concernée et de survoler le libellé de l'élément à documenter
75 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"]]
79 +Vous pouvez également le trouver en allant dans le menu contextuel "Afficher informations" présent sur ce libellé (accès par un clique droit). Cette méthode permet d'en copier la valeur. Il est conseillé de le copier afin de le retrouver facilement par la suite.
77 77  
81 +[[image:1744363948510-224.png]]
78 78  
79 -= Rechercher le champ ou le bloc à documenter =
83 += [[image:1744363968204-295.png]] =
80 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 :
85 += Modifier le fichier d'aide =
82 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.
87 +Dans l'espace de travail Administration, dans le menu Paramétrage, puis Aide en ligne, on retrouve les fichiers d'aide en ligne qu'il est possible de modifier pour son institution.
88 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"]]
89 +[[image:1744364271216-799.png]]
90 90  
91 +Cliquer sur le [[image:1744364312163-238.png]] de l'Aide à la saisie pour déplier la liste des fichiers.
91 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 +[[image:1744364340925-762.png]]
93 93  
95 +(% class="wikigeneratedid" %)
96 +Choisir ensuite la source et la table du champ auquel on souhaite ajouter une aide en ligne. Taper sur les touches Ctrl et F de votre clavier afin de faire apparaitre une barre de recherche. Puis coller le nom informatique du champ dans la barre de recherche afin de le retrouver facilement dans la liste des champs.
94 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"]]
98 +[[image:1744364568000-243.png]]
96 96  
100 +(% class="wikigeneratedid" %)
101 +Cliquer sur le nom informatique du champ afin d'ouvrir l'éditeur html, puis saisir votre texte et cliquer sur sauvegarder.
97 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" %)
103 +(% class="box infomessage" %)
112 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.
105 +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.
117 117  )))
118 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 ->L’exemple ci-dessous illustre le champ **Numéro d’inventaire** avec une aide en ligne enrichie :
136 -
137 ->un **tableau** décrivant les différentes règles d’attribution,
138 -
139 -(((
140 ->(((
141 -*
142 -* (% class="small" %)un **lien hypertexte** vers une référence législative,
143 -* du **texte courant** explicatif,
144 -* et un **texte en rouge** servant à mettre en évidence une information importante.
145 -)))
146 -)))
147 -
148 -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.
149 -
150 150  (% class="wikigeneratedid" id="H200B200B200B200B200B200B200B200B200B200B200B200B200B200B" %)
151 -[[image:1757596818102-351.png]]​​​​​​​​​​​​​​
109 +[[image:1744364831120-598.png]]​​​​​​​​​​​​​​
152 152  
111 += Sauvegarder votre aide en ligne personnalisée =
153 153  
113 +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**
154 154  
115 +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.
155 155  
117 +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.
156 156  
157 -(% id="cke_bm_851S" style="display:none" %)
158 -
159 -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 :
160 -
161 -* (((
162 -[[Firefox>>https://support.mozilla.org/fr/kb/parametres-exceptions-depannage-blocage-popup]]
119 +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]]
163 163  )))
164 -* (((
165 -[[Safari >>https://support.apple.com/fr-fr/guide/safari/ibrwe2159f50/mac]]
166 -)))
167 -* (((
168 -[[Chrome>>https://support.google.com/chrome/answer/95472?co=GENIE.Platform%3DDesktop&hl=fr]]
169 -)))
170 -* (((
171 -[[Edge>>https://support.microsoft.com/fr-fr/help/17479/windows-internet-explorer-11-change-security-privacy-settings]]
172 -)))
173 -
174 -
175 -
176 -
177 -)))
178 178  )))|(% style="width:300px" %)(((
179 179  (% class="box" %)
180 180  (((
181 181  **Sommaire**
182 182  
183 -{{toc depth="1" numbered="true"/}}
126 +
184 184  )))
185 185  
186 186  (% class="box" %)
... ... @@ -187,11 +187,8 @@
187 187  (((
188 188  **Aller plus loin**
189 189  
190 -* [[Comprendre les sources et les tables dans Flora>>doc:2_Administration.Administration fonctionnelle.Présentation des sources et des tables.WebHome||target="_blank"]]
191 -* (((
192 -[[Saisir dans Flora>>doc:1_Fonctionnalités.5\.C\. Saisie.WebHome||target="_blank"]]
133 +* [[Saisir dans Flora>>doc:1_Fonctionnalités.5\.C\. Saisie.WebHome||target="_blank"]]
193 193  )))
194 -)))
195 195  
196 196  (% class="box" %)
197 197  (((
1757594249040-250.png
Auteur
... ... @@ -1,1 +1,0 @@
1 -XWiki.DBA
Taille
... ... @@ -1,1 +1,0 @@
1 -88.6 KB
Contenu
1757594385587-551.png
Auteur
... ... @@ -1,1 +1,0 @@
1 -XWiki.DBA
Taille
... ... @@ -1,1 +1,0 @@
1 -92.8 KB
Contenu
1757595391112-778.png
Auteur
... ... @@ -1,1 +1,0 @@
1 -XWiki.DBA
Taille
... ... @@ -1,1 +1,0 @@
1 -112.8 KB
Contenu
1757595571069-539.png
Auteur
... ... @@ -1,1 +1,0 @@
1 -XWiki.DBA
Taille
... ... @@ -1,1 +1,0 @@
1 -129.8 KB
Contenu
1757595726608-759.png
Auteur
... ... @@ -1,1 +1,0 @@
1 -XWiki.DBA
Taille
... ... @@ -1,1 +1,0 @@
1 -117.4 KB
Contenu
1757595731097-598.png
Auteur
... ... @@ -1,1 +1,0 @@
1 -XWiki.DBA
Taille
... ... @@ -1,1 +1,0 @@
1 -117.4 KB
Contenu
1757596818102-351.png
Auteur
... ... @@ -1,1 +1,0 @@
1 -XWiki.DBA
Taille
... ... @@ -1,1 +1,0 @@
1 -85.3 KB
Contenu