Extension:Preloader

From MediaWiki.org
Jump to: navigation, search
MediaWiki extensions manual
Crystal Clear action run.png
Preloader

Release status: stable

Implementation Page action, Tag
Description Loads boilerplate text when creating new pages
Author(s) Rob Church (Robchurchtalk)
Latest version 1.2.0 (2011-03-22)
MediaWiki 1.7+
Database changes No
License No license specified
Download Template:WikimediaDownload/svn
README
Parameters

$wgPreloaderSource

Hooks used
EditFormPreloadText

ParserFirstCallInit

Translate the Preloader extension if it is available at translatewiki.net

Check usage and version matrix; code metrics
Bugs: list open list all report

The Preloader extension allows the creation of boilerplate text which will be inserted into the edit form when creating new pages. Different boilerplate text can be specified for different namespaces.

In addition, a new parser tag, <nopreload> is introduced, which is used to denote sections which should not be preloaded, ever; useful for instructions and advice on the boilerplate pages. This tag has no effect during a regular parse operation.

Installation

  • Copy the code into files and extract the file(s) in a directory called Preloader in your extensions/ folder.
  • Add the following code at the bottom of your LocalSettings.php:
require_once "$IP/extensions/Preloader/Preloader.php";
  • Done! Navigate to "Special:Version" on your wiki to verify that the extension is successfully installed.

Configuration

Configuration of the boilerplate sources is done via the $wgPreloaderSource configuration variable, which takes the following format:

$wgPreloaderSource[ NAMESPACE ] = PAGE TITLE;

For instance,

$wgPreloaderSource[ NS_MAIN ] = 'Template:Boilerplate';
$wgPreloaderSource[ NS_HELP ] = 'Template:Boilerplate help';

dictates that the boilerplate text for pages in the main namespace should be loaded from Template:Boilerplate, while pages in the Help namespace will be preloaded from Template:Boilerplate_help. Other namespaces have no boilerplate configured.

Feedback

Please submit comments, suggestions and bug reports to the extension's author via email.

See Also

Perhaps Extension:Preloader, Extension:PreloadManager, Extension:NewArticleTemplates and Extension:Boilerplate should be merged?