Extension:TemplateSandbox

From MediaWiki.org
Jump to: navigation, search
This is technical documentation of the extension. There is also a user documentation
MediaWiki extensions manual
Crystal Clear action run.png
TemplateSandbox

Release status: stable

Implementation Special page, Page action
Description Preview pages using sandboxed templates
Author(s) Brad Jorsch (Anomietalk)
Latest version 1.1.0 (2014-03-29)
MediaWiki 1.20, 1.21+
PHP 5.3+
Database changes No
License GPL v2+
Download
Parameters

$wgTemplateSandboxEditNamespaces

Hooks used
AlternateEditPreview

EditPage::importFormData
EditPage::showStandardInputs:options

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

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

The TemplateSandbox extension adds the ability to preview a page using sandboxed versions of templates, allowing for easy testing before making the sandbox code live. It also works with Scribunto modules.

Installation[edit | edit source]

  • Download and extract the file(s) in a directory called TemplateSandbox in your extensions/ folder. If you're a developer and this extension is in a Git repository, then instead you should clone the repository.
  • Add the following code at the bottom of your LocalSettings.php:
require_once "$IP/extensions/TemplateSandbox/TemplateSandbox.php";
  • Done! Navigate to "Special:Version" on your wiki to verify that the extension is successfully installed.

Configuration[edit | edit source]

Parameters
  • $wgTemplateSandboxEditNamespaces: Namespaces in which to show the "Preview page with this template" box below the edit form. NS_TEMPLATE by default.

Usage[edit | edit source]

The extension adds a new special page, Special:TemplateSandbox. To preview a page using sandboxed templates, do the following:

  1. Copy the templates to be tested under a common prefix. For example, you might copy Template:Foo to User:Example/sandbox/Template:Foo. Alternatively, you might create User:Example/sandbox/Template:Foo as a redirect to Template:Foo/sandbox.
  2. Go to Special:TemplateSandbox. Fill in the page or revision to be rendered, and the prefix you chose in step 1. It is possible to specify multiple prefixes (a prefix search path) by separating them using vertical bars, e.g. User:Example/sandbox1|User:Example/sandbox2.
  3. Click View.

The extension also adds a box at the bottom of the edit form for pages in the namespaces configured in $wgTemplateSandboxEditNamespaces. This allows for previewing some other page as it would appear were the template being edited saved with the current contents of the edit form.

See also[edit | edit source]