Extension:TemplateSandbox

This is technical documentation of the extension. There is also a user documentation.
MediaWiki extensions manual
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 (continuous updates)
Compatibility policy Snapshots releases along with MediaWiki. Master is not backward compatible.
MediaWiki 1.35+
PHP 7.0+
License GNU General Public License 2.0 or later
Download
Help Help:Extension:TemplateSandbox
  • $wgTemplateSandboxEditNamespaces
Quarterly downloads 71 (Ranked 96th)
Public wikis using 1,040 (Ranked 233rd)
Translate the TemplateSandbox extension if it is available at translatewiki.net
Issues Open tasks · Report a bug

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

  • Download and place the file(s) in a directory called TemplateSandbox in your extensions/ folder.
  • Add the following code at the bottom of your LocalSettings.php file:
    wfLoadExtension( 'TemplateSandbox' );
    
  •   Done – Navigate to Special:Version on your wiki to verify that the extension is successfully installed.


Configuration edit

Parameters
  • $wgTemplateSandboxEditNamespaces - Namespaces in which to show the "Preview page with this template" box below the edit form. NS_TEMPLATE by default. Can be expanded to all namespaces by individual users using advancedtemplatesandbox.js.

Usage edit

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. The box can be forced to appear in the edit form for any page by adding the query parameter wpTemplateSandboxShow to the URL.

See also edit