Feature/doc – Template

From Bohemia Interactive Community
Jump to navigation Jump to search
(Add ofp/arma0 doc, Fix links)
(Add GVI)
(7 intermediate revisions by the same user not shown)
Line 6: Line 6:
** AFM: [[Arma 3: Advanced Helicopter Flight Model]] feature
** AFM: [[Arma 3: Advanced Helicopter Flight Model]] feature
** ofp/arma0: {{GameCategory|ofp|link=y}} feature
** ofp/arma0: {{GameCategory|ofp|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
Line 12: Line 13:
** arma3contact: [[Arma 3 Contact]] feature
** arma3contact: [[Arma 3 Contact]] feature
** arma3oldman: [[Arma 3 Apex: Old Man]] feature
** arma3oldman: [[Arma 3 Apex: Old Man]] feature
** armaR: {{GameCategory|armaR|link=y}} feature
** arma4: {{GameCategory|arma4|link=y}} feature
** dayz: {{GameCategory|dayz|link=y}} feature
** dayz: {{GameCategory|dayz|link=y}} feature
** Eden Editor: [[Eden Editor]] feature
** Eden Editor: [[:Category:Eden Editor|Eden Editor]] feature
** Gamepad: a gamepad-specific information
** GVI: a '''G'''ame '''V'''ersion '''I'''nformation - see {{Template|GVI}}
*** game id
*** game version (Optional, default "1.00")
*** additional text (Optional, default "This feature was introduced with ''game'' v''Version''")
** Keyboard: a keyboard-specific information
** Important: an '''{{Color|#EA0|important}}''' messagebox; parameters:
** Important: an '''{{Color|#EA0|important}}''' messagebox; parameters:
*** message
*** message
Line 26: Line 35:
*** author
*** author
*** source (URL)
*** source (URL)
** playstation: a PlayStation feature
** Spoiler: spoiler alert
** Spoiler: spoiler alert
** TKOH: {{GameCategory|tkoh|link=y}} feature
** TKOH: {{GameCategory|tkoh|link=y}} feature
Line 32: Line 42:
** Warning: a '''{{Color|#F00|warning}}''' messagebox; parameters:
** Warning: a '''{{Color|#F00|warning}}''' messagebox; parameters:
*** message
*** message
** WIP: a [[:Category:WIP|work in progress]] page
** xbox: an Xbox feature
** Ylands: {{GameCategory|ylands|link=y}} feature
** Ylands: {{GameCategory|ylands|link=y}} feature
* message: (Optional) the message to display
* message: (Optional) the message to display
Line 64: Line 74:
| <nowiki>{{Feature|arma0|Hello there!}}</nowiki>
| <nowiki>{{Feature|arma0|Hello there!}}</nowiki>
| {{Feature|arma0|Hello there!}}
| {{Feature|arma0|Hello there!}}
|-
| <nowiki>{{Feature|ofpe}}</nowiki>
| {{Feature|ofpe}}
|-
| <nowiki>{{Feature|ofpe|Hello there!}}</nowiki>
| {{Feature|ofpe|Hello there!}}
|-
|-
| <nowiki>{{Feature|arma1}}</nowiki>
| <nowiki>{{Feature|arma1}}</nowiki>
Line 100: Line 116:
| <nowiki>{{Feature|arma3oldman|Hello there!}}</nowiki>
| <nowiki>{{Feature|arma3oldman|Hello there!}}</nowiki>
| {{Feature|arma3oldman|Hello there!}}
| {{Feature|arma3oldman|Hello there!}}
|-
| <nowiki>{{Feature|armaR}}</nowiki>
| {{Feature|armaR}}
|-
| <nowiki>{{Feature|armaR|Hello there!}}</nowiki>
| {{Feature|armaR|Hello there!}}
|-
| <nowiki>{{Feature|arma4}}</nowiki>
| {{Feature|arma4}}
|-
| <nowiki>{{Feature|arma4|Hello there!}}</nowiki>
| {{Feature|arma4|Hello there!}}
|-
|-
| <nowiki>{{Feature|dayz}}</nowiki>
| <nowiki>{{Feature|dayz}}</nowiki>
Line 112: Line 140:
| <nowiki>{{Feature|eden editor|Hello there!}}</nowiki>
| <nowiki>{{Feature|eden editor|Hello there!}}</nowiki>
| {{Feature|eden editor|Hello there!}}
| {{Feature|eden editor|Hello there!}}
|-
| <nowiki>{{Feature|gamepad}}</nowiki>
| {{Feature|gamepad}}
|-
| <nowiki>{{Feature|gamepad|Hello there!}}</nowiki>
| {{Feature|gamepad|Hello there!}}
|-
| <nowiki>{{Feature|GVI}}</nowiki>
| {{Feature|GVI}}
|-
| <nowiki>{{Feature|GVI|ofp}}</nowiki>
| {{Feature|GVI|ofp}}
|-
| <nowiki>{{Feature|GVI|ofp|1.75}}</nowiki>
| {{Feature|GVI|ofp|1.75}}
|-
| <nowiki>{{Feature|GVI|ofp|1.75|Great game!}}</nowiki>
| {{Feature|GVI|ofp|1.75|Great game!}}
|-
|-
| <nowiki>{{Feature|important}}</nowiki>
| <nowiki>{{Feature|important}}</nowiki>
Line 124: Line 170:
| <nowiki>{{Feature|informative|Hello there!}}</nowiki>
| <nowiki>{{Feature|informative|Hello there!}}</nowiki>
| {{Feature|informative|Hello there!}}
| {{Feature|informative|Hello there!}}
|-
| <nowiki>{{Feature|keyboard}}</nowiki>
| {{Feature|keyboard}}
|-
| <nowiki>{{Feature|keyboard|Hello there!}}</nowiki>
| {{Feature|keyboard|Hello there!}}
|-
|-
| <nowiki>{{Feature|obsolete}}</nowiki>
| <nowiki>{{Feature|obsolete}}</nowiki>
Line 136: Line 188:
| <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|playstation}}</nowiki>
| {{Feature|playstation}}
|-
| <nowiki>{{Feature|playstation|Hello there!}}</nowiki>
| {{Feature|playstation|Hello there!}}
|-
|-
| <nowiki>{{Feature|quote}}</nowiki>
| <nowiki>{{Feature|quote}}</nowiki>
Line 145: Line 203:
| <nowiki>{{Feature|quote|Hello there!|General Kenobi}}</nowiki>
| <nowiki>{{Feature|quote|Hello there!|General Kenobi}}</nowiki>
| {{Feature|quote|Hello there!|General Kenobi}}
| {{Feature|quote|Hello there!|General Kenobi}}
|-
| <nowiki>{{Feature|quote|Hello there!|General Kenobi|Conversations}}</nowiki>
| {{Feature|quote|Hello there!|General Kenobi|Conversations}}
|-
|-
| <nowiki>{{Feature|quote|Hello there!|General Kenobi|http://www.youtube.com/watch?v{{=}}rEq1Z0bjdwc}}</nowiki>
| <nowiki>{{Feature|quote|Hello there!|General Kenobi|http://www.youtube.com/watch?v{{=}}rEq1Z0bjdwc}}</nowiki>
Line 178: Line 239:
| <nowiki>{{Feature|warning|Hello there!}}</nowiki>
| <nowiki>{{Feature|warning|Hello there!}}</nowiki>
| {{Feature|warning|Hello there!}}
| {{Feature|warning|Hello there!}}
|-
| <nowiki>{{Feature|xbox}}</nowiki>
| {{Feature|xbox}}
|-
| <nowiki>{{Feature|xbox|Hello there!}}</nowiki>
| {{Feature|xbox|Hello there!}}
|-
|-
| <nowiki>{{Feature|ylands}}</nowiki>
| <nowiki>{{Feature|ylands}}</nowiki>

Revision as of 00:38, 5 March 2024

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:
    • AFM: Arma 3: Advanced Helicopter Flight Model feature
    • ofp/arma0: Operation Flashpoint feature
    • ofp: Operation Flashpoint: Elite feature
    • arma1: ArmA: Armed Assault feature
    • arma2: Arma 2 feature
    • arma2oa: Arma 2: Operation Arrowhead feature
    • arma3: Arma 3 feature
    • arma3contact: Arma 3 Contact feature
    • arma3oldman: Arma 3 Apex: Old Man feature
    • armaR: Arma Reforger feature
    • arma4: Arma 4 feature
    • dayz: DayZ feature
    • Eden Editor: Eden Editor feature
    • Gamepad: a gamepad-specific information
    • GVI: a Game Version Information - see {{GVI}}
      • game id
      • game version (Optional, default "1.00")
      • additional text (Optional, default "This feature was introduced with game vVersion")
    • Keyboard: a keyboard-specific information
    • Important: an important messagebox; parameters:
      • message
    • Informative: an informative messagebox; parameters:
      • message
    • 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)
    • playstation: a PlayStation feature
    • Spoiler: spoiler alert
    • TKOH: Take On Helicopters feature
    • UnsupportedDoc: unsupported internal structure documentation (e.g PBO, save file etc)
    • UnsupportedTool: unsupported, most likely unofficial tool
    • Warning: a warning messagebox; parameters:
      • message
    • xbox: an Xbox feature
    • Ylands: Ylands feature
  • message: (Optional) the message to display
Examples
Code Result
{{Feature}} -no feature defined-
{{Feature|test}} -unknown feature ("test") defined-
{{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|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|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|eden editor}}
Eden Editor
This is an Eden Editor feature.
{{Feature|eden editor|Hello there!}}
Eden Editor
Hello there!
{{Feature|gamepad}}
-Text not defined-
{{Feature|gamepad|Hello there!}}
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!
{{Feature|important}}
-Text not defined-
{{Feature|important|Hello there!}}
Hello there!
{{Feature|informative}}
-Text not defined-
{{Feature|informative|Hello there!}}
Hello there!
{{Feature|keyboard}}
-Text not defined-
{{Feature|keyboard|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|playstation}}
This is a PlayStation® feature.
{{Feature|playstation|Hello there!}}
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|tkoh}}
Take On Helicopters
This is a Take On Helicopters feature.
{{Feature|tkoh|Hello there!}}
Take On Helicopters
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.
{{Feature|warning}}
-Text not defined-
{{Feature|warning|Hello there!}}
Hello there!
{{Feature|xbox}}
This is an Xbox® feature.
{{Feature|xbox|Hello there!}}
Hello there!
{{Feature|ylands}}
Ylands
This is a Ylands feature.
{{Feature|ylands|Hello there!}}
Ylands
Hello there!