Oxygen Not Included Wiki:Manual of Style

From Oxygen Not Included Wiki
Jump to: navigation, search

This Manual of Style outlines a standard of clean, consistent formatting for articles in Oxygen Not Included Wiki. The formatting described here is a guideline and can be overridden where circumstances warrant it. These guidelines will never be unerringly perfect for every situation. However, please try your best to keep to the advice outlined in this article so others may use your edits as an example when creating and editing their own articles.

These guidelines are a summary of the most important guidelines for the Oxygen Not Included Wiki, but a more expansive set of guidelines can be found on Wikipedia at Wikipedia Manual of Style.

Article layout[edit source]

One of the most important parts of wiki editing is how to structure an article. The structure is a powerful thing: it dictates what information the reader reads and when he or she reads it. It can influence what people contribute, where it goes, and how it might be written. Structure has the power to inform or confuse the same way good or bad writing does. Keep a well structured article, and you're more likely to have a high quality one.

Organize sections in an article in a hierarchical structure like you would an outline. Keep it logical, but feel free to forsake strict logic for readability. Wherever possible, try to have an introduction for each section. Just like the article as a whole, the section should start with an introduction and then have its subsections below it. Try using a shallow structure rather than a deep one. Too many nested sections usually leads to a confusing or unreadable article. See #Section headings for more info on writing section headings.

Above all, keep your layout consistent. Don't throw your reader a curve ball too often. The following sections will offer some good advice on keeping your articles clean, consistent, and clear. They are presented in the order in which they should appear in an article.

Non-article content[edit source]

A disambiguation line is sometimes put at the beginning of an article to link to another article with the same or similar title. The line should be italicized and indented once. Most usually contain the phrase, "Were you looking for X?". Example:

Were you looking for Copper Ore?

The templates {{for}} or {{about}} can also be used for this purpose.

Article message boxes[edit source]

An article message box is generally a temporary notice on an article—it may flag up some issue or notify the user about some special aspect of the article. It should never be part of the article content. Oxygen Not Included Wiki uses special message boxes that properly format the message box on the page. Editors should not use {{Ambox}}, {{Ombox}}, or other direct template calls. The system that's set up will automatically use the proper template with the correct inclusions.

For a list of all templates, please see this list.

Infoboxes[edit source]

Infoboxes, boxes which summarize data relating to the article, should appear at the top-right corner of the article content. Infoboxes should generally summarize available information; speculation, as well as "unknown" or "n/a" rows should be avoided.

Article lead section[edit source]

An article should begin with an introductory lead section, before the first subheading. The lead should be capable of standing alone as a concise overview of the article, establishing context, and explaining why the subject is interesting or notable. It should be between one or two paragraphs long, and should be written in a clear and accessible style so that the reader is encouraged to read the rest of the article. The lead should not be explicitly entitled == Introduction == or any header with equivalent meaning.

If possible, make the title the subject of the first sentence of the article. For example, write "Oxygen is the primary gaseous element in Oxygen Not Included.".

The first time the article mentions the title, put it in bold using three apostrophes—'''article title''' produces article title. Avoid other uses of bold in the first sentence, except for alternative titles of an article; for example, Polluted Oxygen:

Polluted Oxygen is one of the gas resources. It's breathable and works similarly to Oxygen, allowing Duplicants to survive.…

Follow the normal rules for italics in choosing whether to put part or all of the title in italics. This will mainly apply to the titles of books and games:

Oxygen Not Included is continuously being updated with new features. The latest update is Quality of Life MK I.

Do not put links in the bold reiteration of the title in the article's lead sentence. For example, "Polluted Oxygen…" versus "Polluted Oxygen…"

Table of contents[edit source]

A table of contents (TOC) will automatically appear in articles with a minimum of four headings (unless forced by the below options). By default this will be left-aligned above the first section heading.

  • To force a TOC position (left-aligned): __TOC__
  • To completely remove the TOC from a page: __NOTOC__

The table of contents can be right-aligned—but this should only be done if it is very long (over 15 entries) and an information box is not occupying the top-right corner of the article.

  • Right-aligned TOC that floats next to text: {{tocright}}

Article content[edit source]

For information on writing the article itself, see the #Writing section.

Gallery[edit source]

This section is used to show images in <gallery> tags.

Videos[edit source]

