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

...	...	@@ -33,8 +33,24 @@
33	33	)))
34	34	)))
35	35
36		-= Identifier le nom interne du champ ou du bloc =
	36	+(% class="box successmessage" %)
	37	+(((
	38	+**Bonnes pratiques : **
37	37
	40	+* **Uniformisez la présentation** : adoptez une structure homogène pour toutes vos aides (ex. : définition, usage, remarques).
	41	+* **Soyez clairs et concis** : rédigez des explications courtes et immédiatement compréhensibles.
	42	+* **Employez le vocabulaire métier partagé** : utilisez les termes définis dans la charte de saisie de votre institution.
	43	+* **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).
	44	+* **Ajoutez des exemples concrets** : illustrez les valeurs attendues afin d’éviter les ambiguïtés.
	45	+* **Limitez les redondances** : ne recopiez pas intégralement l’aide du wiki, mais complétez-la ou adaptez-la selon vos besoins.
	46	+* **Documentez aussi les blocs de champs** : expliquez leur rôle global en plus des champs qu’ils contiennent.
	47	+* **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.
	48	+* **Vérifiez l’accessibilité** : testez l’ouverture des pop-up d’aide dans les navigateurs utilisés.
	49	+* **Mettez à jour régulièrement** : adaptez vos contenus lorsque vos procédures internes ou règles métier évoluent.
	50	+)))
	51	+
	52	+= Repérer le nom interne du champ ou du bloc à documenter =
	53	+
