Jump to content

Extension:DismissableSiteNotice

From mediawiki.org
MediaWiki extensions manual
DismissableSiteNotice
Release status: stable
Implementation Skin , MyWiki
Description Allows users to close the site notice
Author(s) Brooke Vibbertalk
Latest version continuous updates
Compatibility policy Snapshots releases along with MediaWiki. Master is not backward compatible.
MediaWiki >= 1.43
Database changes No
License GNU General Public License 2.0 or later
Download
  • $wgMajorSiteNoticeID
  • $wgDismissableSiteNoticeForAnons
Quarterly downloads 50 (Ranked 85th)
Public wikis using 2,711 (Ranked 188th)
Translate the DismissableSiteNotice extension if it is available at translatewiki.net
Issues Open tasks · Report a bug

The DismissableSiteNotice extension allows users to close the site notice, using cookies.

Installation

  • Download and move the extracted DismissableSiteNotice folder to your extensions/ directory.
    Developers and code contributors should install the extension from Git instead, using:cd extensions/
    git clone https://gerrit.wikimedia.org/r/mediawiki/extensions/DismissableSiteNotice
  • Add the following code at the bottom of your LocalSettings.php file:
    wfLoadExtension( 'DismissableSiteNotice' );
    
  • Configure as required.
  • Yes Done – Navigate to Special:Version on your wiki to verify that the extension is successfully installed.

Configuration

This extension provides two configuration parameters:

$wgMajorSiteNoticeID
Integer. The value is stored inside a cookie. When a user decides to close the site notice, the current value of $wgMajorSiteNoticeID is saved as well, and the closed notice is not shown again. $wgMajorSiteNoticeID now can be incremented when a new text is set up as site notice. If $wgMajorSiteNoticeID has in-between been incremented, then the site notice is shown again, even if the user closed an older site notice before.
$wgDismissableSiteNoticeForAnons
This allows setting whether or not it should be possible for anonymous visitors of the wiki to dismiss the site notice shown. Defaults to "false". Available for MW 1.25 +

Usage

When you add a new site notice and want everyone to see it, change the number on the created page "MediaWiki:Sitenotice id" by one (e.g., if it would be 5, you'd replace the page with the number 6 and so on).

The extension behavior is that it will remember the dismissal by the user and only reset after the number in MediaWiki:Sitenotice_id has been raised. This allows a wiki to make minor updates to a notice without causing it to show again for everybody.