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 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 here.

If you have any issues, create a new ticket.

Download

Download the zipped source from here.

The plugin is also available on ​PyPI.

Source

You can check out ShortcutIconPlugin from here using Subversion, or browse the source​ with Trac.

Installation

General instructions on installing Trac plugins can be found on the TracPlugins page.

To enable this plugin add or change the following in your trac.ini file, normally found at ../conf/trac.ini:

[components]
tracshortcuticon.* = enabled

Configuration

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

[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

17135 by rjollos on 2018-04-16 19:44:04

TracShortcutIconPlugin 0.3: Conform to PEP8

15264 by rjollos on 2016-02-11 04:22:34

Remove unnecessary svn:mime-type on py files

svn:mime-type was set to "plain" for many files.

8553 by martin_s on 2010-08-30 21:57:58

Added encoding meta-comment and declared SVN keywords as unicode to avoid issues with non-english locales.

(more)

Author/Contributors

Author: martin_s
Maintainer: Martin Scharrer
Contributors: