User Help File Modification (Compact 2013)
3/26/2014
Shell Help files are available for several user applications. The source code for these Help files are in the Public directories for each application type. For more information, see Location of Shell Help Files
The SYSGEN_HELP variable must be included in the build image to display Help files. If Help files for 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 (.bib) File.
To create or modify shell Help topics, you can use most of the standard HTML tags supported by browsers such as Internet Explorer. The use of scripting, Dynamic HTML (DHTML), and XML are not supported in these files.
Some HTML tags are required to correctly display help topics using the HTML 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 User Help Topic Template.
You can also add support for displaying 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.