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

= Display on-site notifications

== Description

With this plugin ''on-site notifications'' are displayed to users on the Trac web-site itself, as opposed to ''email notifications'' which are sent by email. This is similar to a message inbox on other websites like [http://stackoverflow.com/help/documentation-notifications StackOverflow] or [https://help.github.com/articles/about-notifications/ GitHub].

{{{#!rbox width=320px
= Screenshot: List of available notifications
[[Image(onsitenotification_list.png, border=3, width=300px)]]
}}}

{{{#!rbox width=320px
= Screenshot: Example notification
[[Image(onsitenotification_message.png, border=3, width=300px)]]
}}}

When on-site notifications are available, they are indicated to the user in the meta-nav-bar at the top-right with a symbol and the number of notifications:

[[Image(onsitenotification_symbol.png, border=3, nolink)]]

The list of available notifications links to the notification text and the respective resource (e.g. a ticket) on Trac.

**Note:** You have to set your e-mail in the user preferences to get any on-site notifications.

== !Bugs/Feature Requests

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

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

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

== Download

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

== Source

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

== Installation

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

== Recent Changes

[[ChangeLog(onsitenotificationsplugin, 3)]]

== !Author/Contributors

**Author:** [wiki:psuter] [[BR]]
**Maintainer:** [[Maintainer]] [[BR]]
**Contributors:**