How To Remove The Index From The Browser Help Output

This article will explain how to remove the index from the Browser Output. This can be useful if you do not require the index and wish to save space in the generated output. There is not an option built in to completely exclude the index, but you can remove all references to it with a custom template. 

You can find out how to create a custom template here:

In this case, the base template would be the Classic Browser Style template. You can also use this method to remove the index from the Material template - but you will have to use the alternative method outlined later in this article for the Light template. 

Removing the Index from the Classic and Material Template

After the Template has been created and is open for edit, select the Page Types page, locate and select webnav.html on the list and then click the Edit button on the toolbar above the list. In the Page Type editor that is opened, locate and then remove the following HTML:

<div class="i-header">
    <img src="template/packages/core-web/images/header-index.png" /><span class="i-header-text"><!--DXMETADATA start type="Phrase" name="Index" --><!--DXMETADATA end --></span>
    <div class="i-frame-container">
        <iframe id="i-index" src="webindex<!--DXMETADATA start type="outputfileextension" --><!--DXMETADATA end-->" frameBorder="0"></iframe>

Finally, you need to select your custom template in your build profile editor. You can do this by:

  1. Right clicking on your Build Profile in the Build Profiles section of the Project Explorer and selecting edit;
  2. The Build Profile will be opened for edit;
  3. Select the Templates page;
  4. Select your custom Browser Help template.

Once your output is built, it will look like this:


Removing the Index from the Light Template

In order to remove the Index from the Light template, you will have to use a different method. First of all, you need to create a new Custom Browser Help Template based on the Light template, and then you need to navigate to Page Types. From there, you need to delete your webindex.html page.

Then, you need to create a new Custom Light Topics template, navigate to the Page Types page in the Template editor and open the Master.base.html page for editing. You need to locate and remove the following HTML:

  <!--DXMETADATA start type="outputfileextension" format="<a id=""i-index-button"" href=""webindex.html""></a>" --><a id="i-index-button"></a><!--DXMETADATA end-->

Finally, you need to save your changes and close your custom template for edit. Once you have ensured your custom templates has been selected in the Templates Page of the Build profile editor, you should be able to rebuild and see the built output without the index button:



Have more questions? Submit a request


Please sign in to leave a comment.