Naming Conventions – Bohemia Interactive Community

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Remove AiV, add templates)
(Add arma2baf, arma2pmc, arma2acr, vbs3 and TKOM template - Add detailed description on page formatting - Page format)
Line 1: Line 1:
===Introduction===
== Introduction ==
The BI Community Wiki is attempting to maintain a <u>consistent</u> appearance with articles and categories. Please '''adhere''' to the following '''naming conventions''' when editing or creating an article. When creating new topics or categories, use the common practice of {{Inline code|GameTitleName: Subject}}.<br />
For example, '''List of Actions OFP''' does not sound as good as '''[[Operation Flashpoint: Actions List]]'''; this format is clearer about the concerned game and the mentioned topic of the article. It also makes linking to those articles much easier for editors.


You can use templates in the category name, e.g {{Inline code|<nowiki>[[Category:{{arma3}}: Functions]]</nowiki>}} (result: [[:Category:{{arma3}}: Functions]])


The BI Community Wiki is attempting to maintain a <u>consistent</u> appearance with articles and categories. Please '''adhere''' to the following '''naming conventions''' when editing or creating an article. When creating new topics or categories, use the common practice of [GameTitleName: Subject] for example: '''List of Actions OFP''', does not sound as good as [[Operation Flashpoint: Actions List]], its clearer what the topic is about and which game title the article refers to. It also makes linking to those articles much easier for editors.


===Sort Keys===
== Sorting Keys ==
When defining a category for an article you should include a search key in that definition: [GameTitleName: Subject'''|Sort Key'''].<br>Otherwise the automatically created table of contents will sort everything under the GameTitleName.
When defining a category for an article you should include a search key in that definition:
[GameTitleName: Subject'''|Sort Key''']
If not defined, the automatically created table of contents will sort everything, sometimes unsuccessfully.


One can use the following:
<nowiki>[[Category:{{arma3}} Functions|{{uc:{{PAGENAME}}}}]]</nowiki>


The {{Inline code|uc:}} template will ''uppercase'' the given value, which is {{Inline code|<nowiki>{{PAGENAME}}</nowiki>}}.
{{Informative|See the interest of defining a custom key on a [[:Category:Arma_3:_Functions|Functions]] page: if custom keys were undefined, every function would be sorted under '''B''', for BIS_fnc_*.}}
== Wiki name templates ==
{| cellpadding="8"
{| cellpadding="8"
! Long Names || Short Names || Template
! Long Names || Short Names || Template
Line 15: Line 26:
| Arma 2: Operation Arrowhead || Arma 2:OA || [[Template:arma2oa]] ({{arma2oa}})
| Arma 2: Operation Arrowhead || Arma 2:OA || [[Template:arma2oa]] ({{arma2oa}})
|-
|-
| Arma 2: British Armed Forces || Arma 2:BAF
| Arma 2: British Armed Forces || Arma 2:BAF || [[Template:arma2baf]] ({{arma2baf}})
|-
|-
| Arma 2: Private Military Company || Arma 2:PMC
| Arma 2: Private Military Company || Arma 2:PMC || [[Template:arma2pmc]] ({{arma2pmc}})
|-
|-
| Arma 2: Army of the Czech Republic || Arma 2:ACR
| Arma 2: Army of the Czech Republic || Arma 2:ACR || [[Template:arma2acr]] ({{arma2acr}})
|-
|-
| Arma 2 || Arma 2 || [[Template:arma2]] ({{arma2}})
| Arma 2 || Arma 2 || [[Template:arma2]] ({{arma2}})
Line 33: Line 44:
| Operation Flashpoint: Elite || OFP:E || [[Template:ofpe]] ({{ofpe}})
| Operation Flashpoint: Elite || OFP:E || [[Template:ofpe]] ({{ofpe}})
|-
|-
| Virtual Battlespace || VBS1<br />VBS2<br />VBS3 || [[Template:vbs1]] ({{vbs1}})<br />[[Template:vbs2]] ({{vbs2}})<br /><br />
| Virtual Battlespace || VBS1<br />VBS2<br />VBS3 || [[Template:vbs1]] ({{vbs1}})<br />[[Template:vbs2]] ({{vbs2}})<br />[[Template:vbs3]] ({{vbs3}})
|-
|-
| Take on Helicopters || TKOH (rather than TOH) || [[Template:TKOH]] ({{TKOH}})
| Take on Helicopters || TKOH (rather than TOH) || [[Template:TKOH]] ({{TKOH}})
|-  
|-  
| Take on Mars || TKOM (rather than TOM)
| Take on Mars || TKOM (rather than TOM) || [[Template:TKOM]] ({{TKOM}})
|}
|}


== Mod tag convention ==
Naming conventions for Mod names (so-called TAGs) can be found at [http://ofpec.com/tags/ OFPEC].
Naming conventions for Mod names (so-called TAGs) can be found at [http://ofpec.com/tags/ OFPEC].




[[Category:BI Wiki Policies]]
[[Category:BI Wiki Policies]]

Revision as of 00:32, 7 May 2018

Introduction

The BI Community Wiki is attempting to maintain a consistent appearance with articles and categories. Please adhere to the following naming conventions when editing or creating an article. When creating new topics or categories, use the common practice of GameTitleName: Subject.
For example, List of Actions OFP does not sound as good as Operation Flashpoint: Actions List; this format is clearer about the concerned game and the mentioned topic of the article. It also makes linking to those articles much easier for editors.

You can use templates in the category name, e.g [[Category:{{arma3}}: Functions]] (result: Category:Arma 3: Functions)


Sorting Keys

When defining a category for an article you should include a search key in that definition:

[GameTitleName: Subject|Sort Key]

If not defined, the automatically created table of contents will sort everything, sometimes unsuccessfully.

One can use the following:

[[Category:{{arma3}} Functions|{{uc:{{PAGENAME}}}}]]

The uc: template will uppercase the given value, which is {{PAGENAME}}.

See the interest of defining a custom key on a Functions page: if custom keys were undefined, every function would be sorted under B, for BIS_fnc_*.


Wiki name templates

Long Names Short Names Template
Arma 3 Arma 3 Template:arma3 (Arma 3)
Arma 2: Operation Arrowhead Arma 2:OA Template:arma2oa (Arma 2: Operation Arrowhead)
Arma 2: British Armed Forces Arma 2:BAF Template:arma2baf (Template:arma2baf)
Arma 2: Private Military Company Arma 2:PMC Template:arma2pmc (Template:arma2pmc)
Arma 2: Army of the Czech Republic Arma 2:ACR Template:arma2acr (Template:arma2acr)
Arma 2 Arma 2 Template:arma2 (Arma 2)
Armed Assault Arma Template:arma (Arma)
Bohemia Interactive BI (rather than BIS)
Operation Flashpoint OFP Template:ofp (Operation Flashpoint)
Operation Flashpoint: Resistance OFP:R Template:ofpr (Operation Flashpoint: Resistance)
Operation Flashpoint: Elite OFP:E Template:ofpe (Operation Flashpoint: Elite)
Virtual Battlespace VBS1
VBS2
VBS3
Template:vbs1 (Template:vbs1)
Template:vbs2 (Template:vbs2)
Template:vbs3 (Template:vbs3)
Take on Helicopters TKOH (rather than TOH) Template:TKOH (Template:TKOH)
Take on Mars TKOM (rather than TOM) Template:TKOM (Template:TKOM)


Mod tag convention

Naming conventions for Mod names (so-called TAGs) can be found at OFPEC.