View source for Template:Under construction/doc

{{documentation subpage}}<!--
        PLEASE NOTE

        This is NOT the place to create new articles. Any material placed here as part of a
        new article as a "work in progress" will be deleted. Please read [[Wikipedia:Starting an article]]
        for guidelines on creating an article.
-->
{{Redirect-distinguish2|[[Template:UC]]|the <code><nowiki>{{uc:string}}</nowiki></code> [[WP:MAGIC#Formatting|magic word]]}}
<!-- Categories go where indicated at the bottom of this page, please; interwikis go to Wikidata (see also: [[Wikipedia:Wikidata]]). -->
'''''Example template:'''''
{{Under construction|nocat=true}}
----
{{Twinkle standard installation}}
{{Template shortcut|uc|UC}}
== Usage ==
{{Main|Wikipedia:How to edit a page|Wikipedia:Template messages|Template:In use/doc}}

This template is for articles actively undergoing construction. If the article instead is actively undergoing a major edit, please use {{Tl|In use}}.

In general, this template should not be used for new articles with little or no content. Instead, the [[Wikipedia:About the Sandbox|sandbox]] should be used to develop the article so that it has reasonable content when it is copied into mainspace.

Articles tagged with this template are automatically added to the category [[:Category:Pages actively undergoing construction]].  Add the parameter <code>|placedby=</code> (followed by your user name; do not insert a full signature) to make it easy for people to contact the person who placed the template. If a page using this template has not been edited in 8 days, a bot will automatically remove the template.

If used on a non-article page (such as a user page) which is not yet ready for use, type {{Tlx|Under construction|notready&#61;true}}. That will produce the following:
{{Under construction|notready=true|nocat=true}}

A comment may be added to the box using the ''|comment='' switch.

As this template is used in multiple namespaces it uses {{tl|mbox}}, which will automatically detect individual namespace usage and adapt appropriate styling accordingly.

===Blank template===
<syntaxhighlight lang="wikitext">{{Under construction |placedby= |section= |nosection= |nocat= |notready= |comment= |category= |altimage= |notify= }}</syntaxhighlight>

===Parameters===
*'''altimage''' – provide an alternate image for the template.  Should be a complete file tag, e.g. <code><nowiki>[[File:Under_construction_icon-orange.svg|64px]]</nowiki></code>
*'''category''' – a custom category (must be prefixed with the "Category:" namespace identifier and enclosed in double square brackets) into which the page will be placed.  If omitted, the page is placed by default in [[:Category:Pages actively undergoing construction]].  However the page will not be placed into a category if the page is in the "User:" or "User talk:" namespaces.
*'''comment''' – free-form text. If present, the text "Contributor note:" is shown followed by the content of {{para|comment}}.
*'''nocat''' – set to '''true''' (e.g. {{mono|<nowiki>nocat=true</nowiki>}}) to prevent the page from being placed into default [[:Category:Pages actively undergoing construction]] or into custom category. Set to anything but '''true''' or don't set it at all, and it will be included.
*'''notready''' – value is immaterial, but if present, and not blank, adds the text ", and is not yet ready for use" following the word "restructuring".
*'''nosection''' – value is immaterial, but if present, and not blank (e.g. {{mono|<nowiki>nosection=yes</nowiki>}}), removes the phrase "or section", i.e. makes the message apply to the entire page
*'''placedby''' – user name of the person placing the template. Do not use a full talk page signature.
*'''section''' – value is immaterial, but if present, and not blank (e.g. {{mono|<nowiki>section=yes</nowiki>}}), removes the phrase "article or", i.e. makes the message apply only to a section.
*'''subsection''' – value is immaterial, but if present, and not blank (e.g. {{mono|<nowiki>subsection=yes</nowiki>}}), removes the phrase "article or", i.e. makes the message apply only to a subsection.
*'''notify''' – yes, y or any value. Placing editor wants to be notified on their talk page if template is removed.

== Template data ==
<templatedata>
{
	"params": {
		"altimage": {
			"label": "Alternate image",
			"description": "Provide an alternate image for the template. Should be a complete file tag.",
			"example": "[[File:Under_construction_icon-orange.svg|64px]]",
			"type": "wiki-file-name"
		},
		"section": {
			"label": "Section",
			"description": "Replaces phrase \"article\" with \"section\"",
			"type": "string",
			"suggested": true
		},
		"subsection": {
			"label": "Subsection",
			"description": "Replaces phrase \"article\" with \"subsection\"",
			"type": "string",
			"suggested": true
		},
		"nosection": {
			"label": "No section",
			"description": "Replaces phrase \"section\" with article",
			"type": "string"
		},
		"notready": {
			"label": "Not ready",
			"description": "Adds the text \", and is not yet ready for use\" following the word \"restructuring\".",
			"type": "string"
		},
		"placedby": {
			"label": "Placed by",
			"description": "User name of the person placing the template.",
			"type": "wiki-user-name",
			"example": "Jack",
			"required": true
		},
		"comment": {
			"label": "Comment",
			"description": "A place to add any additional details to the template",
			"type": "unbalanced-wikitext"
		},
		"nocat": {
			"label": "No category",
			"description": "Prevents the page from being placed into default Category:Pages actively undergoing construction or into custom category.",
			"type": "string",
			"default": "false"
		},
		"Category": {
			"description": "A custom category (must be prefixed with the \"Category:\" namespace identifier and enclosed in double square brackets) into which the page will be placed.",
			"example": "[[Category:Science articles undergoing expansion]]",
			"type": "unbalanced-wikitext"
		},
		"notify": {
			"label": "Notify",
			"description": "Asks that the placing editor be notified if template is removed.",
			"type": "string"
		}
	},
	"paramOrder": [
		"altimage",
		"section",
		"subsection",
		"nosection",
		"notready",
		"placedby",
		"comment",
		"nocat",
		"Category",
        "notify"
	],
	"format": "inline",
	"description": "This template is for articles actively undergoing construction. If the article instead is actively undergoing a major edit, please use {{In use}}. "
}
</templatedata>

== See also ==
* {{tl|In creation}} to use this template when multiple edits are being made to add content immediately after creating the article
* {{tl|In use}}, for articles actively undergoing a major edit for a short while to list them in [[:Category:Pages actively undergoing a major edit]]
* {{tl|Under discussion}}, for a non main page undergoing active discussion on its talk page
* {{T1|recently revised}}, if you are unsure about your revision/major changes and want a second opinion 
* {{tl|Deletion under review}}, to prevent deletion nomination until the review process is complete

* [[Wikipedia:Deletion of newly created pages]], regarding preventing pages from getting deleted while they are brand new.

<includeonly>{{Sandbox other||
<!-- Categories go below this line, please; interwikis go to Wikidata, thank you! -->
[[Category:Under-construction templates|{{PAGENAME}}]]

}}</includeonly>