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

...	...	@@ -11,93 +11,126 @@
11	11	)))
12	12
13	13	(((
14		-= L'aide en ligne : un appui à la saisie dans Flora =
	14	+= À quoi sert l'aide en ligne dans Flora ? =
15	15
	16	+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.
16	16
17		-L’aide en ligne **accompagne les utilisateurs** dans la compréhension et l’utilisation des champs présents dans les différentes tables de Flora.
18		-Elle contribue à garantir une saisie homogène, cohérente et conforme aux pratiques définies par votre institution. Elle complète les documents de référence internes et les procédures métiers du musée.
19		-Son objectif est de traduire concrètement ces règles directement dans l’interface de Flora, au plus près des champs utilisés par les équipes au quotidien.
	18	+Elle vient en appui des documents de référence internes comme la **charte de saisie**, la **charte de nommage** ou les **processus métiers** propres au musée. Elle permet ainsi de traduire concrètement ces règles dans l’interface de Flora, au plus près des champs utilisés par les équipes.
20	20
21		-Concrètement, l’aide en ligne permet de :
	20	+**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**.
22	22
23		-* **Expliquer le contenu attendu dans un champ**.
24		-* **Formaliser les règles de saisie propres à l’institution** (abréviations autorisées, vocabulaire contrôlé, conventions d’écriture, etc.).
25		-* **Donner accès à des ressources externes de référence** (textes réglementaires, chartes internes, normes, guides méthodologiques).
26		-* **Harmoniser les pratiques et éviter les erreurs d’interprétation**, notamment dans les équipes élargies ou en cas de renouvellement des agents.
	22	+>(% class="small" %)Cas d'usage:
27	27
28		-Par défaut, **l’aide en ligne est redirigée vers l’aide disponible sur le wiki officiel**. Cette documentation est actuellement en cours de rédaction et d’enrichissement par l’équipe de Flora Software.
	24	+(((
	25	+>(% class="small" %)Expliquer le contenu attendu dans un champ.
29	29
30		-Elle constitue une **base commune de référence pour l’ensemble des utilisateurs**.
	27	+(((
	28	+>(% class="small" %)Formaliser les règles de saisie propres à l’institution.
31	31
32		-Toutefois, chaque institution a la possibilité d**’adapter cette aide à ses propres pratiques**.
	30	+>(% class="small" %)Indiquer à quels processus le champ est lié  (ex. : inventaire, récolement, prêt, dépôt, restauration, etc.).
33	33
34		-= Personnaliser l'aide en ligne =
	32	+>(% class="small" %)Donner accès à des ressources externes de référence.
35	35
36		-Lorsqu’un musée crée une **aide en ligne personnalisée** pour un champ :
	34	+>(% class="small" %)Harmoniser les pratiques et éviter les erreurs d’interprétation.
	35	+)))
	36	+)))
37	37
38		-* le contenu standard issu du** wiki est automatiquement masqué**
39		-* seul le **contenu rédigé localement est affiché**
	38	+= Identifier le nom interne du champ ou du bloc =
40	40
41		-Si cette personnalisation est supprimée, l’aide du wiki réapparaît automatiquement.
	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 :
42	42
43		-Cette **personnalisation est strictement locale** : elle s’applique uniquement à la base de données de l’institution qui l’a créée.
44		-Elle ne modifie pas le contenu du wiki et n’a aucun impact sur les autres institutions.
	42	+* Survolez le libellé dans une grille de saisie : son nom interne s’affiche en infobulle.
	43	+* Vous pouvez aussi faire un clic droit sur le libellé et choisir **Afficher informations** pour copier directement le nom interne.
45	45
46		-== Identifier le nom interne du champ ou du bloc ==
	45	+>(% class="small" %)Exemple : dans la table MUS_BIEN, le champ Numéro d’inventaire porte le nom technique **NUM_INVENTAIRE**.
47	47
48		-Pour retrouver le fichier d’aide correspondant, vous devez d’abord identifier le nom interne du champ ou du bloc de champs.
	47	+[[//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"]]
49	49
50		-Pour cela :
51	51
52		-1. Faites un **clic droit** sur le libellé du champ
53		-1. Choisir **Afficher informations**
54		-1. **Copiez le nom interne **du champ (ligne name)
	50	+[[//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"]]
55	55
56		-[[//Clic droit - Afficher informations//>>image:1744363948510-224.png||data-xwiki-image-style-alignment="center" data-xwiki-image-style-border="true"]]
57	57
	53	+[[//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"]]
58	58
59		-[[//Nom interne du champ//>>image:1744363968204-295.png||data-xwiki-image-style-alignment="center" data-xwiki-image-style-border="true"]]
60	60
	56	+= Ouvrir l’éditeur d’aide en ligne =
61	61
62		-== Accéder à l'éditeur d'aide en ligne ==
	58	+Pour créer ou modifier une aide, rendez-vous dans l’espace de travail **Administration**, menu **Paramétrage** > **Aide en ligne**.
63	63
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. 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
	60	+Vous y trouverez la liste des fichiers disponibles, organisés par source et par table.
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"]]
	62	+Dépliez la rubrique **Aide à la saisie** pour rechercher les champs et blocs de champs à documenter.
72	72
	64	+[[//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"]]
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
	67	+= Localiser le champ ou le bloc à personnaliser =
76	76
77		-[[//Ouverture de l'éditeur//>>image:1757595726608-759.png||data-xwiki-image-style-alignment="center" data-xwiki-image-style-border="true"]]
	69	+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 :
78	78
	71	+1. **Choisissez la source** (ex. Musées, Bibliothèque, Archives).
	72	+1. **Sélectionnez la table** dans laquelle se trouve le champ ou le bloc à documenter.
	73	+1. **Utilisez le raccourci clavier Ctrl + F** pour ouvrir la barre de recherche.
	74	+1. **Collez le nom interne** que vous avez récupéré (champ ou bloc).
	75	+1. **Cliquez sur l’élément trouvé** pour ouvrir l’éditeur.
79	79
80		-== Rédiger l'aide en ligne ==
	77	+[[//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"]]
81	81
82		-L’éditeur fonctionne comme un traitement de texte (type Word) et vous permet d’appliquer différents outils :
83	83
	80	+[[//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"]]
	81	+
	82	+
	83	+[[//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"]]
	84	+
	85	+
	86	+= Rédiger et mettre en forme votre aide =
	87	+
	88	+Une fois le champ ou le bloc trouvé, cliquez sur son nom pour ouvrir l’éditeur HTML.
	89	+
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.
	91	+1. **Saisir le contenu**
	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.
	95	+
	96	+(% class="box successmessage" %)
	97	+(((
	98	+**Bonnes pratiques : **
	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.
91	91	)))
	108	+)))
92	92
93		-(% class="box warningmessage" %)
94	94	(((
	111	+(% start="2" %)
	112	+1. **Mettre en forme l’aide**
95	95
	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.
96	96	)))
97	97
	123	+(% class="box warningmessage" %)
	124	+(((
	125	+**Point d’attention : insérer des liens**
98	98
	127	+* 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.
	128	+* Copiez-collez ensuite ce lien dans l’éditeur d’aide en ligne. Il sera reconnu correctement et restera actif.
	129	+)))
	130	+
99	99	(((
100		-== **Sauvegarder la personnalisation** ==
	132	+(% start="3" %)
	133	+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.
...	...	@@ -130,6 +130,8 @@
130	130
131	131	[[//Saisie et mise en forme des données//>>image:1757596818102-351.png||data-xwiki-image-style-alignment="center" data-xwiki-image-style-border="true"]]
132	132
	166	+(% class="wikigeneratedid" id="H200B200B200B200B200B200B200B200B200B200B200B200B200B200B" %)
	167	+​​​​​​​
133	133
134	134	[[//Sauvegarder l'aide en ligne//>>image:1757597668258-471.png||data-xwiki-image-style-alignment="center" data-xwiki-image-style-border="true"]]
135	135