Modifications pour le document Documenter l’aide en ligne

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

Depuis la version 22.1
modifié par Doriane Bautista
sur 2025/09/11 14:21
Commentaire de modification : Il n'y a aucun commentaire pour cette version
À la version 27.1
modifié par Doriane Bautista
sur 2025/09/11 14:36
Commentaire de modification : Il n'y a aucun commentaire pour cette version

Résumé

Détails

Propriétés de la Page
Contenu
... ... @@ -31,44 +31,48 @@
31 31  )))
32 32  )))
33 33  
34 +(% class="box successmessage" %)
35 +(((
36 +**Bonnes pratiques : **
34 34  
35 -== Comportement par défaut ==
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 +)))
36 36  
37 -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.
50 += Récupérer le nom informatique du champ ou du bloc à documenter =
38 38  
39 -Ainsi, les fichiers digés par les services du musée sont prioritaires sur ceux de Flora.
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 :
40 40  
41 -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 :
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.
42 42  
43 -* [[Firefox>>https://support.mozilla.org/fr/kb/parametres-exceptions-depannage-blocage-popup]]
44 -* [[Safari >>https://support.apple.com/fr-fr/guide/safari/ibrwe2159f50/mac]]
45 -* [[Chrome>>https://support.google.com/chrome/answer/95472?co=GENIE.Platform%3DDesktop&hl=fr]]
46 -* [[Edge>>https://support.microsoft.com/fr-fr/help/17479/windows-internet-explorer-11-change-security-privacy-settings]]
57 +>(% class="small" %)Exemple : dans la table MUS_BIEN, le champ Numéro d’inventaire porte le nom technique **NUM_INVENTAIRE**.
47 47  
48 -== Gestion locale des pages html d'aide ==
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"]]
49 49  
50 -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" :
61 + 
51 51  
63 +[[//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"]]
52 52  
53 -[[image:1744363736609-747.png]]
54 54  
66 +[[//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"]]
55 55  
56 -== Connaître le nom d'un champ Flora ==
57 57  
58 -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.
69 += Accéder à l'éditeur d'aide en ligne =
59 59  
60 -[[image:1744363912649-947.png]]
61 61  
62 -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
63 63  
64 -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.
73 +(% class="wikigeneratedid" id="HModifierlefichierd27aide" %)
74 +Modifier le fichier d'aide
65 65  
66 -[[image:1744363948510-224.png]]
67 -
68 -= [[image:1744363968204-295.png]] =
69 -
70 -= Modifier le fichier d'aide =
71 -
72 72  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.
73 73  
74 74  [[image:1744364271216-799.png]]
... ... @@ -93,7 +93,8 @@
93 93  (% class="wikigeneratedid" id="H200B200B200B200B200B200B200B200B200B200B200B200B200B200B" %)
94 94  [[image:1744364831120-598.png]]​​​​​​​​​​​​​​
95 95  
96 -= Sauvegarder votre aide en ligne personnalisée =
100 +(% class="wikigeneratedid" id="HSauvegardervotreaideenlignepersonnalisE9e" %)
101 +Sauvegarder votre aide en ligne personnalisée
97 97  
98 98  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**
99 99  
... ... @@ -102,7 +102,40 @@
102 102  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.
103 103  
104 104  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]]
110 +
111 +
112 +(% class="wikigeneratedid" id="HComportementpardE9faut" %)
113 +(% id="cke_bm_851S" style="display:none" %) (%%)Comportement par défaut
114 +
115 +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.
116 +
117 +Ainsi, les fichiers rédigés par les services du musée sont prioritaires sur ceux de Flora.
118 +
119 +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 :
120 +
121 +* (((
122 +[[Firefox>>https://support.mozilla.org/fr/kb/parametres-exceptions-depannage-blocage-popup]]
105 105  )))
124 +* (((
125 +[[Safari >>https://support.apple.com/fr-fr/guide/safari/ibrwe2159f50/mac]]
126 +)))
127 +* (((
128 +[[Chrome>>https://support.google.com/chrome/answer/95472?co=GENIE.Platform%3DDesktop&hl=fr]]
129 +)))
130 +* (((
131 +[[Edge>>https://support.microsoft.com/fr-fr/help/17479/windows-internet-explorer-11-change-security-privacy-settings]]
132 +)))
133 +
134 +(% class="wikigeneratedid" id="HGestionlocaledespageshtmld27aide" %)
135 +Gestion locale des pages html d'aide
136 +
137 +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" :
138 +
139 +
140 +[[image:1744363736609-747.png]]
141 +
142 +
143 +)))
106 106  )))|(% style="width:300px" %)(((
107 107  (% class="box" %)
108 108  (((
... ... @@ -115,8 +115,10 @@
115 115  (((
116 116  **Aller plus loin**
117 117  
118 -* [[Saisir dans Flora>>doc:1_Fonctionnalités.5\.C\. Saisie.WebHome||target="_blank"]]
156 +* (((
157 +[[Saisir dans Flora>>doc:1_Fonctionnalités.5\.C\. Saisie.WebHome||target="_blank"]]
119 119  )))
159 +)))
120 120  
121 121  (% class="box" %)
122 122  (((