Aller au contenu

Modifications pour le document Documenter l’aide en ligne

Modifié par Joséphine Ducruet le 2026/02/18 16:34
Depuis la version 1.8
modifié par Joséphine Ducruet
sur 2025/07/23 10:47
Commentaire de modification : Update document after refactoring.
À la version 77.1
modifié par Joséphine Ducruet
sur 2026/02/18 16:31
Commentaire de modification : Il n'y a aucun commentaire pour cette version

Résumé

Détails

Propriétés de la Page
Titre
... ... @@ -1,1 +1,1 @@
1 -Modifier l’aide en ligne
1 +Documenter l’aide en ligne
Contenu
... ... @@ -1,109 +1,143 @@
1 -{{box title="**Sommaire**"}}
2 -{{toc/}}
3 -{{/box}}
1 +**PAGE EN COURS DE REDACTION**
4 4  
5 -= Définition =
3 +(% class="mark small" %)**Version 4.5.54 et ultérieures**
6 6  
7 -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.
5 +|(% style="width:840px" %)(((
6 +(% class="box" %)
7 +(((
8 +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.
8 8  
9 -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.
10 +Elle peut toutefois être personnalisée : chaque institution a la possibilité de** créer sa propre aide en ligne** afin d’adapter les consignes à ses besoins internes et à sa charte de saisie.
11 +)))
10 10  
11 -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.
13 +(((
14 += L'aide en ligne : un appui à la saisie dans Flora =
12 12  
13 -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" :
14 14  
15 -[[image:1744363045589-792.png]]
17 +L’aide en ligne **accompagne les utilisateurs** dans la compréhension et l’utilisation des champs présents dans les différentes tables de Flora.
18 +Elle contribue à garantir une saisie homogène, cohérente et conforme aux pratiques définies par votre institution. Elle complète les documents de référence internes et les procédures métiers du musée.
19 +Son objectif est de traduire concrètement ces règles directement dans l’interface de Flora, au plus près des champs utilisés par les équipes au quotidien.
16 16  
21 +Concrètement, l’aide en ligne permet de :
17 17  
18 -Non seulement les champs, mais aussi les blocs de champs peuvent être documentés :
23 +* **Expliquer le contenu attendu dans un champ**.
24 +* **Formaliser les règles de saisie propres à l’institution** (abréviations autorisées, vocabulaire contrôlé, conventions d’écriture, etc.).
25 +* **Donner accès à des ressources externes de référence** (textes réglementaires, chartes internes, normes, guides méthodologiques).
26 +* **Harmoniser les pratiques et éviter les erreurs d’interprétation**, notamment dans les équipes élargies ou en cas de renouvellement des agents.
19 19  
20 -Exemple avec le bloc DATE_UTILISATION :
28 +Par défaut, **l’aide en ligne est redirigée vers l’aide disponible sur le wiki officiel**. Cette documentation est actuellement en cours de rédaction et d’enrichissement par l’équipe de Flora Software.
21 21  
22 -[[image:1744363311261-338.png]]
30 +Elle constitue une **base commune de référence pour l’ensemble des utilisateurs**.
23 23  
24 -Aide en ligne du champs Numéro d'inventaire :
32 +Toutefois, chaque institution a la possibilité d**’adapter cette aide à ses propres pratiques**.
25 25  
26 -(% style="text-align:center" %)
27 -[[image:1744363337995-749.png]]
34 += Personnaliser l'aide en ligne =
28 28  
29 -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.
36 +Lorsqu’un musée crée une **aide en ligne personnalisée** pour un champ :
30 30  
31 -Les aides en ligne de Flora ont deux supports possibles :
38 +* le contenu standard issu du** wiki est automatiquement masqué**
39 +* seul le **contenu rédigé localement est affiché**
32 32  
33 -* le wiki sur lequel vous êtes actuellement
34 -* des fichiers html présents sur votre applicatif Flora
41 +Si cette personnalisation est supprimée, l’aide du wiki réapparaît automatiquement.
35 35  
36 -== Comportement par défaut ==
43 +Cette **personnalisation est strictement locale** : elle s’applique uniquement à la base de données de l’institution qui l’a créée.
44 +Elle ne modifie pas le contenu du wiki et n’a aucun impact sur les autres institutions.
37 37  
38 -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.
46 +== Identifier le nom interne du champ ou du bloc ==
39 39  
40 -Ainsi, les fichiers rédigés par les services du musée sont prioritaires sur ceux de Flora.
48 +Pour retrouver le fichier d’aide correspondant, vous devez d’abord identifier le nom interne du champ ou du bloc de champs.
41 41  
42 -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 :
50 +Pour cela :
43 43  
44 -* [[Firefox>>https://support.mozilla.org/fr/kb/parametres-exceptions-depannage-blocage-popup]]
45 -* [[Safari >>https://support.apple.com/fr-fr/guide/safari/ibrwe2159f50/mac]]
46 -* [[Chrome>>https://support.google.com/chrome/answer/95472?co=GENIE.Platform%3DDesktop&hl=fr]]
47 -* [[Edge>>https://support.microsoft.com/fr-fr/help/17479/windows-internet-explorer-11-change-security-privacy-settings]]
52 +1. Faites un **clic droit** sur le libellé du champ
53 +1. Choisir **Afficher informations**
54 +1. **Copiez le nom interne **du champ (ligne name)
48 48  
49 -== Gestion locale des pages html d'aide ==
56 +[[//Clic droit - Afficher informations//>>image:1744363948510-224.png||data-xwiki-image-style-alignment="center" data-xwiki-image-style-border="true"]]
50 50  
51 -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" :
52 52  
59 +[[//Nom interne du champ//>>image:1744363968204-295.png||data-xwiki-image-style-alignment="center" data-xwiki-image-style-border="true"]]
53 53  
54 -(% style="text-align:center" %)
55 -[[image:1744363736609-747.png]]
56 56  
62 +== Accéder à l'éditeur d'aide en ligne ==
57 57  
58 -== Connaître le nom d'un champ Flora ==
64 +1. Rendez-vous dans l'espace de travail **Administration, menu Paramétrage, Aide en ligne**
65 +1. Dépliez la rubrique** Aide à la saisie**
66 +1. Choisir la source et la table
67 +1. **Utilisez le raccourci clavier Ctrl + F** pour ouvrir la barre de recherche
68 +1. **Collez le nom interne** que vous avez récupéré
69 +1. **Cliquez sur l’élément trouvé** pour ouvrir l’éditeur
59 59  
60 -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.
71 +[[//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"]]
61 61  
62 -(% style="text-align:center" %)
63 -[[image:1744363912649-947.png]]
64 64  
65 -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
74 +[[//Afficher la barre de recherche avec **CTRL+F** pour rechercher le champ//>>image:1757595571069-539.png||data-xwiki-image-style-alignment="center" data-xwiki-image-style-border="true"]]
66 66  
67 -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.
68 68  
69 -[[image:1744363948510-224.png]]
77 +[[//Ouverture de l'éditeur//>>image:1757595726608-759.png||data-xwiki-image-style-alignment="center" data-xwiki-image-style-border="true"]]
70 70  
71 -= [[image:1744363968204-295.png]] =
72 72  
73 -= Modifier le fichier d'aide =
80 +== Rédiger l'aide en ligne ==
74 74  
75 -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.
82 +L’éditeur fonctionne comme un traitement de texte (type Word) et vous permet d’appliquer différents outils :
76 76  
77 -[[image:1744364271216-799.png]]
84 +(((
85 +* **Mise en forme du texte** : gras, italique, souligné, exposant, indice.
86 +* **Organisation du contenu** : listes à puces, listes numérotées, retrait, alignement.
87 +* **Styles et formats** : titres, styles prédéfinis, choix de la police et de la taille.
88 +* **Tableaux et images** : insertion et gestion de tableaux, ajout d’images.
89 +* **Éléments enrichis** : caractères spéciaux, symboles.
90 +* **Outils pratiques** : correcteur orthographique, recherche/remplacement, annuler/rétablir, affichage du code source.
78 78  
79 -Cliquer sur le [[image:1744364312163-238.png]] de l'Aide à la saisie pour déplier la liste des fichiers.
92 +(% class="box successmessage" %)
93 +(((
94 +**Astuce -  insérer des liens**
80 80  
81 -(% style="text-align:center" %)
82 -[[image:1744364340925-762.png]]
96 +* Pour créer un lien vers un document ou une ressource externe, copiez d’abord l’URL dans un document Word : elle devient un lien bleu cliquable.
97 +* Copiez-collez ensuite ce lien dans l’éditeur d’aide en ligne. Il sera reconnu correctement et restera actif.
98 +)))
99 +)))
83 83  
84 -(% class="wikigeneratedid" %)
85 -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.
101 +(((
102 +== Sauvegarder la personnalisation ==
86 86  
87 -(% style="text-align:center" %)
88 -[[image:1744364568000-243.png]]
104 +Cliquez sur **Sauvegarder** pour enregistrer vos modifications.
89 89  
90 -(% class="wikigeneratedid" %)
91 -Cliquer sur le nom informatique du champ afin d'ouvrir l'éditeur html, puis saisir votre texte et cliquer sur sauvegarder.
106 +Dès la sauvegarde, l’aide en ligne du wiki disparaît : elle est remplacée par votre aide personnalisée.
92 92  
93 -(% class="box infomessage" %)
108 +(% class="box successmessage" %)
94 94  (((
95 -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.
110 +Astuce – Conserver l’aide du wiki tout en la personnalisant
96 96  )))
97 97  
98 -(% class="wikigeneratedid" id="H200B200B200B200B200B200B200B200B200B200B200B200B200B200B" %)
99 -[[image:1744364831120-598.png]]​​​​​​​​​​​​​​
113 +
114 +)))
115 +)))
116 +)))|(% style="width:300px" %)(((
117 +(% class="box" %)
118 +(((
119 +**Sommaire**
100 100  
101 -= Sauvegarder votre aide en ligne personnalisée =
121 +{{toc depth="1" numbered="true"/}}
122 +)))
102 102  
103 -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**
124 +(% class="box" %)
125 +(((
126 +**Aller plus loin**
104 104  
105 -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.
128 +* [[Comprendre les sources et les tables dans Flora>>doc:2_Administration.Administration fonctionnelle.Présentation des sources et des tables.WebHome||target="_blank"]]
129 +* [[Insérer un document interne pour accueil>>doc:2_Administration.Administration fonctionnelle.Documents de référence sur page d'aide.WebHome||target="_blank"]]
130 +* (((
131 +[[Saisir dans Flora>>doc:1_Fonctionnalités.5\.C\. Saisie.WebHome||target="_blank"]]
132 +)))
133 +)))
106 106  
107 -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.
135 +(% class="box" %)
136 +(((
137 +**Icônes principales**
108 108  
109 -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]]
139 +* [[image:1757600253202-543.png||height="45" width="45"]] Paramétrages
140 +)))
141 +)))
142 +
143 +
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
1757595391112-778.png
Auteur
... ... @@ -1,0 +1,1 @@
1 +XWiki.DBA
Taille
... ... @@ -1,0 +1,1 @@
1 +112.8 KB
Contenu
1757595571069-539.png
Auteur
... ... @@ -1,0 +1,1 @@
1 +XWiki.DBA
Taille
... ... @@ -1,0 +1,1 @@
1 +129.8 KB
Contenu
1757595726608-759.png
Auteur
... ... @@ -1,0 +1,1 @@
1 +XWiki.DBA
Taille
... ... @@ -1,0 +1,1 @@
1 +117.4 KB
Contenu
1757595731097-598.png
Auteur
... ... @@ -1,0 +1,1 @@
1 +XWiki.DBA
Taille
... ... @@ -1,0 +1,1 @@
1 +117.4 KB
Contenu
1757596818102-351.png
Auteur
... ... @@ -1,0 +1,1 @@
1 +XWiki.DBA
Taille
... ... @@ -1,0 +1,1 @@
1 +85.3 KB
Contenu
1757597613394-216.png
Auteur
... ... @@ -1,0 +1,1 @@
1 +XWiki.DBA
Taille
... ... @@ -1,0 +1,1 @@
1 +135.0 KB
Contenu
1757597668258-471.png
Auteur
... ... @@ -1,0 +1,1 @@
1 +XWiki.DBA
Taille
... ... @@ -1,0 +1,1 @@
1 +138.2 KB
Contenu
1757597985000-452.png
Auteur
... ... @@ -1,0 +1,1 @@
1 +XWiki.DBA
Taille
... ... @@ -1,0 +1,1 @@
1 +193.0 KB
Contenu
1757599364051-795.png
Auteur
... ... @@ -1,0 +1,1 @@
1 +XWiki.DBA
Taille
... ... @@ -1,0 +1,1 @@
1 +148.4 KB
Contenu
1757599402906-988.png
Auteur
... ... @@ -1,0 +1,1 @@
1 +XWiki.DBA
Taille
... ... @@ -1,0 +1,1 @@
1 +98.9 KB
Contenu
1757599437795-401.png
Auteur
... ... @@ -1,0 +1,1 @@
1 +XWiki.DBA
Taille
... ... @@ -1,0 +1,1 @@
1 +112.8 KB
Contenu
1757599467798-396.png
Auteur
... ... @@ -1,0 +1,1 @@
1 +XWiki.DBA
Taille
... ... @@ -1,0 +1,1 @@
1 +115.5 KB
Contenu
1757599482084-563.png
Auteur
... ... @@ -1,0 +1,1 @@
1 +XWiki.DBA
Taille
... ... @@ -1,0 +1,1 @@
1 +129.8 KB
Contenu
1757599570577-172.png
Auteur
... ... @@ -1,0 +1,1 @@
1 +XWiki.DBA
Taille
... ... @@ -1,0 +1,1 @@
1 +75.3 KB
Contenu
1757599808499-510.png
Auteur
... ... @@ -1,0 +1,1 @@
1 +XWiki.DBA
Taille
... ... @@ -1,0 +1,1 @@
1 +11.4 KB
Contenu
1757600036454-769.png
Auteur
... ... @@ -1,0 +1,1 @@
1 +XWiki.DBA
Taille
... ... @@ -1,0 +1,1 @@
1 +199.0 KB
Contenu
1757600253202-543.png
Auteur
... ... @@ -1,0 +1,1 @@
1 +XWiki.DBA
Taille
... ... @@ -1,0 +1,1 @@
1 +6.3 KB
Contenu