Skip to Content

Code source wiki de Documenter l’aide en ligne

Version 5.1 par Doriane Bautista le 2025/09/11 08:49
Afficher les derniers auteurs
1 (% class="mark small" %)**Version 4.5.54 et ultérieures**
2
3 |(% style="width:840px" %)(((
4 (% class="box" %)
5 (((
6
7 )))
8
9 (((
10
11 )))
12 )))|(% style="width:300px" %)(((
13 (% class="box" %)
14 (((
15 **Sommaire**
16 )))
17
18 (% class="box" %)
19 (((
20 **Aller plus loin**
21 )))
22
23 (% class="box" %)
24 (((
25 **Icônes principales**
26 )))
27
28 (((
29
30
31
32
33 )))
34 )))
35
36
37
38
39 = Définition =
40
41 Chaque champ des différentes tables de Flora peut être documenté. Pour beaucoup de champs, cette aide n'est pas nécessaire car leur libellé suffit à en comprendre le sens et l'usage. Mais pour d'autres, il est nécessaire d'en expliquer le type de contenu, dans quelles fonctions ou processus ils interviennent ou même de donner accès à des ressources externes définissant des problématiques métiers très précises. C'est le cas par exemple des champs spécifiques aux musées et documentés sur la base Joconde du Ministère de la Culture.
42
43 Decalog a mis en place un nombre important de ces aides en ligne, désormais présentes sur ce wiki. Ce travail, toujours perfectible, est en perpétuelle progression.
44
45 Par ailleurs, l'institution utilisatrice de Flora peut être amenée à redéfinir ou préciser, selon ses besoins internes, ces aides. Cela peut être fait dans le cadre d'une charte de saisie, par exemple.
46
47 L'accès à ces aides se fait champ par champ, par un simple clic droit sur le libellé du champ, via le menu "Afficher aide" :
48
49 [[image:1744363045589-792.png]]
50
51
52 Non seulement les champs, mais aussi les blocs de champs peuvent être documentés :
53
54 Exemple avec le bloc DATE_UTILISATION :
55
56 [[image:1744363311261-338.png]]
57
58 Aide en ligne du champs Numéro d'inventaire :
59
60 [[image:1744363337995-749.png||data-xwiki-image-style-alignment="center"]]
61
62 Il est ainsi tout à fait possible de décrire très concrètement l'ensemble des zones de saisies des différentes tables de Flora.
63
64 Les aides en ligne de Flora ont deux supports possibles :
65
66 * le wiki sur lequel vous êtes actuellement
67 * des fichiers html présents sur votre applicatif Flora
68
69 == Comportement par défaut ==
70
71 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.
72
73 Ainsi, les fichiers rédigés par les services du musée sont prioritaires sur ceux de Flora.
74
75 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 :
76
77 * [[Firefox>>https://support.mozilla.org/fr/kb/parametres-exceptions-depannage-blocage-popup]]
78 * [[Safari >>https://support.apple.com/fr-fr/guide/safari/ibrwe2159f50/mac]]
79 * [[Chrome>>https://support.google.com/chrome/answer/95472?co=GENIE.Platform%3DDesktop&hl=fr]]
80 * [[Edge>>https://support.microsoft.com/fr-fr/help/17479/windows-internet-explorer-11-change-security-privacy-settings]]
81
82 == Gestion locale des pages html d'aide ==
83
84 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" :
85
86
87 [[image:1744363736609-747.png||data-xwiki-image-style-alignment="center"]]
88
89
90 == Connaître le nom d'un champ Flora ==
91
92 Pour retrouver le fichier d'aide en ligne à renseigner, il faut connaitre le nom informatique du champ concerné.. Par exemple, en musée, le champ "numéro d'inventaire" de la table des biens (MUS_BIEN) se nomme NUM_INVENTAIRE.
93
94 [[image:1744363912649-947.png||data-xwiki-image-style-alignment="center"]]
95
96 Afin de connaître ce nom, il suffit d'aller sur une grille de saisie concernée et de survoler le libellé de l'élément à documenter
97
98 Vous pouvez également le trouver en allant dans le menu contextuel "Afficher informations" présent sur ce libellé (accès par un clique droit). Cette méthode permet d'en copier la valeur. Il est conseillé de le copier afin de le retrouver facilement par la suite.
99
100 [[image:1744363948510-224.png]]
101
102 = [[image:1744363968204-295.png]] =
103
104 = Modifier le fichier d'aide =
105
106 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.
107
108 [[image:1744364271216-799.png]]
109
110 Cliquer sur le [[image:1744364312163-238.png]] de l'Aide à la saisie pour déplier la liste des fichiers.
111
112 [[image:1744364340925-762.png||data-xwiki-image-style-alignment="center"]]
113
114 (% class="wikigeneratedid" %)
115 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.
116
117 [[image:1744364568000-243.png||data-xwiki-image-style-alignment="center"]]
118
119 (% class="wikigeneratedid" %)
120 Cliquer sur le nom informatique du champ afin d'ouvrir l'éditeur html, puis saisir votre texte et cliquer sur sauvegarder.
121
122 (% class="box infomessage" %)
123 (((
124 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.
125 )))
126
127 (% class="wikigeneratedid" id="H200B200B200B200B200B200B200B200B200B200B200B200B200B200B" %)
128 [[image:1744364831120-598.png]]​​​​​​​​​​​​​​
129
130 = Sauvegarder votre aide en ligne personnalisée =
131
132 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**
133
134 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.
135
136 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.
137
138 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]]