Feature/doc – Template

From Bohemia Interactive Community
(Add Steam)
m (Update documentation (adding Consoles, adding missing Steam, reordering, etc))
Line 4: Line 4:
{{<nowiki/>Feature|'''''name'''''|'''''message'''''}}
{{<nowiki/>Feature|'''''name'''''|'''''message'''''}}
* name: (case-insensitive) can be one of:
* name: (case-insensitive) can be one of:
** AFM: [[Arma 3: Advanced Helicopter Flight Model]] feature
** '''games:''' <spoiler>
** ofp/arma0: {{GameCategory|ofp|link=y}} feature
* ofp/arma0: {{GameCategory|ofp|link=y}} feature
** ofp: {{GameCategory|ofpe|link=y}} feature
* ofp: {{GameCategory|ofpe|link=y}} feature
** arma1: {{GameCategory|arma1|link=y}} feature
* arma1: {{GameCategory|arma1|link=y}} feature
** arma2: {{GameCategory|arma2|link=y}} feature
* arma2: {{GameCategory|arma2|link=y}} feature
** arma2oa: {{GameCategory|arma2oa|link=y}} feature
* arma2oa: {{GameCategory|arma2oa|link=y}} feature
** arma3: {{GameCategory|arma3|link=y}} feature
* arma3: {{GameCategory|arma3|link=y}} feature
** arma3contact: [[Arma 3 Contact]] feature
* Eden Editor: [[:Category:Eden Editor|Eden Editor]] feature
** arma3oldman: [[Arma 3 Apex: Old Man]] feature
* AFM: [[Arma 3: Advanced Helicopter Flight Model]] feature
** armaR: {{GameCategory|armaR|link=y}} feature
* arma3contact: [[Arma 3 Contact]] feature
** arma4: {{GameCategory|arma4|link=y}} feature
* arma3oldman: [[Arma 3 Apex: Old Man]] feature
** dayz: {{GameCategory|dayz|link=y}} feature
* armaR: {{GameCategory|armaR|link=y}} feature
** Eden Editor: [[:Category:Eden Editor|Eden Editor]] feature
* arma4: {{GameCategory|arma4|link=y}} feature
** Gamepad: a gamepad-specific information
* dayz: {{GameCategory|dayz|link=y}} feature
** GVI: a '''G'''ame '''V'''ersion '''I'''nformation - see {{Template|GVI}}
* TKOH: {{GameCategory|tkoh|link=y}} feature
*** game id
* ylands: {{GameCategory|ylands|link=y}} feature
*** game version (Optional, default "1.00")
* GVI: a '''G'''ame '''V'''ersion '''I'''nformation - see {{Template|GVI}}
*** additional text (Optional, default "This feature was introduced with ''game'' v''Version''")
** game id
** Keyboard: a keyboard-specific information
** game version (Optional, default "1.00")
** Important: an '''{{Color|#EA0|important}}''' messagebox; parameters:
** additional text (Optional, default "This feature was introduced with ''game'' v''Version''")
*** message
</spoiler>
** Informative: an '''{{Color|#00BFFF|informative}}''' messagebox; parameters:
** '''controls:''' <spoiler>
*** message
* keyboard: a keyboard-specific information
** Obsolete: an obsolete part of the documentation '''or''' documentation about an obsolete aspect of the product; parameters (all optional):
* gamepad: a gamepad-specific information
*** message (obsolescence reason)
</spoiler>
*** game (e.g arma3)
** '''platforms:''' <spoiler>
*** version (e.g 1.50)
* consoles: any console
** Quote: a quote, parameters (all but ''message'' optional):
* playstation: a PlayStation feature
*** message: quote
* xbox: an Xbox feature
*** author
* PC: a PC<!-- master race --> feature
*** source (URL)
* Steam: a Steam feature
** PC: a PC<!-- master race --> feature
</spoiler>
** playstation: a PlayStation feature
** '''infoboxes:''' <spoiler>
** Spoiler: spoiler alert
* informative: an '''{{Color|#00BFFF|informative}}''' messagebox
** TKOH: {{GameCategory|tkoh|link=y}} feature
* important: an '''{{Color|#EA0|important}}''' messagebox
** UnsupportedDoc: unsupported internal structure documentation (e.g PBO, save file etc)
* warning: a '''{{Color|#F00|warning}}''' messagebox
** UnsupportedTool: unsupported, most likely unofficial tool
* obsolete: an obsolete part of the documentation '''or''' documentation about an obsolete aspect of the product; parameters (all optional):
** Warning: a '''{{Color|#F00|warning}}''' messagebox; parameters:
** message (obsolescence reason)
*** message
** game (e.g arma3)
** xbox: an Xbox feature
** version (e.g 1.50)
** Ylands: {{GameCategory|ylands|link=y}} feature
* quote: a quote, parameters (all but ''message'' optional):
** message: quote
** author
** source (URL)
* spoiler: spoiler alert
* UnsupportedDoc: unsupported internal structure documentation (e.g PBO, save file etc)
* UnsupportedTool: unsupported, most likely unofficial tool
</spoiler>
* message: (Optional) the message to display
* message: (Optional) the message to display


