Extension:TemplateSandbox

Aus MediaWiki
Zur Navigation springen Zur Suche springen
Other languages: English  • Deutsch • 中文
This is technical documentation of the extension. There is also a user documentation.
MediaWiki extensions manual
Crystal Clear action run.svg
TemplateSandbox
Release status: stable
Screenshot of TemplateSandbox.png
Implementation Special page, Page action
Description Preview pages using sandboxed templates
Author(s) Brad Jorsch (AnomieDiskussion)
Latest version 1.1.0 (2014-03-29)
Compatibility policy release branches
MediaWiki 1.21+
PHP 5.5+
Database changes No
License GNU General Public License 2.0 or later
Download
Parameters
  • $wgTemplateSandboxEditNamespaces
Hooks used
AlternateEditPreview
EditPage::importFormData
EditPage::showStandardInputs:options
ApiParseMakeOutputPage
Translate the TemplateSandbox extension if it is available at translatewiki.net
Check usage and version matrix.
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[Bearbeiten]

  • 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:
    wfLoadExtension( 'TemplateSandbox' );
    
  • Yes Done – Navigate to Special:Version on your wiki to verify that the extension is successfully installed.

To users running MediaWiki 1.24 or earlier:

The instructions above describe the new way of installing this extension using wfLoadExtension() If you need to install this extension on these earlier versions (MediaWiki 1.24 and earlier), instead of wfLoadExtension( 'TemplateSandbox' );, you need to use:

require_once "$IP/extensions/TemplateSandbox/TemplateSandbox.php";

Configuration[Bearbeiten]

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[Bearbeiten]

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[Bearbeiten]