 Filter by title Is this page

Microsoft
Documentation Ignite
Join us November 2–4, 2021 for our digital experience, including the latest
product demos, Q&A with Microsoft experts, technical deep-dives, and more. Register now Ｔ
helpful?
How to: Create a Help All skill levels welcome!  Yes  No
November 2–4, 2021 | Free digital event
Document using a Template
In this article
How to: Create Table of
Contents Entries Docs Documentation Learn Q&A Code Samples  Search See also Sign in
How to: Create a Non-HTML
Content
Dynamics 365Element
Get Dynamics 365 Release plans Support Ｓ Regional availability Trust Center AppSource
How to: Add Labels, Fields, and
Microsoft Dynamics
Menu AXa2012
Items to Developer Library / Help System / Writing Documentation for the Help System /
Content  Save Ｄ Feedback ／ Edit

How to:Element
Create a Help Document using a Template ＋ Share

How to: Add a Link to a

Content Element

How to: Add a Collapsible and

How to: Create a Help Document
Expandable Section

How to: Replace Help

using a Template
08/03/2018 • 6 minutes to read •
Documentation
Ｔ Publishing Documentation to the Applies To: Microsoft Dynamics AX 2012 R2, Microsoft Dynamics AX 2012 Feature Pack, Microsoft
Help System Dynamics AX 2012
Ｔ Document Property Metadata
This topic describes how to use a template to create new Help documentation that you can
Reference
publish to the Help server. Each template includes the basic components of a content element
Microsoft Dynamics AX IDE
and helps you focus on the information that is unique to your Help documentation. The following
Ｔ

table specifies the types of templates:

Template Description
type

HTML The HTML templates help you create documentation that appears in the Help viewer. The
HTML templates help you produce a content element that uses the same style and
resources as the existing Help documentation. To use an HTML template, you have to
have an HTML or text editor that can open and save .htm files.

Microsoft The Word template helps you use Word 2007 or a later version to create documentation.
Word The Word template offers the flexibility to create new types of Help documentation or
add existing documentation to the Help server. In addition, you can use the template to
automatically create the HTML file that is required to publish a Word document on the
Help server.

The following sections provide information about how to use each type of template to produce
Help documentation:

To Use the Word Template to Create a Content Element

To Use an HTML Template to Create a Content Element

To Use the Word Template to Create a Content

Element
1. Open the Microsoft Dynamics AX Help viewer. Type Templates for Help Documentation in
the Search Help field, and then press ENTER. The specified topic appears in the Help viewer.

2. In the Help viewer, find the table that contains the Word template, and then click the name
of the template. The template opens on your computer. For example, click Dynamics Help
Content Template.docm to open that template. The template opens using the default
program associated with the .docm file type on your computer.

If you are prompted to select a program for the template, specify that Word 2007 or a later
version. Word might notify you that the document includes macros and that the macros are
currently disabled. Use Word to enable macros for this document.

２ Warning

If you do not enable macros, you will not be able to use the template to produce the
HTML file that contains the document properties for the content element.

3. In Word 2007, click the Office button and then click Save As. In Word 2010, click File and
then click Save As. In the Save As window, specify the folder where you want to save the
file, enter a name for the file, click .docm in the Save as type list, and then click Save.

Word saves the file in the specified folder. In addition, the template automatically creates
and saves two files that have the same name. The following table shows the types of files
that are created:

File extension Description

.docm The Word file that you use to create a Help document.

.htm An HTML file that contains the document properties for the Word document.

.mht An HTML file that saves the Word document as a webpage.

4. Use Word to add the title, headings, paragraphs, and other documentation to the template.
You can enter the text into the template or cut documentation from an existing document
and paste it into the template.

5. Click the Dynamics Help tab. The following table lists the Required Properties that must be
populated with values:

Name Description

Title Specify the text you want to display for this documentation when it appears in a list
of search results or a summary page.

Topic ID Specify a value that identifies the topic associated with this content element. If you
specify more than one ID, use semicolons to separate each entry.

Language Select a language from the drop-down list.

6. Populate the Optional Properties for your document. Supply values for the properties in the
following table that apply to your document:

Name Description

Publisher ID Specify the ID of the publisher of the document.