Line 51: Line 58:
! Code
! Code
! Result
! Result
<!--
ERRORS
-->
|-
! colspan="3" style="height: 3em" | Errors
|-
|-
| <nowiki>{{Feature}}</nowiki>
| <nowiki>{{Feature}}</nowiki>
Line 57: Line 71:
| <nowiki>{{Feature|test}}</nowiki>
| <nowiki>{{Feature|test}}</nowiki>
| {{Feature|test}}
| {{Feature|test}}
<!--
GAMES
-->
|-
|-
| <nowiki>{{Feature|afm}}</nowiki>
! colspan="3" style="height: 3em" | Games
| {{Feature|afm}}
|-
| <nowiki>{{Feature|afm|Hello there!}}</nowiki>
| {{Feature|afm|Hello there!}}
|-
|-
| <nowiki>{{Feature|ofp}}</nowiki>
| <nowiki>{{Feature|ofp}}</nowiki>
Line 105: Line 120:
| <nowiki>{{Feature|arma3|Hello there!}}</nowiki>
| <nowiki>{{Feature|arma3|Hello there!}}</nowiki>
| {{Feature|arma3|Hello there!}}
| {{Feature|arma3|Hello there!}}
|-
| <nowiki>{{Feature|eden editor}}</nowiki>
| {{Feature|eden editor}}
|-
| <nowiki>{{Feature|eden editor|Hello there!}}</nowiki>
| {{Feature|eden editor|Hello there!}}
|-
| <nowiki>{{Feature|afm}}</nowiki>
| {{Feature|afm}}
|-
| <nowiki>{{Feature|afm|Hello there!}}</nowiki>
| {{Feature|afm|Hello there!}}
|-
|-
| <nowiki>{{Feature|arma3contact}}</nowiki>
| <nowiki>{{Feature|arma3contact}}</nowiki>
Line 136: Line 163:
| {{Feature|dayz|Hello there!}}
| {{Feature|dayz|Hello there!}}
|-
|-
| <nowiki>{{Feature|eden editor}}</nowiki>
| <nowiki>{{Feature|tkoh}}</nowiki>
| {{Feature|eden editor}}
| {{Feature|tkoh}}
|-
|-
| <nowiki>{{Feature|eden editor|Hello there!}}</nowiki>
| <nowiki>{{Feature|tkoh|Hello there!}}</nowiki>
| {{Feature|eden editor|Hello there!}}
| {{Feature|tkoh|Hello there!}}
|-
|-
| <nowiki>{{Feature|gamepad}}</nowiki>
| <nowiki>{{Feature|ylands}}</nowiki>
| {{Feature|gamepad}}
| {{Feature|ylands}}
|-
|-
| <nowiki>{{Feature|gamepad|Hello there!}}</nowiki>
| <nowiki>{{Feature|ylands|Hello there!}}</nowiki>
| {{Feature|gamepad|Hello there!}}
| {{Feature|ylands|Hello there!}}
|-
|-
| <nowiki>{{Feature|GVI}}</nowiki>
| <nowiki>{{Feature|GVI}}</nowiki>
Line 159: Line 186:
| <nowiki>{{Feature|GVI|ofp|1.75|Great game!}}</nowiki>
| <nowiki>{{Feature|GVI|ofp|1.75|Great game!}}</nowiki>
| {{Feature|GVI|ofp|1.75|Great game!}}
| {{Feature|GVI|ofp|1.75|Great game!}}
<!--
CONTROLS
-->
|-
! colspan="3" style="height: 3em" | Controls
|-
| <nowiki>{{Feature|keyboard}}</nowiki>
| {{Feature|keyboard}}
|-
| <nowiki>{{Feature|keyboard|Hello there!}}</nowiki>
| {{Feature|keyboard|Hello there!}}
|-
| <nowiki>{{Feature|gamepad}}</nowiki>
| {{Feature|gamepad}}
|-
| <nowiki>{{Feature|gamepad|Hello there!}}</nowiki>
| {{Feature|gamepad|Hello there!}}
<!--
PLATFORMS
-->
|-
! colspan="3" style="height: 3em" | Platforms
|-
| <nowiki>{{Feature|consoles}}</nowiki>
| {{Feature|consoles}}
|-
| <nowiki>{{Feature|consoles|Hello there!}}</nowiki>
| {{Feature|consoles|Hello there!}}
|-
| <nowiki>{{Feature|playstation}}</nowiki>
| {{Feature|playstation}}
|-
| <nowiki>{{Feature|playstation|Hello there!}}</nowiki>
| {{Feature|playstation|Hello there!}}
|-
|-
| <nowiki>{{Feature|important}}</nowiki>
| <nowiki>{{Feature|xbox}}</nowiki>
| {{Feature|important}}
| {{Feature|xbox}}
|-
| <nowiki>{{Feature|xbox|Hello there!}}</nowiki>
| {{Feature|xbox|Hello there!}}
|-
| <nowiki>{{Feature|PC}}</nowiki>
| {{Feature|PC}}
|-
| <nowiki>{{Feature|PC|Hello there!}}</nowiki>
| {{Feature|PC|Hello there!}}
|-
| <nowiki>{{Feature|steam}}</nowiki>
| {{Feature|steam}}
|-
| <nowiki>{{Feature|steam|Hello there!}}</nowiki>
| {{Feature|steam|Hello there!}}
 
