Edit online

How to Add a Favicon in WebHelp Systems

You can add a custom favicon to your WebHelp output by simply using a parameter in the transformation scenario to point to your favicon image.

This customization can be done using an Oxygen Publishing Template or using a transformation scenario from within Oxygen XML Editor/Author.

Using a Publishing Template

To add a favicon to your WebHelp output using an Oxygen Publishing Template, follow this procedure:
  1. If you have not already created a Publishing Template, see Working with Publishing Templates.
  2. Open the template descriptor file associated with your publishing template and add the <favicon> element in the resources section. The path to the image is relative to the template root folder.
    <publishing-template>
    ...
    <webhelp>
      ...                
      <resources>            
          ...
          <favicon file="images/favicon.png"/>
  3. Open the DITA Map WebHelp Responsive transformation scenario.
  4. Click the Choose Custom Publishing Template link and select your template.
  5. Click OK to save the changes to the transformation scenario.
  6. Run the transformation scenario.

Result: Browsers that provide favicon support display the favicon (typically in the browser's address bar, in the list of bookmarks, and in the history).

Using a Transformation Scenario in Oxygen XML Editor/Author

To add a favicon to your WebHelp output using a transformation scenario from within Oxygen XML Editor/Author, follow this procedure:
  1. Edit the DITA Map WebHelp Responsive transformation scenario and choose a template.
  2. Open the Parameters tab and set the webhelp.favicon parameter to the path of your image.
  3. Click OK to save the changes to the transformation scenario.
  4. Run the transformation scenario.