View source for Template:Historical/doc

{{Documentation subpage}}
<!-- Please place categories where indicated at the bottom of this page and interwikis at Wikidata (see [[Wikipedia:Wikidata]]) -->
{{High risk}}
==Usage==
This template should ''not'' be used in articles or in ongoing disputes. It is intended solely for genuine housekeeping purposes and should not be used to prematurely conclude discussions or proposals unless all participants agree to do so.
===Basics===
* To include a [[Wikipedia:Shortcut|shortcut]], pass a [[Help:Template#Parameters|parameter]]: {{Tnull|Historical|2=WP:SHORT}}.
* To provide a last-updated date, use the named parameter {{para|last}} or {{para|date}}, i.e. {{Tnull|Historical|2=last=1 January 2000}}. This should only be used for {{em|substantive}} updates, not things like bot tweaks or typo fixes.
* To provide a briefer form of the text, use {{Tnull|Historical|2=brief=yes}}
* Specifying the {{para|type}} parameter:
** For a former [[Wikipedia:Policy|policy]], use {{para|type|policy}}
** For a former [[Wikipedia:Guideline|guideline]], use {{para|type|guideline}}
** For a page closed down by explicit community [[Wikipedia:Consensus|consensus]], use {{para|type|woundup}}
** For a former [[Wikipedia:Essays|essay]] which at one time had consensus, but is no longer relevant use {{para|type|essay}}
* To append the text of the template, and provide an [[Wikipedia:COMMENT|explanatory comment]], use {{Tnull|Historical|2=comment=explanatory text here}}.  Aliases for {{para|comment}} are {{para|reason}} and {{para|result}}.
** If you want to point to a successor page, use {{tlx|Superseded}} instead of {{tnull|Historical}}.
* Pages using this template will be placed into [[:Category:Inactive project pages]] unless the parameter {{para|category|no}} is given: {{tnull|Historical|2=category=no}} (user and user talk pages are not categorized).
* For related [[:Category:Wikipedia header templates|Wikipedia header templates]], see [[Wikipedia:Template messages/Wikipedia namespace|Template messages/Wikipedia namespace]].
* Please note that this template is {{em|not}} appropriate for [[WP:PORTAL|portals]], which exist for the purpose of informing readers on a given topic and, as such, can never truly be "inactive".
*It is also not appropriate for inactive WikiProjects or task forces, which are dealt with according to the [[Wikipedia:WikiProject Council/Guide#Dealing with inactive WikiProjects|WikiProject Council/Guide]]; these should be tagged with {{tlx|WikiProject status|Defunct}} or {{tlx|WikiProject status|Inactive}}.
*To remove the message {{dc|Either the page is no longer relevant or consensus on its purpose has become unclear. To revive discussion, seek broader input via a forum such as the [[Wikipedia:Village pump (proposals)|village pump]].}} then set {{para|brief|y}}.

===Adding shortcuts===
*In addition, a shortcut can be added to this template by using the following syntax:

:{{Tlc|Historical|SHORTCUT}}

*Up to 5 shortcuts can be added to this template in this fashion:

:{{Tlc|Historical|SHORTCUT1|SHORTCUT2|SHORTCUT3|SHORTCUT4|SHORTCUT5}}

== TemplateData ==
<templatedata>
{
	"params": {
		"1": {
			"label": "Shortcut 1",
			"type": "wiki-page-name",
			"description": "Shortcut",
			"example": "WP:FOO"
		},
		"2": {
			"label": "Shortcut 2",
			"type": "wiki-page-name"
		},
		"3": {
			"label": "Shortcut 3",
			"type": "wiki-page-name"
		},
		"4": {
			"label": "Shortcut 4",
			"type": "wiki-page-name"
		},
		"5": {
			"label": "Shortcut 5",
			"type": "wiki-page-name"
		},
		"last": {
			"description": "The date of the last substantative update to this page.",
			"type": "date",
			"suggested": true,
			"label": "Last update",
			"example": "1 January 2001",
			"aliases": [
				"date"
			]
		},
		"type": {
			"type": "line",
			"suggested": true,
			"description": "The type of page it refers to. Recognized values: policy, guideline, woundup, dbr, section, essay. Optional, by default will output a generic statement.",
			"example": "policy",
			"label": "Type of page",
			"suggestedvalues": [
				"policy",
				"guideline",
				"woundup",
				"dbr",
				"section",
				"essay"
			]
		},
		"brief": {
			"type": "boolean",
			"description": "Whether to use a shortened message.",
			"default": "no",
			"label": "Brief message?",
			"example": "yes"
		},
		"comment": {
			"type": "string",
			"suggested": true,
			"description": "A message explaining why the page is obsolete",
			"aliases": [
				"reason",
				"result"
			],
			"label": "Comment or reason"
		},
		"category": {
			"description": "Whether to include this in [[Category:Inactive project pages]]",
			"example": "no",
			"type": "boolean",
			"default": "yes",
			"label": "Categorize?"
		}
	},
	"paramOrder": [
		"1",
		"2",
		"3",
		"4",
		"5",
		"last",
		"type",
		"brief",
		"comment",
		"category"
	],
	"format": "inline",
	"description": "Mark a page as currently inactive and is retained for historical reference."
}
</templatedata>

==See also==
* {{tl|WikiProject status}}
* {{tl|failed}} for proposals that were never adopted
* [[Wikipedia:Template messages/Wikipedia namespace]] for a listing of Wikipedia namespace banners.

<includeonly>{{Sandbox other||
<!-- Categories below this line, please; interwikis at Wikidata -->
[[Category:Wikipedia header templates|Historical]]

}}</includeonly>