Extension:ShoutBox

MediaWiki extensions manual - list

ShoutBox Release status: beta
Implementation	Parser function
Description	Adds a parser function called #shoutbox for embedding shoutbox into pages.
Author(s)	Jim R. Wilson (Jimbojwtalk)
Last version	0.2.1
MediaWiki	1.16+
License	The MIT License
Download	Download snapshot (Git master) Git [?]: repo summary tree code changes
Parameters $wgShoutBoxMinWidth $wgShoutBoxMaxWidth $wgShoutBoxMinHeight $wgShoutBoxMaxHeight $wgShoutBoxDefaultId $wgShoutBoxCSS
Check usage and version matrix

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. This means a user must go to shoutbox.us, create an account then create a shoutbox. The id is the shoutbox id from this site.

Project Homepage

ShoutBox Extension - Jimbojw.com

Source Code

ShoutBox.php

Licensing

ShoutBox is released under The MIT License.

Installation

1. Download the source code, either via the extension distributor or SVN and place the files in $IP/extensions/ShoutBox/
2. Add the line
   require_once("$IP/extensions/ShoutBox/ShoutBox.php");
   into the wiki's LocalSettings.php
3. Installation can now be verified through the wiki's Special:Version

Usage

The "id" is the shoutbox id found in the top left corner. In this screenshot, the "id" is 46044.

Once this extension is 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)