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,7 +35,7 @@
35	35
36	36	Lorsqu’un musée crée une **aide en ligne personnalisée** pour un champ :
37	37
38		-* le contenu standard issu du** wiki est automatiquement masqué**
	38	+* le contenu standard issu du** wiki est automatiquement masqué**
39	39	* seul le **contenu rédigé localement est affiché**
40	40
41	41	Si cette personnalisation est supprimée, l’aide du wiki réapparaît automatiquement.
...	...	@@ -43,6 +43,7 @@
43	43	Cette **personnalisation est strictement locale** : elle s’applique uniquement à la base de données de l’institution qui l’a créée.
44	44	Elle ne modifie pas le contenu du wiki et n’a aucun impact sur les autres institutions.
45	45
	46	+
46	46	== Identifier le nom interne du champ ou du bloc ==
47	47
48	48	Pour retrouver le fichier d’aide correspondant, vous devez d’abord identifier le nom interne du champ ou du bloc de champs.
...	...	@@ -59,45 +59,86 @@
59	59	[[//Nom interne du champ//>>image:1744363968204-295.png||data-xwiki-image-style-alignment="center" data-xwiki-image-style-border="true"]]
60	60
61	61
62		-== Accéder à l'éditeur d'aide en ligne ==
	63	+== Ouvrir l’éditeur d’aide en ligne ==
63	63
64	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. Dépliez la rubrique** Aide à la saisie**
66	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
	68	+1.
70	70
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"]]
72	72
73	73
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"]]
75	75
	73	+[[//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"]]
76	76
77		-[[//Ouverture de l'éditeur//>>image:1757595726608-759.png||data-xwiki-image-style-alignment="center" data-xwiki-image-style-border="true"]]
78	78
	76	+= Localiser le champ ou le bloc à personnaliser =
79	79
80		-== Rédiger l'aide en ligne ==
	78	+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 :
81	81
82		-L’éditeur fonctionne comme un traitement de texte (type Word) et vous permet d’appliquer différents outils :
	80	+1. **Choisissez la source** (ex. Musées, Bibliothèque, Archives).
	81	+1. **Sélectionnez la table** dans laquelle se trouve le champ ou le bloc à documenter.
	82	+1. **Utilisez le raccourci clavier Ctrl + F** pour ouvrir la barre de recherche.
	83	+1. **Collez le nom interne** que vous avez récupéré (champ ou bloc).
	84	+1. **Cliquez sur l’élément trouvé** pour ouvrir l’éditeur.
83	83
	86	+[[//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"]]
	87	+
	88	+
	89	+[[//Recherche **CTRL+F** et clic sur le nom interne du champ **NUM_INVENTAIRE**//>>image:1757595571069-539.png||data-xwiki-image-style-alignment="center" data-xwiki-image-style-border="true"]]
	90	+
	91	+
	92	+[[//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"]]
	93	+
	94	+
	95	+= Rédiger et mettre en forme votre aide =
	96	+
	97	+Une fois le champ ou le bloc trouvé, cliquez sur son nom pour ouvrir l’éditeur HTML.
	98	+
84	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.
	100	+1. **Saisir le contenu**
	101	+
	102	+* Tapez directement votre texte dans l’éditeur.
	103	+* Vous pouvez aussi copier-coller l’aide issue du wiki et l’adapter à vos besoins internes.
	104	+
	105	+(% class="box successmessage" %)
	106	+(((
	107	+**Bonnes pratiques : **
	108	+
	109	+* Uniformisez la présentation : adoptez une structure homogène pour toutes vos aides (ex. : définition, usage, remarques).
	110	+* Soyez clairs et concis : rédigez des explications courtes et immédiatement compréhensibles.
	111	+* Employez le vocabulaire métier partagé : utilisez les termes définis dans la charte de saisie de votre institution.
	112	+* Précisez le contexte : indiquez si le champ ou bloc est lié à un processus particulier (inventaire, récolement, prêt, dépôt, restauration).
	113	+* Ajoutez des exemples concrets : illustrez les valeurs attendues pour éviter toute ambiguïté.
	114	+* Limitez les redondances : n’intégrez que ce qui est pertinent, sans recopier inutilement l’aide du wiki.
	115	+* Documentez aussi les blocs de champs : expliquez leur rôle global en plus des champs qu’ils contiennent.
91	91	)))
	117	+)))
92	92
93		-(% class="box warningmessage" %)
94	94	(((
	120	+(% start="2" %)
	121	+1. **Mettre en forme l’aide**
95	95
	123	+* L’éditeur fonctionne comme un traitement de texte (type Word) et vous permet d’appliquer différents outils :
	124	+** **Mise en forme du texte** : gras, italique, souligné, exposant, indice.
	125	+** **Organisation du contenu** : listes à puces, listes numérotées, retrait, alignement.
	126	+** **Styles et formats** : titres, styles prédéfinis, choix de la police et de la taille.
	127	+** **Tableaux et images** : insertion et gestion de tableaux, ajout d’images.
	128	+** **Éléments enrichis** : caractères spéciaux, symboles.
	129	+** **Outils pratiques** : correcteur orthographique, recherche/remplacement, annuler/rétablir, affichage du code source.
96	96	)))
97	97
	132	+(% class="box warningmessage" %)
	133	+(((
	134	+**Point d’attention : insérer des liens**
98	98
	136	+* 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.
	137	+* Copiez-collez ensuite ce lien dans l’éditeur d’aide en ligne. Il sera reconnu correctement et restera actif.
	138	+)))
	139	+
99	99	(((
100		-== **Sauvegarder la personnalisation** ==
	141	+(% start="3" %)
	142	+1. **Sauvegarder la personnalisation**
101	101
102	102	* Cliquez sur **Sauvegarder** pour enregistrer vos modifications.
103	103	* Dès la sauvegarde, l’aide en ligne du wiki disparaît : elle est remplacée par votre aide personnalisée.