Template:Historical/doc
< Template:Historical
Jump to navigation
Jump to search
Revision as of 13:09, 15 March 2008 by imported>Sekoia (adding info on the two new parameters)
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.
- Accepts: Anything.
Usage
Template Call | Result |
---|---|
{{historical}} | |
{{historical|type=article}} | |
{{historical|type=section}} | |
{{historical|game=coh}} | |
{{historical|game=v}} | |
{{historical|game=vh}} | |
{{historical|reason=obsolete}} | |
{{historical|reason=maybe}} | |
{{historical|reason=event}} | |
{{historical|game=v|reason=event|type=section}} | |
{{historical|game=h|reason=change|type=section}} |