Template:VersionHistory: Difference between revisions

Latest revision as of 14:15, 22 September 2024

Documentation (for the above template, sometimes hidden or invisible)

Description

This template is used to format version history and changelogs in a consistent and accessible manner.

Usage

For a version, the template is called using {{vh}} and ended with {{vhend}}. Patches are placed in between the main {{vh}} call and the {{vhend}}, but still use {{vh}}.

The template aims to format the list in a fluid and responsive manner that supports varying screen sizes. It was made in response to the old table style of changelogs causing issues on mobile devices.

Patches must include the word "patch" in order to be formatted correctly, in the format [version] patch [patch_number]. This may be unideal for games with irregular patch schemes. Changes to this system (that do not break existing uses of the template) would be welcome.

There is an unused data component in the template that would add version data to the API. It is disabled as the data is redundant except release date.

Parameters

Version History lists. Fluid structure.

Template parameters
This template has custom formatting.
Parameter		Description	Type	Status
Version/Patch	`1`	The full name of the version or patch. Patches are recognised if this parameter has "patch" in the input. This changes what the following parameters do. Example 0.120d patch 3	Line	required
Images/Author	`2`	If a version, specify images in the form "Filename.png (Page Name), File2…". If a patch, add a list of author names, or leave blank if it's a solo game.	Line	suggested
Author/Release Date	`3`	If a version, add a list of author names, or leave blank if it's a solo game. If a patch, add the release date. It's recommended to use YYYY/MM/DD.	Line	suggested
Release Date/Nothing	`4`	If a version, add the release date. It's recommended to use YYYY/MM/DD. Do not include a fourth parameter for patches.	Line	optional

Sample

This is an example on how the template can be used:

This page lists the version history of <some game>.

{{vh
|0.02
|SnowyWorld.png (Snowy World)
|PersonA, PersonB
|2020/04/19
}}
*Changed a warp
*Added Snowy World
**Accessed from another world
*etc
{{vh
|0.02 patch 1
|PersonB
|2020/04/25
}}
*Fixed an issue
{{vhend}}

