Modifications pour le document Documenter l’aide en ligne

Modifié par Joséphine Ducruet le 2026/02/18 16:34

Gérer
- Copier
Actions
- Exporter
- Aperçu avant impression
Affichage

From 59.1 to 58.1 From 74.1 to 73.1

Depuis la version 73.1

modifié par Joséphine Ducruet
sur 2026/02/11 14:47

Commentaire de modification : Il n'y a aucun commentaire pour cette version

À la version 59.1

modifié par Doriane Bautista
sur 2025/09/11 16:25

Commentaire de modification : Il n'y a aucun commentaire pour cette version

Source
Rendu

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 @@
--XWiki.JDT
++XWiki.DBA

Contenu

@@ -1,5 +3,3 @@
--**PAGE EN COURS DE REDACTION**
--
  (% class="mark small" %)**Version 4.5.54 et ultérieures**
  |(% style="width:840px" %)(((
@@ -35,8 +35,24 @@
  )))
  )))
--= Identifier le nom interne du champ ou du bloc =
++(% class="box successmessage" %)
++(((
++**Bonnes pratiques : **
++* **Uniformisez la présentation** : adoptez une structure homogène pour toutes vos aides (ex. : définition, usage, remarques).
++* **Soyez clairs et concis** : rédigez des explications courtes et immédiatement compréhensibles.
++* **Employez le vocabulaire métier partagé** : utilisez les termes définis dans la charte de saisie de votre institution.
++* **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).
++* **Ajoutez des exemples concrets** : illustrez les valeurs attendues afin d’éviter les ambiguïtés.
++* **Limitez les redondances** : ne recopiez pas intégralement l’aide du wiki, mais complétez-la ou adaptez-la selon vos besoins.
++* **Documentez aussi les blocs de champs** : expliquez leur rôle global en plus des champs qu’ils contiennent.
++* **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.
++* **Vérifiez l’accessibilité** : testez l’ouverture des pop-up d’aide dans les navigateurs utilisés.
++* **Mettez à jour régulièrement** : adaptez vos contenus lorsque vos procédures internes ou règles métier évoluent.
++)))
++
++= Repérer le nom interne du champ ou du bloc à documenter =
++
  Pour retrouver le fichier d’aide correspondant, vous devez d’abord identifier le nom interne du champ ou du bloc de champs. Pour cela :
  * Survolez le libellé dans une grille de saisie : son nom interne s’affiche en infobulle.
