Cómo: Mostrar la Ayuda al usuario

Artículo
10/07/2008

Actualización: noviembre 2007

.NET Compact Framework proporciona acceso al programa Ayuda de Windows CE, peghelp.exe, para mostrar los temas de Ayuda correspondientes a las aplicaciones de Pocket PC. Se puede mostrar un tema de Ayuda con el método ShowHelp de la clase Help de formularios Windows Forms que responde al evento HelpRequested y el uso de HelpEventArgs. .NET Compact Framework no admite la enumeración HelpNavigator ni la clase HelpProvider.

Los temas de Ayuda se pueden buscar en uno o más archivos .htm. Pocket PC no admite archivos .chm o HTML compilados. El evento HelpRequested es recibido por el formulario activo cuando el usuario navega hasta el menú Inicio y elige Ayuda. El evento no es provocado por los controles del formulario.

La Ayuda no está integrada en el sistema operativo de Smartphone porque las aplicaciones de Smartphone deben ser simples.

La tabla siguiente muestra las características de Ayuda del sistema que se muestran para cada tema.

Elemento de menú	Función
Ver	Proporciona acceso al comando Contenido que muestra el primer nivel de contenido para el archivo de Ayuda actual, y al comando Toda la Ayuda instalada que muestra una lista de todos los archivos de Ayuda instalados.
Atrás	Muestra el tema visto anteriormente en la sesión actual.
Adelante	Muestra el tema siguiente del historial.
Buscar	Abre el cuadro de diálogo Buscar para buscar temas de Ayuda mediante palabras clave. Se pueden especificar palabras clave en los archivos .htm.

Los procedimientos siguientes muestran la forma de realizar las acciones siguientes:

Crear un archivo .htm de los temas de la Ayuda
Mostrar la Ayuda de la aplicación
Instalar los archivos de la Ayuda en el dispositivo

Para crear un archivo .htm de temas de Ayuda

Cree un archivo de texto con nombre para la Ayuda y con la extensión .htm. Este procedimiento crea la Ayuda para un juego, denominado Critters, como ejemplo. El archivo debe tener la etiqueta META en el encabezado como se muestra a continuación:
```
<HTML>
<HEAD>
<META HTTP-EQUIV="Htm-Help" Content="Critters.htm#main_contents">
```
El primer tema de cada archivo de Ayuda se debe denominar "main_contents".

Agregue palabras clave para el programa Buscar. Separe las palabras clave con puntos y coma. Agregue etiquetas de palabras claves adicionales para establecer vínculos con temas específicos, según sea necesario.

<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">

No hay un límite máximo de palabras clave para un tema.

Cree el tema main_contents. Cada tema, incluido el tema main_contents, debe ir precedido por la etiqueta de comentario siguiente:
```

```
El tema main_contents contiene normalmente vínculos a subtemas. Observe que los vínculos requieren el nombre de archivo además del nombre de delimitador.
```
</head>
<body>

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

<a href="critters.htm#overview">Game Overview</a> 
<a href="critters.htm#options">Options</a> 
```
Se pueden agregar gráficos, pero sólo mapas de bits a los que se debe cambiar el nombre para que tengan una extensión "2pb".
```
<img src="critter.2bp">
```
Cree temas adicionales.

A continuación se muestra un ejemplo del código HTML entre dos temas:
```



<hr>
<a name="overview">
```
Guarde el archivo y cópielo en el directorio de Windows de Pocket PC.

El código HTML completo para este ejemplo es el siguiente:

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

Nota:
Cuando se trabaja con archivos de Ayuda, es posible que la caché tenga una versión anterior de la Ayuda, impidiendo que se puedan ver las últimas actualizaciones. Para actualizar, muestre un tema de Ayuda que no sea el tema en que esté trabajando y, a continuación, muestre de nuevo la Ayuda.

Para mostrar la Ayuda para la aplicación

Para mostrar la Ayuda en Pocket PC, puntee el comando Ayuda en el menú Inicio. Windows CE mostrará el tema de Ayuda correspondiente a la aplicación que se muestra actualmente, con tal de que se haya llamado al método ShowHelp en respuesta al evento HelpRequested.

También se puede utilizar ShowHelp para llamar a la Ayuda desde la aplicación; por ejemplo, mediante un clic de botón. En el ejemplo de código siguiente se muestra la forma de llamar a la Ayuda en ambos casos. Observe que el primer parámetro para el método ShowHelp es el control primario. Este parámetro no es relevante para Pocket PC, pero se proporciona para que haya compatibilidad con .NET Framework completo.

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);
    }
}

Para instalar el archivo de Ayuda en el dispositivo

Cree un archivo de acceso directo para que el sistema de Ayuda muestre la Ayuda con la otra Ayuda instalada en el sistema. En un editor de texto, cree un archivo con una ruta de acceso a la Ayuda utilizando la sintaxis siguiente:
```
14#\windows\critters.htm
```
La ruta de acceso va precedida del número de caracteres que contiene y del signo de número (#). Esta debe ser la única línea del archivo. En este ejemplo, se muestra la Ayuda para el juego denominado Critters.
Guarde el archivo utilizando el mismo nombre que la Ayuda pero con una extensión .lnk en la carpeta \Windows\Ayuda.
Puntee Ayuda en el menú Inicio. Si no se muestra la Ayuda, elija Toda la Ayuda instalada en el menú Ver. La Ayuda se debe incluir alfabéticamente en la lista.

Cómo: Mostrar la Ayuda al usuario

Para crear un archivo .htm de temas de Ayuda

Para mostrar la Ayuda para la aplicación

Para instalar el archivo de Ayuda en el dispositivo

Vea también

Conceptos

Otros recursos

Recursos adicionales