Astroneer Wiki:Style guide

This page serves as a general guide on editing the Astroneer wiki. Before beginning edits of the wiki read through this page and try to follow it as best you can.

= Tips and Information = In this section, you will find tips and useful information geared toward helping editors both new and old.

General Tips

 * References to specific game objects and mechanics should always be capitalized.
 * The first occurrence in a text of references to specific game objects and mechanics with existing pages on the Wiki should always be hyperlinked to its respective pages. Subsequent references can be ignored, but if the text in question is very long and contains multiple sections, this rule may be re-applied to each consecutive section.
 * Follow the formatting in use for titles, sections, image galleries, etc. Consult similar pages' source code before starting a new one.
 * All pages should fit into a category tree. Again, consult similar pages for available categories and decide where best your page belongs.
 * Try to structure the content of your text into concise themes and distribute them through easy to read page sections, instead of dumping every detail about the subject into one huge description.
 * Illustrate pages with relevant images. A single example can be sufficient for most cases, while in other instances a gallery might be more appropriate. Be moderate with their use as they can have a big impact on page rendering times, but be generous whenever they can illuminate unique references to game objects or explanations of game mechanics. They should not replace verbal descriptions, but descriptions alone should not be presumed sufficient.
 * If you are about to make extensive modifications to an existing page, specially if you're unsure of every fact at your disposal, submitting a request for review to its original author (or as an open community request on its discussion page), is not only cordial, it ensures the page results in a better synergy of contributions. Authorship here is not to be construed as a measure of propriety but as a measure of coherence and quality. Feuding over semantics is to be avoided, but efforts to coalesce different author's idiosyncrasies into a unified text and smoothing over the patchwork of multiple contributions is in every reader's best interest. Inviting collaboration is a better alternative to insulated editing.
 * If when modifying a page you change the name or terminology used on the page, be sure to check what pages link to that article and update them with the new terminology or name.
 * If a page already exists under a different name but has other commonly used names, create a redirect page using #REDIRECT Page to redirect to.
 * If you come across an issue that requires immediate admin attention, post the issue on the Admin Noticeboard. That is the quickest way to get an issue to an admin's attention.

Translating Pages

 * Before translating any pages on the Astroneer wiki, be sure to read through the official Gamepedia translation guidelines.
 * (To be continued)

Front Page Editing

 * The front page is divided into four main sections. To suggest changes to any of these sections, you can use the discussion page for the front page sandbox. Alternatively, you can directly edit the sandbox sections by accessing them through the links at the bottom of the sandbox itself.
 * If something on the front page needs immediate attention, leave a message on the Admin Noticeboard.

Notice templates
Whenever you encounter page issues that you cannot resolve promptly, you may refer those changes to other editors through the use of these tags:


 * Tag pages with if facts stated within it contradict your own game experience or seem outlandish in origin, but can't offer yourself conclusive evidenceits it's claims. Pages tagged like this will show up in Category:Citation_needed. You can optionally open discussion on that page to elaborate on your thoughts and recruit volunteers for in-game testing.
 * Tag pages with when they are partially completed or in need of expansion. Pages tagged like this will show up in Category:Stubs.
 * Tag pages with if it's lacking in content, confusing, or badly formatted. Pages tagged like this will show up in Category:Cleanup.
 * Tag pages with as game development and official classifications introduce changes to game lore. Pages tagged like this will show up in Category:Pages to be moved for admin evaluation. If you're not sure a page should be moved, consider starting a discussion page to gather the thoughts of other community members.
 * Tag pages with if they prove redundant. Pages tagged like this will show up in Category:Pages to be merged for admin evaluation.
 * Tag pages with if they become obsolete or irrelevant. Pages tagged like this will show up in Category:Candidates for deletion for admin evaluation. If you're not sure a page should be deleted, consider starting a discussion page to gather the thoughts of other community members.
 * Tag image pages with if they need to be replaced with an improved image. Pages tagged like this will show up in Category:Images needing improvement.

Questions to ask yourself before starting an edit
Below are some questions you should ask your self before making any modifications to a page. Asking these questions before making an edit will help ensure a better quality of edits for all.

Questions to ask yourself before editing a page

 * Is this edit going to help anyone in any way? If the answer is no, you probably shouldn't make the edit.
 * Is this edit going to be based on facts or my opinion? If it's an opinion, you should consider starting a discussion page to gather the opinion of others.
 * Does this edit contain content that isn't released yet (ie: Experimental content, content from a dev stream, etc.)? If the answer is yes, you shouldn't add the content until it's implemented into a released version.
 * Has this edit been made before, but removed for one reason or another? If the answer is yes, you should take the reasoning for its removal under consideration before making it again.

Questions to ask yourself before creating a page

 * Does the page I'm about to create already exist under a different name? If the answer is yes, you shouldn't create the page, but you should consider: Creating a redirect page, or if the old name is outdated, use the move template to request it to be moved to a better name.
 * Does the subject of the page already exist under a different page that has multiple subjects within it? If the answer is yes, you should probably not create the page. However, if you believe it should have its own page, consider starting a discussion on the page where the subject currently is to ask the opinion of others.
 * Is this page based on unreleased content (ie: Experimental content, content from a dev stream, etc.)? If the answer is yes, you probably shouldn't create the page until it's implemented into a released version, however, if it's in a version to be released, the page can be created.
 * Has this page been deleted before? If the answer is yes, you should take the reasoning for its removal under consideration before creating it again.

= Full Page Templates = Below is a list of full-page templates that can be used in creating certain types of new pages. They can easily be copied over to a new page and filled in or generally followed according to the page type. When copying over, remove all and  tags, they are for demonstration only.

Objects Page Template
'Resource' is one of the resources in Astroneer

'Resource' can be found through (list of methods to obtain 'resource' in short paragraph form).

Uses
'Resource' is used in crafting the following: 'Resource' is used with the following:
 * 'Item 1'
 * '(ex.) Generator to produce power

Media
Editing_Guide