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 is available for DocBook WebHelp output using the WebHelp Classic transformation.
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:
- Edit the WebHelp transformation scenario and open the Parameters tab.
- Locate the
webhelp.faviconparameter and enter the file path that points to the image that will be use as the favicon. - 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:
- You must have a valid license for the Oxygen XML WebHelp Plugin (https://www.oxygenxml.com/buy_webhelp.html).
- The Oxygen XML WebHelp Plugin must be installed and integrated.
To add a favicon to your WebHelp output using a script outside of Oxygen XML
Editor/Author, follow this procedure:
- Specify the file path that points to the image that will be use as the favicon
using the
webhelp.faviconparameter. - 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).