Template:Version/doc

From Official Barotrauma Wiki
Jump to: navigation, search
Documentation

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


All of the collected information can be found in the Page Status template.


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". See examples below.


This template searches changelogs using the FindInChangelog template, to see if the page name has been mentioned in a newer version than the page was last updated for. If it wasn't, the page is considered up to date, even if the page version is lower than current game version. Configuration details in the table below.


Field Note Example Default
1 Version
  • If the page version is equal to current game version, it's considered up to date.
  • If the page version is lower than current game version, but it's name or keywords have only been found in an older changelog, it's considered up to date.
  • If the page version is lower than current game version, and it's name or keywords have been found in a more recent changelog, it's considered outdated.
  • If the page version is lower than current game version, and it's name or keywords have not been found in any changelog:
    • Above 1.0.0.0: It's considered up to date.
    • Under 1.0.0.0: It's considered outdated, instead of up to date.
  • If the page version equals 0.8.2.3, it's considered a legacy article.
1.0.7.0
2 Note Outdated images.
stub Is the article a stub yes
stubnote Note regarding stub status Add more content, images.
cleanup Is the article marked for cleanup yes
cleanupnote Note regarding cleanup status Page layout is hard to follow.
deletion Is the article marked for deletion yes
deletionnote Note regarding deletion status Duplicate page.
search Adds additional keywords to search for in changelogs (Example for Structures page) Wreck,Thalamus,Beacon,Outpost,Ruin
nosearch Disables search functionality. Page will default to outdated unless it's exactly at the current game version yes
debug Displays debug info yes
name Overrides the pagename that the template searches for in the changelogs. For debug/demonstration usage. screwdriver
{{PAGENAME}}

Syntax

{{Version|<version number>|<what is outdated?>|deletion=yes|deletionnote=<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.3.0.4

{{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.3.0.4
Notes: Outdated Images

{{Version|1.3.0.4|Partially outdated images.}} gives:

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

{{Version|deletion=yes|deletionnote=Duplicate page.}} gives:

Page is a candidate for deletion Data is potentially outdated
Reason: Duplicate page. Last updated for an unknown version
The current game version is 1.3.0.4

{{Version|0.8.2.3}} gives:

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

{{Version|1.0.7.0|name=Screwdriver}} gives:

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

{{Version|1.0.7.0|name=Mudraptor}} gives:

Data is potentially outdated
Last updated for version 1.0.7.0
Last mentioned in changelog 1.1.18.0
The current game version is 1.3.0.4

{{Version|1.1.18.0|name=Mudraptor}} gives:

Data is up-to-date
Last updated for version 1.1.18.0
Last mentioned in changelog 1.1.18.0
The current game version is 1.3.0.4

{{Version|0.20.16.1|name=I Am That Guy|debug=y|nosearch=y}} gives:
PageName: Version/doc
NameParameter: I Am That Guy
Search:
NoSearch: y

FindInChangelog: Unknown

ChangelogSearchResult: Unknown,

UpToDateOrOutdated: Unknown

LatestChangelogVersion:

FinalState: Outdated

Data is potentially outdated
Last updated for version 0.20.16.1
The current game version is 1.3.0.4

{{Version|1.0.0.0|name=PageNameNotInChangelogs|search=search1,search2,search3,traitors|debug=y}} gives:
PageName: Version/doc
NameParameter: PageNameNotInChangelogs
Search: search1,search2,search3,traitors
NoSearch:

FindInChangelog:

Outdated,1.2.6.0

ChangelogSearchResult: Outdated,1.2.6.0

UpToDateOrOutdated: Outdated

LatestChangelogVersion: 1.2.6.0

FinalState: Outdated

Data is potentially outdated
Last updated for version 1.0.0.0
Last mentioned in changelog 1.2.6.0
The current game version is 1.3.0.4

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