Modifications pour le document Documenter l’aide en ligne

Résumé

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

Détails

Propriétés de la Page

Auteur du document

...	...	@@ -1,1 +1,1 @@
1		-XWiki.JDT
	1	+XWiki.DBA

Contenu

...	...	@@ -1,5 +3,3 @@
1		-**PAGE EN COURS DE REDACTION**
2		-
3	3	(% class="mark small" %)**Version 4.5.54 et ultérieures**
4	4
5	5	|(% style="width:840px" %)(((
...	...	@@ -35,6 +35,30 @@
35	35	)))
36	36	)))
37	37
	36	+(% class="box successmessage" %)
	37	+(((
	38	+**Bonnes pratiques : **
	39	+
	40	+**Présentation et lisibilité**
	41	+
	42	+* Uniformisez la présentation : adoptez une structure homogène pour toutes vos aides (ex. : définition, usage, remarques).
	43	+* Soyez clairs et concis : rédigez des explications courtes et immédiatement compréhensibles.
	44	+* Employez le vocabulaire métier partagé : utilisez les termes définis dans la charte de saisie de votre institution.
	45	+* Ajoutez des exemples concrets : illustrez les valeurs attendues afin d’éviter toute ambiguïté.
	46	+
	47	+**Contenu et cohérence métier**
	48	+
	49	+* 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).
	50	+* Limitez les redondances : n’intégrez que ce qui est pertinent, sans recopier inutilement l’aide du wiki.
	51	+* Documentez aussi les blocs de champs : expliquez leur rôle global en plus des champs qu’ils contiennent.
	52	+
	53	+**Suivi et maintenance**
	54	+
	55	+* 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.
	56	+* Vérifiez l’accessibilité : testez l’ouverture des pop-up d’aide dans les navigateurs utilisés.
	57	+* Mettez à jour régulièrement : adaptez vos contenus lorsque vos procédures internes ou règles métier évoluent.
	58	+)))
	59	+
38	38	= Identifier le nom interne du champ ou du bloc =
39	39
40	40	Pour retrouver le fichier d’aide correspondant, vous devez d’abord identifier le nom interne du champ ou du bloc de champs. Pour cela :
...	...	@@ -87,39 +87,19 @@
87	87
88	88	Une fois le champ ou le bloc trouvé, cliquez sur son nom pour ouvrir l’éditeur HTML.
89	89
90		-(((
91		-1. **Saisir le contenu**
	112	+Vous pouvez saisir directement votre texte ou copier-coller l’aide du wiki avant de l’adapter à vos besoins internes.
92	92
93		-* Tapez directement votre texte dans l’éditeur.
94		-* Vous pouvez aussi copier-coller l’aide issue du wiki et l’adapter à vos besoins internes.
	114	+Cet éditeur fonctionne comme un traitement de texte (type Word) et propose de nombreuses options :
95	95
96		-(% class="box successmessage" %)
97		-(((
98		-**Bonnes pratiques : **
	116	+* **Mise en forme du texte** : gras, italique, souligné, exposant, indice.
	117	+* **Organisation du contenu** : listes à puces, listes numérotées, retrait, alignement.
	118	+* **Styles et formats** : titres, styles prédéfinis, choix de la police et de la taille.
	119	+* **Tableaux et images** : insertion et gestion de tableaux, ajout d’images.
	120	+* **Éléments enrichis** : caractères spéciaux, symboles.
	121	+* **Outils pratiques** : correcteur orthographique, recherche/remplacement, annuler/rétablir, affichage du code source.
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		-* Précisez le contexte : indiquez si le champ ou bloc est lié à un processus particulier (inventaire, récolement, prêt, dépôt, restauration).
104		-* Ajoutez des exemples concrets : illustrez les valeurs attendues pour éviter toute ambiguïté.
105		-* Limitez les redondances : n’intégrez que ce qui est pertinent, sans recopier inutilement l’aide du wiki.
106		-* Documentez aussi les blocs de champs : expliquez leur rôle global en plus des champs qu’ils contiennent.
107		-)))
108		-)))
	123	+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.
