Modifications pour le document Documenter l’aide en ligne

Résumé

• Propriétés de la Page (1 modifications, 0 ajouts, 0 suppressions)

Détails

Propriétés de la Page

Contenu

...	...	@@ -3,136 +3,172 @@
3	3	|(% style="width:840px" %)(((
4	4	(% class="box" %)
5	5	(((
6		-
7		-)))
	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.
8	8
9		-(((
10		-
	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.
11	11	)))
12		-)))|(% style="width:300px" %)(((
13		-(% class="box" %)
14		-(((
15		-**Sommaire**
16		-)))
17	17
18		-(% class="box" %)
19	19	(((
20		-**Aller plus loin**
21		-)))
	12	+= A quoi sert l'aide en ligne dans Flora ? =
22	22
23		-(% class="box" %)
	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	+
	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	+
	18	+>(% class="small" %)Cas d'usage:
	19	+
24	24	(((
25		-**Icônes principales**
26		-)))
	21	+>(% class="small" %)Expliquer le contenu attendu dans un champ.
27	27
28	28	(((
	24	+>(% class="small" %)Formaliser les règles de saisie propres à l’institution.
29	29
	26	+>(% class="small" %)Indiquer à quels processus le champ est lié  (ex. : inventaire, récolement, prêt, dépôt, restauration, etc.).
30	30
	28	+>(% class="small" %)Donner accès à des ressources externes de référence.
31	31
32		-
	30	+>(% class="small" %)Harmoniser les pratiques et éviter les erreurs d’interprétation.
33	33	)))
34	34	)))
35	35
	34	+(% class="box successmessage" %)
	35	+(((
	36	+**Bonnes pratiques : **
36	36
	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	+)))
37	37
	50	+= Récupérer le nom informatique du champ ou du bloc à documenter =
38	38
39		-= Définition =
	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		-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.
	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		-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.
	57	+>(% class="small" %)Exemple : dans la table MUS_BIEN, le champ Numéro d’inventaire porte le nom technique **NUM_INVENTAIRE**.
44	44
45		-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.
	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	46
47		-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" :
	61	+
48	48
49		-[[image:1744363045589-792.png]]
	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"]]
50	50
51	51
52		-Non seulement les champs, mais aussi les blocs de champs peuvent être documentés :
	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"]]
53	53
54		-Exemple avec le bloc DATE_UTILISATION :
55	55
56		-[[image:1744363311261-338.png]]
	69	+= Accéder à l'éditeur d'aide en ligne =
57	57
58		-Aide en ligne du champs Numéro d'inventaire :
59	59
60		-[[image:1744363337995-749.png||data-xwiki-image-style-alignment="center"]]
61	61
62		-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.
	73	+(% class="wikigeneratedid" id="HModifierlefichierd27aide" %)
	74	+Modifier le fichier d'aide
63	63
64		-Les aides en ligne de Flora ont deux supports possibles :
	76	+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.
65	65
66		-* le wiki sur lequel vous êtes actuellement
67		-* des fichiers html présents sur votre applicatif Flora
	78	+[[image:1744364271216-799.png]]
68	68
69		-== Comportement par défaut ==
	80	+Cliquer sur le [[image:1744364312163-238.png]] de l'Aide à la saisie pour déplier la liste des fichiers.
70	70
71		-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.
	82	+[[image:1744364340925-762.png]]
72	72
73		-Ainsi, les fichiers rédigés par les services du musée sont prioritaires sur ceux de Flora.
	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.
74	74
75		-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 :
	87	+[[image:1744364568000-243.png]]
