Comment : afficher l'aide utilisateur

Article
08/21/2008

Mise à jour : novembre 2007

Le .NET Compact Framework permet d'accéder au programme d'aide de Windows CE, peghelp.exe, afin d'afficher des rubriques d'aide pour les applications Pocket PC. Vous pouvez afficher une rubrique d'aide avec la méthode ShowHelp de la classe Help Windows Forms qui répond à l'événement HelpRequested et utiliser HelpEventArgs. Le .NET Compact Framework ne prend pas en charge l'énumération HelpNavigator ou la classe HelpProvider.

Les rubriques d'aide peuvent se trouver dans un ou plusieurs fichiers .htm. Les fichiers HTML compilés, ou .chm, ne sont pas pris en charge sur Pocket PC. L'événement HelpRequested est reçu par le formulaire actif lorsque l'utilisateur accède au menu Démarrer et choisit Aide. L'événement n'est pas déclenché par les contrôles du formulaire.

L'aide n'est pas intégrée au système d'exploitation Smartphone, car les applications Smartphone doivent être simples.

Le tableau suivant répertorie les fonctionnalités d'aide du système qui s'affichent pour chaque rubrique.

Élément de menu	Fonction
Affichage	Permet d'accéder à la commande Sommaire qui affiche le premier niveau de contenu du fichier d'aide actuel, et à la commande Toute l'aide installée qui affiche la liste de tous les fichiers d'aide installés.
Précédente	Affiche la rubrique précédente dans la session actuelle.
Suivante	Affiche la rubrique suivante dans l'historique.
Rechercher	Ouvre la boîte de dialogue Rechercher pour effectuer une recherche par mots clés dans les rubriques d'aide. Vous pouvez spécifier des mots clés dans les fichiers .htm.

Les procédures ci-dessous montrent comment effectuer les opérations suivantes :

Créer un fichier .htm de rubriques d'aide
Afficher l'aide pour votre application
Installer votre fichier d'aide sur le périphérique

Pour créer un fichier .htm de rubriques d'aide

Créez un fichier texte destiné à l'aide, doté d'une extension .htm. Cette procédure crée l'aide d'un jeu nommé Critters (Créatures) à titre d'exemple. La balise META contenue dans l'en-tête du fichier doit être comme suit :
```
<HTML>
<HEAD>
<META HTTP-EQUIV="Htm-Help" Content="Critters.htm#main_contents">
```
La première rubrique de chaque fichier d'aide doit être intitulée "main_contents".

Ajoutez des mots clés pour le programme Rechercher. Séparez les mots clés par des points-virgules. Ajoutez des balises de mot clé supplémentaires pour accéder à des rubriques spécifiques, si nécessaire.

<KEYWORD VALUE="Critters;Games" TITLE="Critters Help" 
  HREF="Critters.htm#main_contents">
<KEYWORD VALUE="Critters overview" TITLE="Critters Help" 
  HREF="Critters.htm#overview">
<KEYWORD VALUE="Critters options" TITLE="Critters Help" 
  HREF="Critters.htm#options">

Il n'y a aucune limite maximale de mots clé par rubrique.

Créez la rubrique main_contents. Chaque rubrique, y compris main_contents, doit être précédée de la balise de commentaire suivante :
```

```
La rubrique main_contents contient généralement des liens d'accès à des sous-rubriques. Notez que les liens nécessitent le nom de fichier en plus du nom d'ancre.
```
</head>
<body>

<a name="Main_Contents"></a>
Critters Help

<a href="critters.htm#overview">Game Overview</a> 
<a href="critters.htm#options">Options</a> 
```
Vous pouvez ajouter des graphismes, mais uniquement des images bitmap qui doivent être renommées pour avoir une extension "2pb".
```
<img src="critter.2bp">
```
Créez des rubriques supplémentaires.

Voici un exemple de code HTML entre deux rubriques :
```



<hr>
<a name="overview">
```
Enregistrez le fichier et copiez-le dans le répertoire Windows de Pocket PC.

Le code HTML complet de cet exemple est le suivant :

<html>
<head>
<META HTTP-EQUIV="Htm-Help" Content="critters.htm#Main_Contents">
<KEYWORD VALUE="Critters;Games" TITLE="Critters Help" 
  HREF="Critters.htm#main_contents">
<KEYWORD VALUE="Critters overview" TITLE="Critters Help" 
  HREF="Critters.htm#overview">
<KEYWORD VALUE="Critters options" TITLE="Critters Help" 
  HREF="Critters.htm#options">
</head>
<body>
<!-- PegHelp -->
<p>
<a name="Main_Contents"></a>
</p>
<b>Critters Help</b>
</p>
<p>
<a href="critters.htm#overview">Game Overview</a><br>
<a href="critters.htm#options">Game Options</a><br>
<img src="critter.2bp">
</p>
<!-- PegHelp -->
<!-- ******* TOPIC BREAK ******* -->
<hr>
<a name="overview"></a>
<p><b>Game Overview</b></p>
<p>Critters are small round creatures that you can adopt and raise.  
  They have various moods and characteristics and each one has its own 
  personality and appearance that will change over time.</p>
