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

...	...	@@ -35,44 +35,55 @@
35	35	(((
36	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.
	38	+* **Être concis et clair** : rédiger des explications courtes, directement utiles à la saisie.
	39	+* **Utiliser le vocabulaire métier partagé** : employer les termes définis dans la charte de saisie de l’institution.
	40	+* **Préciser le contexte** : indiquer si le champ intervient dans un processus spécifique (inventaire, récolement, prêt, dépôt, restauration).
	41	+* **Ajouter des exemples concrets** : illustrer les valeurs attendues pour éviter toute ambiguïté.
	42	+* **Uniformiser la présentation** : structurer les textes de la même manière pour tous les champs (définition, usage, remarques).
	43	+* **Limiter la redondance** : éviter de copier-coller l’intégralité de l’aide du wiki, ne garder que ce qui est réellement utile ou adapté localement.
	44	+* **Documenter les blocs de champs** : expliquer le rôle global du bloc en plus du détail des champs si nécessaire.
	45	+* **Préserver une mémoire interne** : conserver une copie (Word, tableur, etc.) des aides personnalisées pour suivre l’évolution des consignes et faciliter la maintenance lors des mises à jour Flora.
	46	+* **Vérifier l’accessibilité** : tester l’affichage de la pop-up dans les navigateurs utilisés et vérifier que les aides apparaissent correctement.
	47	+* **Actualiser régulièrement** : mettre à jour les contenus quand les procédures internes ou les règles métier évoluent.
48	48	)))
49	49
50		-= Récupérer le nom informatique du champ ou du bloc à documenter =
	50	+== Comportement par défaut ==
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 :
	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	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.
	54	+Ainsi, les fichiers rédigés par les services du musée sont prioritaires sur ceux de Flora.
56	56
57		->(% class="small" %)Exemple : dans la table MUS_BIEN, le champ Numéro d’inventaire porte le nom technique **NUM_INVENTAIRE**.
	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 :
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"]]
	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]]
60	60
61		-
	63	+== Gestion locale des pages html d'aide ==
62	62
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"]]
	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" :
64	64
65	65
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"]]
	68	+[[image:1744363736609-747.png]]
67	67
68	68
69		-= Accéder à l'éditeur d'aide en ligne =
	71	+== Connaître le nom d'un champ Flora ==
70	70
	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.
71	71
	75	+[[image:1744363912649-947.png]]
72	72
73		-(% class="wikigeneratedid" id="HModifierlefichierd27aide" %)
74		-Modifier le fichier d'aide
	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
75	75
	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	+
76	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.
77	77
78	78	[[image:1744364271216-799.png]]
...	...	@@ -97,8 +97,7 @@
97	97	(% class="wikigeneratedid" id="H200B200B200B200B200B200B200B200B200B200B200B200B200B200B" %)
98	98	[[image:1744364831120-598.png]]​​​​​​​​​​​​​​
99	99
100		-(% class="wikigeneratedid" id="HSauvegardervotreaideenlignepersonnalisE9e" %)
101		-Sauvegarder votre aide en ligne personnalisée
	111	+= Sauvegarder votre aide en ligne personnalisée =
102	102
103	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**
104	104
...	...	@@ -107,40 +107,7 @@
107	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.
108	108
109	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]]
110		-
111		-
112		-(% class="wikigeneratedid" id="HComportementpardE9faut" %)
113		-(% id="cke_bm_851S" style="display:none" %) (%%)Comportement par défaut
114		-
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.
116		-
117		-Ainsi, les fichiers rédigés par les services du musée sont prioritaires sur ceux de Flora.
118		-
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 :
120		-
121		-* (((
122		-[[Firefox>>https://support.mozilla.org/fr/kb/parametres-exceptions-depannage-blocage-popup]]
123	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		-)))
133		-
134		-(% class="wikigeneratedid" id="HGestionlocaledespageshtmld27aide" %)
135		-Gestion locale des pages html d'aide
136		-
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" :
138		-
139		-
140		-[[image:1744363736609-747.png]]
141		-
142		-
143		-)))
144	144	)))|(% style="width:300px" %)(((
145	145	(% class="box" %)
146	146	(((
...	...	@@ -153,10 +153,8 @@
153	153	(((
154	154	**Aller plus loin**
155	155
156		-* (((
157		-[[Saisir dans Flora>>doc:1_Fonctionnalités.5\.C\. Saisie.WebHome||target="_blank"]]
	133	+* [[Saisir dans Flora>>doc:1_Fonctionnalités.5\.C\. Saisie.WebHome||target="_blank"]]
158	158	)))
159		-)))
160	160
161	161	(% class="box" %)
162	162	(((