Help?

Help:Adding Extensions

From Textpattern CMS User Documentation

This help is just to confirm what you already know on adding MediaWiki exntensions. :)

Only extensions considered relevant to solving a real user problem, or providing benefit to wiki administration, should be bothered with. See Potentially Useful Extensions thread.

Always test an extension in the test-wiki before installing in main TextBook. Only stable/supported extensions that work with the current MW release should ever be installed.

Contents

Get the Extension

There's two reasonable places to look: MediaWiki's All Extensions listing, or directly in MediaWiki's extensions trunk (svn repo).

Not all extensions are in both places. The repo is likely better kept up to date, so always go there first. You can download from the repo without actually using svn.

We should probably see about putting TextBook under MediaWiki's subversion, since this would make future upgrades much easier/quicker, besides ensuring extensions are current.

Install the Extension

Add Package to File Tree

For any install of MediaWiki, there is a directory in the root called extensions. That's where all extensions go, meaning a given extension's folder (as developed) is copied into it. For example: ../extensions/DeleteBatch

Make the Configuration to Call Extension

Depending on which wiki your working with, you add the required_once call to the custom mods file for the respective wiki's LocalSettings:

  • Main TextBook: textbookSettings.inc
  • Test Wiki: LocalSettingsMods.inc
Would be nice to duplicate the file trees of the two wiki's as much as possible going into the future...for consistency.

The location to add the call is down near the bottom of the file and looks like follows:

## 
############  Extensions
##

# DeleteBatch (http://www.mediawiki.org/wiki/Extension:DeleteBatch)
require_once("$IP/extensions/DeleteBatch/DeleteBatch.php");

# MultiUpload (http://www.mediawiki.org/wiki/Extension:MultiUpload)
require_once("$IP/extensions/MultiUpload/SpecialMultipleUpload.php");

Add extensions in alphabetical order if you think about it.

Translations [?]