| 1 | = Set any server file as shortcut icon. Adds handler for `/favicon.ico`. = |
| 2 | |
| 3 | == Description == |
| 4 | |
| 5 | This small plug-in 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 plug-in is also able to insert (X)HTML `link` tags which point standard compatible browsers to this address. |
| 6 | |
| 7 | Please be aware that this icons can also be configured over the Trac standard config file as described in the [TracInterfaceCustomization#Icon TracInterfaceCustomization] wiki, but forcing the Trac server admin to put the icon in the document root of the host in order to be compatible with the MS IE. |
| 8 | |
| 9 | |
| 10 | == Bugs/Feature Requests == |
| 11 | |
| 12 | Existing bugs and feature requests for ShortcutIconPlugin are |
| 13 | [report:9?COMPONENT=ShortcutIconPlugin here]. |
| 14 | |
| 15 | If you have any issues, create a |
| 16 | [http://trac-hacks.org/newticket?component=ShortcutIconPlugin&owner=martin_s new ticket]. |
| 17 | |
| 18 | == Download == |
| 19 | |
| 20 | Download the zipped source from [download:shortcuticonplugin here]. |
| 21 | |
| 22 | == Source == |
| 23 | |
| 24 | You can check out ShortcutIconPlugin from [http://trac-hacks.org/svn/shortcuticonplugin here] using Subversion, or [source:shortcuticonplugin browse the source] with Trac. |
| 25 | |
| 26 | == Example == |
| 27 | |
| 28 | == Usage == |
| 29 | Put the following settings in the `trac.ini` config file under the section `[shortcuticon]`: |
| 30 | `handler = `''true|false'':: Enables/disables request handler for /favicon.ico` URL. |
| 31 | `linkheader = `''true|false'':: Enables/disables insertion of `link` tags which point to the icon. |
| 32 | `iconpath = `''</local/path/on/trac/server/icon.png>'':: Local OS path (no URL) of the icon file on the Trac server. |
| 33 | `mimetype = image/`''<extention>`:: Overrides auto-detection of mime-type. |
| 34 | |
| 35 | {{{ |
| 36 | [shortcuticon] |
| 37 | handler = true |
| 38 | linkheader = true |
| 39 | iconpath = /local/path/on/trac/server/icon.png |
| 40 | mimetype = image/png |
| 41 | |
| 42 | [project] |
| 43 | # Disable build-in handling of icons: |
| 44 | icon = |
| 45 | }}} |
| 46 | |
| 47 | |
| 48 | == Recent Changes == |
| 49 | |
| 50 | [[ChangeLog(shortcuticonplugin, 3)]] |
| 51 | |
| 52 | == Author/Contributors == |
| 53 | |
| 54 | '''Author:''' [wiki:martin_s] [[BR]] |
| 55 | '''Contributors:''' |