Extension:DismissableSiteNotice
 Release status: stable |
|||
|---|---|---|---|
| Implementation | Skin | ||
| Description | Allows users to close the sitenotice | ||
| Author(s) | Brion Vibber (Brion VIBBERtalk) | ||
| Last version | continuous updates | ||
| Database changes | no | ||
| License | GPLv2+ | ||
| Download |
log |
||
| Example | Wikimedia sites Wikia sites |
||
|
|||
| Check usage and version matrix; stats | |||
| 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).
Contents |
Download[edit]
You can download the extension directly from the MediaWiki source code repository (browse code). You can get:
- One of the extensions tags
Not all extensions have tags. Some extensions have tags for each release, in which case those tags have the same stability as the release. To download a tag
- Go to the tags list
- Click the name of the tag you want to download
- Click "snapshot"
- The latest version of one of the extensions branches
Each extension has a master branch containing the latest code (might be unstable). Extensions can have further branches as well.
- Go to the branches list
- Click the branch name
- Click "snapshot"
- A snapshot made during the release of a MediaWiki version.
This might be unstable and is not guaranteed to work with the associated MediaWiki version.
After you've got the code, save it into the extensions/DismissableSiteNotice directory of your wiki.
If you are familiar with git and have shell access to your server, you can obtain the extension, with all its tags and branches, as follows:
cd extensions
git clone https://gerrit.wikimedia.org/r/p/mediawiki/extensions/DismissableSiteNotice.git
Installation[edit]
- Download and extract the files in a directory called "
DismissableSiteNotice" in your extensions/ folder. - Add the following code to your LocalSettings.php (at the bottom)
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]
How to auto-reset dismissal after every edit to MediaWiki:Sitenotice[edit]
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' ) );
to:
$id = intval( $wgMajorSiteNoticeID ) . "." . crc32( wfMsgForContent( 'sitenotice' ) );
 |
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. |
