Space Engineers Wiki:Styling Guide

Thank you for contributing updates and new content for the community! When editing existing pages or adding new ones, please stick to the following editing guidelines.

Please be polite and constructive and don't use the wiki to advertise. In case of doubt, follow the existing style and heading structure of similar pages.

If any formatting is unclear, don't worry about it, leave a comment on the Discussion tab and an admin will help you. Or ask directly on Discord.

Guidelines

Space Engineers Wiki.gg Styling Guidelines are to help keep consistency in style throughout the site as well give rules on the use of pages.

Contributors should not be intimidated by the guidelines. They are here to help the more serious contributors and help quell disputes. Making a mistake or two is fine and will not result in a ban or other punishment. Users should assume good faith and politely fix or report the issue. Chances are that any mistake will be fixed by the next person to see the page with no grief.

All Pages

The Following guidelines will generally apply to all pages in the "Article" namespace, regardless of page type or subject. Some exceptions are made for top level pages and the Main Pages.

Attribution

As with all information every where, and always, contributors should attribute sources and know that anything posted here is automatically released under the CC-BY-SA Licence.

Language Preferences

Use the spelling that the game uses, that means, American English preferred.

Professional Writing

• Write clearly and unambiguously. Don't introduce several new concepts in one sentence.

• Use a clear, active or imperative style when describing tasks:
  • Avoid: After pasting the script, it should compile.
  • Prefer: Paste the script and compile it.
• Gender Specific: Avoid "him/his/he, her/hers/she". It is easier to use plural: "Players log on to their games, engineers crashed their ships, automatons help them," and so on.
• English Contractions are acceptable, but writing out the words looks better.
• Avoid cultural references: Cliches, Colloquialisms, Catchphrase and other Popular Culture references. An international audience will use this site to find information on Space Engineers. Using cultural references may make understanding more difficult for them and potentially mislead or even offend.

Page Creation

• This Wiki will be using a standard to include the headings References and See also on all article pages. Please include these headings, even if they are temporarily published empty.
  • References shall include any sources referred to in the article, cited in the appropropriate place. Any quotes shall be wrapped in speech marks ("").
  • See also shall include any sources not specifically used in the article, but are related to the article and so may be of further use to the player.
• Singular vs plural - singular preferred in titles where possible.
• Proper Capitalization: All words are Capitalized, except articles (a, an, the)
• Intentional use of redirect pages - Redirect pages are fine where appropriate to do so. However, these may be removed at administrator's discretion.
• Category page use - category pages may include information where appropriate, such as Category:Blocks. If you discover a page that is outdated, please add it to the Category:Updateme.

Linking

• To link to another article inside Space Engineers Wiki.gg, place double square brackets about the word to be linked ([[ ]]).
  • Example: [[Space Engineer]] will produce Space Engineer
