History/doc

This template is used to list the history related to the entity described on a page. Due to its standardized format and supplemental functionalities, it is meant to be used for all historical events in the History sections of all pages.

It automatically categorizes the page in the respective Entities introduced/patched in <patch> category. See Category:History.

Usage

{{ history | <patch name> | <change notes> | introduced = 1 (optional) | nocat = 1 (optional) }}

Parameter		Description	Type	Status
Patch name	1	Name of the patch in which the change happened (Important: Always use the full name that includes the platform, e.g. "Desktop 1.2" instead of "1.2"!) Example: Desktop 1.3.0.1 / Console-Release / Mobile 1.2.11964 Easter Update	Line	required
Notes	2	List of changes that were made	String	required
Suppress categorization	nocat	Prevents the page from being categorized in the respective history category of this patch Auto value: True (1/y/yes)	Boolean	optional
Force "introduced" category	introduced	Adds the page to the "Entities introduced in X" category, regardless of whether that corresponds to the patch notes or not Auto value: True (1/y/yes)	Boolean	optional
Force "Patched" category	patched	Adds the page to the "Entities patched in X" category, only valid when "introduced" parameter is set (i.e. require |introduced=y|patched=y ). Auto value: True (1/y/yes)	Boolean	optional
Patch name display	t	Custom vanity text for the patch name	Line	optional
Version header	version	Prints a header above the patch notes for the entered version Example: desktop / mobile	Line	deprecated Remove this parameter where it is used. Version header handling is fully automated (if there are any issues, please report them on Template talk:History).

Test of raw TemplateData output:

Used for standard history entries.

Template parameters

Parameter		Description	Type	Status
Patch name	1	Name of the patch in which the change happened (Important: Always use the full name that includes the platform, e.g. "Desktop 1.2" instead of "1.2"!) Example Desktop 1.3.0.1 / Console-Release / Mobile 1.2.11964 Easter Update	Line	required
Notes	2	List of changes that were made	String	required
Suppress categorization	nocat	Prevents the page from being categorized in the respective history category of this patch Auto value 1	Boolean	optional
Force "introduced" category	introduced	Adds the page to the "Entities introduced in X" category, regardless of whether that corresponds to the patch notes or not Auto value 1	Boolean	optional
Force "Patched" category	patched	Adds the page to the "Entities patched in X" category, only valid when "introduced" parameter is set (i.e. require |introduced=y|patched=y ). Auto value 1	Boolean	optional
Patch name display	t	Custom vanity text for the patch name Auto value	Line	optional
Version header	version	Prints a header above the patch notes for the entered version Example desktop / mobile	Line	deprecated

Example

Note that all {{history}} calls regarding the same platform should generally be grouped together. The following is only an illustrative example of the functionality, not of how it is meant to be used.

{{history|Desktop 1.4.0.1|t=Journey's End|Changed damage from 20 to 24.}}
{{history|Console 1.17|Updated mechanics.}}
{{history|Console-Release|Introduced.}}
{{history|Desktop 1.2|Introduced.}}
{{history|Mobile 1.3.0.7|Removed.}}
{{history|Mobile 1.2.11964 Easter Update|Introduced.}}

returns:

 PC version

• Journey's End: Changed damage from 20 to 24.

 Console version

• Console 1.17: Updated mechanics.

• Console-Release: Introduced.

 PC version

• Desktop 1.2: Introduced.

 Mobile version

• Mobile 1.3.0.7: Removed.

• Mobile 1.2.11964 Easter Update: Introduced.