View source for PWExt

=PW Extension=

==Summery==

The PluginWatcher extension aims to provide the user with plugin activity information via its Plugin Activity Meter - a user interface component located at the bottom right corner of Firefox (as part of the status bar). It does this by listening to runtime notification information sent by [[PWCore | PW Core]].

==Release Information==

PluginWatcher extension v1.0 has been released and is available on Mozilla's addons website (see below). If you plan to use it you will need Minefield/Firefox v3.0pre or later as previous versions do not include [[PWCore | PW Core]]. PW Core is included in nightly Minefield builds as of April 24th, 2008.

==User Interface==

The user interface consists of a small bar at the bottom right corner of Firefox. This bar is made up of two parts - the activity meter and the ON/OFF indicator button.

===Activity Meter===

The activity meter (shown below) provides a visual indication of how much of the runtime being given to Firefox is being used up by running plugins. The meter contains 6 bars - 4 green, 1 orange and 1 red. The higher the runtime of the plugin becomes, the more bars light up. 

[[Image:PWC1.jpg]] 


Below is a table showing the different states of the activity meter and their meaning:

<table border="1">

<tr>
<th>Activity Meter State</th>
<th>Used Resources</th>
</tr>

<tr>
<td>[[Image:pw.inactive.png]]</td>
<td>No active plugins are present</td>
</tr>

<tr>
<td>[[Image:pw.green.png]]</td>
<td>Using 20% or less of total time given to Firefox</td>
</tr>

<tr>
<td>[[Image:pw.lightBlue.png]]</td>
<td>Using 40% or less of total time given to Firefox</td>
</tr>

<tr>
<td>[[Image:pw.navyBlue.png]]</td>
<td>Using 60% or less of total time given to Firefox</td>
</tr>

<tr>
<td>[[Image:pw.orange.png]]</td>
<td>Using 80% or less of total time given to Firefox</td>
</tr>

<tr>
<td>[[Image:pw.hotOrange.png]]</td>
<td>Using 99% or less of total time given to Firefox</td>
</tr>

<tr>
<td>[[Image:pw.red.png]]</td>
<td>Using over 99% of total time given to Firefox</td>
</tr>

</table>


===ON/OFF Indicator Button===

The ON/OFF indicator (shown below) is situated to the right of the activity meter and displays the current status of the PluginWatcher extension. The icon lets the user know if the extension is currently enabled or disabled while also acting as a button to allow the user to change between the two states. 

[[Image:PwIndicator.png]]


Below is a table showing the different states of the indicator and their meaning:

<table border="1">

<tr>
<th>Indicator State</th>
<th>PluginWatcher Extension State</th>
</tr>

<tr>
<td>[[Image:pw.on.png]]</td>
<td>The extension is enabled</td>
</tr>

<tr>
<td>[[Image:pw.off.png]]</td>
<td>The extension is disabled</td>
</tr>

</table>


===High Runtime Notifications===

In addition to showing the user plugin runtime information in the activity meter, PluginWatcher also watches the plugin activity over time to determine if there is an unusually high runtime for an extended period of time. When this happens the extension pops up a non intrusive message at the bottom right corner, notifying the user of the situation. The picture below demonstrates what this pop up looks like:


[[Image:Pw.popup.png]]

==Installation==

You can download and install the PluginWatcher extension by visiting the [https://addons.mozilla.org/en-US/firefox/addon/7055 extension's page] on the addons Mozilla website ([http://addons.mozilla.org http://addons.mozilla.org]). 

==Support==

The extension is currently supported by Fima Kachinski. You can email him at [mailto:xrayon@gmail.com xrayon (at) gmail.com].

==License/Privacy==

This extension is released under the BSD license. This extension neither collects nor transmits any personal information.

==Additional Resources==

If you are interested in finding out how this extension works, or if you would like to build your own extension please visit the [[PWCore | PW Core]] page as it contains all the information you will need.