Including User Help in an Application (Compact 2013)
3/26/2014
You can provide Help files for Windows Embedded Compact shell applications by creating new Help files or by modifying existing HTML Help files and then adding them to your run-time image. Providing Help for the applications that you include on your target device helps enable users to be successful using your product. A detailed explaination of how to create Help files is beyond the scope of this documentation.
Shell help topics are displayed through your Windows Embedded Compact-based OS using HTML files and the provided HTML Help Viewer. Existing Help topics are accessed by clicking or tapping the Help button on the application's command bar. Existing topics can be modified to fit your shell.
To provide access to new Help topics created for your applications:
- Create or modify the content you want to display. For more information, see User Help File Modification and User Help Topic Template.
- Add the HTML files to your project. To do this, modify the .bib file to copy the Help file to the \Windows\Help folder on the target device. For more information, see Binary Image Builder (.bib) File.
- Provide access to the content by including the appropriate command bar functionality in your application code. For more information, see Command Bars Reference.
Note
Modifying included HTML Help source files is subject to the Microsoft Software License Terms. To understand the rights you have to a specific source code file, review the copyright header of each file. For a copy of the license terms, see the LICENSE.RTF on your installation media.