Template:Infobox Version/doc: Difference between revisions

From Progressbar95 Wiki
Content added Content deleted
(Created page with "==Usage== <pre> {{Infobox Version | image = File:0.99 magazine.png | first_release = Example | current_release = Example | official_release = Example | final_release = Example | successor = Example | predecessor = Example }} </pre> === Preview === {{Infobox Version | image = File:0.99 magazine.png | first_release = Example | current_release = Example | official_release = Example | final_release = Example | successor = Example | predecessor = Example }}")
 
(Update documentation according to the new template)
 
Line 1: Line 1:
Infobox for [[Progressbar95_(Game)|Progressbar95]] versions
==Usage==
<pre>
{{Infobox Version
| image = [[File:0.99 magazine.png]]
| first_release = Example
| current_release = Example
| official_release = Example
| final_release = Example
| successor = Example
| predecessor = Example
}}
</pre>


=== Preview ===
==Basic template==
The following is the base code required to generate an infobox. One can copy and paste the base code into an article and insert relevant information in front of the <code>=</code> signs.

<syntaxhighlight lang="wikitext">
{{Infobox Version
{{Infobox Version
| title =
| image = [[File:0.99 magazine.png]]
| name =
| first_release = Example
| first_version =
| current_release = Example
| release_version =
| official_release = Example
| latest_version =
| final_release = Example
| successor = Example
| prev_update =
| predecessor = Example
| next_update =
}}
}}
</syntaxhighlight>

== Full usage ==
{| class="wikitable"
! Parameter
! Function
! Example
! Default value
|-
| <code>title</code> || The version string of the update || <code>0.86</code> || <code><nowiki>{{PAGENAME}}</nowiki></code>
|-
| <code>name</code> || The alternative name of the update || <code>September Update</code> ||
|-
| <code>image</code> || The filename of the "PB Magazine" issue for the update (posted by u/icoeye on r/Progressbar95), without 'File:' || <code>0.86.png</code> || <code><nowiki>{{PAGENAME}}.png</nowiki></code> or <code><nowiki>{{PAGENAME}}_Magazine.png</nowiki></code>; ''None'' if neither exists
|-
| <code>first_version</code> || The first version of the update (most of the time a beta version, sometimes a release) || <code><nowiki>{{Version|ver=0.8450|type=alpha|android_date={{Date|2021|9|26}}}}</nowiki></code> ||
|-
| <code>release_version</code> || The first major RTM (release) version of the update || <code><nowiki>{{Version|ver=0.8600|type=rtm|steam_date={{Date|2021|10|3}}|android_date={{Date|2021|10|4}}|ios_date={{Date|2021|10|5}}}}</nowiki></code> ||
|-
| <code>latest_version</code> || The last version of the update. Either the latest version of the game available ("Latest version"), or the version before the first version leading up to the next game update ("Final version") || <code><nowiki>{{Version|ver=0.8610|type=hotfix|date={{Date|2021|10|13}}}}</nowiki></code> || <code>release_version</code> > <code>first_version</code> > ''None''
|-
| <code>prev_update</code> || The name of the previous game update || <code>0.84</code> ||
|-
| <code>next_update</code> || The name of the next game update || <code>0.88</code>
|-
|}
<hr>
'''[[mw:Help:TemplateData|TemplateData]] documentation used by [[mw:VisualEditor|VisualEditor]] and other tools'''
<templatedata>
{
"params": {
"title": {
"label": "Title",
"description": "The version string of the update",
"type": "string",
"suggested": true,
"example": "0.86",
"default": "The current page name"
},
"name": {
"label": "Name",
"description": "The alternative name of the update",
"example": "September Update",
"type": "string",
"suggested": true
},
"image": {
"label": "Magazine image",
"description": "The filename of the \"PB Magazine\" issue for the update (posted by u/icoeye on r/Progressbar95), without 'File:'",
"example": "0.86.png",
"type": "string",
"default": "<title>.png or <title>_Magazine.png; none if neither exists"
},
"first_version": {
"label": "First version",
"description": "The first version of the update (most of the time a beta version, sometimes a release)",
"example": "{{Version|ver=0.8450|type=alpha|android_date={{Date|2021|9|26}}}}",
"suggested": true
},
"release_version": {
"label": "Release version",
"description": "The first major RTM (release) version of the update",
"example": "{{Version|ver=0.8600|type=rtm|steam_date={{Date|2021|10|3}}|android_date={{Date|2021|10|4}}|ios_date={{Date|2021|10|5}}}}",
"suggested": true
},
"next_update": {
"label": "Next Update",
"description": "The name of the next game update",
"example": "0.88",
"type": "string",
"suggested": true
},
"latest_version": {
"label": "Latest version",
"description": "The last version of the update. Either the latest version of the game available (\"Latest version\"), or the version before the first version leading up to the next game update (\"Final version\")",
"example": "{{Version|ver=0.8610|type=hotfix|date={{Date|2021|10|13}}}}",
"suggested": true,
"default": "Release version; if not specified - the first version; if not specified - none"
},
"prev_update": {
"label": "Previous Update",
"description": "The name of the previous game update",
"example": "0.84",
"type": "string",
"suggested": true
}
},
"format": "block",
"description": "Infobox for Progressbar95 versions",
"paramOrder": [
"title",
"name",
"image",
"first_version",
"release_version",
"latest_version",
"prev_update",
"next_update"
]
}
</templatedata>

