Template:Historical: Difference between revisions

From Unofficial Homecoming Wiki
Jump to navigation Jump to search
imported>Konoko
(added 'more' parameter and another option for the 'reason' parameter)
imported>Sekoia
(moved docs to subpage)
Line 1: Line 1:
{| class="messagebox"
<includeonly>{| class="messagebox"
|-
|-
| style="padding-right: 5px;" | [[Image:Badge_time.png]]
| style="padding-right: 5px;" | [[Image:Badge_time.png]]
Line 23: Line 23:
| hv
| hv
| #default = Heroes/Villains}}. {{#if:{{{more|}}}|{{{more}}}|It is provided only for historical purposes.}}
| #default = Heroes/Villains}}. {{#if:{{{more|}}}|{{{more}}}|It is provided only for historical purposes.}}
|}<noinclude>
|}</includeonly><noinclude>{{Documentation}}</noinclude>
== Overview ==
This template is to be used for articles or sections of articles that fit the description in the message.
 
== Parameters ==
All parameters are optional. If not supplied, a default value will be used.
 
; type
: Purpose: Indicates whether the message applies to the whole article or just a section.
: Default: "article or section"
: Accepts: Anything, but should probably be "article" or "section".
 
; reason
: Purpose: A keyword that indicates which reason this is historical. Fills in the spot between "... contains information ..." and "...City of...".
: Default: that no longer applies to the current version of
: Accepts:
:* change = about changes that took place in
:* event = about a past event in
:* maybe = that may not apply to the current version of
:* notused = about a system or idea that was never implemented into
:* obsolete = that no longer applies to the current version of
:* issue = about a major update to
 
; game
: Purpose: Indicates which game the message applies to. Will be preceded by "City of ".
: Default: "Heroes/Villains"
: Accepts:
:*h, coh, hero, heroes ''for'' "Heroes"
:*v, cov, villain, villains ''for'' "Villains"
:*both, hv ''for'' "Heroes/Villains"
:*vh ''for'' "Villains/Heroes"
 
; more
: Used to replace the last sentence with more descriptive sentence, particularly for [[Issues]]
== Usage ==
 
