Creating Help using a Single File

Before you begin writing Help for one file, remember that:

Creating the Help File

All of the Help topics for an application are contained in a single file instead of many smaller files.

Each contents topic contains a list of jumps to other topics. Each topic must start with the <html> tag, end with the </html> tag, and contain two parts: the head and the body.

The head section starts with the <head> tag and ends with the </head> tag. The <head> tag should contain a <meta> tag that references the name of the contents file associated with this file. Unless you are nesting a set of help files within another set, this should be blank.

Each named section is separated with <!-- PegHelp --> as a separator between each of the sections, and before the first section.

When users view the contents, the Contents button is disabled. The tag for the list of topics is <menu> </menu>.

Help File Sample

The following is a sample file that contains multiple help topics. These sections are separated with the <!-- PegHelp --> separator between the sections. It contains the table of contents as well as the information.

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN">
<HTML>
<HEAD>
<META HTTP-EQUIV="Content-Type" Content="soltr.htp#solitaire_help">
<title>Solitaire Help</title>
</HEAD>
<BODY BGCOLOR=#FFFFFF TEXT=#000000>
<!-- PegHelp -->
<p>
<a name="solitaire_help"></a><b>Solitaire Help</b></p>
<p>
<a href="soltr.htp#playing_the_game">Playing the Game</a> </p>
<p>
<a href="soltr.htp#setting_solitaire_options">Setting Solitaire Options</a> </p>
<p>
<a href="soltr.htp#solitaire_scoring_systems">Solitaire Scoring Systems</a> </p>
<div align=right>
<a href="soltr.htp#playing_the_game"><img src="arrowr.2bp" border=0></a></div><br clear=all>
<!-- PegHelp -->
<a name="playing_the_game"></a><b>Playing the Game</b>
<ul>
<li>
To deal the cards, tap the <b>Deal</b> button.<br><br></li>
<li>
To display cards in the upper-left stack, tap the stack.</li>
<li>
To move a card to one of the row stacks, drag the card.</li>
<li>
In the row stacks, turn a card face up by tapping it.</li>
<li>
You win the game when all the cards are in the suit stacks.</li>
</ul>
<p>
<a href="soltr.htp#setting_solitaire_options">Setting Solitaire Options</a> </p>
<p>
<div align=right>
<a href="soltr.htp#solitaire_help"><img src="arrowl.2bp" border=0></a>&nbsp;
<a href="soltr.htp#setting_solitaire_options"><img src="arrowr.2bp" border=0></a>
</div><br clear=all>
<!-- PegHelp -->
<a name="setting_solitaire_options"></a><b>Setting Solitaire Options</b>
<ol>
<li>
Tap <b>Options</b>.</li>
<li>
(<b>Draw</b>) Specify whether you want to draw one card or three cards at a time.</li>
<li>
(<b>Scoring</b>) Select the type of scoring you want, if any.</li>
<li>
(<b>Card Back)</b> Select the deck style you want.</li>
<li>
Select the display options you want.</li>
</ol>
<p>
<a href="soltr.htp#playing_the_game">Playing the Game</a> </p>
<p>
<div align=right>
<a href="soltr.htp#playing_the_game"><img src="arrowl.2bp" border=0></a>
<!-- PegHelp -->
</BODY>
</HTML>