109	109
110		-(((
111		-(% start="2" %)
112		-1. **Mettre en forme l’aide**
113		-
114		-* L’éditeur fonctionne comme un traitement de texte (type Word) et vous permet d’appliquer différents outils :
115		-** **Mise en forme du texte** : gras, italique, souligné, exposant, indice.
116		-** **Organisation du contenu** : listes à puces, listes numérotées, retrait, alignement.
117		-** **Styles et formats** : titres, styles prédéfinis, choix de la police et de la taille.
118		-** **Tableaux et images** : insertion et gestion de tableaux, ajout d’images.
119		-** **Éléments enrichis** : caractères spéciaux, symboles.
120		-** **Outils pratiques** : correcteur orthographique, recherche/remplacement, annuler/rétablir, affichage du code source.
121		-)))
122		-
123	123	(% class="box warningmessage" %)
124	124	(((
125	125	**Point d’attention : insérer des liens**
...	...	@@ -128,21 +128,18 @@
128	128	* Copiez-collez ensuite ce lien dans l’éditeur d’aide en ligne. Il sera reconnu correctement et restera actif.
129	129	)))
130	130
131		-(((
132		-(% start="3" %)
133		-1. **Sauvegarder la personnalisation**
134		-
135		-* Cliquez sur **Sauvegarder** pour enregistrer vos modifications.
136		-* Dès la sauvegarde, l’aide en ligne du wiki disparaît : elle est remplacée par votre aide personnalisée.
137		-* Cette personnalisation ne s’applique que dans votre base institutionnelle et n’a aucun impact sur le wiki ni sur les autres musées.
138		-)))
139		-
140	140	(% class="box successmessage" %)
141	141	(((
142	142	**Bonnes pratiques : **
143	143
144		-* 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.
145		-* Mettez à jour régulièrement : adaptez vos contenus lorsque vos procédures internes ou règles métier évoluent.
	137	+* **Uniformisez la présentation** : adoptez une structure homogène (définition, usage, remarques).
	138	+* **Soyez clairs et concis** : rédigez des explications courtes et directement utiles.
	139	+* **Employez le vocabulaire métier partagé** : utilisez les termes définis dans la charte de saisie de votre institution.
	140	+* **Précisez le contexte** : indiquez si le champ ou bloc est lié à un processus particulier (inventaire, récolement, prêt, dépôt, restauration).
	141	+* **Ajoutez des exemples concrets** : illustrez les valeurs attendues pour éviter toute ambiguïté.
	142	+* **Limitez les redondances** : n’intégrez que ce qui est pertinent, sans recopier inutilement l’aide du wiki.
	143	+* **Documentez aussi les blocs de champs** : expliquez leur rôle global en plus des champs qu’ils contiennent.
	144	+* **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.
146	146	)))
147	147
148	148	>(% class="small" %)L’exemple ci-dessous illustre le champ **Numéro d’inventaire** avec une aide en ligne enrichie :
...	...	@@ -164,9 +164,9 @@
164	164	[[//Saisie et mise en forme des données//>>image:1757596818102-351.png||data-xwiki-image-style-alignment="center" data-xwiki-image-style-border="true"]]
165	165
166	166	(% class="wikigeneratedid" id="H200B200B200B200B200B200B200B200B200B200B200B200B200B200B" %)
167		-​​​​​​​
	166	+​​​​​​​​​​​​​​
168	168
169		-[[//Sauvegarder l'aide en ligne//>>image:1757597668258-471.png||data-xwiki-image-style-alignment="center" data-xwiki-image-style-border="true"]]
	168	+[[//Sauvegarde de l'aide en ligne//>>image:1757597668258-471.png||data-xwiki-image-style-alignment="center" data-xwiki-image-style-border="true"]]
170	170
171	171
172	172	= Contrôler le rendu dans Flora =
...	...	@@ -202,7 +202,7 @@
202	202
203	203	**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.
204	204
205		-[[//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"]]
	204	+[[//Repérage nom interne du champ - survol//>>image:1757599364051-795.png||data-xwiki-image-style-alignment="center" data-xwiki-image-style-border="true"]]
206	206
207	207
208	208	[[//Choix de **la source** et de la** table**//>>image:1757599467798-396.png||data-xwiki-image-style-alignment="center" data-xwiki-image-style-border="true"]]