{| style="margin: 1em 1em 1em 0; background: #f9f9f9; border: 1px #aaaaaa solid; border-collapse: collapse;"
|-
! style="border: 1px #aaaaaa solid; padding: 0.2em;" | Template Call
! style="border: 1px #aaaaaa solid; padding: 0.2em;" | Result
|-
| style="border: 1px #aaaaaa solid; padding: 0.2em;" | {{tl|historical}}
| style="border: 1px #aaaaaa solid; padding: 0.2em;" | {{historical}}
|-
| style="border: 1px #aaaaaa solid; padding: 0.2em;" | {{tl|historical|type&#61;article}}
| style="border: 1px #aaaaaa solid; padding: 0.2em;" | {{historical|type=article}}
|-
| style="border: 1px #aaaaaa solid; padding: 0.2em;" | {{tl|historical|type&#61;section}}
| style="border: 1px #aaaaaa solid; padding: 0.2em;" | {{historical|type=section}}
|-
| style="border: 1px #aaaaaa solid; padding: 0.2em;" | {{tl|historical|game&#61;coh}}
| style="border: 1px #aaaaaa solid; padding: 0.2em;" | {{historical|game=coh}}
|-
| style="border: 1px #aaaaaa solid; padding: 0.2em;" | {{tl|historical|game&#61;v}}
| style="border: 1px #aaaaaa solid; padding: 0.2em;" | {{historical|game=v}}
|-
| style="border: 1px #aaaaaa solid; padding: 0.2em;" | {{tl|historical|game&#61;vh}}
| style="border: 1px #aaaaaa solid; padding: 0.2em;" | {{historical|game=vh}}
|-
| style="border: 1px #aaaaaa solid; padding: 0.2em;" | {{tl|historical|reason&#61;obsolete}}
| style="border: 1px #aaaaaa solid; padding: 0.2em;" | {{historical|reason=obsolete}}
|-
| style="border: 1px #aaaaaa solid; padding: 0.2em;" | {{tl|historical|reason&#61;maybe}}
| style="border: 1px #aaaaaa solid; padding: 0.2em;" | {{historical|reason=maybe}}
|-
| style="border: 1px #aaaaaa solid; padding: 0.2em;" | {{tl|historical|reason&#61;event}}
| style="border: 1px #aaaaaa solid; padding: 0.2em;" | {{historical|reason=event}}
|-
| style="border: 1px #aaaaaa solid; padding: 0.2em;" | {{tl|historical|game&#61;v|reason&#61;event|type&#61;section}}
| style="border: 1px #aaaaaa solid; padding: 0.2em;" | {{historical|game=v|reason=event|type=section}}
|-
| style="border: 1px #aaaaaa solid; padding: 0.2em;" | {{tl|historical|game&#61;h|reason&#61;change|type&#61;section}}
| style="border: 1px #aaaaaa solid; padding: 0.2em;" | {{historical|game=h|reason=change|type=section}}
|}
[[Category:Templates]]</noinclude>

Revision as of 12:56, 15 March 2008

[edit] [purge] Documentation
This documentation is transcluded from Template:Historical/doc. (edit | history)

Overview

This template is to be used for articles or sections of articles that fit the description in the message.

Parameters

All parameters are optional. If not supplied, a default value will be used.

type
Purpose: Indicates whether the message applies to the whole article or just a section.
Default: "article or section"
Accepts: Anything, but should probably be "article" or "section".
reason
Purpose: A keyword that indicates which reason this is historical. Fills in the spot between "... contains information ..." and "...City of...".
Default: that no longer applies to the current version of
Accepts:
  • change = about changes that took place in
  • event = about a past event in
  • maybe = that may not apply to the current version of
  • notused = about a system or idea that was never implemented into
  • obsolete = that no longer applies to the current version of
  • issue = about a major update to
  • nopaid = about content which required payment in the past, but is now available to all players in the current version of
customreason
Purpose: Supplies a customized reason when there exists no reason= option that will work. Try to use only for special cases! If a more generalized reason can be added to reason=, that may be better. If used, this will disable reason=.
Accepts: Anything.
game
Purpose: Indicates which game the message applies to.
Default: "City of Heroes Freedom"
Accepts:
  • f, freedom for "City of Heroes Freedom"
  • h, coh, hero, heroes for "City of Heroes"
  • v, cov, villain, villains for "City of Villains"
  • both, hv for "City of Heroes/Villains"
  • vh for "City of Villains/Heroes"
more
Purpose: Used to replace the last sentence with more descriptive sentence, when applicable.
Accepts: Anything.
text
Purpose: Used to provide custom text to replace the entire text structure that is normally used. Thus, all other parameters will have no effect. This should be used fairly sparingly.
Accepts: Anything.

Usage

Template Call Result
{{historical}}
Badge time.png This article or section contains information that no longer applies to the current version of City of Heroes/Villains. It is provided only for historical purposes.
{{historical|type=article}}
Badge time.png This article contains information that no longer applies to the current version of City of Heroes/Villains. It is provided only for historical purposes.
{{historical|type=section}}
Badge time.png This section contains information that no longer applies to the current version of City of Heroes/Villains. It is provided only for historical purposes.
{{historical|game=f}}
Badge time.png This article or section contains information that no longer applies to the current version of City of Heroes/Villains. It is provided only for historical purposes.
{{historical|game=coh}}
Badge time.png This article or section contains information that no longer applies to the current version of City of Heroes. It is provided only for historical purposes.
{{historical|game=v}}
Badge time.png This article or section contains information that no longer applies to the current version of City of Villains. It is provided only for historical purposes.
{{historical|game=vh}}
Badge time.png This article or section contains information that no longer applies to the current version of City of Villains/Heroes. It is provided only for historical purposes.
{{historical|reason=obsolete}}
Badge time.png This article or section contains information that no longer applies to the current version of City of Heroes/Villains. It is provided only for historical purposes.
{{historical|reason=maybe}}
Badge time.png This article or section contains information that may not apply to the current version of City of Heroes/Villains. It is provided only for historical purposes.
{{historical|reason=event}}
Badge time.png This article or section contains information about a past event in City of Heroes/Villains. It is provided only for historical purposes.
{{historical|reason=nopaid}}
Badge time.png This article or section contains information that no longer applies to the current version of City of Heroes/Villains. It is provided only for historical purposes.
{{historical|game=v|reason=event|type=section}}
Badge time.png This section contains information about a past event in City of Villains. It is provided only for historical purposes.
{{historical|game=h|reason=change|type=section}}
Badge time.png This section contains information about changes that took place in City of Heroes. It is provided only for historical purposes.
Retrieved from "https://homecoming.wiki/w/index.php?title=Template:Historical&oldid=232763"