• Link no more than necessary.
• Do not link terms linked in info boxes... they are already linked.
• Link terms that may be used in specific ways in-game, especially if they have another meaning out of the game.
• To link an article to an external site place single square brackets about the "URL" and space, then the text to be displayed to be linked ([ ]). External links will show up as blue with a box and arrow.
  • Example: [http://www.google.com google] will produce google
• If an article does not exist by the given name, or if a URL is invalid, the link will show up as dark red, like this.

Headers

• Use proper capitalization.
• Avoid other styling like bolding, underlining, and italicizing in headers.
• Make all Headers unique, regardless of level (this is for linking sake, e.g. [[Page Name#Header]]).
• Avoid punctuations and special characters (again, this is for linking sake).
• Headings should not normally contain links, especially where only part of a heading is linked.
• Headings should not explicitly refer to the subject of the article, or to higher-level headings, unless doing so is shorter or clearer.
• Headings should be descriptive and in a consistent order.
• Headings should be nested sequentially:
  • the automatically generated top-level heading of a page is H1, which gives the article title;
  • primary headings are then ==H2==, ===H3===, ====H4====, and so on until the lowest-level heading ======H6======.
  • headings should be nested sequentially, neither using random heading levels (e.g. selected for emphasis, which is not the purpose of headings), nor skipping parts of the sequence.

Heading use (and misuse) examples

Correct	Random/chaotic	Skipping levels
[Article lead here] ==Section== [level 2] ===Sub-section=== [3] ==Section== [2] ===Sub-section=== [3] ====Sub-sub-section==== [4] ==Section 3== [2]	[Article lead here] ====Section?==== [4] ===Section?=== [3] ==Section?== [2] ==Section?== [2] ====Section?==== [4] ===Section?=== [2]	[Article lead here] [Level-2 section missing here] ===Section?=== [3] ==Section== [2] [Level-3 sub-section missing here] ====Sub-section?==== [4] ==Section== [2]

Table Styles

• Small Tables (generally less than 20 cells)
  • Float the table if it is narrow (one, two, or three narrow columns)
• Large Tables (generally more than 20 cells)
  • Avoid floating a large table as it may end up placing text in a vary narrow area beside the table.

Note: Avoid tables that require a huge amount of space. If they are best for a set of information, use the "wikitable mw-collapsible mw-collapsed" class and default to the collapsed position. This will help keep articles shorter and help readers find information below the table they might otherwise miss.

Warnings, Tips, Spoilers

To highlight a warning or tip, you can use a notebox:

• {{Note|notetext=lorem ipsum.|type=note}}
• {{Note|notetext=lorem ipsum.|type=info}}
• {{Note|notetext=lorem ipsum.|type=warning}}
• {{Note|notetext=lorem ipsum.|type=error}}

This is an example of what a highlighted tip could look like.

To warn readers of spoilers and let them choose whether they want to scroll further down or skip the rest of the page, use {{Spoiler}}, which renders as this banner:

Spoiler warning!
This article or section contains details about the game which players may be intended to discover on their own!

To hide whole paragraphs or images containing spoilers, use: {{CollapsibleBox|title=Click to view spoiler|content=Clang Cola contains gravel!}}

Click to view spoiler

Clang Cola contains gravel!

Keyboard, Mouse, Controler

Use the following templates to render keys or mousebuttons. https://spaceengineers.wiki.gg/wiki/Template:Mouse https://spaceengineers.wiki.gg/wiki/Template:Key

Visual Media

• Caption rules
• Image Format: png preferred but jpg fine.
• Use gifs only where they add more information than a screenshot would. Otherwise, avoid them.
• Use videos as above, unless the video is a Keen official video. Use the <youtube></youtube> element to embed.
• Qty of media on a page (use of galleries) - (try to keep the number low ish to keep page load time down)
• Give credit to media creators / owners. This also includes workshop items. Avoid plagiarism at all times. If you are known to be plagiarizing, there will be consequences.

Player Suggestions

• Personal player suggestions, tips, recommendations, strategies, and methods are generally discouraged on pages about the game proper.
  • If you want to give tips on how to play the game, write a tutorial.
• This Wiki has been designed with game information and mechanics in mind. However, if you feel that an external guide or gameplay tip would be useful, please either:
  • Link to the guide externally - for example, a guide to building an airlock on the Air Vent page. Remember to credit the author.
  • Use the {{Spoiler}} template and place this information inside the spoiler tag.
• Sources may include, but are not limited to: The Space Engineers subreddit , Space Engineers Steam guides , Twitch clips or streams or Youtube videos.

Categorization Rules

• All Pages: Every page should be in a category. If a contributor does not know what category a page should go, it should remain uncategorized so that an admin can use the "uncategorized pages" tool to find it and place it in the appropriate category.
• Lowest Relevant level only: do not place a page into all the categories in a nest. Only the lowest category that is appropriate is needed.
• Max number of categories for a page (?): Do not place a page into lots of categories. If a page will fit into more than 3 categories, then it may need to be worked.
• Creating a new category: In general, contributors should avoid making new categories. If a new category is appropriate, then the category page should be filled in with content. Categories should have more than 5 pages in them to be justified.
• For more help with categories, see Help:Category

Templates

Templates are preformatted blocks of text and/or code that are used repeatedly or have small amounts of content that change often. They are generally placed at the top of a page, though that is not always the case.

Common, General Wiki.gg Templates

• {{clr}} - Clears a full line between the lowest pixel of content above the tag, and the highest pixel below the tag. Commonly used just before a new header while an image or floating table (i.g. table of contents) is placed in the previous.
• {{Stub}} - This indicates that an article is to short to justify its own page. It either needs to be expanded or placed as part of another article.
• {{Delete|Reason}} - See Below.
• {{Main|Page}} - This is used to refer back to a page that explains a topic in more depth. Generally used in top level pages that give an over view of many game mechanics or content.

https://commons.wiki.gg/wiki/Category:Game_input_images https://commons.wiki.gg/wiki/Category:PC_images

Special Templates, Mostly Unique to this Site

• {{Cleanup|Reason}} - Clean Up template is used to indicate that the article does not follow the styling guidelines and needs reworking.
• {{WIP}} - If an article is still under construction, placing the {{WIP}} tag on it will indicate that it is a Work In Progress and should not be deleted or taken as complete. This should only be used if there is a large amount of work to be done and will be worked on in the near future.

https://spaceengineers.wiki.gg/wiki/Template:About {{About|the block named "Assembler"|its early-game counterparts|Basic Assembler|and|Survival Kit}}

https://spaceengineers.wiki.gg/wiki/Template:Header

{{Tocright}}

{{Info Block}}

{{PAGENAME}}

Deletion

Reasons for deletion include, but are not limited to:

• Copyright violations and other material violating the non-free content criteria.
• Vandalism, including inflammatory redirects, pages that exist only to disparage their subject, patent nonsense, or gibberish
• Advertising or other spam without relevant content (but not an article about an advertising-related subject).
• Articles for which thorough attempts to find reliable sources to verify them have failed.
• Redundant or otherwise useless templates.
• Categories representing over-categorization.
• Files that are unused, obsolete, or violate the Non-free policy.
• Any other use of the article, template, project, or user namespace that is contrary to the established separate policy for that namespace.
• Any other content not suitable for an encyclopedia.

subject to the condition that improvement or deletion of an offending section, if practical, is preferable to deletion of an entire page.

Since only Admins are able to delete the pages, regular users may mark the page for deleting by using the {{delete}} template.

Power User Privileges

Admins, Staff, and some other contributors maintain the privilege to change or diverge from the styling guide lines at any time.

Tutorials

Modding Tutorials and Scripting Tutorials use a template to help authors include all relevant information.

TODO