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 11.1
modifié par Doriane Bautista
sur 2025/09/11 14:00
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
... ... @@ -3,82 +3,89 @@
3 3  |(% style="width:840px" %)(((
4 4  (% class="box" %)
5 5  (((
6 -Dans Flora, chaque 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.
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.
7 7  
8 -Elle peut toutefois être personnalisée : chaque institution a la possibilité de rédiger sa propre aide en ligne pour l'adapter les consignes aux besoins internes et à sa charte de saisie.
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.
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 -Chaque champ des différentes tables de Flora peut être documenté. Pour beaucoup de champs, cette aide n'est pas nécessaire car leur libellé suffit à en comprendre le sens et l'usage. Mais pour d'autres, il est nécessaire d'en expliquer le type de contenu, dans quelles fonctions ou processus ils interviennent ou même de donner accès à des ressources externes définissant des problématiques métiers très précises. C'est le cas par exemple des champs spécifiques aux musées et documentés sur la base Joconde du Ministère de la Culture.
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 -Decalog a mis en place un nombre important de ces aides en ligne, désormais présentes sur ce wiki. Ce travail, toujours perfectible, est en perpétuelle progression.
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 -Par ailleurs, l'institution utilisatrice de Flora peut être amenée à redéfinir ou préciser, selon ses besoins internes, ces aides. Cela peut être fait dans le cadre d'une charte de saisie, par exemple.
18 +>(% class="small" %)Cas d'usage:
19 19  
20 -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" :
20 +(((
21 +>(% class="small" %)Expliquer le contenu attendu dans un champ.
21 21  
22 -[[image:1744363045589-792.png]]
23 +(((
24 +>(% class="small" %)Formaliser les règles de saisie propres à l’institution.
23 23  
26 +>(% class="small" %)Indiquer à quels processus le champ est lié  (ex. : inventaire, récolement, prêt, dépôt, restauration, etc.).
24 24  
25 -Non seulement les champs, mais aussi les blocs de champs peuvent être documentés :
28 +>(% class="small" %)Donner accès à des ressources externes de référence.
26 26  
27 -Exemple avec le bloc DATE_UTILISATION :
30 +>(% class="small" %)Harmoniser les pratiques et éviter les erreurs d’interprétation.
31 +)))
32 +)))
28 28  
29 -[[image:1744363311261-338.png]]
34 +(% class="box successmessage" %)
35 +(((
36 +**Bonnes pratiques : **
30 30  
31 -Aide en ligne du champs Numéro d'inventaire :
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 +)))
32 32  
33 -[[image:1744363337995-749.png]]
50 += Récupérer le nom informatique du champ ou du bloc à documenter =
34 34  
35 -Il est ainsi tout à fait possible de décrire très concrètement l'ensemble des zones de saisies des différentes tables 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 :
36 36  
37 -Les aides en ligne de Flora ont deux supports possibles :
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.
38 38  
39 -* le wiki sur lequel vous êtes actuellement
40 -* des fichiers html présents sur votre applicatif Flora
57 +>(% class="small" %)Exemple : dans la table MUS_BIEN, le champ Numéro d’inventaire porte le nom technique **NUM_INVENTAIRE**.
41 41  
42 -== Comportement par défaut ==
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"]]
43 43  
44 -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.
45 45  
46 -Ainsi, les fichiers rédigés par les services du musée sont prioritaires sur ceux de Flora.
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"]]
47 47  
48 -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 :
49 49  
50 -* [[Firefox>>https://support.mozilla.org/fr/kb/parametres-exceptions-depannage-blocage-popup]]
51 -* [[Safari >>https://support.apple.com/fr-fr/guide/safari/ibrwe2159f50/mac]]
52 -* [[Chrome>>https://support.google.com/chrome/answer/95472?co=GENIE.Platform%3DDesktop&hl=fr]]
53 -* [[Edge>>https://support.microsoft.com/fr-fr/help/17479/windows-internet-explorer-11-change-security-privacy-settings]]
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 -== Gestion locale des pages html d'aide ==
56 56  
57 -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" :
68 += Accéder à l'éditeur d'aide en ligne =
58 58  
70 +Pour créer ou modifier une aide, rendez-vous dans l’espace de travail **Administration**, menu **Paramétrage** > **Aide en ligne**.
59 59  
60 -[[image:1744363736609-747.png]]
72 +Vous y trouverez la liste des fichiers disponibles, organisés par source et par table.
61 61  
74 +Dépliez la rubrique **Aide à la saisie** pour afficher les champs et blocs de champs.
62 62  
63 -== Connaître le nom d'un champ Flora ==
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"]]
64 64  
65 -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.
66 66  
67 -[[image:1744363912649-947.png]]
79 += Rechercher le champ ou le bloc à documenter =
68 68  
69 -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
70 70  
71 -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.
72 72  
73 -[[image:1744363948510-224.png]]
74 74  
75 -= [[image:1744363968204-295.png]] =
84 +(% class="wikigeneratedid" id="HModifierlefichierd27aide" %)
85 +Modifier le fichier d'aide
76 76  
77 -= Modifier le fichier d'aide =
78 -
79 79  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.
80 80  
81 -[[image:1744364271216-799.png]]
82 82  
83 83  Cliquer sur le [[image:1744364312163-238.png]] de l'Aide à la saisie pour déplier la liste des fichiers.
84 84  
... ... @@ -100,7 +100,8 @@
100 100  (% class="wikigeneratedid" id="H200B200B200B200B200B200B200B200B200B200B200B200B200B200B" %)
101 101  [[image:1744364831120-598.png]]​​​​​​​​​​​​​​
102 102  
103 -= Sauvegarder votre aide en ligne personnalisée =
110 +(% class="wikigeneratedid" id="HSauvegardervotreaideenlignepersonnalisE9e" %)
111 +Sauvegarder votre aide en ligne personnalisée
104 104  
105 105  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**
106 106  
... ... @@ -109,19 +109,57 @@
109 109  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.
110 110  
111 111  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]]
112 112  )))
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 +)))
113 113  )))|(% style="width:300px" %)(((
114 114  (% class="box" %)
115 115  (((
116 116  **Sommaire**
117 117  
118 -
159 +{{toc depth="1" numbered="true"/}}
119 119  )))
120 120  
121 121  (% class="box" %)
122 122  (((
123 123  **Aller plus loin**
165 +
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"]]
124 124  )))
170 +)))
125 125  
126 126  (% class="box" %)
127 127  (((
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