{{vh
|0.01
…

Visit Template:VersionHistory/doc to edit this text! (How does this work?)

@@ Line 1: / Line 1: @@
 <includeonly><!--
--->{{#if:{{{4|}}}<!-- If it has a fourth parameter it's a version
+-->{{#if: {{#rmatch:{{{1}}}|patch|1}}<!-- If it has the word "patch" return a value
+-->|</div><!-- If patch, close div of border bottom from previous template use
+   -->{{#subobject:<!-- patches get a subobject too-->
+|Version = {{{1|}}}
+|Version/Type = patch
+|Is part of game = {{NAMESPACE}}
+|Has contributing author = {{{2|}}}|+sep=,
+|Version/Date = {{{3|}}}
+}}<!--
 -->|<!-- If version:
-   --><div style="clear:both;"></div></div></div><!-- Clear, remove bottom border div, remove main box div
     --><h3><!-- Open header
-      -->{{#switch:{{NAMESPACENUMBER}}<!-- Switch for version label
+   -->{{#switch:{{NAMESPACENUMBER}}<!-- Switch for version label
-      -->|3014=Ver<!-- Uneven Dream
+   -->|3014=Ver<!-- Uneven Dream
-      -->|Version&#32;<!--
+   -->|Version&#32;<!--
-      -->}}<!-- End switch for version label
+   -->}}<!-- End switch for version label
     -->{{{1}}}</h3><!-- Close header
-    --><div style="border:4px solid #b2af9c;><!-- Open main box div
+    --><div style="border:4px solid; border-color:var(--box-border, #ccc);"><!-- Open main box div
-      -->{{#if:{{{2|}}}<!-- Check for images
+   -->{{#if:{{{2|}}}<!-- Check for images
-       -->|{{#arraymaptemplate:{{{2}}}|VersionHistory/Images|,|}}<!-- Array for images and their annotations
+   -->|<!-- If there are images:
-      -->}}<!-- End image check
+      --><div id="mw-content" class="floatright" style="padding:12px;padding-bottom:1px;font-size:1px;"><!-- Open image div
--->|</div><!-- If patch, close div of border bottom from previous template use
+       -->{{#arraymap:{{{2}}}|,|?|[[File:{{#rmatch:?|^(.+\.[A-z]+)|\1}}{{!}}left{{!}}border{{!}}370px{{#rmatch:?|\(([^\(\)]+)\)$|then={{!}}link={{NAMESPACEE}}:\1}}]]|\n}}<!-- Array for images and their annotations
--->}}<!-- End check for dot
+   --></div><!-- Close image div
+   -->}}<!-- End image check
+   -->{{#subobject:<!-- since we know it's a version-->
+|Version = {{{1|}}}
+|Version/Type = version
+|Version/Image = {{#arraymap:{{{2}}}|,|?|File:{{#rmatch:?|^(.+\.[A-z]+)|\1}}|?}}|+sep=?
+|Is part of game = {{NAMESPACE}}
+|Has contributing author = {{{3|}}}|+sep=,
+|Version/Date = {{{4|}}}
+}}<!--
+-->}}<!-- End version check
 The below is common to every template usage
 --><div style="display:table-cell;padding:6px 10px;"><!-- Div for author and date info
-   -->{{#if:{{{4|}}}<!-- Check if version
+-->{{#if:{{#rmatch:{{{1}}}|patch|1}}<!-- Version check
-   -->|<!-- If version
+-->|<!-- if patch:
-      -->{{#if:{{{3|}}}<!-- Only place authors list if one is specified
+   --><b>Patch {{#rmatch:{{{1}}}|patch(.+)|\1}} / </b><!-- separate with a slash and unbold
-      -->|'''Contributing Authors:''' <!-- Space here
+-->}}<!-- End version check
-         -->{{#arraymap:{{{3}}}<!-- Array categories
+-->{{#if: {{#if:{{#rmatch:{{{1}}}|patch|1}}|{{{2|}}}|{{{3|}}}}}<!-- If theres an author
-         -->|,|#|[[:Category:#|#]]|,&#32;}}<!-- End array usage
+-->|'''Contributing Authors:''' <!-- Space here
-      --><br><!-- Separate author list and date with newline
+   -->{{#arraymap:{{#if:{{#rmatch:{{{1}}}|patch|1}}|{{{2|}}}|{{{3|}}}}}<!-- Array categories
-      -->}}<!-- End author check
+   -->|,|$|{{#ifexist: Category:$|[[:Category:$|$]]|$}}|,\s}}<!-- End array usage
-   -->|<b>{{#tag:nowiki|Patch {{{1|}}} / }}<!-- If patch, prepend text using the patch number
+   --><br><!-- Separate author list and date with newline
-      -->{{#if:{{{2|}}}<!-- Only place authors list if one is specified
+-->}}<!-- End version+author check
-      -->|Contributing Authors:</b> <!-- Space here
+-->'''Release Date:''' {{#if:{{#rmatch:{{{1}}}|patch|1}}|{{{3|}}}|{{{4|}}}}}<!--
-         -->{{#arraymap:{{{2}}}<!-- Array categories
-         -->|,|#|[[:Category:#|#]]|,&#32;}}<!-- End array usage
-      --><br><!-- Separate author list and date with newline
-      -->|</b><!-- Ensure you close bolding even if no author
-      -->}}<!-- End author check
-   -->}}<!-- End version check
--->'''Release Date:''' {{{4|{{{3|}}}}}}<!--
 --></div><!-- Close div of author and date info
 --><div style="padding:6px 10px;border-bottom:1px solid #a2a9b1;border-top:1px solid #a2a9b1;"><!-- Open div for bottom border of box, above text
---></includeonly><noinclude>
+--></includeonly><noinclude>{{documentation}}</noinclude>
-use in a version history page like this
-<pre>{{vh
-|0.100a
-|example.png (Example World), two.png (Another World)
-|author1, author2
-|1999/09/19}}
-*text
-*text
-...
-</pre>
-or for patches like this
-<pre>{{vh
-|2
-|author1, author2
-|1999/09/29}}
-*text
-*text
-...
-</pre>
-If there is normal page content below a usage of this template, put a couple <nowiki></div></nowiki> in there to stop the css from bleeding onto it
-[[Template:VersionHistory/Images]]
-[[Template:VersionHistory/Category]]
-[[Category:Formatting templates]]
-</noinclude>