Template:History/doc

< Template:History
Revision as of 21:39, 9 June 2023 by Lizz (talk | contribs) (→‎Changes: add description change, adjust formatting - not sure if the formatting change is an improvement (looks abrasive), but makes it clearer what should be italicized)

Description

This template lists and formats version changes in an article and links the changes in each version to the appropriate update Version History sub-article.

Usage

The convention is to add a History section to the article directly above the navbox and below the references section. Inside the template the first parameter is the version number of the change, and the second is a description of it

==History==
{{history|''version number''|''changes''}}

Examples

{{history|1.3|Updated image}}

results in...

  • 1.3: Updated image
{{history|1.0|Added}}
{{history|1.2|Changed name from ''Purple Couch''}}
{{history|1.3|Updated appearance and image}}

results in...

  • 1.0: Added
  • 1.2: Changed name from Purple Couch
  • 1.3: Updated appearance and image

Version

This parameter is game version number which published the change.

This value is linked and displayed through Template:Version. For full details about format and accepted values see the documentation and examples for that template.

Changes

This parameter lists changes that happened in the associated version. The first listed version is commonly when something is introduced - simply listed as Added. Each version where there is a change after that version should be listed, and all changes to that version should be contained inside the same template.

If there are multiple changes to the same version separate each change by comma inside the same template parameter.

For language standardization the wiki uses the following descriptions when listing changes;

  • Item renaming: Only the previous item name needs listed in changes. For example: Changed name from ''PREVIOUS NAME''
  • Description change: Only the previous item description needs listed in changes. For example: Changed description from ''PREVIOUS DESCRIPTION''
  • Price changes: List both the previous price and the new price. For example: Increased purchase price from ''OLD PRICE'' to ''NEW PRICE''
  • Catalog Thumbnail updated: Describe as Updated image
  • Model appearance updated: Describe as Updated appearance
  • Both thumbnail and model updated: Describe as Updated appearance and image