Template:Version/doc: Difference between revisions

From Official Barotrauma Wiki
Jump to: navigation, search
mNo edit summary
mNo edit summary
Line 1: Line 1:
{{doc/start}}
{{doc/start}}
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.
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.<br>
All parameters are optional.<br>
If the version number is omitted, the notice will state "Last updated for an '''unknown version'''".<br>
If using delete, 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.
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>{{ 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>
<nowiki>
 
{{ 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>
</code>
==Examples==
==Examples==
----
----
<code><nowiki>{{Version}}</nowiki></code> gives: {{Version}}
<code><nowiki>{{Version}}</nowiki></code> gives: {{Version}} {{clr}}
{{clear}}
----
----
<code><nowiki>{{Version|</nowiki>{{Current_version}}<nowiki>}}</nowiki></code> gives: {{Version|{{Current_version}}}}
<code><nowiki>{{Version|0.8.7.0}}</nowiki></code> gives: {{Version|0.8.7.0}} {{clr}}
{{clear}}
----
----
<code><nowiki>{{Version|0.9.10.0|Outdated images}}</nowiki></code> gives: {{Version|0.9.10.0|Outdated images}}
<code><nowiki>{{Version|0.8.7.0|Outdated images}}</nowiki></code> gives: {{Version|0.8.7.0|Outdated Images}} {{clr}}
{{clear}}
----
----
<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}}
<code><nowiki>{{Version|</nowiki>{{Current_version}}<nowiki>}}</nowiki></code> gives: {{Version|{{Current_version}}}} {{clr}}
{{clear}}
----
----
<code><nowiki>{{Version</nowiki><br>
<code><nowiki>{{Version|</nowiki>{{Current_version}}<nowiki>|Partially outdated images}}</nowiki></code> gives: {{Version|{{Current_version}}|Partially outdated images}} {{clr}}
|{{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}}
{{doc/end}}
{{doc/end}}

Revision as of 20:32, 12 June 2022

Documentation
[purge]

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, 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> | <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?> }}

Examples

{{Version}} gives:

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

{{Version|0.8.7.0}} gives:

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

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

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

{{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|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

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

Retrieved from "https://barotraumagame.com/baro-wiki/index.php?title=Template:Version/doc&oldid=26025"