Naming Conventions – Bohemia Interactive Community

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Minor fixes)
m (Fix <tt> usage)
Line 4: Line 4:
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.
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 <tt>Namespace: PageTitle</tt>, e.g <tt>GameTitleName: Subject</tt>.<br>
When creating new topics or categories, use the common practice of {{hl|Namespace: PageTitle}}, e.g {{hl|GameTitleName: Subject}}.<br>
For example, '''List of Actions OFP''' does not sound as good as '''[[Operation Flashpoint: Actions]]'''; 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.
For example, '''List of Actions OFP''' does not sound as good as '''[[Operation Flashpoint: Actions]]'''; 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.


Line 27: Line 27:


The [[Template:Name|Name Template]] provides the expected names for various product and company names.<br>
The [[Template:Name|Name Template]] provides the expected names for various product and company names.<br>
Some shortcut templates exist for simplicity (e.g <tt>{{<nowiki/>arma3}}</tt> instead of <tt>{{<nowiki/>Name|arma3}}</tt>) and are listed in the table below.
Some shortcut templates exist for simplicity (e.g {{hl|<nowiki>{{arma3}}</nowiki>}} instead of {{hl|<nowiki>{{Name|arma3}}</nowiki>}}) and are listed in the table below.


{| class="wikitable"
{| class="wikitable"
! Long Names || Short Names || Template
! Long Names || Short Names || Template
|-
|-
| Arma 3 || Arma 3 || [[Template:arma3]] ({{arma3}})
| {{Name|arma4}} || {{Name|arma4|short}} || [[Template:arma4]] ({{arma4}})
|-
|-
| Arma 2: Operation Arrowhead || Arma 2:OA || [[Template:arma2oa]] ({{arma2oa}})
| {{Name|armaR}} || {{Name|armaR|short}} || [[Template:armaR]] ({{armaR}})
|-
|-
| Arma 2 || Arma 2 || [[Template:arma2]] ({{arma2}})
| {{Name|arma3}} || {{Name|arma3|short}} || [[Template:arma3]] ({{arma3}})
|-
|-
| Armed Assault || Arma || [[Template:arma1]] ({{arma1}})
| {{Name|arma2oa}} || {{Name|arma2oa|short}} || [[Template:arma2oa]] ({{arma2oa}})
|-
|-
| Bohemia Interactive || BI ('''not''' BIS) || ''[[Template:Name|<nowiki>{{Name|bi}}</nowiki>]] ({{Name|bi}})''
| {{Name|arma2}} || {{Name|arma2|short}} || [[Template:arma2]] ({{arma2}})
|-
|-
| Operation Flashpoint || OFP || [[Template:ofp]] ({{ofp}})
| {{Name|arma1}} || {{Name|arma1|short}} || [[Template:arma1]] ({{arma1}})
|-
|-
| Operation Flashpoint: Resistance || OFP:R || [[Template:ofpr]] ({{ofpr}})
| | {{Name|bi}} || {{Name|bi|short}} ('''not''' BIS) || ''[[Template:Name|<nowiki>{{Name|bi}}</nowiki>]]'' ({{Name|bi}})
|-
|-
| Operation Flashpoint: Elite || OFP:E || [[Template:ofpe]] ({{ofpe}})
| {{Name|ofp}} || {{Name|ofp|short}} || [[Template:ofp]] ({{ofp}})
|-
|-
| Take on Helicopters || TKOH (not TOH) || [[Template:tkoh]] ({{tkoh}})
| {{Name|ofpr}} || {{Name|ofpr|short}} || [[Template:ofpr]] ({{ofpr}})
|-
| {{Name|ofpe}} || {{Name|ofpe|short}} || [[Template:ofpe]] ({{ofpe}})
|-
| {{Name|tkoh}} || {{Name|tkoh|short}} (not TOH) || [[Template:tkoh]] ({{tkoh}})
|-  
|-  
| Take on Mars || TKOM (not TOM) || [[Template:tkom]] ({{tkom}})
| {{Name|tkom}} || {{Name|tkom|short}} (not TOM) || [[Template:tkom]] ({{tkom}})
|}
|}




[[Category:Bohemia Interactive Community:Policies]]
[[Category:Bohemia Interactive Community:Policies]]

Revision as of 16:51, 27 May 2022

↘
↗
This article has been proposed to merge with Bohemia Interactive Community: Guidelines.


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 Namespace: PageTitle, e.g GameTitleName: Subject.
For example, List of Actions OFP does not sound as good as Operation Flashpoint: Actions; 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)

ⓘ
See also the GameCategory template.


Sorting Keys

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

[[Category: CategoryName|Sort Key]]

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

One can use the following: 

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

The uc: wiki 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 not defined in the {{RV}} template, every function would be sorted under B, for BIS_fnc_*.


Wiki common names

The Name Template provides the expected names for various product and company names.
Some shortcut templates exist for simplicity (e.g {{arma3}} instead of {{Name|arma3}}) and are listed in the table below.

Long Names Short Names Template
Arma 4 Arma 4 Template:arma4 (Arma 4)
Arma Reforger Reforger Template:armaR (Arma Reforger)
Arma 3 Arma 3 Template:arma3 (Arma 3)
Arma 2: Operation Arrowhead Arma 2:OA Template:arma2oa (Arma 2: Operation Arrowhead)
Arma 2 Arma 2 Template:arma2 (Arma 2)
Armed Assault ArmA Template:arma1 (Armed Assault)
Bohemia Interactive BI (not BIS) {{Name|bi}} (Bohemia Interactive)
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)
Take On Helicopters TKOH (not TOH) Template:tkoh (Take On Helicopters)
Take On Mars TKOM (not TOM) Template:tkom (Take On Mars)
Retrieved from "https://community.bistudio.com/wiki?title=Bohemia_Interactive_Community:Naming_Conventions&oldid=322266"