Export (0) Print
Expand All

How to: Create a Non-HTML Content Element [AX 2012]

Updated: August 24, 2011

Applies To: Microsoft Dynamics AX 2012 R2, Microsoft Dynamics AX 2012 Feature Pack, Microsoft Dynamics AX 2012

This topic describes how to create a non-HTML document that you can publish to the Microsoft Dynamics AX Help server. While the help viewer cannot display a non-HTML file, the viewer can open another application that can display the document. For example, you might use Microsoft Office Word to view Help documentation in a .docx file.

To use a non-HTML document together with the help viewer, you must have the following components:

  • To publish a non-HTML file on the help server, you must include an HTML file that contains the help system metadata properties and a script that targets the non-HTML file. The HTML file must have the same name as the content element file. In addition, both files must be published to the same folder on the help server.

  • To view your non-HTML content element, the computer on which the help viewer is installed must have an application that can display that type of file. In addition, that application must be the default viewer for that type of file. If there is no viewer application associated with the specified file type, the file will not open.

The following steps show you how to create a non-HTML content element and the required HTML metadata file.

To create the content element

  1. Open the application that creates and displays the non-HTML content and create a new file. For example, open Microsoft Office Word and create a new document.

    TipTip

    If you use Microsoft Office Word for a content element, consider using one of the templates included with the help system. The templates help you quickly create a content element that resembles existing Help documentation.

  2. Use the application to add Help documentation to the file. To create a typical content element, add a title, section headings, and paragraphs.

  3. Save the file. Note the file name. You will use this file name when you create the HTML file that provides the metadata for your new content element. To continue the Microsoft Office Word example, save the file as SampleContentElement.docx.

To create the HTML metadata file

  1. Use a text or HTML editor to create a new file.

  2. Add the HTML for a basic webpage. The following HTML example creates a basic webpage.

    <html>
       <head>
       
       </head>
    </html>
    
  3. Add an HTML <meta> element to the file for the following metadata properties.

    Property

    Required

    Description

    description

    No

    Specify the brief summary of the content element that appears in a list of search results.

    documentSets

    Yes

    Specify the ID of the document set by setting this property to UserDocumentation.

    Microsoft.Help.F1

    Yes

    Specify a topic ID for the content element. If the content element applies to more than one topic, use a semicolon delimited list to specify the ID of each topic.

    Microsoft.Help.Id

    Yes

    Specify a text value that uniquely identifies the content element.

    Microsoft.Help.Keywords

    No

    Specify a semicolon delimited collection of keyword entries. Search keywords are optional and the property can be empty.

    ms.locale

    Yes

    Specify the language for the content element. For example, use EN-US to specify that the content element contains United States English.

    publisher

    Yes

    Specify your publisher ID.

    suppressedPublishers

    No

    Specify a semicolon delimited list of publisher IDs. Hiding content elements produced by other publishers is optional and the property can be empty.

    Title

    Yes

    Specify the text that displays in the title bar of the help viewer.

    The following example shows the metadata properties for a sample content element:

    <head>
       <meta name="Title" content="Sample content element" />
       <meta name="Microsoft.Help.Id" content="8D937F19-3A00-4F37-A316-0A48D052D627" />
       <meta name="ms.locale" content="En-Us" />
       <meta name="publisher" content="Microsoft" />
       <meta name="documentSets" content="UserDocumentation" />
       <meta name="Microsoft.Help.Keywords" content="" />
       <meta name="suppressedPublishers" content="" />
       <meta name="Microsoft.Help.F1" content="SampleContentElement" />
       <meta name="description" content="An example of a non-HTML content element that was published to the Help system." />
    </head>
    
  4. Add a script element and specify the file that you want to open. Specify the script type as javascript and use the window.location object to specify the file. The following HTML example shows a script element that opens the file that is named SampleContentElement.docx.

    <script type="text/javascript">
       <!-- 
          window.location="SampleContentElement.docx" 
       //-->
    </script>
    
  5. Save the file. The file name must match your content element file. The file name extension must be .htm. For example, use SampleContentElement.htm to match the SampleContentElement.docx example from the previous step.

The following HTML example shows the contents of an HTML file. Notice how the <meta> elements provide the metadata properties and the <script> element specifies the file that contains the content element.

<html>
   <head>
      <meta name="Title" content="Sample content element" />
      <meta name="Microsoft.Help.Id" content="8D937F19-3A00-4F37-A316-0A48D052D627" />
      <meta name="ms.locale" content="EN-US" />
      <meta name="publisher" content="Microsoft" />
      <meta name="documentSets" content="UserDocumentation" />
      <meta name="Microsoft.Help.Keywords" content="" />
      <meta name="suppressedPublishers" content="" />
      <meta name="Microsoft.Help.F1" content="SampleContentElement" />
      <meta name="description" content="An example of a non-HTML content element that was published to the Help system." />

      <script type="text/javascript">
         <!-- 
            window.location=" SampleContentElement.docx" 
         //-->
      </script>

   </head>
</html>

Community Additions

ADD
Show:
© 2014 Microsoft