Template:History/doc: Difference between revisions

Latest revision as of 21:55, 8 January 2023

Description

This template creates a list entry for version changes in an article or page, with a link to that version in the Version History.

Use

Common case

The convention is to add a History section at the bottom of the page, just above the navboxes:

==History==
{{History|1.0|Introduced.}}
{{History|1.1|Adjusted Rancher bonus to 20%, up from 10%, Artisan now increases the value of [[Artisan Goods]] by 40%, down from 50%}}
{{History|1.2.26|Farming level now affects crop yield prior to level 10.}}

Minus the header, this results in:

1.0: Introduced.
1.1: Adjusted Rancher bonus to 20%, up from 10%, Artisan now increases the value of Artisan Goods by 40%, down from 50%
1.2.26: Farming level now affects crop yield prior to level 10.

Version label

In niche cases, you can override the link text shown for the version number. For example:

{{History|1.3.27|version label=1.3|Farming level now affects crop yield prior to level 10.}}

1.3: Farming level now affects crop yield prior to level 10.

@@ Line 1: / Line 1: @@
 ==Description==
-This template provides a list entry for version changes in an article or page. It lists the version history and provides a link to that version's section in the [[Version History]] page. If it's an unknown build or unconfigured it will default to whatever is entered in the build field as a subsection of the [[Version History]] page. It always links the first unnamed parameter back to that page.
+This template creates a list entry for version changes in an article or page, with a link to that version in the [[Version History]].
-The second unnamed parameter is simply the description of changes. This passes to the template untouched.
+==Use==
+===Common case===
+The convention is to add a ''History'' section at the bottom of the page, just above the navboxes:
-==Usage==
+<pre>
-Proper page formatting is to insert the template at the bottom of the page, just above the navboxes under a History header.
+==History==
+{{History|1.0|Introduced.}}
+{{History|1.1|Adjusted Rancher bonus to 20%, up from 10%, Artisan now increases the value of [[Artisan Goods]] by 40%, down from 50%}}
+{{History|1.2.26|Farming level now affects crop yield prior to level 10.}}
+</pre>
+Minus the header, this results in:
+{{History|1.0|Introduced.}}
+{{History|1.1|Adjusted Rancher bonus to 20%, up from 10%, Artisan now increases the value of [[Artisan Goods]] by 40%, down from 50%}}
+{{History|1.2.26|Farming level now affects crop yield prior to level 10.}}
-This template should be used by entering the following onto a relevant page:
+===Version label===
+In niche cases, you can override the link text shown for the version number. For example:
 <pre>
-==History==
+{{History|1.3.27|version label=1.3|Farming level now affects crop yield prior to level 10.}}
-{{history|''version number''|''version change description''}}
-{{history|''version number 2''|''version 2 change description''}}
-etc...
 </pre>
-[[de:Vorlage:{{PAGENAME}}]]
+{{History|1.3.27|version label=1.3|Farming level now affects crop yield prior to level 10.}}
-[[es:Plantilla:{{PAGENAME}}]]
-[[ja:テンプレート:{{PAGENAME}}]]
+<includeonly>{{Addlanglinks}}[[Category:Templates]]</includeonly><noinclude>[[Category:Template documentation]]</noinclude>
-[[pt:Predefinição:{{PAGENAME}}]]
-[[ru:Шаблон:{{PAGENAME}}]]
-[[zh:Template:{{PAGENAME}}]]
-<noinclude>[[Category:Template documentation]]</noinclude>