Removing The Index from 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 achieve this with a custom template. 

Creating a Custom Template

With a custom Template you can modify pretty much anything - add or remove whole sections or even pages. To do this, if you go to Options (found on the program menu), and then to Custom Templates. From there you can create a new custom Template by clicking the yellow button at the top of the dialog, and selecting the relevant base Template.

In this case, the base template would be the Classic Browser Style 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:

  1. Right clicking your Build Profile in the Build Profiles section of the Project Explorer;
  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 should look like this:




Have more questions? Submit a request


Please sign in to leave a comment.