<!--
INFOBOXES
-->
 
|-
|-
| <nowiki>{{Feature|important|Hello there!}}</nowiki>
! colspan="3" style="height: 3em" | Infoboxes
| {{Feature|important|Hello there!}}
|-
|-
| <nowiki>{{Feature|informative}}</nowiki>
| <nowiki>{{Feature|informative}}</nowiki>
Line 172: Line 256:
| {{Feature|informative|Hello there!}}
| {{Feature|informative|Hello there!}}
|-
|-
| <nowiki>{{Feature|keyboard}}</nowiki>
| <nowiki>{{Feature|important}}</nowiki>
| {{Feature|keyboard}}
| {{Feature|important}}
|-
| <nowiki>{{Feature|important|Hello there!}}</nowiki>
| {{Feature|important|Hello there!}}
|-
| <nowiki>{{Feature|warning}}</nowiki>
| {{Feature|warning}}
|-
|-
| <nowiki>{{Feature|keyboard|Hello there!}}</nowiki>
| <nowiki>{{Feature|warning|Hello there!}}</nowiki>
| {{Feature|keyboard|Hello there!}}
| {{Feature|warning|Hello there!}}
|-
|-
| <nowiki>{{Feature|obsolete}}</nowiki>
| <nowiki>{{Feature|obsolete}}</nowiki>
Line 189: Line 279:
| <nowiki>{{Feature|obsolete|Hello there!|arma2|1.03}}</nowiki>
| <nowiki>{{Feature|obsolete|Hello there!|arma2|1.03}}</nowiki>
| {{Feature|obsolete|Hello there!|arma2|1.03}}
| {{Feature|obsolete|Hello there!|arma2|1.03}}
|-
| <nowiki>{{Feature|PC}}</nowiki>
| {{Feature|PC}}
|-
| <nowiki>{{Feature|PC|Hello there!}}</nowiki>
| {{Feature|PC|Hello there!}}
|-
| <nowiki>{{Feature|playstation}}</nowiki>
| {{Feature|playstation}}
|-
| <nowiki>{{Feature|playstation|Hello there!}}</nowiki>
| {{Feature|playstation|Hello there!}}
|-
|-
| <nowiki>{{Feature|quote}}</nowiki>
| <nowiki>{{Feature|quote}}</nowiki>
Line 222: Line 300:
| <nowiki>{{Feature|spoiler|Hello there!}}</nowiki>
| <nowiki>{{Feature|spoiler|Hello there!}}</nowiki>
| {{Feature|spoiler|Hello there!}}
| {{Feature|spoiler|Hello there!}}
|-
| <nowiki>{{Feature|steam}}</nowiki>
| {{Feature|steam}}
|-
| <nowiki>{{Feature|steam|Hello there!}}</nowiki>
| {{Feature|steam|Hello there!}}
|-
| <nowiki>{{Feature|tkoh}}</nowiki>
| {{Feature|tkoh}}
|-
| <nowiki>{{Feature|tkoh|Hello there!}}</nowiki>
| {{Feature|tkoh|Hello there!}}
|-
|-
| <nowiki>{{Feature|UnsupportedDoc}}</nowiki>
| <nowiki>{{Feature|UnsupportedDoc}}</nowiki>
Line 246: Line 312:
| <nowiki>{{Feature|UnsupportedTool|Hello there!}}</nowiki>
| <nowiki>{{Feature|UnsupportedTool|Hello there!}}</nowiki>
| {{Feature|UnsupportedTool|Hello there!}}
| {{Feature|UnsupportedTool|Hello there!}}
|-
| <nowiki>{{Feature|warning}}</nowiki>
| {{Feature|warning}}
|-
| <nowiki>{{Feature|warning|Hello there!}}</nowiki>
| {{Feature|warning|Hello there!}}
|-
| <nowiki>{{Feature|xbox}}</nowiki>
| {{Feature|xbox}}
|-
| <nowiki>{{Feature|xbox|Hello there!}}</nowiki>
| {{Feature|xbox|Hello there!}}
|-
| <nowiki>{{Feature|ylands}}</nowiki>
| {{Feature|ylands}}
|-
| <nowiki>{{Feature|ylands|Hello there!}}</nowiki>
| {{Feature|ylands|Hello there!}}
|}
|}


