tengel/Preloader
Archived
1
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

Some modernization & code cleanup

Browse source 
* Move the Preloader class into its own file + add $wgAutoloadClasses entry
* Coding style tweaks, as per MediaWiki's coding conventions
* Converted from PHP-based i18n to JSON i18n
* Version 1.3 with the appropriate changelog entries and whatnot
* Deprecated Preloader.php (but didn't fully remove it yet) in favor of extension.json -- MediaWiki 1.25 or newer is now required for this extension
* Added myself into authors
* Changed the Special:Version URL back to MediaWiki.org as it should be the canonical location for extension (and skin etc.) documentation; since this is an updated version of [[mw:Extension:Preloader]] it should be no problem to update that page to point to the correct repository etc.
* Tweak the README file to account for new MW requirements + extension loading method
* Fix $wgPreloaderSource so that it works again ( HT @legoktm )
This commit is contained in:
tengel 2024-03-20 09:20:41 -05:00
parent 8a1c409feb
commit 9b7b7526ab
58 changed files with 534 additions and 462 deletions
Download patch file Download diff file Expand all files Collapse all files

14
README.md
View file

@ -1,7 +1,7 @@
Preloader MediaWiki Extension
=============================
Fork of http://www.mediawiki.org/wiki/Extension:Preloader
See http://www.mediawiki.org/wiki/Extension:Preloader
## Overview
@ -20,11 +20,11 @@ This extension supports the standard `<includeonly>` and `<noinclude>` tags in t
## 2. Requirements
The Preloader extension requires MediaWiki 1.7.0 or later.
The Preloader extension requires MediaWiki 1.25.0 or later.
## 3. Installation
Git - clone the Github repository into your extensions subdirectory:
Git - clone the GitHub repository into your extensions subdirectory:
```
cd /path/to/wiki/extensions
@ -38,7 +38,7 @@ Composer - the package is available via Composer / Packagist:
Then edit your `LocalSettings.php` file and add the following line:
```
require_once "$IP/extensions/Preloader/Preloader.php";
wfLoadExtension( 'Preloader' );
```
Installation can be verified through the **Special:Version** page on your wiki.
@ -48,14 +48,14 @@ Installation can be verified through the **Special:Version** page on your wiki.
Configuration of the boilerplate sources is done via the `$wgPreloaderSource` configuration variable, which takes the following format:
```
$wgPreloaderSource[ <namespace index> ] = PAGE TITLE;
$wgPreloaderSource[<namespace index>] = PAGE TITLE;
```
For instance:
```
$wgPreloaderSource[ NS_MAIN ] = 'Template:Boilerplate';
$wgPreloaderSource[ NS_HELP ] = 'Template:Boilerplate help';
$wgPreloaderSource[NS_MAIN] = 'Template:Boilerplate';
$wgPreloaderSource[NS_HELP] = 'Template:Boilerplate help';
```
...indicates 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.