Documenter l’aide en ligne

1

(% class="mark small" %)**Version 4.5.54 et ultérieures**

2

3

|(% style="width:840px" %)(((

4

(% class="box" %)

5

(((

6

Dans Flora, chaque **champ ou bloc de champ** est accompagné d’une **aide en ligne **accessible directement depuis une **grille de saisie**. Par défaut, l’aide affichée provient du wiki.

7

8

Elle peut toutefois être personnalisée : chaque institution a la possibilité de** rédiger sa propre aide en ligne** afin d’adapter les consignes à ses besoins internes et à sa charte de saisie.

)))

(((

= A quoi sert l'aide en ligne dans Flora ? =

13

14

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.

15

16

**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**.

17

18

>(% class="small" %)Cas d'usage:

19

20

(((

21

>(% class="small" %)Expliquer le contenu attendu dans un champ.

22

23

(((

24

>(% class="small" %)Formaliser les règles de saisie propres à l’institution.

25

26

>(% class="small" %)Indiquer à quels processus le champ est lié (ex. : inventaire, récolement, prêt, dépôt, restauration, etc.).

27

28

>(% class="small" %)Donner accès à des ressources externes de référence.

29

30

>(% class="small" %)Harmoniser les pratiques et éviter les erreurs d’interprétation.

)))

)))

(% class="box successmessage" %)

35

(((

36

**Bonnes pratiques : **

37

38

* **Uniformisez la présentation** : adoptez une structure homogène pour toutes vos aides (ex. : définition, usage, remarques).

39

* **Soyez clairs et concis** : rédigez des explications courtes et immédiatement compréhensibles.

40

* **Employez le vocabulaire métier partagé** : utilisez les termes définis dans la charte de saisie de votre institution.

41

* **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).

42

* **Ajoutez des exemples concrets** : illustrez les valeurs attendues afin d’éviter les ambiguïtés.

43

* **Limitez les redondances** : ne recopiez pas intégralement l’aide du wiki, mais complétez-la ou adaptez-la selon vos besoins.

44

* **Documentez aussi les blocs de champs** : expliquez leur rôle global en plus des champs qu’ils contiennent.

45

* **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.

46

* **Vérifiez l’accessibilité** : testez l’ouverture des pop-up d’aide dans les navigateurs utilisés.

47

* **Mettez à jour régulièrement** : adaptez vos contenus lorsque vos procédures internes ou règles métier évoluent.

48

)))

49

50

= Récupérer le nom informatique du champ ou du bloc à documenter =

51

52

Pour retrouver le fichier d’aide correspondant, vous devez d’abord identifier le nom interne du champ ou du bloc de champs. Pour cela :

53

54

* Survolez le libellé dans une grille de saisie : son nom interne s’affiche en infobulle.

55

* Vous pouvez aussi faire un clic droit sur le libellé et choisir **Afficher informations** pour copier directement le nom interne.

56

57

>(% class="small" %)Exemple : dans la table MUS_BIEN, le champ Numéro d’inventaire porte le nom technique **NUM_INVENTAIRE**.

58

59

[[//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"]]

[[//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"]]

64

65

66

[[//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"]]

67

68

69

= Accéder à l'éditeur d'aide en ligne =

(% class="wikigeneratedid" id="HModifierlefichierd27aide" %)

74

Modifier le fichier d'aide

75

76

Dans l'espace de travail Administration, dans le menu Paramétrage, puis Aide en ligne, on retrouve les fichiers d'aide en ligne qu'il est possible de modifier pour son institution.

77

78

[[image:1744364271216-799.png]]

79

80

Cliquer sur le [[image:1744364312163-238.png]] de l'Aide à la saisie pour déplier la liste des fichiers.

81

82

[[image:1744364340925-762.png]]

83

84

(% class="wikigeneratedid" %)

85

Choisir ensuite la source et la table du champ auquel on souhaite ajouter une aide en ligne. Taper sur les touches Ctrl et F de votre clavier afin de faire apparaitre une barre de recherche. Puis coller le nom informatique du champ dans la barre de recherche afin de le retrouver facilement dans la liste des champs.

86

87

[[image:1744364568000-243.png]]

88

89

(% class="wikigeneratedid" %)

90

Cliquer sur le nom informatique du champ afin d'ouvrir l'éditeur html, puis saisir votre texte et cliquer sur sauvegarder.

91

92

(% class="box infomessage" %)

93

(((

94

Si vous souhaitez conserver l'aide en ligne du wiki en plus de votre aide spécifique, copier-coller l'aide en ligne déjà disponible dans l'éditeur html avant de le modifier.

95

)))

96

97

(% class="wikigeneratedid" id="H200B200B200B200B200B200B200B200B200B200B200B200B200B200B" %)

98

[[image:1744364831120-598.png]]

99

100

(% class="wikigeneratedid" id="HSauvegardervotreaideenlignepersonnalisE9e" %)

101

Sauvegarder votre aide en ligne personnalisée

102

103

Parmi la foultitude de champs de toutes les tables, il vous sera difficile de savoir **quels sont les champs pour lesquels le musée à un protocole de saisie particulier**

104

105

Lors des changements de version, Flora veillera à ne pas écraser ces personnalisations en les récupérant par comparaison de dates de mise à jour de fichier.

106

107

Mais il serait pratique pour vous de créer un document traitement de texte dans lequel vous copie/collerez les contenus des champs personnalisés de chaque table.

108

109

Ce document sera la "mémoire" des spécificités de votre protocole de saisie, et pourra d'ailleurs être affiché sur la page d'accueil comme indiqué [[ici>>doc:2_Administration.Administration fonctionnelle.Documents de référence sur page d'aide.WebHome]]

110

111

112

(% class="wikigeneratedid" id="HComportementpardE9faut" %)

113

(% id="cke_bm_851S" style="display:none" %) (%%)Comportement par défaut

114

115

Lors d'un appel au menu "Afficher aide" Flora recherche d'abord le fichier html correspondant sur votre applicatif. Si cette recherche est infructueuse, Flora interroge le wiki dans un second temps.

116

117

Ainsi, les fichiers rédigés par les services du musée sont prioritaires sur ceux de Flora.

118

119

Que ce soit les pages html ou celle du wiki leur ouverture de fait au sein d'une pop-up. Si vous ne voyez pas de fenêtre s'ouvrir lors d'un appel au menu "Afficher aide", pensez à vérifier les autorisations accordées à Flora par votre navigateur. Voici des liens d'information sur ce sujet :

120

121

* (((

122

[[Firefox>>https://support.mozilla.org/fr/kb/parametres-exceptions-depannage-blocage-popup]]

123

)))

124

* (((

125

[[Safari >>https://support.apple.com/fr-fr/guide/safari/ibrwe2159f50/mac]]

126

)))

127

* (((

128

[[Chrome>>https://support.google.com/chrome/answer/95472?co=GENIE.Platform%3DDesktop&hl=fr]]

129

)))

130

* (((

131

[[Edge>>https://support.microsoft.com/fr-fr/help/17479/windows-internet-explorer-11-change-security-privacy-settings]]

132

)))

133

134

(% class="wikigeneratedid" id="HGestionlocaledespageshtmld27aide" %)

135

Gestion locale des pages html d'aide

136

137

L'accès à ces pages, en modification, suppression ou création, se fait avec un compte autorisé, dans l'espace de travail "Administration", Menu "Paramétrage Aides en ligne" :

138

139

140

[[image:1744363736609-747.png]]

)))

)))|(% style="width:300px" %)(((

145

(% class="box" %)