User Help (Compact 2013)

3/26/2014

Windows Embedded Compact 2013 does not include the Internet Explorer browser. Instead, a simple HTML Help Viewer with basic functionality is provided with the product. You can use this viewer to include Help files in your shell applications by modifying existing Help topics or creating new ones. To add this viewer to your OS, see User Help Catalog Items and Sysgen Variables.

The HTML Help Viewer supports three common scenarios:

  • An OEM can provide Help documentation for Windows Embedded Compact shell applications by creating new HTML Help files, or by modifying existing HTML Help files and then adding them to a run-time image.
  • An ISV can add HTML Help files to a Windows Embedded Compact project, and can provide access to this content by including the appropriate command bar functionality in the application code. For information about how to create and use command bars, see Command Bars Reference.
  • Device users can access existing Help topics by clicking or tapping the Help button on the application’s command bar.

The following figure shows a sample HTML file displayed in the Windows Embedded Compact HTML Help Viewer.

HTML Help Viewer Example

Ee484941.Caution(en-us,WinEmbedded.80).gifCaution:
Under certain circumstances, the HTML Help Viewer UI will incorrectly display the raw HTML code for the HTML file that you are trying to display. The viewer window may also display the path of the HTML file instead of the intended Help file title (for example, \\wcebrowser01\htmlhelp\word.htm instead of WordPad Help). If this occurs, just refresh the page by clicking or tapping the Refresh button on the toolbar, and HTML Help Viewer will display the correct Help file contents.

User Help Catalog Items and Sysgen Variables

Provides information about how to include support for the HTML Help Viewer in your OS.

User Help Application Development

Describes the shell Help files for applications.

Including User Help in an Application

Provides information about how to include Help files.

Show: