- This is technical documentation of the extension. There is also a user documentation.
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)|
|License||GNU General Public License 2.0 or later|
Translate the TemplateSandbox extension if it is available at translatewiki.net
|Check usage and version matrix; code metrics|
|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 | edit source]
- 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:
- Done! Navigate to "Special:Version" on your wiki to verify that the extension is successfully installed.
§Configuration[edit | edit source]
$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:
- Copy the templates to be tested under a common prefix. For example, you might copy
User:Example/sandbox/Template:Foo. Alternatively, you might create
User:Example/sandbox/Template:Fooas a redirect to
- 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.
- 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]
- Extension:Scribunto − This extension also allows for sandboxing Scribunto modules.
|This extension is being used on one or more Wikimedia projects. This probably means that the extension is stable and works well enough to be used by such high-traffic websites. Look for this extension's name in Wikimedia's CommonSettings.php and InitialiseSettings.php configuration files to see where it's installed. A full list of the extensions installed on a particular wiki can be seen on the wiki's Special:Version page.|