Difference between revisions of "Template:Historical/doc"
Jump to navigation
Jump to search
imported>SMcCandlish (→Usage: update) |
|||
| (2 intermediate revisions by 2 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. --> | ||
| + | ==Usage== | ||
| + | {{Warning|'''This template is "not" for use in articles or where there is an ongoing dispute.''' }} | ||
| + | |||
| + | ===Basics=== | ||
| + | * To include a shortcut, pass a [[Help:Template#Parameters|parameter]]: {{Tnull|Historical|2=WP:SHORT}}. | ||
| + | * To provide a last-updated date, use the named parameter "last" or "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}} | ||
| + | * For a former policy, use {{Tnull|Historical|2=type=policy}} | ||
| + | * For a former guideline, use {{Tnull|Historical|2=type=guideline}} | ||
| + | * For a page closed down by explicit community consensus, use {{Tnull|Historical|2=type=woundup}} | ||
| + | * To provide an 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}}. | ||
| + | |||
| + | ===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" | ||
| + | }, | ||
| + | "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 | ||
| + | }, | ||
| + | "date": { | ||
| + | "description": "Formerly an alias for last.", | ||
| + | "type": "date", | ||
| + | "deprecated": "Deprecated for confusion with deprecated-date" | ||
| + | }, | ||
| + | "type": { | ||
| + | "type": "line", | ||
| + | "suggested": true, | ||
| + | "description": "The type of page this is, eg. policy, guideline, script, etc.", | ||
| + | "example": "policy" | ||
| + | }, | ||
| + | "brief": { | ||
| + | "type": "boolean", | ||
| + | "description": "Whether to use a shortened message.", | ||
| + | "default": "no" | ||
| + | }, | ||
| + | "comment": { | ||
| + | "type": "string", | ||
| + | "suggested": true, | ||
| + | "description": "A message explaining why the page is obsolete" | ||
| + | }, | ||
| + | "category": { | ||
| + | "description": "Whether to include this in [[Category:Inactive project pages]]", | ||
| + | "example": "category=no", | ||
| + | "type": "boolean", | ||
| + | "default": "yes" | ||
| + | } | ||
| + | }, | ||
| + | "paramOrder": [ | ||
| + | "1", | ||
| + | "2", | ||
| + | "3", | ||
| + | "4", | ||
| + | "5", | ||
| + | "last", | ||
| + | "date", | ||
| + | "type", | ||
| + | "brief", | ||
| + | "comment", | ||
| + | "category" | ||
| + | ], | ||
| + | "format": "inline" | ||
| + | } | ||
| + | </templatedata> | ||
| + | |||
==See also== | ==See also== | ||
* {{tl|WikiProject status}} | * {{tl|WikiProject status}} | ||
Latest revision as of 10:11, 28 January 2021
| This is a documentation subpage for Template:Historical. It contains usage information, categories and other content that is not part of the original template page. |
Usage
| This template is "not" for use in articles or where there is an ongoing dispute. |
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}} - 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
- 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
No description.
| Parameter | Description | Type | Status | |
|---|---|---|---|---|
| Shortcut 1 | 1 | no description | Page | optional |
| Shortcut 2 | 2 | no description | Page | optional |
| Shortcut 3 | 3 | no description | Page | optional |
| Shortcut 4 | 4 | no description | Page | optional |
| Shortcut 5 | 5 | no description | Page | 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, eg. policy, guideline, script, etc.
| 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
- {{WikiProject status}}
- {{failed}} for proposals that were never adopted
- Wikipedia:Template messages/Wikipedia namespace for a listing of Wikipedia namespace banners.