[[Category:Templates|{{uc:{{PAGENAME}}}}]]
[[Category:Templates|{{uc:{{PAGENAME}}}}]]

Revision as of 15:44, 22 May 2025

Adds a feature messagebox. Adds the page to the Feature template usage error category if wrongly filled.

Usage

{{Feature|name|message}}

  • name: (case-insensitive) can be one of:
    • games:
    • controls:
      • keyboard: a keyboard-specific information
      • gamepad: a gamepad-specific information
    • platforms:
      • consoles: any console
      • playstation: a PlayStation feature
      • xbox: an Xbox feature
      • PC: a PC feature
      • Steam: a Steam feature
    • infoboxes:
      • informative: an informative messagebox
      • important: an important messagebox
      • warning: a warning messagebox
      • obsolete: an obsolete part of the documentation or documentation about an obsolete aspect of the product; parameters (all optional):
        • message (obsolescence reason)
        • game (e.g arma3)
        • version (e.g 1.50)
      • quote: a quote, parameters (all but message optional):
        • message: quote
        • author
        • source (URL)
      • spoiler: spoiler alert
      • UnsupportedDoc: unsupported internal structure documentation (e.g PBO, save file etc)
      • UnsupportedTool: unsupported, most likely unofficial tool
  • message: (Optional) the message to display
