Page History

h1. Favourites Icon

This feature is accessed from the [Options tabTab] in the [Layout Manager] in Theme Builder 3.0 and above.

!Options Tab^options-tab.png|align=center!

{excerpt}The favourites icon appears next to the URL of your wiki in the browser and also in your bookmarks, web feeds and other locations that link to your site. This option allows you to customise it.{excerpt}

!Options Tab^options-tab-favourites-icon.png|align=center!

{menuicon:key} System Administrators can set [permissions|Global Permissions Tab] to restrict who can use these options. By default, only Confluence site administrators ({{confluence-administrators}} group) can change these options.

By default the Confluence logo is displayed, however you might want something more custom and that's what this option allows you to do.

There are two formats for setting the icon - a URL (absolute or relative) or a shortcut to a [menu icon|menuicon macro].

h2. Using an icon from the in-built library

Theme Builder is bundled with over 800 professional icons that can be used with the [menuicon macro]. You'll be glad to know that it's really easy to use any of those icons as your favourites icon.

A key benefit here, over the URL based methods discussed below, is that Theme Builder will handle the URL automatically so you don't have to worry about protocols and domains, etc. As an added advantage Theme Builder ensures the icon is cached, speeding up subsequent page views.

To use an in-built icon, simply enter it's name prefixed with the "at" sign, for example:

{code}@copy{code}

That would use the "copy" icon as your favourites icon: {menuicon:copy}

For a list of common menu icons, and to find out how to view a list of all icons available, please see [menuicon macro].

h2. Setting the icon using a URL

Simply enter the URL to your icon, for example:

{noformat}http://www.mysite.com/images/myicon.png{noformat}

(!) The icon should be a 16x16 pixel PNG image.

You can also use relative URLs (ideal for sites that are accessible via HTTP and HTTPS or different domain names):

{noformat}/path/myicon.png{noformat}

Once the icon is defined, it will start appearing in the browser URL bar, tabs and bookmarks, etc:

!url-favicon.png|align=center!

There are three common places where images can be stored:

h3. Confluence {{/images}} folder

To do this, you'll need access privileges for the server file system. Simply copy your icon to the {{/images}} folder on the server and then specify the relative path to the image.

If Confluence is clustered, you'll have to upload the image to each server to ensure users can access it from each node.

The key benefit to this approach is that the icon will always be available - even to logged out users.

The key disadvantage is that you'll have to re-upload the icon after each Confluence upgrade so be sure to include this task in your change control procedures.

h3. Page Attachments

Simply attach the icon to a page in your wiki and then right-click the link to that file and copy the link location. For best results, remove the {{http://mysite.com}} part of the URL to make it relative.

This is probably the easiest way to use a custom icon, even in a clustered environment, however anonymous users (i.e. not logged in) will only be able to see the icon if the page where it's attached (and the associated space and wiki as a whole) is accessible to anonymous users.

h3. External Web Space

If you have some standard web space, eg. an Apache server sat in front of Confluence, you can serve the image from there.

If you're Confluence wiki is served from a different domain (or sub-domain) to the location where the image is stored, you'll need to use an absolute URL (i.e. including the {{http:\//mysite.com}} part).

There are two possible disadvantages to using this method:

# If the image is served from a different domain, some browsers might block it due to cross-domain security policies.
# If your site can be accessed via multiple protocols (e.g. {{http}} and {{https}}) or domains, the image URL won't automatically reflect the URL being used to access your wiki and this could cause problems.

h2. Using an icon from the in-builtdefault libraryicon

ThemeIf Builderyou is bundled with over 800 professional icons that can be used with the [menuicon macro]. You'll be glad to know that it's really easy to use any of those icons as your favourites icon.

A key benefit here, over the URL based methods, is that Theme Builder will handle the URL automatically so you don't have to worry about protocols and domains, etc.

To use an in-built icon, simply enter it's name prefixed with the "at" sign, for example:

{code}@copy{code}

That would use the "copy" icon as your favourites icon: {menuicon:copy}want to revert to using the default Confluence favicon, simply leave the Favourites Icon field empty.