76	76
77		-* [[Firefox>>https://support.mozilla.org/fr/kb/parametres-exceptions-depannage-blocage-popup]]
78		-* [[Safari >>https://support.apple.com/fr-fr/guide/safari/ibrwe2159f50/mac]]
79		-* [[Chrome>>https://support.google.com/chrome/answer/95472?co=GENIE.Platform%3DDesktop&hl=fr]]
80		-* [[Edge>>https://support.microsoft.com/fr-fr/help/17479/windows-internet-explorer-11-change-security-privacy-settings]]
	89	+(% class="wikigeneratedid" %)
	90	+Cliquer sur le nom informatique du champ afin d'ouvrir l'éditeur html, puis saisir votre texte et cliquer sur sauvegarder.
81	81
82		-== Gestion locale des pages html d'aide ==
	92	+(% class="box infomessage" %)
	93	+(((
	94	+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.
	95	+)))
83	83
84		-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" :
	97	+(% class="wikigeneratedid" id="H200B200B200B200B200B200B200B200B200B200B200B200B200B200B" %)
	98	+[[image:1744364831120-598.png]]​​​​​​​​​​​​​​
85	85
	100	+(% class="wikigeneratedid" id="HSauvegardervotreaideenlignepersonnalisE9e" %)
	101	+Sauvegarder votre aide en ligne personnalisée
86	86
87		-[[image:1744363736609-747.png||data-xwiki-image-style-alignment="center"]]
	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**
88	88
	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.
89	89
90		-== Connaître le nom d'un champ Flora ==
	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.
91	91
92		-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.
	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]]
93	93
94		-[[image:1744363912649-947.png||data-xwiki-image-style-alignment="center"]]
95	95
96		-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
	112	+(% class="wikigeneratedid" id="HComportementpardE9faut" %)
	113	+(% id="cke_bm_851S" style="display:none" %) (%%)Comportement par défaut
97	97
98		-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.
	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.
99	99
100		-[[image:1744363948510-224.png]]
	117	+Ainsi, les fichiers rédigés par les services du musée sont prioritaires sur ceux de Flora.
101	101
102		-= [[image:1744363968204-295.png]] =
	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 :
103	103
104		-= Modifier le fichier d'aide =
	121	+* (((
	122	+[[Firefox>>https://support.mozilla.org/fr/kb/parametres-exceptions-depannage-blocage-popup]]
	123	+)))
	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	+)))
105	105
106		-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.
	134	+(% class="wikigeneratedid" id="HGestionlocaledespageshtmld27aide" %)
	135	+Gestion locale des pages html d'aide
107	107
108		-[[image:1744364271216-799.png]]
	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" :
109	109
110		-Cliquer sur le [[image:1744364312163-238.png]] de l'Aide à la saisie pour déplier la liste des fichiers.
111	111
112		-[[image:1744364340925-762.png||data-xwiki-image-style-alignment="center"]]
	140	+[[image:1744363736609-747.png]]
113	113
114		-(% class="wikigeneratedid" %)
115		-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.
	142	+
	143	+)))
	144	+)))|(% style="width:300px" %)(((
	145	+(% class="box" %)
	146	+(((
	147	+**Sommaire**
116	116
117		-[[image:1744364568000-243.png||data-xwiki-image-style-alignment="center"]]
	149	+
	150	+)))
118	118
119		-(% class="wikigeneratedid" %)
120		-Cliquer sur le nom informatique du champ afin d'ouvrir l'éditeur html, puis saisir votre texte et cliquer sur sauvegarder.
	152	+(% class="box" %)
	153	+(((
	154	+**Aller plus loin**
121	121
122		-(% class="box infomessage" %)
	156	+* (((
	157	+[[Saisir dans Flora>>doc:1_Fonctionnalités.5\.C\. Saisie.WebHome||target="_blank"]]
	158	+)))
	159	+)))
	160	+
	161	+(% class="box" %)
123	123	(((
124		-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.
	163	+**Icônes principales**
125	125	)))
126	126
127		-(% class="wikigeneratedid" id="H200B200B200B200B200B200B200B200B200B200B200B200B200B200B" %)
128		-[[image:1744364831120-598.png]]​​​​​​​​​​​​​​
	166	+(((
	167	+
129	129
130		-= Sauvegarder votre aide en ligne personnalisée =
131	131
132		-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**
	170	+
	171	+)))
	172	+)))
133	133
134		-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.
135		-
136		-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.
137		-
138		-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]]
	174	+