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 21.1
modifié par Doriane Bautista
sur 2025/09/11 14:19
Commentaire de modification : Il n'y a aucun commentaire pour cette version
À la version 38.1
modifié par Doriane Bautista
sur 2025/09/11 15:30
Commentaire de modification : Il n'y a aucun commentaire pour cette version

Résumé

Détails

Propriétés de la Page
Contenu
... ... @@ -9,11 +9,11 @@
9 9  )))
10 10  
11 11  (((
12 -= A quoi sert l'aide en ligne dans Flora ? =
12 += À 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  
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**.
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 17  
18 18  >(% class="small" %)Cas d'usage:
19 19  
... ... @@ -31,106 +31,163 @@
31 31  )))
32 32  )))
33 33  
34 -
35 -L'accès à ces aides se fait champ par champ, par un simple clic droit sur le libellé du champ, via le menu "Afficher aide" :
34 +(% class="box successmessage" %)
35 +(((
36 +**Bonnes pratiques : **
36 36  
37 -[[image:1744363045589-792.png]]
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 +)))
38 38  
50 += Récupérer le nom informatique du champ ou du bloc à documenter =
39 39  
40 -Non seulement les champs, mais aussi les blocs de champs peuvent être documentés :
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 :
41 41  
42 -Exemple avec le bloc DATE_UTILISATION :
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.
43 43  
44 -[[image:1744363311261-338.png]]
57 +>(% class="small" %)Exemple : dans la table MUS_BIEN, le champ Numéro d’inventaire porte le nom technique **NUM_INVENTAIRE**.
45 45  
46 -Aide en ligne du champs Numéro d'inventaire :
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"]]
47 47  
48 -[[image:1744363337995-749.png]]
49 49  
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"]]
50 50  
51 -== Comportement par défaut ==
52 52  
53 -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.
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"]]
54 54  
55 -Ainsi, les fichiers rédigés par les services du musée sont prioritaires sur ceux de Flora.
56 56  
57 -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 :
68 += Accéder à l'éditeur d'aide en ligne =
58 58  
59 -* [[Firefox>>https://support.mozilla.org/fr/kb/parametres-exceptions-depannage-blocage-popup]]
60 -* [[Safari >>https://support.apple.com/fr-fr/guide/safari/ibrwe2159f50/mac]]
61 -* [[Chrome>>https://support.google.com/chrome/answer/95472?co=GENIE.Platform%3DDesktop&hl=fr]]
62 -* [[Edge>>https://support.microsoft.com/fr-fr/help/17479/windows-internet-explorer-11-change-security-privacy-settings]]
70 +Pour créer ou modifier une aide, rendez-vous dans l’espace de travail **Administration**, menu **Paramétrage** > **Aide en ligne**.
63 63  
64 -== Gestion locale des pages html d'aide ==
72 +Vous y trouverez la liste des fichiers disponibles, organisés par source et par table.
65 65  
66 -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" :
74 +Dépliez la rubrique **Aide à la saisie** pour rechercher les champs et blocs de champs à documenter.
67 67  
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"]]
68 68  
69 -[[image:1744363736609-747.png]]
70 70  
79 += Rechercher le champ ou le bloc à documenter =
71 71  
72 -== Connaître le nom d'un champ Flora ==
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 :
73 73  
74 -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.
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.
75 75  
76 -[[image:1744363912649-947.png]]
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"]]
77 77  
78 -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
79 79  
80 -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.
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"]]
81 81  
82 -[[image:1744363948510-224.png]]
83 83  
84 -= [[image:1744363968204-295.png]] =
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"]]
85 85  
86 -= Modifier le fichier d'aide =
87 87  
88 -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.
98 += Éditer l'aide en ligne =
89 89  
90 -[[image:1744364271216-799.png]]
100 +Une fois le champ ou le bloc trouvé, cliquez sur son nom pour ouvrir l’éditeur HTML.
91 91  
92 -Cliquer sur le [[image:1744364312163-238.png]] de l'Aide à la saisie pour déplier la liste des fichiers.
102 +Cet éditeur fonctionne comme un traitement de texte (type Word) et propose de nombreuses options :
93 93  
94 -[[image:1744364340925-762.png]]
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.
95 95  
96 -(% class="wikigeneratedid" %)
97 -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.
111 +(% class="box warningmessage" %)
112 +(((
113 +**Point d’attention : insérer des liens**
98 98  
99 -[[image:1744364568000-243.png]]
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 +)))
100 100  
101 -(% class="wikigeneratedid" %)
102 -Cliquer sur le nom informatique du champ afin d'ouvrir l'éditeur html, puis saisir votre texte et cliquer sur sauvegarder.
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.
103 103  
104 -(% class="box infomessage" %)
121 +(% class="box successmessage" %)
105 105  (((
106 -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.
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.
107 107  )))
108 108  
135 +>L’exemple ci-dessous illustre le champ **Numéro d’inventaire** avec une aide en ligne enrichie :
136 +
137 +>(((
138 +* un **tableau** décrivant les différentes règles d’attribution,
139 +* un **lien hypertexte** vers une référence législative,
140 +* du **texte courant** explicatif,
141 +* et un **texte en rouge** servant à mettre en évidence une information importante.
142 +)))
143 +
144 +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.
145 +
109 109  (% class="wikigeneratedid" id="H200B200B200B200B200B200B200B200B200B200B200B200B200B200B" %)
110 -[[image:1744364831120-598.png]]​​​​​​​​​​​​​​
147 +[[image:1757596818102-351.png]]​​​​​​​​​​​​​​
111 111  
112 -= Sauvegarder votre aide en ligne personnalisée =
113 113  
114 -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**
115 115  
116 -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.
117 117  
118 -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.
119 119  
120 -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]]
153 +(% id="cke_bm_851S" style="display:none" %)
154 +
155 +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 :
156 +
157 +* (((
158 +[[Firefox>>https://support.mozilla.org/fr/kb/parametres-exceptions-depannage-blocage-popup]]
121 121  )))
160 +* (((
161 +[[Safari >>https://support.apple.com/fr-fr/guide/safari/ibrwe2159f50/mac]]
162 +)))
163 +* (((
164 +[[Chrome>>https://support.google.com/chrome/answer/95472?co=GENIE.Platform%3DDesktop&hl=fr]]
165 +)))
166 +* (((
167 +[[Edge>>https://support.microsoft.com/fr-fr/help/17479/windows-internet-explorer-11-change-security-privacy-settings]]
168 +)))
169 +
170 +
171 +
172 +
173 +)))
122 122  )))|(% style="width:300px" %)(((
123 123  (% class="box" %)
124 124  (((
125 125  **Sommaire**
126 126  
127 -
179 +{{toc depth="1" numbered="true"/}}
128 128  )))
129 129  
130 130  (% class="box" %)
131 131  (((
132 132  **Aller plus loin**
185 +
186 +* [[Comprendre les sources et les tables dans Flora>>doc:2_Administration.Administration fonctionnelle.Présentation des sources et des tables.WebHome||target="_blank"]]
187 +* (((
188 +[[Saisir dans Flora>>doc:1_Fonctionnalités.5\.C\. Saisie.WebHome||target="_blank"]]
133 133  )))
190 +)))
134 134  
135 135  (% class="box" %)
136 136  (((
1757594249040-250.png
Auteur
... ... @@ -1,0 +1,1 @@
1 +XWiki.DBA
Taille
... ... @@ -1,0 +1,1 @@
1 +88.6 KB
Contenu
1757594385587-551.png
Auteur
... ... @@ -1,0 +1,1 @@
1 +XWiki.DBA
Taille
... ... @@ -1,0 +1,1 @@
1 +92.8 KB
Contenu
1757595391112-778.png
Auteur
... ... @@ -1,0 +1,1 @@
1 +XWiki.DBA
Taille
... ... @@ -1,0 +1,1 @@
1 +112.8 KB
Contenu
1757595571069-539.png
Auteur
... ... @@ -1,0 +1,1 @@
1 +XWiki.DBA
Taille
... ... @@ -1,0 +1,1 @@
1 +129.8 KB
Contenu
1757595726608-759.png
Auteur
... ... @@ -1,0 +1,1 @@
1 +XWiki.DBA
Taille
... ... @@ -1,0 +1,1 @@
1 +117.4 KB
Contenu
1757595731097-598.png
Auteur
... ... @@ -1,0 +1,1 @@
1 +XWiki.DBA
Taille
... ... @@ -1,0 +1,1 @@
1 +117.4 KB
Contenu
1757596818102-351.png
Auteur
... ... @@ -1,0 +1,1 @@
1 +XWiki.DBA
Taille
... ... @@ -1,0 +1,1 @@
1 +85.3 KB
Contenu