Difference between revisions of "Template:Version Nav/doc"

From RimWorld Wiki
Jump to navigation Jump to search
m
 
(2 intermediate revisions by 2 users not shown)
Line 1: Line 1:
__NOTOC__
 
{{Rewrite|reason=Updated template to use release date for accurate sorting and testing on non Version pages, but examples need formatting and such}}
 
 
== Description ==
 
== Description ==
Generates a small widget to go to the next version in the [[:Category:Version]] or [[:Category: Console version]]
+
Generates a small widget to go to the next version in the [[:Category:Version]] or [[:Category:Console version]]
  
Also handles the categorization of the page and the setting of [[Property:Release Date]] and its display. Note that while most PC versions can have the dates automatically calculated, the console versions must have their dates manually set.
+
Also handles the categorization of the page and the setting of [[Property:Release Date]] and its display. The date is either calculated manually or can be set with <code>date=</code>. For testing purposes like on this page <code>date=false</code> should be set, to forbid that properties are set.
  
== Example usage ==
+
In case of an Unstable version, the field <code>unstable=</code> must be set to 1 (or any non-empty value). This will also set the page property <code>Stable Version=false</code>, for search purposes.
<nowiki>{{Version Nav}}</nowiki>
 
  
Produces:
+
== Examples ==
{{Version Nav|date=false}}
+
=== Standard ===
 +
<pre>{{Version Nav}}</pre>
 +
on page [[Version/0.9.722]] would produce:
 +
{{Version Nav|date=false|page=Version/0.9.722}}
  
 +
=== Unstable versions ===
 +
<pre>{{Version Nav|unstable=1}}</pre>
 +
on page [[Version/1.5.4101]] would produce:
 +
{{Version Nav|date=false|unstable=1|page=Version/1.5.4101}}
 +
 +
=== Special cases ===
 +
<pre>{{Version Nav}}</pre>
 +
on page [[Version/0.9.722]] would produce:
 
{{Version Nav|date=false|page=Version/0.9.722}}
 
{{Version Nav|date=false|page=Version/0.9.722}}
 +
 +
<pre>{{Version Nav|date=2018-10-17}}</pre>
 +
on page [[Version/1.0.0]] would produce:
 
{{Version Nav|date=false|page=Version/1.0.0}}
 
{{Version Nav|date=false|page=Version/1.0.0}}
 +
 +
<pre>{{Version Nav}}</pre>
 +
on page [[Version/0.0.232]] would produce:
 
{{Version Nav|date=false|page=Version/0.0.232}}
 
{{Version Nav|date=false|page=Version/0.0.232}}
 +
 +
<pre>{{Version Nav}}</pre>
 +
on page [[Version/0.1.334]] would produce:
 
{{Version Nav|date=false|page=Version/0.1.334}}
 
{{Version Nav|date=false|page=Version/0.1.334}}
 +
 +
<pre>{{Version Nav}}</pre>
 +
on page [[Version/0.2.363]] would produce:
 
{{Version Nav|date=false|page=Version/0.2.363}}
 
{{Version Nav|date=false|page=Version/0.2.363}}
 +
 +
<pre>{{Version Nav}}</pre>
 +
on page [[Version/0.19.2009]] would produce:
 
{{Version Nav|date=false|page=Version/0.19.2009}}
 
{{Version Nav|date=false|page=Version/0.19.2009}}
{{Version Nav|date=false|page=Version/{{Current Version}}}}
+
 
 +
<pre>{{Version Nav}}</pre>
 +
on page [[Version/{{Current Version}}|current version]] would produce:
 +
{{Version Nav|date=false|page=Version/{{Current Version}} }}
 +
 
 +
=== Console version ===
 +
<pre>{{Version Nav|date=2023-04-25}}</pre>
 +
on page [[Console version/1.21]] would produce:
 
{{Version Nav|date=false|page=Console version/1.21}}
 
{{Version Nav|date=false|page=Console version/1.21}}
  
 
<noinclude>[[Category:Template documentation]]</noinclude>
 
<noinclude>[[Category:Template documentation]]</noinclude>
 
<includeonly>[[Category:Navigation templates]]</includeonly>
 
<includeonly>[[Category:Navigation templates]]</includeonly>

Latest revision as of 20:04, 20 August 2024

Description[edit]

Generates a small widget to go to the next version in the Category:Version or Category:Console version

Also handles the categorization of the page and the setting of Property:Release Date and its display. The date is either calculated manually or can be set with date=. For testing purposes like on this page date=false should be set, to forbid that properties are set.

In case of an Unstable version, the field unstable= must be set to 1 (or any non-empty value). This will also set the page property Stable Version=false, for search purposes.

Examples[edit]

Standard[edit]

{{Version Nav}}

on page Version/0.9.722 would produce:

Previous Version: Version/0.8.657
Released on: 16 December 2014
Next Version: Version/0.10.785
Released on: 23 April 2015

Released on: 19 February 2015


Unstable versions[edit]

{{Version Nav|unstable=1}}

on page Version/1.5.4101 would produce:

Previous Version: Version/1.5.4097
Released on: 17 May 2024
Next Version: Version/1.5.4104
Released on: 24 May 2024
UNSTABLE

Released on: 21 May 2024


Special cases[edit]

{{Version Nav}}

on page Version/0.9.722 would produce:

Previous Version: Version/0.8.657
Released on: 16 December 2014
Next Version: Version/0.10.785
Released on: 23 April 2015

Released on: 19 February 2015


{{Version Nav|date=2018-10-17}}

on page Version/1.0.0 would produce:

Previous Version: Version/0.19.2009
Released on: 29 August 2018
Next Version: Version/1.0.2096
Released on: 24 November 2018

Released on: 17 October 2018


{{Version Nav}}

on page Version/0.0.232 would produce:

Previous Version: Version history
Released on:
Next Version: Version/0.0.245
Released on: 30 October 2013

Released on: 17 October 2013


{{Version Nav}}

on page Version/0.1.334 would produce:

Previous Version: Version/0.0.254B
Released on: 7 November 2013
Next Version: Version/0.2.363
Released on: 26 February 2014

Released on: 27 January 2014


{{Version Nav}}

on page Version/0.2.363 would produce:

Previous Version: Version/0.1.334
Released on: 27 January 2014
Next Version: Version/0.3.410
Released on: 13 April 2014

Released on: 26 February 2014


{{Version Nav}}

on page Version/0.19.2009 would produce:

Previous Version: Version/0.18.1722
Released on: 15 November 2017
Next Version: Version/1.0.0
Released on: 17 October 2018

Released on: 29 August 2018


{{Version Nav}}

on page current version would produce:

Previous Version: Version/1.5.4136
Released on: 25 June 2024
Next Version: Version history
Released on:

Released on: 8 October 2024


Console version[edit]

{{Version Nav|date=2023-04-25}}

on page Console version/1.21 would produce:

Previous Version: Console version/1.11
Released on: 8 December 2022
Next Version: Console version/1.22
Released on: 4 May 2023

Released on: 25 April 2023