Jump to content

Template:Historical/doc: Difference between revisions

From Wikipedia, the free encyclopedia
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 "not" for use in articles or where there is an ongoing dispute.''' }}
{{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 "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 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 guideline, use {{Tnull|Historical|2=type=guideline}}
** For a former [[Wikipedia:Policy|policy]], use {{para|type|policy}}
* For a page closed down by explicit community consensus, use {{Tnull|Historical|2=type=woundup}}
** 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}}
* To provide an explanatory comment, use {{Tnull|Historical|2=comment=explanatory text here}}. If you want to point to a successor page, use {{tlx|Superseded}} instead of {{tnull|Historical}}.
** 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}}.
** 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).
* 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, eg. policy, guideline, script, etc.",
"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 [[:Category:Inactive project pages]]",
"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

Usage

[edit]

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

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.

Template parameters

This template prefers inline formatting of parameters.

ParameterDescriptionTypeStatus
Shortcut 11

no description

Page nameoptional
Shortcut 22

no description

Page nameoptional
Shortcut 33

no description

Page nameoptional
Shortcut 44

no description

Page nameoptional
Shortcut 55

no description

Page nameoptional
lastlast

The date of the last substantative update to this page.

Datesuggested
datedate

Formerly an alias for last.

Datedeprecated
typetype

The type of page this is. Recognized values: policy, guideline, woundup, dbr.

Example
policy
Linesuggested
briefbrief

Whether to use a shortened message.

Default
no
Booleanoptional
commentcomment

A message explaining why the page is obsolete

Stringsuggested
categorycategory

Whether to include this in [[Category:Inactive project pages]]

Default
yes
Example
category=no
Booleanoptional

See also

[edit]