Was this page helpful?
Your feedback about this content is important. Let us know what you think.
Additional feedback?
1500 characters remaining
Export (0) Print
Expand All

Adding a Topic to the Table of Contents

banner art

[Applies to: Microsoft Dynamics CRM 4.0]

Find the latest SDK documentation: CRM 2015 SDK

The Help_toc.xml file contains the table of contents. Changes made to this file will be overwritten if you repair, reinstall, or upgrade Microsoft Dynamics CRM. You should make a backup copy of this file after your changes are complete.

The Help_toc.xml file follows the structure shown here.

<books>
 <section>Non-clickable Section Title</section>
 <volume code="short unique volume code" 
          name="Volume Title">
  <chapter code="short unique chapter code" 
            name="Visible Chapter Title">
   <page topic="filename without extension">Page Title</page>
  </chapter>
  <chapter code="short chapter code" 
             name="hidden section">
   <page topic="filename without extension" 
            filename="path of page calling context-sensitive help">
       Page Title</page>
  </chapter>
 </volume>
</books>

The last volume in the table of contents is used for associating context-sensitive Help topics from the page that calls them. It contains the parameter hidden="true" so that these topics do not show up in the table of contents. All <page> elements in the <chapter> element use the filename parameter to specify the name of the page in the user interface that the Help page is opened from.

To add a section in the table of contents

  1. Open the Help_TOC.xml file (in the \Help\<lcid>\OP\ folder).
  2. Type the following:
    <section>Section Title</section>
    

To add a book in the table of contents

  1. Open the Help_TOC.xml file (in the \Help\<lcid>\OP\ folder).
  2. Copy an existing volume section.
  3. Modify the data in it.

Example

To add a book at the top of the table of contents that will point to the five pages of your company's style guide, create the five pages in the AW folder, and then add the following lines to the Help_TOC.xml file.

<section>Adventure Works Help</section>
<volume code="AW" name="Adventure Works Style Guide">
   <chapter code="Style" name="Purpose">
    <page topic="AW\Style_Purpose">Why Use the Adventure Works Style 
      Guide</page>
   </chapter>
   <chapter code="Style-Address" name="Entering New Address Information">
      <page topic="AW\Style-Address_Street" procedure="true">Street Addresses</page>
      <page topic="AW\Style-Address_Phone" procedure="true">Phone Numbers</page>
      <page topic="AW\Style-Address_State" procedure="true">States</page>
   </chapter>
</volume>

This will create the following structure in the table of contents:

Customized Help Table of Contents

For each volume, if you want a separate topic to be displayed for the volume itself, you can add a topic attribute with a reference to the page to the <volume> element. For example, to display a page when you click on a volume, you can add a topic attribute with a reference to a page.

To add a page visible in the table of contents

  1. Open the Help_TOC.xml file (in the \Help\<lcid>\OP\ folder).
  2. Copy an existing <page topic> line.
  3. Modify the title and the HTML file name.

For example, to add a new page called AW_new.htm that you created in the AW folder to the Getting Started section, Common Tasks volume, Getting Started and Finding Help chapter, add the following line in the Help_toc.xml file below the line that defines the chapter.

<page topic="AW\AW_new"> Using Microsoft Dynamics CRM at Adventure Works</page>

By default, pages show up with a question mark (?) icon next to them in the table of contents. To set a page to use the green circle icon, which is used for procedures, add procedure="true". For example:

<page procedure="true" topic="AW\AW_new_procedure">Edit Adventure Works data</page>

© 2010 Microsoft Corporation. All rights reserved.


Show:
© 2015 Microsoft