Code source wiki de Documenter l’aide en ligne

Version 25.1 par Cécile Vinoche le 2025/09/11 14:26

Masquer les derniers auteurs
Cécile Vinoche 5.1 1 (% class="mark small" %)**Version 4.5.54 et ultérieures**
admin admin 1.1 2
Cécile Vinoche 5.1 3 |(% style="width:840px" %)(((
4 (% class="box" %)
5 (((
Cécile Vinoche 21.1 6 Dans Flora, chaque **champ ou bloc de champ** est accompagné d’une **aide en ligne **accessible directement depuis une **grille de saisie**. Par défaut, l’aide affichée provient du wiki.
Cécile Vinoche 10.1 7
Cécile Vinoche 13.1 8 Elle peut toutefois être personnalisée : chaque institution a la possibilité de** rédiger sa propre aide en ligne** afin d’adapter les consignes à ses besoins internes et à sa charte de saisie.
Cécile Vinoche 5.1 9 )))
Cécile Vinoche 3.1 10
Cécile Vinoche 5.1 11 (((
Cécile Vinoche 12.1 12 = A quoi sert l'aide en ligne dans Flora ? =
admin admin 1.1 13
Cécile Vinoche 21.1 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.
Cécile Vinoche 13.1 15
Cécile Vinoche 22.1 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**.
Cécile Vinoche 14.1 17
Cécile Vinoche 21.1 18 >(% class="small" %)Cas d'usage:
Cécile Vinoche 18.1 19
Cécile Vinoche 14.1 20 (((
Cécile Vinoche 17.1 21 >(% class="small" %)Expliquer le contenu attendu dans un champ.
Cécile Vinoche 16.1 22
Cécile Vinoche 17.1 23 (((
24 >(% class="small" %)Formaliser les règles de saisie propres à l’institution.
Cécile Vinoche 16.1 25
Cécile Vinoche 21.1 26 >(% class="small" %)Indiquer à quels processus le champ est lié  (ex. : inventaire, récolement, prêt, dépôt, restauration, etc.).
Cécile Vinoche 16.1 27
Cécile Vinoche 18.1 28 >(% class="small" %)Donner accès à des ressources externes de référence.
Cécile Vinoche 16.1 29
Cécile Vinoche 17.1 30 >(% class="small" %)Harmoniser les pratiques et éviter les erreurs d’interprétation.
Cécile Vinoche 13.1 31 )))
Cécile Vinoche 16.1 32 )))
Cécile Vinoche 13.1 33
Cécile Vinoche 23.1 34 (% class="box successmessage" %)
35 (((
36 **Bonnes pratiques : **
Cécile Vinoche 24.1 37
Cécile Vinoche 25.1 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.
Cécile Vinoche 23.1 48 )))
admin admin 1.1 49
50 == Comportement par défaut ==
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.
53
54 Ainsi, les fichiers rédigés par les services du musée sont prioritaires sur ceux de Flora.
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 accordées à Flora par votre navigateur. Voici des liens d'information sur ce sujet :
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]]
62
63 == Gestion locale des pages html d'aide ==
64
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" :
66
67
Cécile Vinoche 6.1 68 [[image:1744363736609-747.png]]
admin admin 1.1 69
70
71 == Connaître le nom d'un champ Flora ==
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.
74
Cécile Vinoche 6.1 75 [[image:1744363912649-947.png]]
admin admin 1.1 76
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
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.
80
81 [[image:1744363948510-224.png]]
82
83 = [[image:1744363968204-295.png]] =
84
85 = Modifier le fichier d'aide =
86
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
89 [[image:1744364271216-799.png]]
90
91 Cliquer sur le [[image:1744364312163-238.png]] de l'Aide à la saisie pour déplier la liste des fichiers.
92
Cécile Vinoche 6.1 93 [[image:1744364340925-762.png]]
admin admin 1.1 94
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.
97
Cécile Vinoche 6.1 98 [[image:1744364568000-243.png]]
admin admin 1.1 99
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.
102
103 (% class="box infomessage" %)
104 (((
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.
106 )))
107
108 (% class="wikigeneratedid" id="H200B200B200B200B200B200B200B200B200B200B200B200B200B200B" %)
109 [[image:1744364831120-598.png]]​​​​​​​​​​​​​​
110
111 = Sauvegarder votre aide en ligne personnalisée =
112
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
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.
116
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
Joséphine Ducruet 1.7 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]]
Cécile Vinoche 6.1 120 )))
121 )))|(% style="width:300px" %)(((
122 (% class="box" %)
123 (((
124 **Sommaire**
Cécile Vinoche 7.1 125
126
Cécile Vinoche 6.1 127 )))
128
129 (% class="box" %)
130 (((
131 **Aller plus loin**
Cécile Vinoche 22.1 132
133 * [[Saisir dans Flora>>doc:1_Fonctionnalités.5\.C\. Saisie.WebHome||target="_blank"]]
Cécile Vinoche 6.1 134 )))
135
136 (% class="box" %)
137 (((
138 **Icônes principales**
139 )))
140
141 (((
142
143
144
145
146 )))
147 )))
148
149