Chapter 6: Custom Help

Attention: ANSYS, Inc. supports only the functionality as described in the Help system as shipped on the distribution media. Any customizations you make to the Help system, including content, are solely your responsibility. We recommend that you limit your help customizations to adding additional topics.

.NET Framework 4.0 is required to build the following search index.

On Windows, you must have administrative privileges to create custom help.

To add Custom User Help files to the ANSYS, Inc. Help:

  1. Create a subfolder in the Program Files\ANSYS Inc\V182\commonfiles\help\en-us\help\sample (typical installation) folder for your user help (for this example, the folder is titled sample). Copy your help html files into the new sample folder.

  2. Create a toc.toc file for your user help in the sample folder. This file contains Table of Contents information gathered from your Custom User Help files. The toc.toc file is an html-based xml file that will describe the structure of the book. With this structure, having any number of hierarchy levels is possible. Hierarchies are accomplished by using the dt tag, which contains a reference to a chapter, section, subsection, etc., followed by a dd tag. A dl tag is then placed inside of the dd tag, which will contain the child topics. The dt and dd tags can continue to be nested to create any structure necessary. This nesting can be seen more clearly in the following example:

    <?xml version="1.0" encoding="utf-8"?>
    <toc>
      <title href="sample_book.html" title2="My Sample">Sample</title>
      <dl>
        <dt>
          <span>
            <a href="sample_chapter.html">1. My Chapter</a>
          </span>
        </dt>
        <dd>
          <dl>
            <dt>
              <span>
                <a href="sample_section1.html">1.1 My Section</a>
              </span>
            </dt>
            <dd>
              <dl>
                <dt>
                  <span>
                    <a href="sample_subsection1.html">1.1.1 My Subsection</a>
                  </span>
                </dt>
                <dt>
                  <span>
                    <a href="sample_subsection2.html">1.1.2 My Other Subsection</a>
                  </span>
                </dt>
              </dl>
            </dd>
            <dt>
              <span>
                <a href="sample_section2.html">1.2 My Other Section</a>
              </span>
            </dt>
          </dl>
        </dd>
      </dl>
    </toc>
  3. Test opening ANSYS, Inc. Help from the Start Menu. The Help should open with your Custom User Help in the Table of Contents pane, as shown:

  4. After verifying that your Custom User Help is shown in the Help viewer correctly, the Help will need to be indexed so that the new Custom User Help will be included in searches. To begin, open a command prompt and navigate to Program Files\ANSYS Inc\V182\commonfiles\help\HelpViewer\Indexer (typical Windows installation paths shown).

  5. Create an output directory under help\en-us with a name that begins with LuceneIndex_ and then use that output directory in the next step. The indexer will not work if the output directory name does not begin with LuceneIndex_. For this example, we'll use help\en-us\LuceneIndex_sample.

  6. Run the command: ANSYSHelpIndexer.exe -operation CUSTOM_HELP -inputDir "C:\Program Files\ANSYS Inc\V182\commonfiles\help\en-us\help\sample" -outputDir "C:\Program Files\ANSYS Inc\V182\commonfiles\help\en-us\LuceneIndex_sample" (typical Windows installation path shown). This command must be run using Mono on Linux systems.

Once the indexing is complete, Custom User Help installation is finished and will be included in the search. If you do not see your content in the search results, open the Application filter at the top of the results panel and verify that your custom content is selected.


Release 18.2 - © ANSYS, Inc. All rights reserved.