What's New in Microsoft Dynamics NAV Help Guide

With the introduction of the Microsoft Dynamics NAV 2013 R2 Help Server, this Help Guide has been updated to reflect new work processes. The Help Toolkit used in this Help Guide is the version released with Microsoft Dynamics NAV 2013. The Microsoft Dynamics NAV Help Toolkit 2013 can be downloaded from PartnerSource (requires PartnerSource logon).

Good to know before getting started

Now that the Help for Microsoft Dynamics NAV is based on HTML files, the way that you create Help solutions changes. This section outlines a number of things that you should know before getting started.

Important

Microsoft Dynamics NAV no longer uses .chm files. You can still use .chm files that are generated using Help Builder, but these are no longer context-sensitive. This Microsoft Dynamics NAV Help Guide only describes how to work with HTML files.

  • Use HTML files, optionally HTML files that are generated by Help Builder and deploy these by adding them to the specific language folder on your Help server. To make your Help look like the Microsoft Dynamics NAV Help, use the classic.css file to style your HTML files. For more information, see Help Topic Formatting.

  • For the Microsoft Dynamics NAV release of Help Server, the table of contents is coded in a ToC.xml file. To include new Help topics in the table of contents, this ToC.xml file must be edited manually.

  • We recommend that you use Help Generator to generate object reference for the following reasons:

    • The object reference topics are named correctly for context-sensitivity to work.

    • The formatting of the object reference topics will be similar to the Microsoft Dynamics NAV Help.

  • Using Help Builder to generate .htm files will still provide you with a number of advantages, such as replacing object tokens from the object string file. For more information, see Building Help.

  • Context-sensitivity is decided by topic names alone, so naming is crucial to get F1 Help to work. For more information, see Help Topic File Names.

  • Since all Help is online, we recommend that you work in a local folder when editing Help files and then upload the files after you are done editing.

See Also

Tasks

Walkthrough: Creating and Building a New Help Topic
Walkthrough: Customizing an Existing Help Project
How to: Create the Object String File

Concepts

Help Debug Window