View source for Template:User sandbox/doc

<noinclude>{{Pp-template|small=yes}}
</noinclude>{{Documentation subpage}}
<!-- Please place categories where indicated at the bottom of this page and interwikis at Wikidata (see [[Wikipedia:Wikidata]]) -->
{{not a sandbox}}
{{high-risk}}

This template is for placement at the top of [[WP:SANDBOX|sandbox]] pages in the [[WP:USER|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)

<pre>{{user sandbox}}</pre>

;Plain version

<pre>{{user sandbox|plain=yes}}</pre>

{{user sandbox|plain=yes|demospace=User}}

;All parameters

<pre style="overflow:auto;">{{user sandbox|Username|plain=all|list=[[Personalization|Custom]] [[WP:USERSUBPAGE|list]] of [[Help:My sandbox|sandboxes]]|selectskin=yes|afc=no|noindex=yes|demospace=User}}</pre>

{{user sandbox|Username|plain=all|list=[[Personalization|Custom]] [[WP:USERSUBPAGE|list]] of [[Help:My sandbox|sandboxes]]|selectskin=yes|afc=no|noindex=yes|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. <code><nowiki>[[User:Example/Sandbox1]], [[User:Example/Sandbox2]]</nowiki></code>.
* '''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 {{para|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 [[WP:NS|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 header}}
<templatedata>{
"description": "This template creates a box marking the current page as a user sandbox.",
"params": {
    "1": {
        "label": "Username",
        "description": "The username of the editor who owns the page.  If the page is in that editor's userspace, this parameter is optional.",
        "type": "string/wiki-user-name",
        "required": false
    },
    "plain": {
        "label": "Plain",
        "description": "If set to 'all', this hides all of the extra links.  If set to something else, this hides nearly all of the extra links.",
        "type": "string",
        "required": false
    },
    "list": {
        "label": "List",
        "description": "Can be set to a list of other sandboxes owned by this editor.  Optional.",
        "type": "string",
        "required": false
    },
    "selectskin": {
        "label": "Show skin selector",
        "description": "Set to 'yes' to include a menu for displaying the sandbox with different skins.",
        "type": "string",
        "required": false
    },
    "afc": {
        "label": "Show AFC notice",
        "description": "Set to 'no' to hide the AFC notice ('If you are writing an article...'), which is shown by default.",
        "type": "string",
        "required": false
    },
    "noindex": {
        "label": "Hide from search engines",
        "description": "Set to something other than 'yes' to make this page visible to search engines like Google.",
        "type": "string",
        "required": false
    },
    "demospace": {
        "label": "Demo namespace",
        "description": "Set to a namespace to make this template behave as if it is in that namespace.",
        "type": "string",
        "required": false
    }
}
}</templatedata>
<includeonly>{{Sandbox other||
<!-- Categories below this line, please; interwikis at Wikidata -->
[[Category:Sandbox templates]]
[[Category:Exclude in print]]
[[Category:Userpage header templates]]
}}</includeonly>

{{Userspace Disclaimers}}