[[PageOutline(2-5,Contents,pullout)]]

= Set any server file as shortcut icon, including handler for favicon

== Description

This plugin provides an request handler for the widely used shortcut icon URL path `/favicon.ico`. Especially MS Internet Explorer seems to need the shortcut icon located at this position. The plugin is also able to insert (X)HTML `link` tags which point standard compatible browsers to this address.

Note that favicons can also be configured over the Trac standard config file as described in the [TracInterfaceCustomization#Icon TracInterfaceCustomization] wiki. However, this plugin forces the Trac server admin to put the icon in the document root of the host to be compatible with the MS IE.

== Bugs/Feature Requests

Existing bugs and feature requests for ShortcutIconPlugin are 
[report:9?COMPONENT=ShortcutIconPlugin here].

If you have any issues, create a 
[/newticket?component=ShortcutIconPlugin new ticket].

[[TicketQuery(component=ShortcutIconPlugin&group=type,format=progress)]]

== Download

Download the zipped source from [export:shortcuticonplugin here].

The plugin is also available on [pypi:TracShortcutIconPlugin PyPI].

== Source

You can check out ShortcutIconPlugin from [/svn/shortcuticonplugin here] using Subversion, or [source:shortcuticonplugin browse the source] with Trac.

== Installation

General instructions on installing Trac plugins can be found on the [TracPlugins#InstallingaTracplugin TracPlugins] page.

To enable this plugin add or change the following in your `trac.ini` file, normally found at `../conf/trac.ini`:
{{{#!ini
[components]
tracshortcuticon.* = enabled
}}}

== Configuration

Put the following settings in the `trac.ini` configuration file:

{{{#!ini
[shortcuticon]
handler = true
linkheader = true
iconpath = /local/path/on/trac/server/icon.png
mimetype = image/png

[project]
# Disable build-in handling of icons:
icon =
}}}

The meaning behind these settings is as follows:
 `handler = ` ''true|false'':: Enables/disables request handler for `/favicon.ico` URL.

 `linkheader = ` ''true|false'':: Enables/disables insertion of `link` tags which point to the icon.

 `iconpath = ` ''/local/path/on/trac/server/icon.png'':: Local OS path (no URL) of the icon file on the Trac server. While some browsers support PNG and GIF icons, some others support only the MS ICO format. The icon should be 16x16 or 32x32 pixels in size.

 `mimetype = image/` ''<extension>'':: Overrides auto-detection by file extension of the mime-type.

== Recent Changes

[[ChangeLog(shortcuticonplugin, 3)]]

== Author/Contributors

'''Author:''' [wiki:martin_s] [[BR]]
'''Maintainer:''' [[Maintainer]] [[BR]]
'''Contributors:'''