<!-- PegHelp -->
<!-- ******* TOPIC BREAK ******* -->
<hr>
<a name="options"></a>
<p><b>Options</b></p>
<ul>
<li><i>Sound</i> – Turn sound on / off</li>
<li><i>Sub-Games</i> – Turn sub-games on / off.  When a caretaker 
  attempts to play with a critter or teach a critter, sub-games are 
  presented such as ‘Guess my number’ and ‘Trivia’ if this option is 
  checked.</li>
<li><i>Animation</i> – Turn animation on / off.  Turning this off will 
  cause the critter to remain still.</li>
<li><i>Notifications</i> – Choose icon / text / none.  Notifications 
  appear to inform you when your critter is in danger of dying due to 
  a particular need not being met.</li>
<li><i>Speed</i> – This is the rate at which the game engine operates.
  It affects how fast feelings develop and statistics are 
  modified.</li>
</ul>
</p>
</body>
</html>

Remarque :
Lorsque vous travaillez avec des fichiers d'aide, une version antérieure de l'aide peut se trouver dans le cache, ce qui vous empêche d'afficher les mises à jour les plus récentes. Pour actualiser l'aide, affichez une rubrique d'aide différente de celle sur laquelle vous travaillez, puis affichez-la de nouveau.

Pour afficher l'aide pour votre application

Pour afficher l'aide sur Pocket PC, appuyez sur la commande Aide dans le menu Démarrer. Windows CE affiche la rubrique d'aide de l'application actuellement affichée, à condition que vous ayez appelé la méthode ShowHelp en réponse à l'événement HelpRequested.

Vous pouvez également utiliser ShowHelp pour appeler l'aide à partir de votre application, par exemple en cliquant sur un bouton. L'exemple suivant montre comment appeler l'aide dans les deux cas. Notez que le premier paramètre de la méthode ShowHelp est le contrôle parent. Ce paramètre n'est pas utile pour Pocket PC, mais est fourni pour assurer la compatibilité avec le .NET Framework complet.

Protected Overrides Sub OnHelpRequested(ByVal hlpevent As HelpEventArgs) 
    ' The HelpRequested event occurs when
    ' the user taps Help on the Start menu.
    Help.ShowHelp(Me, "\windows\myAppHelp.htm#Main_Contents")
    MyBase.OnHelpRequested(hlpevent)

End Sub
Private Sub button1_Click(ByVal sender As Object, ByVal e As System.EventArgs) _
    Handles button1.Click
    ' You can also show Help
    ' for a subtopic
    ' by clicking a button.
    Try
        Help.ShowHelp(Me, "\windows\myappHelp.htm#overview")
    Catch ex As Exception
        MessageBox.Show(ex.Message)
    End Try
End Sub

protected override void OnHelpRequested(HelpEventArgs hlpevent)
{
    // The HelpRequested event occurs when
    // the user taps Help on the Start menu.
    Help.ShowHelp(this,@"\windows\myAppHelp.htm#Main_Contents");
    base.OnHelpRequested(hlpevent);
}

private void button1_Click(object sender, System.EventArgs e)
{
    // You can also show Help
    // for a subtopic
    // by clicking a button.
    try
    {
        Help.ShowHelp(this,@"\windows\myappHelp.htm#overview");
    }
    catch (Exception ex)
    {
        MessageBox.Show(ex.Message);
    }
}

Pour installer votre fichier d'aide sur le périphérique

Créez un fichier de raccourci pour le système d'aide afin de répertorier votre aide avec l'autre aide installée sur le système. Dans un éditeur de texte, créez un fichier contenant le chemin d'accès à votre aide en utilisant la syntaxe suivante :
```
14#\windows\critters.htm
```
Le chemin d'accès est précédé par le nombre de caractères contenus dans le chemin et par le signe dièse (#). Ceci doit être la seule ligne du fichier. Dans cet exemple, l'aide du jeu Critters est affichée.
Enregistrez le fichier en utilisant le même nom que votre aide, mais avec l'extension .lnk, dans le dossier \Windows\Help.
Appuyez sur Aide dans le menu Démarrer. Si votre aide n'est pas déjà affichée, choisissez Toute l'aide installée dans le menu Affichage. Votre aide doit être incluse dans la liste, dans l'ordre alphabétique.

Partager via

Comment : afficher l'aide utilisateur

Pour créer un fichier .htm de rubriques d'aide

Pour afficher l'aide pour votre application

Pour installer votre fichier d'aide sur le périphérique

Voir aussi

Concepts

Autres ressources

Ressources supplémentaires