Template:Historical/doc

This is a documentation subpage for Template:Historical (see that page for the template itself).
It contains usage information, categories and other content that is not part of the original template page.

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

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

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}}	This article or section contains information that no longer applies to the current version of City of Heroes Freedom. It is provided for historical purposes.
{{historical|type=article}}	This article contains information that no longer applies to the current version of City of Heroes Freedom. It is provided for historical purposes.
{{historical|type=section}}	This section contains information that no longer applies to the current version of City of Heroes Freedom. It is provided for historical purposes.
{{historical|game=coh}}	This article or section contains information that no longer applies to the current version of City of Heroes. It is provided for historical purposes.
{{historical|game=v}}	This article or section contains information that no longer applies to the current version of City of Villains. It is provided for historical purposes.
{{historical|game=vh}}	This article or section contains information that no longer applies to the current version of City of Villains/Heroes. It is provided for historical purposes.
{{historical|reason=obsolete}}	This article or section contains information that no longer applies to the current version of City of Heroes Freedom. It is provided for historical purposes.
{{historical|reason=maybe}}	This article or section contains information that may not apply to the current version of City of Heroes Freedom. It is provided for historical purposes.
{{historical|reason=event}}	This article or section contains information about a past event in City of Heroes Freedom. It is provided for historical purposes.
{{historical|game=v|reason=event|type=section}}	This section contains information about a past event in City of Villains. It is provided for historical purposes.
{{historical|game=h|reason=change|type=section}}	This section contains information about changes that took place in City of Heroes. It is provided for historical purposes.