User Help File Modification (Windows Embedded CE 6.0)
1/6/2010
Shell Help files are available for several user applications, including standard control panels, RDP, Windows Messenger, WordPad, and a variety of pocket viewers.
The source code for these help files are in the Public directories for each application type.
The SYSGEN_HELP and either the SYSGEN_IE or the SYSGEN_IESAMPLE variables must be included in the build image to display help files.
If help files for user interface applications are included in the image without the appropriate Sysgen variable, a runtime message is displayed stating that the code routines necessary for displaying Help could not be found.
To include the existing Shell Help files in a run-time image, you must modify the .bib file to copy the Shell Help files to the \Windows\Help folder on the target device. For more information about .bib files, see Binary Image Builder File.
To create or modify shell help topics, you can use most of the HTML tags supported by Internet Explorer 6.
The use of scripting, Dynamic HTML (DHTML), and Extensible Markup Language (XML) are not supported in these files.
Some HTML tags are required to properly display help topics using the Windows Embedded CE Help viewer. For example, to set each help topic apart from the rest of the content, the following code must be added to the end of each topic:
<BR><!-- PegHelp --><HR>
<!-- ************************Topic Break************************* -->
If this code is not used to separate individual topics, all help topics in the file are displayed contiguously. For more information, see Shell Help Topic Template.
You can also add support for displaying User Help topics from a .NET Compact Framework application. To do this, you can call the Help.ShowHelp function from the code in an OnClick event handler. For more information, see Help.ShowHelp.
Note
To understand the rights that you have to a specific source code file, review the copyright header of each file or review the Shared Source License Terms at the Shared Source Initiative Home Page.
See Also
Reference
Concepts
Including User Help in an Application
User Help Topic Template