Difference between revisions of "Help:Style guide"

From Grid Sage Wiki
Jump to navigation Jump to search
(Added preferred font size for art)
 
(2 intermediate revisions by the same user not shown)
Line 11: Line 11:
 
Try to be consistent with existing articles:
 
Try to be consistent with existing articles:
  
* Name pages with uppercase letters.
+
* Capitalize page names.
 
* Prefer singular to plural (e.g. Swarmer instead of Swarmers)
 
* Prefer singular to plural (e.g. Swarmer instead of Swarmers)
  
Line 42: Line 42:
 
The highest header level that should be used is <nowiki>==This==</nowiki>. Do not use <nowiki>=These=</nowiki>, they are reserved for the article main title only. In each article, there should be a brief introduction before going into specifics. This introduction should not have a header, like <nowiki>==Introduction==</nowiki>, because it is obvious and because when omitting it, the introduction appears before the table of contents as it is supposed to.
 
The highest header level that should be used is <nowiki>==This==</nowiki>. Do not use <nowiki>=These=</nowiki>, they are reserved for the article main title only. In each article, there should be a brief introduction before going into specifics. This introduction should not have a header, like <nowiki>==Introduction==</nowiki>, because it is obvious and because when omitting it, the introduction appears before the table of contents as it is supposed to.
  
==Item pages==
+
==Art/Images==
  
Each item page should also list the effects of the item, and any messages that item can generate. Tips and strategy relating to that item should go next.
+
Ideally the default form of any ASCII art (as well as screenshots, where possible) should use the size 12/Cogmind font. Cogmind was designed specifically around this default, and some of the other options don't look quite as good. While there are many other options available, consistency is key.
  
 
==Templates==
 
==Templates==
Line 59: Line 59:
  
 
==General principles==
 
==General principles==
 +
 +
Please proofread for grammar and spelling.
  
 
Consider consulting [http://en.wikipedia.org/wiki/Wikipedia:Manual_of_Style Wikipedia's Manual of Style] on the matter; some editors think that it's pretty good.
 
Consider consulting [http://en.wikipedia.org/wiki/Wikipedia:Manual_of_Style Wikipedia's Manual of Style] on the matter; some editors think that it's pretty good.
  
 
[[Category:Help]]
 
[[Category:Help]]

Latest revision as of 23:32, 3 June 2015

Grid Sage Wiki (Edit box)


The Grid Sage Wiki is just beginning and lacks a formal style guide, but below are some conventions to follow as we add content and keep the wiki consistent to aid in both browsing and future expansion. Discuss style suggestions and changes on the talk page.

Tone

Articles should be written in a largely encyclopedic tone. That means clearly separating facts from comments, by putting strategy tips in their own section, and comments on the talk page. Spelling and grammar should follow Americanized language rules.

Article names

Try to be consistent with existing articles:

  • Capitalize page names.
  • Prefer singular to plural (e.g. Swarmer instead of Swarmers)

The first time the article name appears in the main text, it should be bolded. This includes the titles of any redirects redirecting to the article.

Redirects

When creating a new article, redirect variations on that name to it to avoid someone duplicating the article under a slightly different title.

The syntax for a redirect is like this:

#REDIRECT [[insert article]]

See the MediaWiki redirects help page for further help with redirects.

New articles

Do not create empty new articles or new articles that contain nothing but the {{Stub}} message just in hopes of seeing someone add more content to them. Add the content yourself! If you don't know about the subject, learn about it or ask politely on Grid Sage Wiki's talk page for someone to create the article.

Categories

Categories are not articles. Do not link an article directly to a category page. Category pages are simply to organize lists of related pages in one place. Each new article should have at least one category assigned to it. The naming convention should be: singular for article pages, and plural for categories, so you have Robot to describe robots, and Category:Robots to list the robots.

Capitalization

Capitalization should be used for the names of any in-game objects such as robots ("Swarmers"), parts ("Anti-Matter Cannon"), machines ("Terminals") and areas ("Mines").

Headers

The highest header level that should be used is ==This==. Do not use =These=, they are reserved for the article main title only. In each article, there should be a brief introduction before going into specifics. This introduction should not have a header, like ==Introduction==, because it is obvious and because when omitting it, the introduction appears before the table of contents as it is supposed to.

Art/Images

Ideally the default form of any ASCII art (as well as screenshots, where possible) should use the size 12/Cogmind font. Cogmind was designed specifically around this default, and some of the other options don't look quite as good. While there are many other options available, consistency is key.

Templates

  • {{Stub}} can be used on a page to plea for someone to expand it. From time to time, some editors will look over Category:Stubs for articles to expand.
  • {{Delete}} adds a page to Category:Candidates for Deletion so that administrators can consider deleting it. Please give a reason in the talk page of an article before adding the Delete template.

A list of templates can be found here.

Sign your posts

When writing on articles/users' talk-pages sign your posts with four tildes, ~~~~. That will automatically expand to your signature with time-stamp.

General principles

Please proofread for grammar and spelling.

Consider consulting Wikipedia's Manual of Style on the matter; some editors think that it's pretty good.