Extension:FanBoxes

MediaWiki extensions manual - list

FanBoxes Release status: stable
Implementation	other (invalid type)
Description	A new way of creating and using userboxes, based on special pages
Author(s)	Aaron Wright David Pean Robert Lefkowitz Jack Phoenix
Last version	2.0
MediaWiki	1.16+
Database changes	yes
License	GNU General Public License 2.0 or later
Download	Download snapshot (Git master) Git [?]: repo summary • tree • code changes SVN [?]: checkout-url • tree • code changes
Hooks used TitleMoveComplete ArticleDelete ArticleFromTitle ParserBeforeStrip ParserFirstCallInit LoadExtensionSchemaUpdates RenameUserSQL CanonicalNamespaces
Check usage (experimental) Bugs: list open list all report

FanBoxes extension adds a new way of creating and using userboxes, based on special pages. When installed, three new special pages will be added: Special:UserBoxes (to create new userboxes), Special:TopUserBoxes (to view most popular ones) and Special:ViewUserBoxes (to view all userboxes). It also adds <userboxes> and <fan> parser hooks (TODO: document). Both of these parser hooks disable parser cache.

FanBoxes requires SocialProfile extension and YUI (YUI is used only for the color picker feature on Special:UserBoxes; the YUI files are loaded from Yahoo!'s servers).

Dependencies

• SocialProfile extension
• YUI
• New database tables: fantag and user_fantag

Installation

1. Dump the files into $IP/extensions/FanBoxes
2. Create the three required database tables (see fantag.sql for the schemas); the best way to do this is to re-run the MediaWiki updater script, update.php, via command line
3. Add require_once("$IP/extensions/FanBoxes/FanBox.php"); into the wiki's LocalSettings.php
4. Installation can now be verified through the wiki's Special:Version

Parameters

• $wgFanBoxDirectory — path to extension files. Defaults to "$IP/extensions/FanBoxes".
• $wgFanBoxScripts — web-readable path to FanBox files (used to fetch CSS & JS). Defaults to $wgScriptPath . '/extensions/FanBoxes'.
• $wgFanBoxPageDisplay['comments'] — should we display comments on FanBox pages? Defaults to true (for now, anyway). Requires Extension:Comments.

TODO list

1. Should be rewritten to use jQuery color picker one day
2. .imageUpload-frame { height: 70px; } in FanBoxes.css is bad when $wgAllowCopyUploads = true;

Version history

Version	SVN revision	Release date	Comments
2.0	r97059	14 September 2011	Initial public release, phase II changes: Upload form was rewritten to be compatible with 1.16+ JavaScript rewritten to be object-oriented Rewrote the nasty raw SQL in UserFanBoxes class to use MW's Database stuff (TODO: test this and if test passes, drop the old raw SQL code!) wfLoadExtensionMessages() cruft removed Moved all hooked functions into a FanBoxesHooks class, renamed the functions and autoloaded the class in the main setup file SQL file changed to be compatible with SQLite (and maybe other DBMSes, too) Internationalization changes: new FanBox.alias.php file to allow translators to translate the special page names new FanBox.namespaces.php file to allow translators to translate the UserBox namespace names + initial translations in Finnish (fi) and Dutch (nl) new constant, NS_FANBOX_TALK, defined in the main extension setup file for the NS translation file removed unused i18n message 'fanbox-namespace' Fixed an E_DEPRECATED (Call-time pass-by-reference) in FanBoxPage.php New user argument to the <userboxes /> hook Fixed a bug in the YUI colorpicker on SpecialFanBoxes.php where it wasn't possible to set the background colors for left and right sides, only thing you could set was the text code Added handling for $wgFanBoxPageDisplay['comments'] to FanBoxPage::view() (copied from PollPage::view()) [[Special:ViewUserBoxes/Username]] can be used to view Username's userboxes Removed the unused global variable $wgFanBoxDirectory; we already use standard dirname( __FILE__ ) stuff in the main setup file to build paths so we don't need that Renameuser support via the RenameUserSQL hook