Extension:Preloader

From MediaWiki.org
Jump to navigation Jump to search
MediaWiki extensions manual
Crystal Clear action run.svg
Preloader
Release status: stable
Implementation Page action, Tag
Description Loads boilerplate text when creating new pages
Author(s) Rob Church, troyengel
Latest version 1.3.0 (2018-06-04)
MediaWiki 1.25+
Database changes No
License No license specified
Download
README
Parameters
$wgPreloaderSource
Hooks used
EditFormPreloadText
ParserFirstCallInit
Translate the Preloader extension if it is available at translatewiki.net
Check usage and version matrix.

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

  • Add the following code at the bottom of your LocalSettings.php:
    wfLoadExtension( 'Preloader' );
    
  • Yes 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 on Gitlab.

See Also