Template:Version/doc: Difference between revisions

From Official Barotrauma Wiki
Jump to: navigation, search
mNo edit summary
(added "spoiler" to the syntax, as well as another example to show what happens if no version was inputted, but another optional parameter was)
Line 3: Line 3:


All parameters are optional.<br>
All parameters are optional.<br>
If using delete, stub, or cleanup, "yes" must be added after an "=" sign, otherwise it might be interpreted as an "anonymous parameter". See examples below.
If using delete, stub, cleanup, or spoiler, "yes" must be added after an "=" sign, otherwise it might be interpreted as an "anonymous parameter". See examples below.


==Syntax==
==Syntax==
<code><nowiki>{{ Version | <version number> | <what is outdated?> | delete = yes | deletenote = <why should the page be deleted?> | stub = yes | stubnote = <what needs to be added?> | cleanup = yes | cleanupnote = <what needs to be improved?> }}</nowiki></code>
<code><nowiki>{{ Version | <version number> | <what is outdated?> | delete = yes | deletenote = <why should the page be deleted?> | stub = yes | stubnote = <what needs to be added?> | cleanup = yes | cleanupnote = <what needs to be improved?> | spoiler = yes | spoilersection = <what section has spoilers?> }}</nowiki></code>


==Examples==
==Examples==
Line 19: Line 19:
----
----
<code><nowiki>{{Version|0.8.2.3}}</nowiki></code> gives: {{Version|0.8.2.3}} {{clr}}
<code><nowiki>{{Version|0.8.2.3}}</nowiki></code> gives: {{Version|0.8.2.3}} {{clr}}
----
<code><nowiki>{{Version|spoiler=yes}}</nowiki></code> gives: {{Version|}} {{clr}}
----
----
<code><nowiki>{{Version|0.8.2.3|spoiler=yes|spoilersection=Examples}}</nowiki></code> gives: {{Version|0.8.2.3|spoiler=yes|spoilersection=Examples}} {{clr}}
<code><nowiki>{{Version|0.8.2.3|spoiler=yes|spoilersection=Examples}}</nowiki></code> gives: {{Version|0.8.2.3|spoiler=yes|spoilersection=Examples}} {{clr}}
{{doc/end}}
{{doc/end}}

Revision as of 03:35, 22 June 2022

Documentation

This template is used to more easily keep track of article versions, as well as other flags. It should be placed at the very start of an article.

All parameters are optional.
If using delete, stub, cleanup, or spoiler, "yes" must be added after an "=" sign, otherwise it might be interpreted as an "anonymous parameter". See examples below.

Syntax

{{ Version | <version number> | <what is outdated?> | delete = yes | deletenote = <why should the page be deleted?> | stub = yes | stubnote = <what needs to be added?> | cleanup = yes | cleanupnote = <what needs to be improved?> | spoiler = yes | spoilersection = <what section has spoilers?> }}

Examples


{{Version}} gives:

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

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

Data is potentially outdated
Last updated for version 0.10.0.0
The current game version is 1.4.6.0
Notes: Outdated Images

{{Version|1.4.6.0|Partially outdated images}} gives:

Data is up-to-date
Last updated for version 1.4.6.0
The current game version is 1.4.6.0
Notes: Partially outdated images

{{Version|1.4.6.0|Outdated images|spoiler=yes}} 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

{{Version|0.8.2.3}} gives:

This page is a Legacy article
Features described on this page are no longer in the game.

{{Version|spoiler=yes}} gives:

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

{{Version|0.8.2.3|spoiler=yes|spoilersection=Examples}} gives:

This page is a Legacy article
Features described on this page are no longer in the game.

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