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
change | This template is "not" for use in articles or where there is an ongoing dispute. |
Basics
change- 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}} - For a former policy, use
{{Historical|type=policy}} - For a former guideline, use
{{Historical|type=guideline}} - For a page closed down by explicit community consensus, use
{{Historical|type=woundup}} - To 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}}.
- If you want to point to a successor page, use
- Pages using this template will be placed into Category:Inactive project pages unless the parameter
|category=nois 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}}.
Adding shortcuts
change- 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
changeNo description.
| Parameter | Description | Type | Status | |
|---|---|---|---|---|
| Shortcut 1 | 1 | no description | 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 | last | The date of the last substantative update to this page. | Date | suggested |
| date | date | Formerly an alias for last. | Date | deprecated |
| type | type | The type of page this is. Recognized values: policy, guideline, woundup, dbr.
| Line | suggested |
| brief | brief | Whether to use a shortened message.
| Boolean | optional |
| comment | comment | A message explaining why the page is obsolete | String | suggested |
| category | category | Whether to include this in [[Category:Inactive project pages]]
| Boolean | optional |