Naming Conventions – Bohemia Interactive Community
Jump to navigation
Jump to search
Lou Montana (talk | contribs) (Add arma2baf, arma2pmc, arma2acr, vbs3 and TKOM template - Add detailed description on page formatting - Page format) |
Lou Montana (talk | contribs) (Add Template:Name link, fix formatting and removal of OFPEC tag mention) |
||
| Line 1: | Line 1: | ||
{{SideTOC}} | |||
The BI Community Wiki is attempting to maintain a | 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> | |||
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. | 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. | ||
| Line 7: | Line 9: | ||
== Sorting Keys == | == Sorting Keys == | ||
When defining a category for an article you should include a search key in that definition: | When defining a category for an article you should include a search key in that definition: | ||
[ | <nowiki>[[Category: CategoryName'''|Sort Key''']]</nowiki> | ||
If not defined, the automatically created table of contents will sort everything, sometimes unsuccessfully. | If not defined, the automatically created table of contents will sort everything alphabetically, sometimes unsuccessfully. | ||
One can use the following: | One can use the following: | ||
<nowiki>[[Category:{{arma3}} Functions|{{uc:{{PAGENAME}}}}]]</nowiki> | <nowiki>[[Category:{{arma3}} Functions|{{uc:{{PAGENAME}}}}]]</nowiki> | ||
The {{Inline code|uc:}} template will '' | The {{Inline code|uc:}} wiki template will '''''u'''pper'''c'''ase'' the given value, which is {{Inline code|<nowiki>{{PAGENAME}}</nowiki>}}. | ||
{{Informative|See the interest of defining a custom key on a [[:Category: | {{Informative | See the interest of defining a custom key on a [[:Category:Arma 3: Functions|Functions]] page: if custom keys were not defined in the [[Template:Function|Function Template]], every function would be sorted under '''B''', for BIS_fnc_*.}} | ||
== Wiki common names == | |||
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. | |||
{| class="wikitable" | |||
{| | |||
! Long Names || Short Names || Template | ! Long Names || Short Names || Template | ||
|- | |- | ||
| Line 50: | Line 57: | ||
| Take on Mars || TKOM (rather than TOM) || [[Template:TKOM]] ({{TKOM}}) | | Take on Mars || TKOM (rather than TOM) || [[Template:TKOM]] ({{TKOM}}) | ||
|} | |} | ||
[[Category:BI Wiki Policies]] | [[Category:BI Wiki Policies]] | ||
Revision as of 00:53, 2 May 2020
Template:SideTOC 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 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:
[[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}} Functions|{{uc:{{PAGENAME}}}}]]
The uc: wiki template will uppercase the given value, which is {{PAGENAME}}.
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 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) |