This section is used to show YouTube (and other sites) embedded videos using <vplayer /> at the top of the section and {{#vlink:<youtube video id>|<description>}} <br /> for each video.

Template:Seealso

See also[edit source]

This section is used to list links to related topics on Oxygen Not Included Wiki, which may not have been linked within the article content. Use bullets to list the links.

References[edit source]

Under the references section should be placed <references/>, or {{reflist}}, the usage of which can be found at Project:Citation.

External links[edit source]

In the external links section should be any external (off-wiki) links relating to the article.

Categories and interwiki links[edit source]

Categories and interwiki links should be added at the very end of the article, with category links followed by interwiki links. A full list of categories can be found on Special:Categories. They take the form [[Category:Categoryname]], and should be named in the same fashion as articles.

Writing[edit source]

We now come to the most important part of an article: the words themselves. When you're editing wikis, you're both academic and artist. You have to be accurate, but you also have to be interesting. Neither one can dominate; you have to skillfully balance both.

Style[edit source]

  • Keep your writing concise. Don't use two words where one will do. Keeping your writing simple will make it easy to understand and easy to expand on. Use complete sentences whenever possible. When you write, use grammar as a toolbox: know the rules, but only break them on purpose.
  • Check your spelling and grammar. Do not use 'u' in place of 'you' or '2' in place of 'to'. Write the way you would for a class paper or a newspaper article. This makes it easier for all readers to understand, not just the ones accustomed to the same conventions you are.
  • Write from an impersonal perspective. Do not use "I." For example, do not write, "I always place generators above the base to avoid excessive heat generation." Avoid drawing attention to the author (yourself) as much as possible.

Content[edit source]

Keep the following general guidelines in mind when considering what to include in the article:

  • Keep all of the topics you cover within the scope of the article. What that means is, you don't need to give a detailed description of Oxygen on the page about Resources. Consider the article's title as your point of origin and write from that perspective. Make use of the wiki's ability to link to more detailed articles or external sources for more information.
  • Avoid repeating other sources verbatim. In general, prose in Oxygen Not Included Wiki articles should be original. If possible, you should avoid reusing Klei's descriptions or previews of e.g. game features or updates. Use your own words to describe the subject matter.

Grammar[edit source]

Grammar is a writer's toolbox. You can't build good sentences without knowing how to use your tools. Since a wiki article must be as clear as possible for all of the people reading it, editors must maintain a high level of adherence with the rules of grammatical use, to ensure clear communication. Note that a sentence that seems grammatically incorrect, may not be depending on context.

This cannot be emphasized strongly enough. Numerous edits to the Wiki have to be performed, which are purely for the purpose of correcting truly atrocious grammar. Do not use a native language other than English as an excuse - there are any number of grammar tutorials and references available on the Web, so you should be doing your utmost to make your contributions correct while improving your command of the language.

Capitalization[edit source]

Shortcut: ONIW:CAPS

Capitalization generally follows the rules used in the game, even in cases where the term could be used in both in and out of the game contexts. This provides a consistent standard without bogging down editors in trying to figure out which is correct in every individual case.

In-game buildings such as Air Pump should be capitalized as they are in-game. Titles such as Researcher or Farmer should also be capitalized.

Tense[edit source]

Most articles should be described as facts, so use the present or future tenses. "Regolith is found near the top of the map." "This building can be researched by Researchers."

Content that has been removed or otherwise changed should be referred to in the past tense, as the information being presented is no longer current.

Formatting[edit source]

Dates[edit source]

Shorthand dates (used in tables and templates) should be written in the form YYYY-MM-DD (for example, 2009-04-01), to aid alphanumeric organizing. Dates in longhand (as written in article sentences) should be written in the form M D, YYYY (for example, April 1, 2009).

Oxygen Not Included Wiki does not use MM-DD-YY[YY] (04-01-2009) or DD-MM-YY[YY] (01-04-2009), as use of either format may be confusing.

Quotations[edit source]

Format a long quote (over four lines) as an italicized block quotation, which will be indented from both margins. Do not enclose the block quote in quotation marks. To format a block quotation, do not use the wiki indentation mark ":" — instead, use the HTML <blockquote> element.

Tables[edit source]

Tables should use the "darktable" class design when possible, and should include as little "fancy" formatting as possible. Tables can also be made sortable by adding a "sortable" class.

For long tables, striped tables utilizing alternating shadings are recommended to aid in distinguishing rows, using the "zebra" class.

More information about wiki tables can be found on Help:Table.

Section headings[edit source]

Use the == (two equal signs) style markup for main headings, equivalent to <h2>.

Do not use a single =. This is because a single = creates an <h1> heading. The page header already uses an h1, and to use further h1s would be poor semantics. In addition, do not use wikilinks in subject headings. When edited, these sections become confusing in the edit history because of the link code. Consider instead putting the word in the first or second sentence of the section and linking it there.

Capitalize the first letter only of the first word and of any proper nouns in a heading and leave all of the other letters in lower-case. Use "Tips and tricks", not "Tips and Tricks". Note that this is different from most section title rules you'll encounter elsewhere.

Avoid special characters in headings, such as an ampersand (&), a plus sign (+), curly braces ({}), or square braces ([]). In place of the ampersand, use the word "and" (unless the ampersand is part of a formal name).

Always keep headings short and simple. Headings are guidelines to your page's structure and should inform the reader rather than confuse. To keep it short, avoid unnecessary words or redundancy in headings, i.e. avoid a, an, and the, pronouns, repeating the article title, and so on. Also, try to avoid giving identical titles to different sections.

Links[edit source]

Some templates on Oxygen Not Included Wiki modify how incoming links to a page appear on other pages; others allow you to customize the appearance of a link explicitly. Note that this formatting functionality should be used appropriately; the formatting used must be relevant to the context being discussed.

Conclusion[edit source]

Every article can be improved (even this one). Following these guidelines will not ensure a perfect article the first time, but it will give the article a stronger skeleton. It's ultimately your job as an editor to put meat on it.

See also[edit source]