Template:Version/doc: Difference between revisions

From Official Barotrauma Wiki
Jump to: navigation, search
m (1 revision imported)
No edit summary
Line 1: Line 1:
{{doc/start}}
{{doc/start}}
This template is used to more easily keep track of article versions. It should be placed before any content in an article.
This template is used to more easily keep track of article versions, as well as stub and cleanup flags. It should be placed before any content in an article.
 
All parameters are optional.<br>
If the version number is omitted, the notice will state " last updated in unkown version".<br>
If using stub or cleanup, "yes" must be added after an "=" sign, otherwise it might be interpreted as an "anonymous parameter" ( <nowiki>{{{1}}}</nowiki> or <nowiki>{{{2}}}</nowiki>, version number and note respectively, if they weren't specified ). See examples below.
==Syntax==
==Syntax==
<code>
<code>
<nowiki>
<nowiki>
{{Version|<version>|<note>}}
{{ Version | <version number> | <note about what is outdated> | stub = yes | cleanup = yes | stubnote = <note about what's missing> | cleanupnote = <note about what should be improved> }}
</nowiki>
</nowiki>
</code>
</code>
==Examples==
==Examples==
----
<code><nowiki>{{Version}}</nowiki></code> gives: {{Version}}
<code><nowiki>{{Version}}</nowiki></code> gives: {{Version}}
{{clear}}
{{clear}}
----
<code><nowiki>{{Version|</nowiki>{{Current_version}}<nowiki>}}</nowiki></code> gives: {{Version|{{Current_version}}}}
<code><nowiki>{{Version|</nowiki>{{Current_version}}<nowiki>}}</nowiki></code> gives: {{Version|{{Current_version}}}}
{{clear}}
{{clear}}
<code><nowiki>{{Version|0.9.10.0}}</nowiki></code> gives: {{Version|0.9.10.0}}
----
<code><nowiki>{{Version|0.9.10.0|Outdated images}}</nowiki></code> gives: {{Version|0.9.10.0|Outdated images}}
{{clear}}
{{clear}}
<code><nowiki>{{Version|0.9.10.0|Outdated images}}</nowiki></code> gives: {{Version|0.9.10.0|Outdated images}}
----
<code><nowiki>{{Version|</nowiki>{{Current_version}}<nowiki>|stub=yes|stubnote=Missing damage table}}</nowiki></code> gives: {{Version|{{Current_version}}|stub=yes|stubnote=Missing damage table}}
{{clear}}
----
<code><nowiki>{{Version</nowiki><br>
|{{Current_version}}<br>
|Outdated images<br>
|stub = yes<br>
|stubnote = Missing damage table<br>
|cleanup = yes<br>
|cleanupnote = Usage of second person needs to be replaced<br>
}}</code><br> gives:
 
{{Version|{{Current_version}}|Outdated images|stub=yes|stubnote=Missing damage table|cleanup=yes|cleanupnote=Usage of second person needs to be replaced}}
{{clear}}
{{clear}}
{{doc/end}}
{{doc/end}}

Revision as of 21:11, 7 November 2021

Documentation

This template is used to more easily keep track of article versions, as well as stub and cleanup flags. It should be placed before any content in an article.

All parameters are optional.
If the version number is omitted, the notice will state " last updated in unkown version".
If using stub or cleanup, "yes" must be added after an "=" sign, otherwise it might be interpreted as an "anonymous parameter" ( {{{1}}} or {{{2}}}, version number and note respectively, if they weren't specified ). See examples below.

Syntax

{{ Version | <version number> | <note about what is outdated> | stub = yes | cleanup = yes | stubnote = <note about what's missing> | cleanupnote = <note about what should be improved> }}

Examples


{{Version}} gives:

Data is potentially outdated
Last updated for an unknown version
The current game version is 1.4.6.0

{{Version|1.4.6.0}} gives:

Data is up-to-date
Last updated for version 1.4.6.0
The current game version is 1.4.6.0

{{Version|0.9.10.0|Outdated images}} gives:

Data is potentially outdated
Last updated for version 0.9.10.0
The current game version is 1.4.6.0
Notes: Outdated images

{{Version|1.4.6.0|stub=yes|stubnote=Missing damage table}} gives:

Data is up-to-date
Last updated for version 1.4.6.0
The current game version is 1.4.6.0
Stub Notes: Missing damage table

{{Version
|1.4.6.0
|Outdated images
|stub = yes
|stubnote = Missing damage table
|cleanup = yes
|cleanupnote = Usage of second person needs to be replaced
}}

gives:


Data is up-to-date
Last updated for version 1.4.6.0
The current game version is 1.4.6.0
Notes: Outdated images
Cleanup Notes: Usage of second person needs to be replaced
Stub Notes: Missing damage table

This is the documentation page, it should be transcluded into the main template page. See Template:Doc for more information.