Jump to content

Extension:WikiBanner

From mediawiki.org
MediaWiki extensions manual
WikiBanner
Release status: unmaintained
Implementation Hook
Description Adds a banner to the top and bottom of the wiki that are defined in LocalSettings.php
Author(s) (maelstr0mtalk)
Latest version 1.1.0 (2013-08-17)
MediaWiki
Database changes No
License GNU General Public License 2.0
Download
README
  • $wgTopBannerCode
  • $wgBottomBannerCode

The WikiBanner extension allows banners to easily be added to the top and bottom of the wiki. The code for the banners is defined in LocalSettings.php and is controlled by variables. This implementation makes it easy for inexperienced users of MediaWiki to implement banners at the top and bottom of the wiki. It also makes it possible to add banners that cannot be changed or removed, such as would be possible by wiki administrators if the banner were added to the site notice. This makes the extension particularly useful for placing advertising or report abuse links, as such content cannot be removed by abusive or rogue administrators. The bottom banner can also be used to include post article advertisements as readers leave the page and/or Disqus comment boxes.

Installation

[edit]
  • Download, extract and place the file(s) in a directory called WikiBanner in your extensions/ folder.
  • Add the following code at the bottom of your LocalSettings.php file:
    require_once "$IP/extensions/WikiBanner/WikiBanner.php";
    
  • Configure as required.
  • Yes Done – Navigate to Special:Version on your wiki to verify that the extension is successfully installed.

Configuration

[edit]

One or more banners can be added to the wiki. The banners can consist of any HTML and/or JavaScript.

To configure the top banner, add the following to LocalSettings.php after the installation line:

$wgTopBannerCode = '
Your banner code here.
';

To create a banner at the bottom, add the following after the installation line:

$wgBottomBannerCode = '
Your banner code here.
';