Help:Extension:TemplateSandbox

From Linux Web Expert

File:PD-icon.svg Note: When you edit this page, you agree to release your contribution under the CC0. See Public Domain Help Pages for more info. File:PD-icon.svg
This is user documentation for TemplateSandbox. Technical documentation for the TemplateSandbox extension is also available.

The TemplateSandbox extension makes it easier to test changes to templates and Scribunto modules by allowing the changes to be previewed in existing pages without making the changes live for everyone.

Testing a change to a single template

When the extension is installed and enabled, a box titled "⧼templatesandbox-editform-legend⧽" will appear on the edit form underneath the "Save page" and other buttons in template and module pages. If you enter the title of a page in the text field and use the adjacent "⧼templatesandbox-editform-view-label⧽" button, the entered page will be previewed as if the changes to the current template were saved.

Testing a change to multiple templates

To test changes to multiple templates, first save sandbox versions as subpages of a page somewhere. For example, to test changes to Template:Example 1 and Template:Example 2, you might save the sandbox versions to User:Example/sandbox/Template:Example 1 and User:Example/sandbox/Template:Example 2.

Next, go to Special:TemplateSandbox. Enter the title of the page to be previewed in the "⧼templatesandbox-page-label⧽" field, and the prefix used in the previous step (e.g. "User:Example/sandbox") in the "⧼templatesandbox-prefix-label⧽" field.

To preview a particular revision of a page, enter the revision number in the "⧼templatesandbox-revid-label⧽" field. To preview arbitrary wikitext, fill in both the "⧼templatesandbox-page-label⧽" (for magic words such as {{PAGENAME}}) and "⧼templatesandbox-text-label⧽" fields.

Note that the canonical name of the page must be used after the sandbox prefix; equivalent titles will not work. For example, User:Example/sandbox/Template:example 1 will not work, despite the fact that Template:example 1 is equivalent to Template:Example 1.