Modifications pour le document Documenter l’aide en ligne

Modifié par Doriane Bautista le 2025/09/17 16:01

Depuis 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
À la version 29.1
modifié par Doriane Bautista
sur 2025/09/11 14:47
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 -= 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  
... ... @@ -35,58 +35,57 @@
35 35  (((
36 36  **Bonnes pratiques : **
37 37  
38 -* **Être concis et clair** : 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 (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 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.
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 vocabulairetier 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 daide 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 48  )))
49 49  
50 -== Comportement par défaut ==
50 += Récupérer le nom informatique du champ ou du bloc à documenter =
51 51  
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.
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 53  
54 -Ainsi, les fichiers rédigés par les services du musée sont prioritaires sur ceux de Flora.
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.
55 55  
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 accores à Flora par votre navigateur. Voici des liens d'information sur ce sujet :
57 +>(% class="small" %)Exemple : dans la table MUS_BIEN, le champ Numéro d’inventaire porte le nom technique **NUM_INVENTAIRE**.
57 57  
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]]
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"]]
62 62  
63 -== Gestion locale des pages html d'aide ==
64 64  
65 -L'accès à ces pages, en modification, suppression ou cation, se fait avec un compte autorisé, dans l'espace de travail "Administration", Menu "Paramétrage Aides en ligne" :
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"]]
66 66  
67 67  
68 -[[image:1744363736609-747.png]]
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"]]
69 69  
70 70  
71 -== Connaître le nom d'un champ Flora ==
68 += Accéder à l'éditeur d'aide en ligne =
72 72  
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.
70 +Pour créer ou modifier une aide, rendez-vous dans l’espace de travail **Administration**, menu **Paramétrage** > **Aide en ligne**.
74 74  
75 -[[image:1744363912649-947.png]]
72 +Vous y trouverez la liste des fichiers disponibles, organisés par source et par table.
76 76  
77 -Afin de connaître ce nom, il suffit d'aller sur une grille de saisie concernée et de survoler le libel de l'élément à documenter
74 +Dépliez la rubrique **Aide à la saisie** pour afficher les champs et blocs de champs.
78 78  
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.
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"]]
80 80  
81 -[[image:1744363948510-224.png]]
82 82  
83 -= [[image:1744363968204-295.png]] =
79 += Rechercher le champ ou le bloc à documenter =
84 84  
85 -= Modifier le fichier d'aide =
86 86  
82 +
83 +
84 +(% class="wikigeneratedid" id="HModifierlefichierd27aide" %)
85 +Modifier le fichier d'aide
86 +
87 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 -[[image:1744364271216-799.png]]
90 90  
91 91  Cliquer sur le [[image:1744364312163-238.png]] de l'Aide à la saisie pour déplier la liste des fichiers.
92 92  
... ... @@ -108,7 +108,8 @@
108 108  (% class="wikigeneratedid" id="H200B200B200B200B200B200B200B200B200B200B200B200B200B200B" %)
109 109  [[image:1744364831120-598.png]]​​​​​​​​​​​​​​
110 110  
111 -= Sauvegarder votre aide en ligne personnalisée =
110 +(% class="wikigeneratedid" id="HSauvegardervotreaideenlignepersonnalisE9e" %)
111 +Sauvegarder votre aide en ligne personnalisée
112 112  
113 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**
114 114  
... ... @@ -117,13 +117,46 @@
117 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.
118 118  
119 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]]
120 +
121 +
122 +(% class="wikigeneratedid" id="HComportementpardE9faut" %)
123 +(% id="cke_bm_851S" style="display:none" %) (%%)Comportement par défaut
124 +
125 +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.
126 +
127 +Ainsi, les fichiers rédigés par les services du musée sont prioritaires sur ceux de Flora.
128 +
129 +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 :
130 +
131 +* (((
132 +[[Firefox>>https://support.mozilla.org/fr/kb/parametres-exceptions-depannage-blocage-popup]]
120 120  )))
134 +* (((
135 +[[Safari >>https://support.apple.com/fr-fr/guide/safari/ibrwe2159f50/mac]]
136 +)))
137 +* (((
138 +[[Chrome>>https://support.google.com/chrome/answer/95472?co=GENIE.Platform%3DDesktop&hl=fr]]
139 +)))
140 +* (((
141 +[[Edge>>https://support.microsoft.com/fr-fr/help/17479/windows-internet-explorer-11-change-security-privacy-settings]]
142 +)))
143 +
144 +(% class="wikigeneratedid" id="HGestionlocaledespageshtmld27aide" %)
145 +Gestion locale des pages html d'aide
146 +
147 +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" :
148 +
149 +
150 +[[image:1744363736609-747.png]]
151 +
152 +
153 +)))
121 121  )))|(% style="width:300px" %)(((
122 122  (% class="box" %)
123 123  (((
124 124  **Sommaire**
125 125  
126 -
159 +{{toc depth="1" numbered="true"/}}
127 127  )))
128 128  
129 129  (% class="box" %)
... ... @@ -130,8 +130,11 @@
130 130  (((
131 131  **Aller plus loin**
132 132  
133 -* [[Saisir dans Flora>>doc:1_Fonctionnalités.5\.C\. Saisie.WebHome||target="_blank"]]
166 +* [[Comprendre les sources et les tables dans Flora>>doc:2_Administration.Administration fonctionnelle.Présentation des sources et des tables.WebHome||target="_blank"]]
167 +* (((
168 +[[Saisir dans Flora>>doc:1_Fonctionnalités.5\.C\. Saisie.WebHome||target="_blank"]]
134 134  )))
170 +)))
135 135  
136 136  (% class="box" %)
137 137  (((
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