Template:Historical/doc

This is a documentation subpage for Template:Historical.
It may contain usage information, categories and other content that is not part of the original template page.

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 shortcut, pass a parameter: {{Historical|WP:SHORT}}.
To provide a last-updated date, use the named parameter |last= or |date=, i.e. {{Historical|last=1 January 2000}}. This should only be used for substantive updates, not things like bot tweaks or typo fixes.
To provide a briefer form of the text, use {{Historical|brief=yes}}
Specifying the |type= parameter:
- For a former policy, use |type=policy
- For a former guideline, use |type=guideline
- For a page closed down by explicit community consensus, use |type=woundup
- For a former essay which at one time had consensus, but is no longer relevant use |type=essay
To append the text of the template, and provide an explanatory comment, use {{Historical|comment=explanatory text here}}. Aliases for |comment= are |reason= and |result=.
- If you want to point to a successor page, use {{Superseded}} instead of {{Historical}}.
Pages using this template will be placed into Category:Inactive project pages unless the parameter |category=no is given: {{Historical|category=no}} (user and user talk pages are not categorized).
For related Wikipedia header templates, see Template messages/Wikipedia namespace.
Please note that this template is not appropriate for 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 WikiProject Council/Guide; these should be tagged with {{WikiProject status|Defunct}} or {{WikiProject status|Inactive}}.
To remove the message ~~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 village pump.~~ then set |brief=y.

Adding shortcuts

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

{{Historical|SHORTCUT}}

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

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

TemplateData

Mark a page as currently inactive and is retained for historical reference.

Template parameters
This template prefers inline formatting of parameters.
Parameter		Description	Type	Status
Shortcut 1	`1`	Shortcut Example WP:FOO	Page name	optional
Shortcut 2	`2`	no description	Page name	optional
Shortcut 3	`3`	no description	Page name	optional
Shortcut 4	`4`	no description	Page name	optional
Shortcut 5	`5`	no description	Page name	optional
Last update	`last` `date`	The date of the last substantative update to this page. Example 1 January 2001	Date	suggested
Type of page	`type`	The type of page it refers to. Recognized values: policy, guideline, woundup, dbr, section, essay. Optional, by default will output a generic statement. Suggested values `policy` `guideline` `woundup` `dbr` `section` `essay` Example policy	Line	suggested
Brief message?	`brief`	Whether to use a shortened message. Default no Example yes	Boolean	optional
Comment or reason	`comment` `reason` `result`	A message explaining why the page is obsolete	String	suggested
Categorize?	`category`	Whether to include this in [[Category:Inactive project pages]] Default yes Example no	Boolean	optional

Usage

Basics

Adding shortcuts

TemplateData

See also