Template:User sandbox/doc

This template is for placement at the top of sandbox pages in the User namespace so that readers understand it is not an active/live article or Wikipedia project page.

Non-userspace uses of this template are tracked in Category:Non-userspace pages using User sandbox.

It is used by Template:User sandbox/preload, the default text preloaded (by MediaWiki:Gadget-mySandbox.js) when a user creates their sandbox.

Usage

Basic usage (shown above)

{{user sandbox}}

Plain version

{{user sandbox|plain=yes}}

Complex example

{{user sandbox|Username|plain=all|list=[[Personalization|Custom]] [[WP:USERSUBPAGE|list]] of [[Help:My sandbox|sandboxes]]|selectskin=yes|afc=no|demospace=User}}

Parameters

• The first positional parameter is the username of the editor the sandbox belongs to. This is not necessary if the sandbox is located in that user's userspace.
• plain - this removes most of the extra links. If this is equal to "all", only the basic message is left. If this parameter is present but not equal to "all", the text "For a sandbox of your own, create it here" is still visible.
• list - a list of your user sandboxes can be inserted here. This needs to be done with square brackets, e.g. [[User:Example/Sandbox1]], [[User:Example/Sandbox2]]. Use of this parameter also changes "the sandbox" to "a sandbox". For an automatically-generated list of your sandboxes, you can use {{Special:PrefixIndex}}. For example, if your sandboxes are titled as "sandbox", "sandbox2", etc, you can use list={{Special:PrefixIndex/User:{{ROOTPAGENAME}}/sandbox}}.
• a=yes - changes "the sandbox" to "a sandbox", without having to use the "list" parameter above.
• selectskin=yes - a menu appears allowing you to select different skins to use with the sandbox.
• afc=no - the articles for creation text "Finished writing a draft article? Are you ready to request an experienced editor review it for possible inclusion in Wikipedia? [Submit your draft for review!]" is suppressed. This parameter is unnecessary if the |plain= parameter is specified.
• noindex=no - indexing by search engines will be allowed (by default, noindex is "yes", i.e. pages with this template transcluded on them are not indexed by search engines). This parameter should almost always be omitted, because sandboxes should not be indexed as Wikipedia content.
• demospace - if this is set to the name of a Wikipedia namespace, the template acts as if it were transcluded in that namespace no matter what the actual current namespace is. This is useful for demonstration purposes.

Template data

This is the TemplateData for this template used by TemplateWizard, VisualEditor and other tools. See a monthly parameter usage report for Template:User sandbox in articles based on its TemplateData.

TemplateData for User sandbox

This template creates a box marking the current page as a user sandbox.

Template parameters

Parameter		Description	Type	Status
Username	1	The username of the editor who owns the page. If the page is in that editor's userspace, this parameter is optional.	User	optional
Plain	plain	If set to 'all', this hides all of the extra links. If set to something else, this hides nearly all of the extra links.	String	optional
List	list	Can be set to a list of other sandboxes owned by this editor. Optional.	String	optional
Show skin selector	selectskin	Set to 'yes' to include a menu for displaying the sandbox with different skins.	String	optional
Show AFC notice	afc	Set to 'no' to hide the AFC notice ('Finished writing a draft article? Are you ready...'), which is shown by default.	String	optional
Hide from search engines	noindex	Set to something other than 'yes' to make this page visible to search engines like Google.	String	optional
Demo namespace	demospace	Set to a namespace to make this template behave as if it is in that namespace.	String	optional