Monday, 28 July 2014

How to Build an Online Help Page in Microsoft Dynamics NAV 2013 R2



Online help page is a web page which displays information in a web browser when user presses the key F1 for the selected field or page in MS Dynamics NAV 2013 R2.

In this blog I will try to document the process of creating online help page for Microsoft Dynamics NAV 2013 R2 version, from creating online help topic to building the complied (html) help page and also how to integrate the help page into your project.
Prerequisites:

   ·    Microsoft Dynamics NAV 2013 R2 with a developer license.

   ·    The Cronus International Ltd. Demonstration database.

   ·    Microsoft Dynamics NAV Help Builder.

   ·    Microsoft Dynamics NAV Help Server.

   ·    HTML Help Workshop.

   ·    An HTML Editor, example: - Notepad.

Following steps illustrates the process of creating and building an online help page:

1. Setting up the Help Project Folder

                  Create a folder which contains a Source subfolder. The Source subfolder contains all project system files and source files that you will need to work with. After you compile the Help project for the first time, a subfolder named Processed is automatically created next to the Source subfolder to hold the built .chm files. You will find the html folder, under the Processed subfolder, which holds all of the .html files.

The HTML files contains online help topic which is displayed in web browser when user presses the key F1 for selected field in a page.

          I.   Create a folder named HelpExample on drive C of your computer.

         II.   Navigate to the Help Toolkit installation location, and then open the Samples folder. The installation is typically located at "C:\Program Files (X86)\Microsoft Dynamics NAV 2013 Help Toolkit"

        III.   Copy the addin_a and Shared folders to C:\HelpExample, these folders contain system files which will be used by Help Toolkit to generate .chm and .html files.

2. Creating New Help Topics and Adding Them to the Help Project

                Create the topics and add them to a Help project file that will output the .html file. If you are creating many new field topics under a table, then you can save time by using the Help Generator Tool. For more information, see http://msdn.microsoft.com/en-us/library/dn414543(v=nav.71).aspx.

Create a Help topic for the new table, field and page

         I.    In the windows Explorer, open C:\HelpExample\addin_a\Source\HTML folder and select T_9.htm file and open it with Notepad.

        II.   To display number and name of the table on the title bar of a web page, find the and replace the text with the ($ T_TableNumber TableName $) where TableNumber and TableName is number and name of the table to which you are creating help topic.

       III.   To display number and name of a page on the header of a web page, find the and replace the text with ($ T_TableNumber TableName $).