How to Add a Favicon in WebHelp Systems
Edit online

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 is available for DITA and DocBook WebHelp output using WebHelp Classic or WebHelp Classic with Feedback transformations.

Using 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 WebHelp transformation scenario and open the Parameters tab.
  2. Locate the webhelp.favicon parameter and enter the file path that points to the image that will be use as the favicon.
  3. Run the transformation scenario.

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

Using a Script Outside of Oxygen XML Editor/Author

Important: Running WebHelp transformations from a script outside of Oxygen XML Editor/Author requires an additional license and some additional setup:
To add a favicon to your WebHelp output using a script outside of Oxygen XML Editor/Author, follow this procedure:
  1. Specify the file path that points to the image that will be use as the favicon using the webhelp.favicon parameter.
  2. Execute the transformation script.

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

For example:
  • Windows:

    dita.bat -i c:\mySample.ditamap -f webhelp -Dwebhelp.favicon=c:\myFavicon.jpg

  • Mac OS X/ Linux:

    dita -i /mySample.ditamap -f webhelp -Dwebhelp.favicon=/myFavicon.jpg