Template:User sandbox/doc
 | This is a documentation subpage for Template:User sandbox. It contains usage information, categories and other content that is not part of the original template page. |
 | This page is not a sandbox. It should not be used for test editing. To experiment, please use the Wikipedia sandbox, your user sandbox, or the other sandboxes. |
 | This template is used on approximately 258,000 pages, or roughly 1151% of all pages. To avoid major disruption and server load, any changes should be tested in the template's /sandbox or /testcases subpages, or in your own user subpage. The tested changes can be added to this page in a single edit. Consider discussing changes on the talk page before implementing them. |
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.
Usage
- Basic usage (shown above)
{{user sandbox}}
- Plain version
{{user sandbox|plain=yes}}
 | This is the user sandbox of User sandbox. A user sandbox is a subpage of the user's user page. It serves as a testing spot and page development space for the user and is not an encyclopedia article. Create or edit your own sandbox here. |
- All parameters
{{user sandbox|Username|plain=all|list=[[Personalization|Custom]] [[WP:USERSUBPAGE|list]] of [[Help:My sandbox|sandboxes]]|selectskin=yes|afc=no|noindex=yes|demospace=User}}
| This is a user sandbox of Username. A user sandbox is a subpage of the user's user page. It serves as a testing spot and page development space for the user and is not an encyclopedia article. |
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]]. - selectskin - if this is set to "yes", a menu appears allowing you to select different skins to use with the sandbox.
- afc - if this is set to "no", the text "If you are writing an article, and are ready to request its creation, click here" is suppressed. This parameter is unnecessary if the
|plain=parameter is specified. - noindex - by default, pages with this template transcluded on them are not indexed by search engines. If this parameter is set to anything other than "yes", indexing by search engines is allowed.
- demospace - if this is set to the name of a Wikipedia namespace, the template acts as if it was transcluded in that namespace no matter what the actual current namespace is. This is useful for demonstration purposes.
Template data
TemplateData for User sandbox
This template creates a box marking the current page as a user sandbox.
| 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 ('If you are writing an article...'), 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 |