HOW TO：顯示使用者說明

發行項
08/21/2008

更新：2007 年 11 月

.NET Compact Framework 提供 Windows CE Help 程式 (peghelp.exe) 的存取，以顯示 Pocket PC 應用程式的說明主題。您可以使用會回應 HelpRequested 事件之 Windows Form Help 類別的 ShowHelp 方法來顯示說明主題，以及使用 HelpEventArgs。.NET Compact Framework 不支援 HelpNavigator 列舉型別或 HelpProvider 類別。

說明主題可以位於一個或多個 .htm 檔中。Pocket PC 不支援已編譯的 HTML 或 .chm 檔。當使用者巡覽至 [開始] 功能表並選擇 [說明] 時，目前使用中的表單會收到 HelpRequested 事件。這個事件不是由表單上的控制項所引發的。

[說明] 不會整合至 Smartphone 作業系統，因為 Smartphone 應用程式的設計應該是相當簡單的。

下表列出針對每一個主題所顯示的系統說明功能。

功能表項目	功能
檢視	提供 [內容] 命令的存取，這個命令會顯示目前說明檔的第一層內容，以及提供 [所有已安裝的說明] 命令的存取，這個命令則會顯示所有已安裝的說明檔清單。
上一頁	顯示目前工作階段中所檢視的上一個主題。
下一頁	顯示記錄清單中的下一個主題。
尋找	開啟 [尋找] 對話方塊，按照關鍵字搜尋說明主題。您可以在 .htm 檔中指定關鍵字。

下列程序顯示如何執行下列作業：

建立說明主題的 .htm 檔
顯示您的應用程式的說明
在裝置上安裝說明檔

若要建立說明主題的 .htm 檔

建立副檔案名為 .htm 的說明文字檔。這個程序會建立名為 Critters 的遊戲說明檔，做為範例。這個檔案的標頭必須有 META 標記，如下所示：
```
<HTML>
<HEAD>
<META HTTP-EQUIV="Htm-Help" Content="Critters.htm#main_contents">
```
每個說明檔的第一個主題都必須命名為 "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">

主題沒有最大關鍵字限制。

建立 main_contents 主題。每一個主題 (包括 main_contents) 的前面都必須有下列註解標記：
```

```
main_contents 主題通常包含子主題連結。請注意，除了錨定名稱之外，連結還需要檔案名稱。
```
</head>
<body>

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

<a href="critters.htm#overview">Game Overview</a> 
<a href="critters.htm#options">Options</a> 
```
您可以加入圖形，但只限點陣圖，而且必須重新命名，以具有 "2pb" 副檔名。
```
<img src="critter.2bp">
```

建立額外的主題。

底下是兩個主題之間的 HTML 範例：

</p>
<!-- PegHelp -->
<!-- ******* TOPIC BREAK ******* -->
<hr>
<a name="overview">

儲存檔案並將它複製至 Pocket PC 的 Windows 目錄。

這個範例的完整 HTML 如下：

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

注意事項：
使用說明檔時，您可能會因為舊版的說明檔仍在快取區中，而無法看到最新的更新。若要重新整理，請顯示不是您正在使用的說明主題，然後重新顯示說明。

若要顯示應用程式的說明

若要顯示 Pocket PC 上的說明，請點選 [開始] 功能表上的 [說明] 命令。如果您已呼叫 ShowHelp 方法來回應 HelpRequested 事件，則 Windows CE 會顯示目前顯示之應用程式的說明主題。

您也可以使用 ShowHelp，從應用程式內呼叫說明，例如按一下按鈕。下列程式碼範例會顯示如何為這兩種情況呼叫說明。請注意，ShowHelp 方法的第一個參數是父代控制項。這個參數與 Pocket PC 無關，但是仍必須存在，才能夠與 .NET Framework 完全相容。

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

若要在裝置上安裝說明檔

建立說明系統的捷徑檔案，列出您的說明和系統中其他已安裝的說明。在文字編輯器中，使用下列語法，以您的說明路徑建立檔案：
```
14#\windows\critters.htm
```
路徑之前是路徑中的字元數和數字符號 (#)。這應該是檔案中唯一的一行。在這個範例中，會顯示 Critters 遊戲的說明。
使用與您說明相同的名稱 (副檔名為 .lnk)，並將檔案儲存在 \Windows\Help 資料夾中。
從 [開始] 功能表點選 [說明]。如果未出現說明，請從 [檢視] 功能表選擇 [所有已安裝的說明]。您的說明應該按字母順序併入清單中。

HOW TO：顯示使用者說明

若要建立說明主題的 .htm 檔

若要顯示應用程式的說明

若要在裝置上安裝說明檔

請參閱

概念

其他資源

其他資源