Latest revision as of 18:04, 24 April 2024

Infobox for Progressbar95 versions

Basic template[edit source]

The following is the base code required to generate an infobox. One can copy and paste the base code into an article and insert relevant information in front of the = signs.

{{Infobox Version
| title = 
| name = 
| first_version = 
| release_version = 
| latest_version = 
| prev_update = 
| next_update = 
}}

Full usage[edit source]

Parameter Function Example Default value
title The version string of the update 0.86 {{PAGENAME}}
name The alternative name of the update September Update
image The filename of the "PB Magazine" issue for the update (posted by u/icoeye on r/Progressbar95), without 'File:' 0.86.png {{PAGENAME}}.png or {{PAGENAME}}_Magazine.png; None if neither exists
first_version The first version of the update (most of the time a beta version, sometimes a release) {{Version|ver=0.8450|type=alpha|android_date={{Date|2021|9|26}}}}
release_version The first major RTM (release) version of the update {{Version|ver=0.8600|type=rtm|steam_date={{Date|2021|10|3}}|android_date={{Date|2021|10|4}}|ios_date={{Date|2021|10|5}}}}
latest_version The last version of the update. Either the latest version of the game available ("Latest version"), or the version before the first version leading up to the next game update ("Final version") {{Version|ver=0.8610|type=hotfix|date={{Date|2021|10|13}}}} release_version > first_version > None
prev_update The name of the previous game update 0.84
next_update The name of the next game update 0.88

TemplateData documentation used by VisualEditor and other tools

Infobox for Progressbar95 versions

Template parameters

This template prefers block formatting of parameters.

ParameterDescriptionTypeStatus
Titletitle

The version string of the update

Default
The current page name
Example
0.86
Stringsuggested
Namename

The alternative name of the update

Example
September Update
Stringsuggested
Magazine imageimage

The filename of the "PB Magazine" issue for the update (posted by u/icoeye on r/Progressbar95), without 'File:'

Default
<title>.png or <title>_Magazine.png; none if neither exists
Example
0.86.png
Stringoptional
First versionfirst_version

The first version of the update (most of the time a beta version, sometimes a release)

Example
{{Version|ver=0.8450|type=alpha|android_date={{Date|2021|9|26}}}}
Unknownsuggested
Release versionrelease_version

The first major RTM (release) version of the update

Example
{{Version|ver=0.8600|type=rtm|steam_date={{Date|2021|10|3}}|android_date={{Date|2021|10|4}}|ios_date={{Date|2021|10|5}}}}
Unknownsuggested
Latest versionlatest_version

The last version of the update. Either the latest version of the game available ("Latest version"), or the version before the first version leading up to the next game update ("Final version")

Default
Release version; if not specified - the first version; if not specified - none
Example
{{Version|ver=0.8610|type=hotfix|date={{Date|2021|10|13}}}}
Unknownsuggested
Previous Updateprev_update

The name of the previous game update

Example
0.84
Stringsuggested
Next Updatenext_update

The name of the next game update

Example
0.88
Stringsuggested