Plusieurs outils :
utiles pour constituer une Aide à l'utilisateur de notre programme :
Les Tooltip :
- Courtes séquences de texte qui se déclenchent quand la souris passe sur un contrôle qui permettent d'informer ou de décrire la fonction du contrôle.
Les Formulaires :
- Aide détaillée grâce à un formulaire ou un wizard, formulaire déjà pré-formaté, facile d'utilisation avec ses possibles, différentes pages :
Ils permettent d'insérer du texte et des images. Les incrustations de texte peuvent se faire de différentes
façons et sous différents
formats :
1°) Façons :
Typiquement pour ces incrustations de texte, on utilise des TextArea dont la propriété ReadOnly est à True, car on ne veut pas que l'utilisateur modifie quoi que ce soit :
1
| TextArea1. ReadOnly = TRUE
|
On peut incruster directement le texte dans ceux-ci grâce au code de notre programme et profiter, par là même d'une traduction possible grâce à l'IDE en entourant de parenthèses le texte à traduire.
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
| PUBLIC SUB Form_Open()
ME.Text = ("Aide de -") & Application.Title & ("- version : ") & Application.Version
TextArea5.Foreground = 1 '<------------------------------------' Menu Principal
Panel5.Layout = [65, 35]
Panel5.Expand = TRUE
TextArea5.Text = ("Le Menu Principal permet d'accéder à plusieurs sous-menus :"& "\n\n"
TextArea5.Text &= ("- Affichage :") & "\n"
TextArea5.Text &= (" Pour sélectionner une option d'affichage." & "\n\n"
TextArea5.Text &= ("- Design :") & "\n"
TextArea5.Text &= (" Pour choisir parmi les design possibles.") & "\n\n"
TextArea5.Text &= ("- Autres :") & "\n"
TextArea5.Text &= (" Pour accéder à d'autres choix."& "\n\n"
TextArea5.Text &= ("- Enregistrement :") & "\n"
TextArea5.Text &= (" Pour enregistrer vos choix avant la sortie.") & "\n\n"
TextArea5.Text &= ("-Aide :") & "\n"
TextArea5.Text &= (" Pour accéder à cette aide."& "\n\n"
TextArea5.Text &= ("- Sortie :") & "\n"
TextArea5.Text &= (" Pour quitter le programme.") & "\n"
TextArea5.ReadOnly = TRUE '<--------------------------------------' Menu Principal
TextArea5.pos = 0 '<----------------------------------------------' Menu Principal
TextArea5.EnsureVisible()
END
|
On peut, aussi créer des fichiers de texte séparés que l'on va charger dans chaque TextArea. (Il faudra penser à la traduction de chaque fichier, à l'aide d'un traducteur en ligne, par exemple)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
| PUBLIC SUB Form_Open()
DIM leText AS STRING
DIM i AS INTEGER
DIM cLangues AS String[] = ["fr", "it", "de"]
DIM labelText AS Variant[] = [TextArea1, TextArea2, TextArea3, TextArea4, TextArea5, TextArea6, TextArea7]
DIM panneau AS Variant[] = [Panel1, Panel2, Panel3, Panel4, Panel5]
ME.Text = ("Aide de -") & Application.Title & ("- version : ") & Application.Version
IF NOT cLangues.Exist(Left(System.Language, 2)) THEN
FOR i = 0 TO 6
leText = "./Aide/texte" & CStr(i + 1) & "-" & "fr" & ".txt"
labelText[i].Text = File.Load(leText)
labelText[i].ReadOnly = TRUE
labelText[i].pos = 0
labelText[i].EnsureVisible()
labelText[i].Foreground = 1
labelText[i].Font = Font["Noto Sans, 11,bold"]
labelText[i].Enabled = TRUE
NEXT
ELSE
FOR i = 0 TO 6
leText = "./Aide/texte" & CStr(i + 1) & "-" & Left(System.Language, 2) & ".txt"
labelText[i].Text = File.Load(leText)
labelText[i].ReadOnly = TRUE
labelText[i].pos = 0
labelText[i].EnsureVisible()
labelText[i].Foreground = 1
labelText[i].Font = Font["Noto Sans, 11,bold"]
labelText[i].Enabled = TRUE
NEXT
ENDIF
FOR i = 0 TO 4
Panneau[i].Layout = [66, 34]
Panneau[i].Expand = TRUE
Panneau[i].Enabled = TRUE
NEXT
TextArea3.Text &= ("Actuellement ") & " " & CStr(FMain.iNumImage + 1) & " " & (" design différents sont disponibles." & "\n"
END
|
2°) Formats :
- Fichier texte
1
2
3
| TextArea1.Text=("Le Texte à traduire ici"
'<----- ou si fichier séparé
TextArea1.Text = File.Load("leTextQuiVaBien.txt")
|
- Fichier Html
Il faudra penser à activer le WebKit et utiliser un WebView comme contrôle.1
| WebView1.Path = Application.Path &/ "aide.html"
|
- Fichier PDF
Le composant gb.pdf doit être activé et on pourra utiliser LibreOffice writer ou autre, pour produire les fichiers PDF nécessaires.
L'appel de l'aide
Se fait typiquement, par l'appui sur la touche F1 du
clavier ou par un
menu contextuel.
Par le clavier :
1
2
3
4
5
6
7
8
| PUBLIC SUB Form_KeyPress()
IF Key.code = Key.esc THEN ME.Close()
IF Key.Code = Key.F1 THEN FHelp.Show() '<-------------------------' Appel Aide par touche F1
IF Key.Code = Key.Help THEN FHelp.Show()
IF Key.Code = Key.Menu THEN ME.PopupMenu = "mnuContext"
END
|
Par un menu contextuel :
1
2
3
4
5
6
7
8
9
10
11
12
13
| PUBLIC SUB PictureBox1_MouseDown()
DIM hContext AS OBJECT
DIM hMenuItem AS OBJECT '<---------------------------------------' on peut les rendre Static Public
hContext = NEW Menu(ME) AS "mnuContext"
hMenuItem = NEW Menu(hContext) AS "mnuHelp" '<---------------' menu contextuel secondaire
hMenuItem.Text = ("Aide et À propos"
hMenuItem.Picture = Picture["icon:/32/help"]
hMenuItem.Action = "Aide" '<------------------------------------' Action à récupérer
hMenuItem.Shortcut = "F1"
ENDIF
|
====================
Navigation :
<-- Liens du Wiki : <--<-- Accueil du WIKI : <-- <-- Développement <--====================
La Documentation :
==============================