Extension:TemplateSandbox
- This is technical documentation of the extension. There is also 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 (continuous updates) |
| Compatibility policy | Snapshots releases along with MediaWiki. Master is not backward compatible. |
| MediaWiki | >= 1.43 |
| License | GNU General Public License 2.0 or later |
| Download | |
| Help | Help:Extension:TemplateSandbox/en |
|
|
| Quarterly downloads | 54 (Ranked 81st) |
| 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
- Download and move the extracted
TemplateSandboxfolder to yourextensions/directory.
Developers and code contributors should install the extension from Git instead, using:cd extensions/
git clone https://gerrit.wikimedia.org/r/mediawiki/extensions/TemplateSandbox - Add the following code at the bottom of your LocalSettings.php file:
wfLoadExtension( 'TemplateSandbox' );
- Configure as required.
Done – Navigate to Special:Version on your wiki to verify that the extension is successfully installed.
Configuration
- Parameters
$wgTemplateSandboxEditNamespaces- Namespaces in which to show the "Preview page with this template" box below the edit form.NS_TEMPLATEby default. Can be expanded to all namespaces by individual users using advancedtemplatesandbox.js.
Usage
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
Template:FootoUser:Example/sandbox/Template:Foo. Alternatively, you might createUser:Example/sandbox/Template:Fooas a redirect toTemplate:Foo/sandbox. - 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. - 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
- User:Jackmcbarn/advancedtemplatesandbox.js — A user script that enables use of TemplateSandbox for all pages.
- Help:ExpandTemplates
- Extension:SandboxLink
- 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. |
| This extension is included in the following wiki farms/hosts and/or packages: This is not an authoritative list. Some wiki farms/hosts and/or packages may contain this extension even if they are not listed here. Always check with your wiki farms/hosts or bundle to confirm. |