How to add a favicon to a web help system?

LisaR

2 days ago

2 comments

I've created a webhelp system using HelpSmith and it works just fine.

Q: Can you provide some instructions on how to add a favicon?

Comments

Michael

2 days ago

Can you provide some instructions on how to add a favicon?

For Web Help system on a separate domain (or sub-domain)

If your Web Help system is located on:

Separate domain (for example: https://example.com/, or on
Sub-domain (for example: https://help.example.com/),

then you can simply place the "favicon.ico" file to the web help's root folder.

The web browser will access the default "favicon.ico" file from the root folder. In this case, defining the favicon file in meta tags is not mandatory.

Michael

2 days ago

For a web help system located in a sub-folder

If your web help system is located in a sub-folder (for example: https://example.com/webhelp/), you should define the favicon file in the Head section of the web help's layout:

In HelpSmith, on the Project tab, click Project Options.
In the Project Options window, go to HTML Export|<HEAD> Section

In the <HEAD> Section editor, copy/paste the following code:

<IF_#WebHelp>
<link href="<%media:favicon.png%>" rel="icon" type="image/x-icon" />
</IF_#WebHelp>

Remark: In the HTML editor, you can double-click on the <%media:favicon.png%> placeholder to select the needed image file from the project's media repository.

How to add a favicon to a web help system?

Comments

For Web Help system on a separate domain (or sub-domain)

For a web help system located in a sub-folder

Add a Comment