Hide Specify one or more publisher IDs. Separate each publisher ID value with a
Publishers semicolon.

Keywords Specify one or more search keywords associated with the documentation.
Separate each keyword with a semicolon.

7. Verify that the Automatically Save Properties check box is selected. This ensures the values
in the document properties boxes are saved to the .htm file every time that you save the
Word document.

8. Verify that the Save As Webpage check box is selected. This guarantees that the .mht
webpage file is created or updated every time that you save the Word document.

9. To save the document, click Save in the Quick Access toolbar. The .docm file, the .html file,
and the .mht file are saved in the folder that you specified earlier.

To Use an HTML Template to Create a Content

Element
1. Press F1 to open the Help viewer. Type Templates for Help Documentation in the Search
Help field, and then press ENTER. The specified topic appears in the Help viewer.

2. In the Help viewer, find the table that lists the HTML templates. Click the name of the
template you want to use. For example, if you want to create documentation that
introduces a new component, click ConceptualTemplate.htm.

） Important

The template opens using the default program associated with the .htm file type on
your computer. If the template opens in a Web browser, you might have to save the
template file to your computer so that you can open the file by using an HTML or text
editor.

3. To create the file for the content element, click the Save As option of the HTML or text
editor, specify the name for the file, specify that the file type as .htm or .html, and then click
Save. An .htm or.html file that uses the specified file name is created.

4. Use the HTML editor to find the meta elements for the document properties. You have to
specify a value for the content attribute for the following elements:

Name Description

documentSets Type UserDocumentation.

Microsoft.Help.Id Specify a value that uniquely identifies this content element. To ensure the ID
is unique, you might want to use a GUID.

Microsoft.Help.F1 Specify a value that identifies the topic associated with this content element.
If you enter more than one ID, use semi-colons to separate each entry.

ms.locale Select a language from the drop-down list.

Title Specify the text you want to display for this documentation when it appears
in a list of search results or a summary page.

5. Specify values for the optional document properties that apply to your content element.
Use the HTML editor to populate the content attribute for the following document
properties that apply to your documentation:

Name Description

description Provide text that summarizes the information in the content element.

publisher Specify the ID that identifies the publisher of the document.

suppressedPublishers Enter one or more publisher IDs. Separate each publisher ID value
with a semicolon.

Microsoft.Help.Keywords Specify one or more search keywords associated with the

documentation. Separate each keyword with a semicolon.

6. Use the HTML editor to find the link, script, and img elements. Verify that the src attribute of
each element correctly specifies the path of targeted file. If needed, update the file path of
the location of the file on your Help server. Typically, the target files are installed in the
c:/inetput/wwwroot/<HelpServer>/content/Microsoft/en-us/local folder of the Help
server.

7. Use the HTML editor to add the title, headings, paragraphs, and other documentation to the
template.

8. To add links to related content elements, find the seeAlsoSection. Use an existing dynHelp
element to add the link. To create the link, populate the topicId attribute by using the ID of
the content element, populate the documentSet attribute by using UserDocumentation, and
then add the text you want the link to display. The following code example shows a link that
opens the Customers (form) content element:

＝ Copy

<div class="seeAlsoStyle">
<span>
<dynHelp:topicLink topicId="c3fc5774-6ed0-4760-86f5-7899e825ab25" documentS
</span>
</div>

9. To save the document, click Save in the HTML or text editor.

See also
Using Templates to Create Documentation

Authoring Help Documents

Publishing Documentation to the Help System

Recommended content

Overview of Visual Studio 2012 updates - Visual Studio

This article introduces the updates that were released after Visual Studio 2012 was released.

Visual Studio 2013 Redistribution

Find the Distributable Code for Microsoft Visual Studio 2013, including Utilities, Extensibility, and
BuildServer files.

Reserved error "Item"; there is no message for this error (Error 3000)
Office VBA reference topic

Cannot open a database created with a previous version of your application (Error 3041)
Office VBA reference topic

Show more Ｓ

Feedback

Submit and view feedback for

This product ６ This page

６ View all page feedback

 English (United States) ０ Theme Previous Version Docs Blog Contribute Privacy & Cookies Terms of Use Trademarks © Microsoft 2021