@@ -53,7 +53,7 @@
  [[//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"]]
--= Ouvrir l’éditeur d’aide en ligne =
++= Accéder à l'éditeur d'aide en ligne =
  Pour créer ou modifier une aide, rendez-vous dans l’espace de travail **Administration**, menu **Paramétrage** > **Aide en ligne**.
@@ -64,7 +64,7 @@
  [[//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"]]
--= Localiser le champ ou le bloc à personnaliser =
++= Rechercher le champ ou le bloc à documenter =
  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 :
@@ -83,43 +83,23 @@
  [[//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"]]
--= Rédiger et mettre en forme votre aide =
++= Éditer l'aide en ligne =
  Une fois le champ ou le bloc trouvé, cliquez sur son nom pour ouvrir l’éditeur HTML.
--(((
--1. **Saisir le contenu**
++Vous pouvez saisir directement votre texte ou copier-coller l’aide du wiki avant de l’adapter à vos besoins internes.
--* Tapez directement votre texte dans l’éditeur.
--* Vous pouvez aussi copier-coller l’aide issue du wiki et l’adapter à vos besoins internes.
++Cet éditeur fonctionne comme un traitement de texte (type Word) et propose de nombreuses options :
--(% class="box successmessage" %)
--(((
--**Bonnes pratiques : **
++* **Mise en forme du texte** : gras, italique, souligné, exposant, indice.
++* **Organisation du contenu** : listes à puces, listes numérotées, retrait, alignement.
++* **Styles et formats** : titres, styles prédéfinis, choix de la police et de la taille.
++* **Tableaux et images** : insertion et gestion de tableaux, ajout d’images.
++* **Éléments enrichis** : caractères spéciaux, symboles.
++* **Outils pratiques** : correcteur orthographique, recherche/remplacement, annuler/rétablir, affichage du code source.
--* Uniformisez la présentation : adoptez une structure homogène pour toutes vos aides (ex. : définition, usage, remarques).
--* Soyez clairs et concis : rédigez des explications courtes et immédiatement compréhensibles.
--* Employez le vocabulaire métier partagé : utilisez les termes définis dans la charte de saisie de votre institution.
--* Précisez le contexte : indiquez si le champ ou bloc est lié à un processus particulier (inventaire, récolement, prêt, dépôt, restauration).
--* Ajoutez des exemples concrets : illustrez les valeurs attendues pour éviter toute ambiguïté.
--* Limitez les redondances : n’intégrez que ce qui est pertinent, sans recopier inutilement l’aide du wiki.
--* Documentez aussi les blocs de champs : expliquez leur rôle global en plus des champs qu’ils contiennent.
--)))
--)))
++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.
--(((
--(% start="2" %)
--1. **Mettre en forme l’aide**
--
--* L’éditeur fonctionne comme un traitement de texte (type Word) et vous permet d’appliquer différents outils :
--** **Mise en forme du texte** : gras, italique, souligné, exposant, indice.
--** **Organisation du contenu** : listes à puces, listes numérotées, retrait, alignement.
--** **Styles et formats** : titres, styles prédéfinis, choix de la police et de la taille.
--** **Tableaux et images** : insertion et gestion de tableaux, ajout d’images.
--** **Éléments enrichis** : caractères spéciaux, symboles.
--** **Outils pratiques** : correcteur orthographique, recherche/remplacement, annuler/rétablir, affichage du code source.
--)))
--
  (% class="box warningmessage" %)
  (((
  **Point d’attention : insérer des liens**
@@ -128,21 +128,18 @@
  * Copiez-collez ensuite ce lien dans l’éditeur d’aide en ligne. Il sera reconnu correctement et restera actif.
  )))
--(((
--(% start="3" %)
--1. **Sauvegarder la personnalisation**
--
--* Cliquez sur **Sauvegarder** pour enregistrer vos modifications.
--* Dès la sauvegarde, l’aide en ligne du wiki disparaît : elle est remplacée par votre aide personnalisée.
--* Cette personnalisation ne s’applique que dans votre base institutionnelle et n’a aucun impact sur le wiki ni sur les autres musées.
--)))
--
  (% class="box successmessage" %)
  (((
  **Bonnes pratiques : **
--* 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.
--* Mettez à jour régulièrement : adaptez vos contenus lorsque vos procédures internes ou règles métier évoluent.
++* **Uniformisez la présentation** : adoptez une structure homogène (définition, usage, remarques).
++* **Soyez clairs et concis** : rédigez des explications courtes et directement utiles.
++* **Employez le vocabulaire métier partagé** : utilisez les termes définis dans la charte de saisie de votre institution.
++* **Précisez le contexte** : indiquez si le champ ou bloc est lié à un processus particulier (inventaire, récolement, prêt, dépôt, restauration).
++* **Ajoutez des exemples concrets** : illustrez les valeurs attendues pour éviter toute ambiguïté.
++* **Limitez les redondances** : n’intégrez que ce qui est pertinent, sans recopier inutilement l’aide du wiki.
++* **Documentez aussi les blocs de champs** : expliquez leur rôle global en plus des champs qu’ils contiennent.
++* **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.
  )))
  >(% class="small" %)L’exemple ci-dessous illustre le champ **Numéro d’inventaire** avec une aide en ligne enrichie :
@@ -164,12 +164,12 @@
  [[//Saisie et mise en forme des données//>>image:1757596818102-351.png||data-xwiki-image-style-alignment="center" data-xwiki-image-style-border="true"]]
  (% class="wikigeneratedid" id="H200B200B200B200B200B200B200B200B200B200B200B200B200B200B" %)
--
++
--[[//Sauvegarder l'aide en ligne//>>image:1757597668258-471.png||data-xwiki-image-style-alignment="center" data-xwiki-image-style-border="true"]]
++[[//Sauvegarde de l'aide en ligne//>>image:1757597668258-471.png||data-xwiki-image-style-alignment="center" data-xwiki-image-style-border="true"]]
--= Contrôler le rendu dans Flora =
++= Consulter le résultat =
  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.
@@ -187,7 +187,7 @@
  (% id="cke_bm_851S" style="display:none" %)
--= Rétablir l’aide par défaut du wiki =
++= Revenir à l'aide en ligne du wiki =
  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 :
@@ -202,7 +202,7 @@
  **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.
--[[//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"]]
++[[//Repérage nom interne du champ - survol//>>image:1757599364051-795.png||data-xwiki-image-style-alignment="center" data-xwiki-image-style-border="true"]]
  [[//Choix de **la source** et de la** table**//>>image:1757599467798-396.png||data-xwiki-image-style-alignment="center" data-xwiki-image-style-border="true"]]