Examples
Code Result


Errors
{{Feature}} -no feature defined-
{{Feature|test}} -unknown feature ("test") defined-


Games
{{Feature|ofp}}
Operation Flashpoint
This is an Arma: Cold War Assault feature.
{{Feature|ofp|Hello there!}}
Operation Flashpoint
Hello there!
{{Feature|arma0}}
Operation Flashpoint
This is an Arma: Cold War Assault feature.
{{Feature|arma0|Hello there!}}
Operation Flashpoint
Hello there!
{{Feature|ofpe}}
Operation Flashpoint: Elite
This is an Operation Flashpoint: Elite feature.
{{Feature|ofpe|Hello there!}}
Operation Flashpoint: Elite
Hello there!
{{Feature|arma1}}
Armed Assault
This is an ArmA: Armed Assault feature.
{{Feature|arma1|Hello there!}}
Armed Assault
Hello there!
{{Feature|arma2}}
Arma 2
This is an Arma 2 feature.
{{Feature|arma2|Hello there!}}
Arma 2
Hello there!
{{Feature|arma2oa}}
Arma 2: Operation Arrowhead
This is an Arma 2: Operation Arrowhead feature.
{{Feature|arma2oa|Hello there!}}
Arma 2: Operation Arrowhead
Hello there!
{{Feature|arma3}}
Arma 3
This is an Arma 3 feature.
{{Feature|arma3|Hello there!}}
Arma 3
Hello there!
{{Feature|eden editor}}
Eden Editor
This is an Eden Editor feature.
{{Feature|eden editor|Hello there!}}
Eden Editor
Hello there!
{{Feature|afm}}
Advanced Helicopter Flight Model
For this command to have any effect, the Advanced Flight Model (AFM) has to be enabled. AFM status can be checked with difficultyEnabledRTD.
{{Feature|afm|Hello there!}}
Advanced Helicopter Flight Model
Hello there!
{{Feature|arma3contact}}
enoch icon ca.png
This content is exclusive to the Arma 3 Contact Expansion.
{{Feature|arma3contact|Hello there!}}
enoch icon ca.png
Hello there!
{{Feature|arma3oldman}}
arma3apex oldman logo simplyfied white.png
This function is used by the Arma 3 Apex: Old Man content. It might only work properly inside this scenario.
{{Feature|arma3oldman|Hello there!}}
arma3apex oldman logo simplyfied white.png
Hello there!
{{Feature|armaR}}
Arma Reforger
This is an Arma Reforger feature.
{{Feature|armaR|Hello there!}}
Arma Reforger
Hello there!
{{Feature|arma4}}
Arma 4
This is an Arma 4 feature.
{{Feature|arma4|Hello there!}}
Arma 4
Hello there!
{{Feature|dayz}}
DayZ
This is a DayZ feature.
{{Feature|dayz|Hello there!}}
DayZ
Hello there!
{{Feature|tkoh}}
Take On Helicopters
This is a Take On Helicopters feature.
{{Feature|tkoh|Hello there!}}
Take On Helicopters
Hello there!
{{Feature|ylands}}
Ylands
This is a Ylands feature.
{{Feature|ylands|Hello there!}}
Ylands
Hello there!
{{Feature|GVI}}
?
-no game provided-
{{Feature|GVI|ofp}}
This feature was introduced with Operation Flashpoint.
{{Feature|GVI|ofp|1.75}}
This feature was introduced with Operation Flashpoint v1.75.
{{Feature|GVI|ofp|1.75|Great game!}}
Great game!


Controls
{{Feature|keyboard}}
␽
-Text not defined-
{{Feature|keyboard|Hello there!}}
␽
Hello there!
{{Feature|gamepad}}
␼
-Text not defined-
{{Feature|gamepad|Hello there!}}
␼
Hello there!


