Osiris New Dawn Wiki:Style guide

=Style Guide= The following is a guide to help create and edit pages on the Osiris: New Dawn Wiki in accordance with the established wiki article style. These guidelines are not set in stone, but they should generally be followed in order to maintain consistency across all wiki pages.

Standard Wiki markups can be found here - for more in-depth documentation check the links below in the additional resources section.

General guidelines
1) All object names should be decapitalized (e.g. Primitive work bench) - only the first letter of the first word should be capitalized; the main reason being that it prevents a lot of headaches with links and templates to begin with. The only case names should not be decapitalized: Generally, taking a look at existing pages can help you make a decision. If it is not clear how to name a page, asking for advice is always a viable option.
 * actual names of places (e.g. Susano Crater, Lake Xaris, Icy Plains of Mag Mon Ur, etc.)
 * character names (e.g. Dr. Anja Kochnewoska)
 * any specific name given to a specific object or structure (e.g. Bearman's Best Brown Ale, Ankratech Laboratories, Ecto Morph Ripper, etc.)

2) The first instance of the page title should be bold. This should usually be in the first sentence of the article. To make a word or phrase bold, place three apostrophes (') on each side:  (using two apostrophes on each side will result in italic text). Bold can also be used for emphasis on other words in rare cases if needed. Example:

3) The first instance of an object name on a page should always be decapitalized as well and linked using double brackets  (e.g.  ). Further mentions of the same object nem should generally not be linked, though multiple identical links can exist if they occur far from each other and would be helpful to readers. An example might be one link in the introductory section along with an identical link in a section, table, or template occurring further down. Duplicate links may be especially helpful on larger pages that would require scrolling to find an item's first mention. Example:

4) Be sure to read the page before editing. The information you want to add may have been mentioned already in the article's various sections. Make sure to only add up-to-date information. Also, instead of removing obsolete information, you can use  to strike out text. This can be very useful if there is a chance of certain content returning to the game at a later point in time (e.g. devs sometimes remove things from the game for complete overhauls). Especially in such cases, adding the build version is a good idea. Example:

5) Make sure to avoid duplicate pages and files. Use the search function to find out if the page you want to create already exists. Sometimes certain in-game content is already explained in much detail within a section of another page. Only create a new page if it really is necessary. If unsure, ask for advice first. Moving and deleting duplicate pages only increases the workload of the admins.

Phrasing
1) Try to keep things simple. Long sentences usually tend to confuse readers, especially when too much information is squeezed into short paragrahps. If a more elaborate explanation is needed, don't hesitate to provide one.

2) Unlike guides, wiki articles should be written from a neutral point of view. Avoid addressing the reader directly. For example, instead of writing something like:

a more formal, impersonal wording should be used:

Page types
Different page types require different page formats. Check out the following pages to get an idea what the layout should look like and which infoboxes should be used:


 * TODO

Templates
Templates are used quite often to reduce the amount of inserting the same (or similar) code to display certain content. While there are more complex templates with distinct functions, others are rather simple to use. Do not edit templates unless you know what you are doing, since some of them are dependent on each other which can lead to layout errors. If you need help creating/editing a template, ask for help.

Here is a list of simple template types you can use without doing much harm:


 * TODO

Talk
Talk pages are for suggestions regarding the structure or contents of a page, or for a discussion with another editor. When editing a Talk: page, make sure to explain your suggestion properly. If the topic you wanted to discuss is already on the page, you should always use a colon  before your reply to make it easier to follow the flow of comments. When you are finished with your editing, please sign with your signature using  so other editors know who they are talking to.

The Talk: page should not be used to test code, mainly because it may result in displaying previews differently compared to a regular page. Instead, create a subpage on your user profile. If you need help with setting this up, feel free to ask fellow editors by visiting our community portal.

Suggestions
Suggestions should only be related to the Osiris: New Dawn Wiki, not to the game itself. If you'd like to get in contact with the developers, please utilize the game's Steam forums or email the developers at [mailto:houston@fenixfire.com houston@fenixfire.com].

Additional resources

 * Gamepedia Help Wiki
 * Wikimedia Editor Handbook
 * Wikimedia Editor Guides
 * Mediawiki Help Section