Template:Historical/doc: Difference between revisions
Appearance
Content deleted Content added
→Usage: note |
→Basics: c/e |
||
(21 intermediate revisions by 14 users not shown) | |||
Line 1: | Line 1: | ||
{{Documentation subpage}} |
{{Documentation subpage}} |
||
<!-- PLEASE ADD CATEGORIES AND INTERWIKIS AT THE BOTTOM OF THIS PAGE. --> |
<!-- PLEASE ADD CATEGORIES AND INTERWIKIS AT THE BOTTOM OF THIS PAGE. --> |
||
{{High risk}} |
|||
==Usage== |
==Usage== |
||
{{Warning|'''This template is |
{{Warning|'''This template is ''not'' for use in articles or where there is an ongoing dispute.''' }} |
||
===Basics=== |
===Basics=== |
||
* To include a shortcut, pass a [[Help:Template#Parameters|parameter]]: {{Tnull|Historical|2=WP:SHORT}}. |
* 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 |
* 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}} |
* To provide a briefer form of the text, use {{Tnull|Historical|2=brief=yes}} |
||
* Specifying the {{para|type}} parameter: |
|||
* For a former policy, use {{Tnull|Historical|2=type=policy}} |
|||
* For a former |
** For a former [[Wikipedia:Policy|policy]], use {{para|type|policy}} |
||
* For a |
** 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}}. |
|||
⚫ | |||
* 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). |
* 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]]. |
* 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". |
* 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 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}}. |
*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}}. |
||
===Adding shortcuts=== |
===Adding shortcuts=== |
||
Line 63: | Line 67: | ||
"type": "line", |
"type": "line", |
||
"suggested": true, |
"suggested": true, |
||
"description": "The type of page this is |
"description": "The type of page this is. Recognized values: policy, guideline, woundup, dbr.", |
||
"example": "policy" |
"example": "policy" |
||
}, |
}, |
||
Line 77: | Line 81: | ||
}, |
}, |
||
"category": { |
"category": { |
||
"description": "Whether to include this in [[ |
"description": "Whether to include this in [[Category:Inactive project pages]]", |
||
"example": "category=no", |
"example": "category=no", |
||
"type": "boolean", |
"type": "boolean", |
Latest revision as of 19:21, 5 November 2024
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. |
This template is used on approximately 25,000 pages and changes may be widely noticed. Test changes in the template's /sandbox or /testcases subpages, or in your own user subpage. Consider discussing changes on the talk page before implementing them. |
Usage
[edit]This template is not for use in articles or where there is an ongoing dispute. |
Basics
[edit]- 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: - 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}}
.
- 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=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}}
.
Adding shortcuts
[edit]- 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
[edit]No 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 |
See also
[edit]- {{WikiProject status}}
- {{failed}} for proposals that were never adopted
- Wikipedia:Template messages/Wikipedia namespace for a listing of Wikipedia namespace banners.