Release status: stable
|Description||Allows users to close the sitenotice|
|Author(s)||Brion Vibber (Brion VIBBERtalk)|
|Latest version||continuous updates|
Translate the DismissableSiteNotice extension if possible
|Check usage and version matrix; code metrics|
|Bugs: list open list all report|
The DismissableSiteNotice extension allows users to close the sitenotice, using cookies. When you add a new sitenotice 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).
Installation[edit | edit source]
- Download and extract the files in a directory called
extensions/folder. If you're a developer and this extension is in a Git repository, then instead you should clone the repository using:
git clone https://gerrit.wikimedia.org/r/p/mediawiki/extensions/DismissableSiteNotice.git
- Add the following code at the bottom of your LocalSettings.php:
require_once( "$IP/extensions/DismissableSiteNotice/DismissableSiteNotice.php" );
- Done! Navigate to "Special:Version" on your wiki to verify that the extension is successfully installed.
Usage[edit | edit source]
- How to auto-reset dismissal after every edit to MediaWiki
The default 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.
Some sites may not need this additional control and may want to reset it no matter the change. The below code change will reset ("re-display") the sitenotice whenever the MediaWiki:Sitenotice message is edited. This eliminates the need for the "sitenotice_id" message entirely.
In DismissableSiteNotice.php change the one line of extension code:
$id = intval( $wgMajorSiteNoticeID ) . "." . intval( wfMsgForContent( 'sitenotice_id' ) );
$id = intval( $wgMajorSiteNoticeID ) . "." . crc32( wfMsgForContent( 'sitenotice' ) );
See also[edit | edit source]
|This extension is being used on one or more Wikimedia projects. This probably means that the extension is stable and works well enough to be used by such high-traffic websites. Look for this extension's name in Wikimedia's CommonSettings.php and InitialiseSettings.php configuration files to see where it's installed. A full list of the extensions installed on a particular wiki can be seen on the wiki's Special:Version page.|