Platforms
{{Feature|consoles}}
␼
This is a console feature.
{{Feature|consoles|Hello there!}}
␼
Hello there!
{{Feature|playstation}}
This is a PlayStation® feature.
{{Feature|playstation|Hello there!}}
Hello there!
{{Feature|xbox}}
This is an Xbox® feature.
{{Feature|xbox|Hello there!}}
Hello there!
{{Feature|PC}}
␿
This is a PC feature.
{{Feature|PC|Hello there!}}
␿
Hello there!
{{Feature|steam}}
Steam icon logo.png
This is a Steam feature.
{{Feature|steam|Hello there!}}
Steam icon logo.png
Hello there!


Infoboxes
{{Feature|informative}}
ⓘ
-Text not defined-
{{Feature|informative|Hello there!}}
ⓘ
Hello there!
{{Feature|important}}
⚠
-Text not defined-
{{Feature|important|Hello there!}}
⚠
Hello there!
{{Feature|warning}}
⚠
-Text not defined-
{{Feature|warning|Hello there!}}
⚠
Hello there!
{{Feature|obsolete}}
🕖
This information is obsolete.
{{Feature|obsolete|Hello there!}}
🕖
This information is obsolete. Reason: Hello there!
{{Feature|obsolete|Hello there!|arma2}}
🕖
This information is obsolete as of Arma 2. Reason: Hello there!
{{Feature|obsolete|Hello there!|arma2|1.03}}
🕖
This information is obsolete as of Arma 2 v1.03. Reason: Hello there!
{{Feature|quote}}
«
-Text not defined-
{{Feature|quote|Hello there!}}
«
« Hello there! »
{{Feature|quote|Hello there!|General Kenobi}}
«
« Hello there! » – General Kenobi
{{Feature|quote|Hello there!|General Kenobi|Conversations}}
«
« Hello there! » – General Kenobi (source)
{{Feature|quote|Hello there!|General Kenobi|http://www.youtube.com/watch?v{{=}}rEq1Z0bjdwc}}
«
« Hello there! » – General Kenobi (source)
{{Feature|spoiler}}
Spoiler Warning
The following text contains game spoilers such as story details or mission walkthroughs. Read at your own risk!
{{Feature|spoiler|Hello there!}}
Spoiler Warning
The following text contains game spoilers such as story details or mission walkthroughs. Read at your own risk!
The potential spoilers concern the following topic: Hello there!.
{{Feature|UnsupportedDoc}}
bi symbol white.png
Disclaimer: This page describes internal undocumented structures of Bohemia Interactive software.

This page contains unofficial information.

Some usage of this information may constitute a violation of the rights of Bohemia Interactive and is in no way endorsed or recommended by Bohemia Interactive.
Bohemia Interactive is not willing to tolerate use of such tools if it contravenes any general licenses granted to end users of this community wiki or BI products.
{{Feature|UnsupportedDoc|Hello there!}}
bi symbol white.png
Disclaimer: This page describes internal undocumented structures of Bohemia Interactive software.

This page contains unofficial information.

Some usage of this information may constitute a violation of the rights of Bohemia Interactive and is in no way endorsed or recommended by Bohemia Interactive.
Bohemia Interactive is not willing to tolerate use of such tools if it contravenes any general licenses granted to end users of this community wiki or BI products.
{{Feature|UnsupportedTool}}
bi symbol white.png
Disclaimer: This page describes an unofficial tool created without permission or support of Bohemia Interactive.

The product itself and its usage may be violating rights of Bohemia Interactive and is in no way endorsed or recommended by Bohemia Interactive.

See also Official Tools.
{{Feature|UnsupportedTool|Hello there!}}
bi symbol white.png
Disclaimer: This page describes an unofficial tool created without permission or support of Bohemia Interactive.

The product itself and its usage may be violating rights of Bohemia Interactive and is in no way endorsed or recommended by Bohemia Interactive.

See also Official Tools.
Retrieved from "https://community.bistudio.com/wiki?title=Template:Feature/doc&oldid=373551"