Template:Historical/doc

< Template:Historical
Revision as of 13:10, June 17, 2019 by Al15 (talk | contribs) (1 revision imported)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)

Usage

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}}. 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 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

<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