38	38	Pour retrouver le fichier d’aide correspondant, vous devez d’abord identifier le nom interne du champ ou du bloc de champs. Pour cela :
39	39
40	40	* Survolez le libellé dans une grille de saisie : son nom interne s’affiche en infobulle.
...	...	@@ -51,7 +51,7 @@
51	51	[[//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"]]
52	52
53	53
54		-= Ouvrir l’éditeur d’aide en ligne =
	70	+= Accéder à l'éditeur d'aide en ligne =
55	55
56	56	Pour créer ou modifier une aide, rendez-vous dans l’espace de travail **Administration**, menu **Paramétrage** > **Aide en ligne**.
57	57
...	...	@@ -62,7 +62,7 @@
62	62	[[//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"]]
63	63
64	64
65		-= Localiser le champ ou le bloc à personnaliser =
	81	+= Rechercher le champ ou le bloc à documenter =
66	66
67	67	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 :
68	68
...	...	@@ -81,49 +81,23 @@
81	81	[[//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"]]
82	82
83	83
84		-= Rédiger et mettre en forme votre aide =
	100	+= Éditer l'aide en ligne =
85	85
86	86	Une fois le champ ou le bloc trouvé, cliquez sur son nom pour ouvrir l’éditeur HTML.
87	87
88		-(((
89		-1. **Saisir le contenu**
	104	+Vous pouvez saisir directement votre texte ou copier-coller l’aide du wiki avant de l’adapter à vos besoins internes.
90	90
91		-* Tapez directement votre texte dans l’éditeur.
92		-* Vous pouvez aussi copier-coller l’aide issue du wiki et l’adapter à vos besoins internes.
	106	+Cet éditeur fonctionne comme un traitement de texte (type Word) et propose de nombreuses options :
93	93
94		-(% class="box successmessage" %)
95		-(((
96		-**Bonnes pratiques : **
	108	+* **Mise en forme du texte** : gras, italique, souligné, exposant, indice.
	109	+* **Organisation du contenu** : listes à puces, listes numérotées, retrait, alignement.
	110	+* **Styles et formats** : titres, styles prédéfinis, choix de la police et de la taille.
	111	+* **Tableaux et images** : insertion et gestion de tableaux, ajout d’images.
	112	+* **Éléments enrichis** : caractères spéciaux, symboles.
	113	+* **Outils pratiques** : correcteur orthographique, recherche/remplacement, annuler/rétablir, affichage du code source.
97	97
98		-**Présentation et clarté**
	115	+Une fois votre saisie terminée, cliquez sur **Sauvegarder** pour enregistrer votre personnalisation. **Dès la sauvegarde, l’aide en ligne par défaut issue du wiki est remplacée par votre aide personnalisée** : celle-ci ne s’affichera que dans votre base de données institutionnelle et n’aura aucun impact sur le wiki ni sur les autres musées.
99	99
100		-* Uniformisez la présentation : adoptez une structure homogène pour toutes vos aides (ex. : définition, usage, remarques).
101		-* Soyez clairs et concis : rédigez des explications courtes et immédiatement compréhensibles.
102		-* Employez le vocabulaire métier partagé : utilisez les termes définis dans la charte de saisie de votre institution.
103		-* Ajoutez des exemples concrets : illustrez les valeurs attendues afin d’éviter toute ambiguïté.
104		-
105		-**Contenu et cohérence**
106		-
107		-* Précisez le contexte : indiquez si le champ ou bloc est lié à un processus particulier (inventaire, récolement, prêt, dépôt, restauration).
108		-* Ajoutez des exemples concrets : illustrez les valeurs attendues pour éviter toute ambiguïté.
109		-* Limitez les redondances : n’intégrez que ce qui est pertinent, sans recopier inutilement l’aide du wiki.
110		-* Documentez aussi les blocs de champs : expliquez leur rôle global en plus des champs qu’ils contiennent.
111		-)))
112		-)))
113		-
114		-(((
115		-(% start="2" %)
116		-1. **Mettre en forme l’aide**
117		-
118		-* L’éditeur fonctionne comme un traitement de texte (type Word) et vous permet d’appliquer différents outils :
119		-** **Mise en forme du texte** : gras, italique, souligné, exposant, indice.
120		-** **Organisation du contenu** : listes à puces, listes numérotées, retrait, alignement.
121		-** **Styles et formats** : titres, styles prédéfinis, choix de la police et de la taille.
122		-** **Tableaux et images** : insertion et gestion de tableaux, ajout d’images.
123		-** **Éléments enrichis** : caractères spéciaux, symboles.
124		-** **Outils pratiques** : correcteur orthographique, recherche/remplacement, annuler/rétablir, affichage du code source.
125		-)))
126		-
127	127	(% class="box warningmessage" %)
128	128	(((
129	129	**Point d’attention : insérer des liens**
...	...	@@ -132,21 +132,18 @@
132	132	* Copiez-collez ensuite ce lien dans l’éditeur d’aide en ligne. Il sera reconnu correctement et restera actif.
133	133	)))
134	134
135		-(((
136		-(% start="3" %)
137		-1. **Sauvegarder la personnalisation**
138		-
139		-* Cliquez sur **Sauvegarder** pour enregistrer vos modifications.
140		-* Dès la sauvegarde, l’aide en ligne du wiki disparaît : elle est remplacée par votre aide personnalisée.
141		-* Cette personnalisation ne s’applique que dans votre base institutionnelle et n’a aucun impact sur le wiki ni sur les autres musées.
142		-)))
143		-
144	144	(% class="box successmessage" %)
145	145	(((
146	146	**Bonnes pratiques : **
147	147
148		-* 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.
149		-* Mettez à jour régulièrement : adaptez vos contenus lorsque vos procédures internes ou règles métier évoluent.
	129	+* **Uniformisez la présentation** : adoptez une structure homogène (définition, usage, remarques).
	130	+* **Soyez clairs et concis** : rédigez des explications courtes et directement utiles.
	131	+* **Employez le vocabulaire métier partagé** : utilisez les termes définis dans la charte de saisie de votre institution.
	132	+* **Précisez le contexte** : indiquez si le champ ou bloc est lié à un processus particulier (inventaire, récolement, prêt, dépôt, restauration).
	133	+* **Ajoutez des exemples concrets** : illustrez les valeurs attendues pour éviter toute ambiguïté.
	134	+* **Limitez les redondances** : n’intégrez que ce qui est pertinent, sans recopier inutilement l’aide du wiki.
	135	+* **Documentez aussi les blocs de champs** : expliquez leur rôle global en plus des champs qu’ils contiennent.
	136	+* **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.
150	150	)))
151	151
152	152	>(% class="small" %)L’exemple ci-dessous illustre le champ **Numéro d’inventaire** avec une aide en ligne enrichie :
...	...	@@ -170,10 +170,10 @@
170	170	(% class="wikigeneratedid" id="H200B200B200B200B200B200B200B200B200B200B200B200B200B200B" %)
171	171	​​​​​​​​​​​​​​
172	172
173		-[[//Sauvegarder l'aide en ligne//>>image:1757597668258-471.png||data-xwiki-image-style-alignment="center" data-xwiki-image-style-border="true"]]
	160	+[[//Sauvegarde de l'aide en ligne//>>image:1757597668258-471.png||data-xwiki-image-style-alignment="center" data-xwiki-image-style-border="true"]]
174	174
175	175
176		-= Contrôler le rendu dans Flora =
	163	+= Consulter le résultat =
177	177
178	178	Une fois votre aide personnalisée sauvegardée, il est essentiel de** vérifier son affichage** dans les grilles de saisie. Cette étape vous permet de **contrôler que le contenu rédigé apparaît bien en contexte** et qu’il remplace correctement, le cas échéant, l’aide du wiki.
179	179
...	...	@@ -191,7 +191,7 @@
191	191
192	192	(% id="cke_bm_851S" style="display:none" %)
193	193
194		-= Rétablir l’aide par défaut du wiki =
	181	+= Revenir à l'aide en ligne du wiki =
195	195
196	196	Si vous ne souhaitez plus conserver une aide en ligne personnalisée et préférez retrouver l’aide générique fournie par le wiki, procédez comme suit :
197	197
...	...	@@ -206,7 +206,7 @@
206	206
207	207	**Résultat :** l’aide en ligne personnalisée disparaît et l’aide générique du wiki réapparaît automatiquement pour ce champ ou ce bloc.
208	208
209		-[[//Repérage nom interne du champ - une infobulle apparait avec le survol du champ//>>image:1757599364051-795.png||data-xwiki-image-style-alignment="center" data-xwiki-image-style-border="true"]]
	196	+[[//Repérage nom interne du champ - survol//>>image:1757599364051-795.png||data-xwiki-image-style-alignment="center" data-xwiki-image-style-border="true"]]
210	210
211	211
212	212	[[//Choix de **la source** et de la** table**//>>image:1757599467798-396.png||data-xwiki-image-style-alignment="center" data-xwiki-image-style-border="true"]]