Guidelines – Bohemia Interactive Community

From Bohemia Interactive Community
Jump to navigation Jump to search

As with any good public internet place, rules and guidelines help maintain order and sanity among readers and editors. The following rules and guidelines are designed so that people will return here to contribute and find quality information. Respecting these rules will help in providing a positive experience for both editors and readers alike.

User behaviour is regulated by general BI Rules.


Content Guidelines

The content guidelines are important to ensure that content, names and pictures remain consistent. This makes reading the articles much easier, and it also makes the job of the editors easier. Content guidelines ensure that articles and topics do not violate the Rules of Conduct, or violate the law.

Text

When writing an article:

  • Do your research beforehand. Read all the relevant documentation, posts and articles on the web, this very wiki, test the situations your are describing, and only then start your article. If you are still in the early stages of editing, formatting, etc. keep the article in your sandbox until it is finished. If you are unsure about certain subjects that are brought up by your article, don't guess. Likewise, it is good to be honest and say the data is incomplete. It is better to leave out subjects about which you are unsure rather than to post hear-say or false information. This is a Wiki and other users will, over time, complete the missing parts.
  • Preview the changes before saving them. Saving every single revision during editing will clutter the "History" and "Recent Changes" pages, and will make it harder for others to track the actual changes.
  • Aim for the best spelling ("u r"/"you're" → "you are", "its" → "its", "it's" → "it is").

If there are some minor points in your article that you think someone else might be able to answer, ask on the Arma Platform Discord's #community_wiki channel

  • Only post verified information on the wiki - this should go without saying.
  • Do not ask questions (about a topic, a future game, anything else).
  • Talk pages and Discussion pages are not to be used anymore and are blocked for modification.
  • If in doubt, use Arma Platform Discord's #community_wiki channel or the or the forums

Images

Uploaded images must not contain porn, real killings, mutilations, wounds, carnage and other explicit images. This also includes links to pages that contain such images. The only accepted images for this Wiki must be related to a Bohemia Interactive product. Keep the following guidelines in mind when uploading and posting pictures here:

  • You must own the image rights or its copyright must allow its upload on this wiki
  • Do not use hotlinked images in the Wiki. Use the Upload File function instead to upload images to this Wiki.
  • Use the Naming Rules
  • When appropriate use an image thumbnail on the article page (such as on the OFP Easter Eggs page).
  • Avoid using a text link to point to an image. Display the image as thumbnail or sized appropriately for the article.


Format Guidelines

These guidelines are here to ensure that articles are presented in a clear, understandable and consistent style.

Categorise your Article

Organisation is essential for making it easy to find information on this Wiki. Be sure to categorise your article once you have completed the writing. Always use categories for a page. Unless you categorise your article properly people will not be able to find it.

Clearly distinguish content specific to a particular project. If the content you are creating is about Operation Flashpoint then it should be categorised in the appropriate Operation Flashpoint category, not everything from Operation Flashpoint is applicable to later titles).

Create/Edit Sections

When starting a new subject on an article or discussion page define a section name to describe the sub-topic (Example: == Create/edit Sections ==).
When editing only a section of a page, use the section edit button (the [edit] link on the right side) to open only that particular part of the page. This will prevent conflicts if two people are editing the same page.

External Links

  • To link an external page, use the {{Link}} template (e.g {{Link|https://www.google.com|My Link}} – this will allow to track dead links faster in the future.
  • Do not link to websites that have temporary addresses (e.g IPs).

Changes Summary

When making only small edits check the "This is a minor edit" box at the bottom. This makes the version history easier to read. Generally 90% of the edits will be minor edits for boldness, typos, etc. By default all edits are marked as "major". This can be changed to "minor" in your preferences setting.

Be sure to include a summary text of edits you have made. This makes it easy for other people to see at a glance what the edit was about. Even short text statements like "fixed typo" will be sufficient in most cases.

Page Titles

Do Don't
  • Operation Flashpoint: Actions List
  • Operation Flashpoint: Elite
  • Arma 3: Weapons
  • List of Actions OFP
  • OFP:Elite
  • A3:Weapons

When creating new categories or articles, consider the naming convention to be used.
[[Operation Flashpoint: Elite]] is more acceptable than [[OFP:Elite]]. The new category or article should almost always be [[Game Title: something]] such as [[Operation Flashpoint: Addons]].

The namespace must be considered:

Use Namespaces whenever possible!

The name choice should always be clear and concise for the reader, and easy for the editor to link back to. Keep in mind that you can use spaces in the name of the article (e.g. [[Easter Eggs]] would be better than [[EasterEggs]]).

Content

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)

Categories

Use the GameCategory template whenever possible.

Templates can be used 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}}|{{uc:{{PAGENAME}}}}]]

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

See the interest of defining a custom key on the Arma 3 Functions page: if custom keys were not defined in the {{RV}} template, every function would be sorted under B, for BIS_fnc/BIN_fnc.

Deletion Guidelines

Deletion is only possible by a wiki admin. Pages should not be created without thinking beforehand, therefore pages are usually moved rather than deleted.

A page can be marked for deletion with {{Wiki|delete}}:

  • A page containing pointless/test/BI-unrelated/law-breaking content is prone to be deleted.
  • All links to that page must be removed before doing so.