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

Résumé

Détails

Propriétés de la Page
Contenu
... ... @@ -3,146 +3,123 @@
3 3  |(% style="width:840px" %)(((
4 4  (% class="box" %)
5 5  (((
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.
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.
7 7  
8 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 -= À quoi sert l'aide en ligne dans Flora ? =
12 += A quoi sert l'aide en ligne dans Flora ? =
13 13  
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.
14 +L’aide en ligne **accompagne** les utilisateurs dans la** compréhension **et l’**usage** des champs présents dans toutes les tables de Flora. Elle garantit 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 +>(% class="small" %)Cas d'utilisation principaux :(%%)(((
17 +* (% class="small" %)Expliquer le contenu attendu dans un champ.
18 +* (% class="small" %)Indiquer à quels processus le champ est lié.
19 +* (% class="small" %)Donner accès à des ressources externes de référence (ex. : base Joconde).
20 +* (% class="small" %)Formaliser les règles de saisie propres à l’institution.
21 +* (% class="small" %)Harmoniser les pratiques et éviter les erreurs d’interprétation.
22 +)))
17 17  
18 ->(% class="small" %)Cas d'usage:
19 19  
20 -(((
21 ->(% class="small" %)Expliquer le contenu attendu dans un champ.
25 +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.
22 22  
23 -(((
24 ->(% class="small" %)Formaliser les règles de saisie propres à l’institution.
27 +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.
25 25  
26 ->(% class="small" %)Indiquer à quels processus le champ est lié  (ex. : inventaire, récolement, prêt, dépôt, restauration, etc.).
29 +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.
27 27  
28 ->(% class="small" %)Donner accès à des ressources externes de référence.
31 +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" :
29 29  
30 ->(% class="small" %)Harmoniser les pratiques et éviter les erreurs d’interprétation.
31 -)))
32 -)))
33 +[[image:1744363045589-792.png]]
33 33  
34 -(% class="box successmessage" %)
35 -(((
36 -**Bonnes pratiques : **
37 37  
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 +Non seulement les champs, mais aussi les blocs de champs peuvent être documentés :
49 49  
50 -= Récupérer le nom informatique du champ ou du bloc à documenter =
38 +Exemple avec le bloc DATE_UTILISATION :
51 51  
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 +[[image:1744363311261-338.png]]
53 53  
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 +Aide en ligne du champs Numéro d'inventaire :
56 56  
57 ->(% class="small" %)Exemple : dans la table MUS_BIEN, le champ Numéro d’inventaire porte le nom technique **NUM_INVENTAIRE**.
44 +[[image:1744363337995-749.png]]
58 58  
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"]]
46 +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.
60 60  
48 +Les aides en ligne de Flora ont deux supports possibles :
61 61  
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 +* le wiki sur lequel vous êtes actuellement
51 +* des fichiers html présents sur votre applicatif Flora
63 63  
53 +== Comportement par défaut ==
64 64  
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"]]
55 +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.
66 66  
57 +Ainsi, les fichiers rédigés par les services du musée sont prioritaires sur ceux de Flora.
67 67  
68 -= Accéder à l'éditeur d'aide en ligne =
59 +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 :
69 69  
70 -Pour créer ou modifier une aide, rendez-vous dans l’espace de travail **Administration**, menu **Paramétrage** > **Aide en ligne**.
61 +* [[Firefox>>https://support.mozilla.org/fr/kb/parametres-exceptions-depannage-blocage-popup]]
62 +* [[Safari >>https://support.apple.com/fr-fr/guide/safari/ibrwe2159f50/mac]]
63 +* [[Chrome>>https://support.google.com/chrome/answer/95472?co=GENIE.Platform%3DDesktop&hl=fr]]
64 +* [[Edge>>https://support.microsoft.com/fr-fr/help/17479/windows-internet-explorer-11-change-security-privacy-settings]]
71 71  
72 -Vous y trouverez la liste des fichiers disponibles, organisés par source et par table.
66 +== Gestion locale des pages html d'aide ==
73 73  
74 -Dépliez la rubrique **Aide à la saisie** pour rechercher les champs et blocs de champs à documenter.
68 +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" :
75 75  
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"]]
77 77  
71 +[[image:1744363736609-747.png]]
78 78  
79 -= Rechercher le champ ou le bloc à documenter =
80 80  
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 :
74 +== Connaître le nom d'un champ Flora ==
82 82  
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.
76 +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.
88 88  
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"]]
78 +[[image:1744363912649-947.png]]
90 90  
80 +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
91 91  
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"]]
82 +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.
93 93  
84 +[[image:1744363948510-224.png]]
94 94  
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"]]
86 += [[image:1744363968204-295.png]] =
96 96  
88 += Modifier le fichier d'aide =
97 97  
98 -= Éditer l'aide en ligne =
90 +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.
99 99  
100 -Une fois le champ ou le bloc sélectionné, cliquez sur son nom pour ouvrir l’éditeur html. Vous pouvez :
92 +[[image:1744364271216-799.png]]
101 101  
102 -* saisir directement votre texte,
103 -* ou copier-coller l’aide du wiki avant de l’adapter à vos besoins internes.
94 +Cliquer sur le [[image:1744364312163-238.png]] de l'Aide à la saisie pour déplier la liste des fichiers.
104 104  
105 -Lorsque votre rédaction est terminée, cliquez sur **Sauvegarder** pour enregistrer votre personnalisation.
96 +[[image:1744364340925-762.png]]
106 106  
107 -(% class="box successmessage" %)
108 -(((
109 -**Bonnes pratiques : **
98 +(% class="wikigeneratedid" %)
99 +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.
110 110  
111 -* **Uniformisez la présentation** : adoptez une structure homogène (définition, usage, remarques).
112 -* **Soyez clairs et concis** : rédigez des explications courtes et directement utiles.
113 -* **Employez le vocabulaire métier partagé** : utilisez les termes définis dans la charte de saisie de votre institution.
114 -* **Précisez le contexte** : indiquez si le champ ou bloc est lié à un processus particulier (inventaire, récolement, prêt, dépôt, restauration).
115 -* **Ajoutez des exemples concrets** : illustrez les valeurs attendues pour éviter toute ambiguïté.
116 -* **Limitez les redondances** : n’intégrez que ce qui est pertinent, sans recopier inutilement l’aide du wiki.
117 -* **Documentez aussi les blocs de champs** : expliquez leur rôle global en plus des champs qu’ils contiennent.
118 -* **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.
101 +[[image:1744364568000-243.png]]
102 +
103 +(% class="wikigeneratedid" %)
104 +Cliquer sur le nom informatique du champ afin d'ouvrir l'éditeur html, puis saisir votre texte et cliquer sur sauvegarder.
105 +
106 +(% class="box infomessage" %)
107 +(((
108 +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.
119 119  )))
120 120  
121 121  (% class="wikigeneratedid" id="H200B200B200B200B200B200B200B200B200B200B200B200B200B200B" %)
122 -[[image:1757596818102-351.png]]​​​​​​​​​​​​​​
112 +[[image:1744364831120-598.png]]​​​​​​​​​​​​​​
123 123  
124 -
114 += Sauvegarder votre aide en ligne personnalisée =
125 125  
126 -(% id="cke_bm_851S" style="display:none" %)
116 +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**
127 127  
128 -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 :
118 +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.
129 129  
130 -* (((
131 -[[Firefox>>https://support.mozilla.org/fr/kb/parametres-exceptions-depannage-blocage-popup]]
132 -)))
133 -* (((
134 -[[Safari >>https://support.apple.com/fr-fr/guide/safari/ibrwe2159f50/mac]]
135 -)))
136 -* (((
137 -[[Chrome>>https://support.google.com/chrome/answer/95472?co=GENIE.Platform%3DDesktop&hl=fr]]
138 -)))
139 -* (((
140 -[[Edge>>https://support.microsoft.com/fr-fr/help/17479/windows-internet-explorer-11-change-security-privacy-settings]]
141 -)))
120 +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.
142 142  
143 -
144 -
145 -
122 +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]]
146 146  )))
147 147  )))|(% style="width:300px" %)(((
148 148  (% class="box" %)
... ... @@ -149,18 +149,13 @@
149 149  (((
150 150  **Sommaire**
151 151  
152 -{{toc depth="1" numbered="true"/}}
129 +
153 153  )))
154 154  
155 155  (% class="box" %)
156 156  (((
157 157  **Aller plus loin**
158 -
159 -* [[Comprendre les sources et les tables dans Flora>>doc:2_Administration.Administration fonctionnelle.Présentation des sources et des tables.WebHome||target="_blank"]]
160 -* (((
161 -[[Saisir dans Flora>>doc:1_Fonctionnalités.5\.C\. Saisie.WebHome||target="_blank"]]
162 162  )))
163 -)))
164 164  
165 165  (% class="box" %)
166 166  (((
1757594249040-250.png
Auteur
... ... @@ -1,1 +1,0 @@
1 -XWiki.DBA
Taille
... ... @@ -1,1 +1,0 @@
1 -88.6 KB
Contenu
1757594385587-551.png
Auteur
... ... @@ -1,1 +1,0 @@
1 -XWiki.DBA
Taille
... ... @@ -1,1 +1,0 @@
1 -92.8 KB
Contenu
1757595391112-778.png
Auteur
... ... @@ -1,1 +1,0 @@
1 -XWiki.DBA
Taille
... ... @@ -1,1 +1,0 @@
1 -112.8 KB
Contenu
1757595571069-539.png
Auteur
... ... @@ -1,1 +1,0 @@
1 -XWiki.DBA
Taille
... ... @@ -1,1 +1,0 @@
1 -129.8 KB
Contenu
1757595726608-759.png
Auteur
... ... @@ -1,1 +1,0 @@
1 -XWiki.DBA
Taille
... ... @@ -1,1 +1,0 @@
1 -117.4 KB
Contenu
1757595731097-598.png
Auteur
... ... @@ -1,1 +1,0 @@
1 -XWiki.DBA
Taille
... ... @@ -1,1 +1,0 @@
1 -117.4 KB
Contenu
1757596818102-351.png
Auteur
... ... @@ -1,1 +1,0 @@
1 -XWiki.DBA
Taille
... ... @@ -1,1 +1,0 @@
1 -85.3 KB
Contenu