Extension:ShoutBox

From MediaWiki.org

Jump to: navigation, search
Manual on MediaWiki Extensions
List of MediaWiki Extensions
ShoutBox

Release status: beta

Implementation Parser function
Description Adds a parser function called #shoutbox for embedding shoutbox into pages.
Author(s) Jim R. Wilson (Jimbojw)
Version 0.1
MediaWiki 1.6.x, 1.9.x, 1.10.x or higher
Download ShoutBox.php
Example in use at Meopedia

The ShoutBox Extension is a MediaWiki extension which adds a parser function called #shoutbox for embedding a shoutbox into pages. Only shoutboxes hosted by http://www.shoutbox.us are supported.

Project Homepage
ShoutBox Extension - Jimbojw.com
Source Code
ShoutBox.php
Licensing
ShoutBox is released under The MIT License.

Installation

  1. Download ShoutBox, and be sure to rename the downloaded file to ShoutBox.php.
  2. Drop this script in $IP/extensions
    Note: $IP is your MediaWiki install directory.
  3. Enable the extension by adding this line to your LocalSettings.php:
    require_once('extensions/ShoutBox.php');
    

Usage

Once installed, you (or editors of your wiki) may begin embedding shoutboxes into any article.

The parser extension expects to be called in any of the following ways:

  • {{#shoutbox}} (if a $wgShoutBoxDefaultId has been specified) -or-
  • {{#shoutbox:id}} -or-
  • {{#shoutbox:id|width}} -or-
  • {{#shoutbox:id|width|height}}

Where:

  • id is the id of the shoutbox to display
  • width (optional) is the width in pixels of the shoutbox (defaults to 150 if unspecified)
  • height (optional) is the height in pixels of the shoutbox (defaults to 300 if unspecified)
Personal tools