Difference between revisions of "Style Guide"

From OCE Space Simulation
Jump to: navigation, search
m (→‎Common Spelling Errors)
 
(28 intermediate revisions by 7 users not shown)
Line 1: Line 1:
 +
{{sim}}
 
__FORCETOC__
 
__FORCETOC__
  
−
This page is likely to never be complete, and is a compilation of wit and (mostly) wisdom surrounding the art of editing a Wiki article. The tips given here are by no means mandatory, unless [[Stefan]] upgrades [[TheKillerRabbit]] to a full God of editing, but they make life easier for everyone on the Wiki.
+
==General Guidelines==
 +
===Wikipedia===
 +
'''When in doubt, follow the [http://en.wikipedia.org/wiki/Category:Wikipedia_guidelines Wikipedia Guidelines].''' People have spent years trying to perfect these. They work. 'Nuff said.
  
 +
===Common Links===
 +
====Current====
 +
The link [[current]] redirects to the current year's page. Please do not use this too much, and instead write "as of [[{{{date}}}]]", where {{{date}}} is a month and/or year.
  
−
==Common Errors==
+
====Preferences====
 +
Use the first link in each of the following groups preferentially:
 +
*[[Habitat]] vs. Hab
 +
*[[440 Albert]] vs. Ottawa Tech
 +
*[[OCESS]] or [[Spacesim]] vs. Sim
  
−
This is an area for Sysops, and those who spend a great deal of time trying to organise the Wiki so that all the links are correct to post their pet peves.
+
===Signatures===
 +
Sign any comments you might make with four tildes (<nowiki>~~~~</nowiki>).
  
−
===Hab vs. Habitat===
+
===Common Spelling Errors===
−
 
+
Try to avoid these common misspellings (the first word in each pair is correct):
−
If you are posting a link to the habitat page, please make it <nowiki> [[habitat]]</nowiki> and not <nowiki>[[hab]]</nowiki>. I could just make a redirect, but for us to maintain a semblance of proffessionalism, we need to cut down on the use of coloquial contractions.
+
*Plan'''e'''tarium vs. Plan'''a'''tarium
−
 
+
*Sate'''l'''lite vs. Sat'''t'''elite
−
===440 Albert===
+
*Harold'''e''' vs. Harold
−
 
+
−
If you are posting a link to our current facilities page, make it <nowiki> [[Ottawa Tech]]</nowiki> and not <nowiki> [[440 Albert]]</nowiki> or various other permutations of our current address. I would make a redirect but I do not know how to, and uniformity is good.
+
  
 
===Capitalization===
 
===Capitalization===
 +
In multi-word titles, the first letter of every word in the title should be capitalized excepting articles and prepositions. Articles or prepositions should be capitalized if they are the first word in the title.
  
−
Since computers are stupid, and cannot process a capital letters and lower case letters, I recomend that we capitalize the first letter of every word in the title of an article, since the computer treats [[Mission Control]] differently from [[Mission control]], which leads to numerous internal links being non-functional, even though we have an article with the same name, bit different capitalization. For some reason this problem only occurs for titles with 2 letters or more. for single letters, [[mission]] will work just as well as [[Mission]]. Either way, we should capitalize in a proper fashion to keep the english teachers happy
+
===Third Person===
 +
All articles are to be written in the third person.
  
−
===1st person vs. 3rd person===
+
===Lists===
 +
Do not create lists of current members, for example "Current Simulators", "Current Astros", and "Current MCs" pages. Instead, these should be mentioned on the appropriate Mission article.
  
−
All articles are to be written in the third person. I don't want to see any "Now, we are become simulators, destroyers of the hab", or "Those of us in mission control have the following duties..."
+
===Years===
  
 +
For the wiki, all years are noted in 20##-## form. (ex 2005-06). Please use this for all links and references to facilitate linking and make everything look uniform. '''Do not use''' eg. 2005-2006 or 2005.
  
−
The reason for this is that this wiki is not a day to day account of current events. This is the BBoS replacement. This is Sim HISTORY, and as such, all articles must not attempt to reflect the whims of the current membership. Please pause and reflect on how to make you articles both factual, and able to survive for at least a year before needing to be edited because you're no longer EEP commander.
+
===Bolding===
−
 
+
Please bold (enclose in triple apostrophes) the title of an article. This rule does not apply to Mission ([[1992-93]] for example) pages, talk pages, etc.
−
 
+
−
This also bans the creation of "Current Simulators", "Current Astros", and "Current MCs" pages. We have the website to do that, and the wiki for HISTORY.
+
  
 
==Talk Pages==
 
==Talk Pages==
 
===Signatures===
 
===Signatures===
 
Talk pages are a prime breeding ground for poor formatting, just as swamps breed disgusting insects. The two main things to make sure of when editing a talk page are to sign everything you write (by typing <nowiki> ~~~~ </nowiki> after your comment, or by clicking the button that looks like a signature, second from the right). Otherwise, you are likely to be ignored, since we don't know who we're talking to.
 
Talk pages are a prime breeding ground for poor formatting, just as swamps breed disgusting insects. The two main things to make sure of when editing a talk page are to sign everything you write (by typing <nowiki> ~~~~ </nowiki> after your comment, or by clicking the button that looks like a signature, second from the right). Otherwise, you are likely to be ignored, since we don't know who we're talking to.
 +
 +
Your signature can be customized (look at mine: [[User:TheKillerRabbit|<font color="green">The</font> <font color="#0099CC">Killer</font> <font color="red">Rabbit</font>]] <font size="1">[http://vv.carleton.ca/~nhotson aka Nevin]</font>). There is a wikipedia article on how to do this ([http://en.wikipedia.org/wiki/Wikipedia:How_to_fix_your_signature Wikipedia:How to fix your signature]), which deals with pointers on how to correct errors; if you know basic HTML, both it and Wiki formatting work in signatures if you turn on the "Raw Signatures" option in your preferences. For example, my signature is set up like this: <pre><nowiki>[[User:TheKillerRabbit|<font color="green">The</font> <font color="#0099CC">Killer</font> <font color="red">Rabbit</font>]] <font size="1">[http://vv.carleton.ca/~nhotson aka Nevin]</font></nowiki></pre>
 +
 +
It uses a mix of Wiki formatting (for the links) and HTML tags (for the colours and sizes).
  
 
===Indenting===
 
===Indenting===

Latest revision as of 15:25, 9 April 2010

WTF FTW FTW!

This is an OCESS Wiki organizational article.

Do not edit unless you are a wikimaster or alumnus.


General Guidelines

Wikipedia

When in doubt, follow the Wikipedia Guidelines. People have spent years trying to perfect these. They work. 'Nuff said.

Common Links

Current

The link current redirects to the current year's page. Please do not use this too much, and instead write "as of [[{{{date}}}]]", where {{{date}}} is a month and/or year.

Preferences

Use the first link in each of the following groups preferentially:

Signatures

Sign any comments you might make with four tildes (~~~~).

Common Spelling Errors

Try to avoid these common misspellings (the first word in each pair is correct):

  • Planetarium vs. Planatarium
  • Satellite vs. Sattelite
  • Harolde vs. Harold

Capitalization

In multi-word titles, the first letter of every word in the title should be capitalized excepting articles and prepositions. Articles or prepositions should be capitalized if they are the first word in the title.

Third Person

All articles are to be written in the third person.

Lists

Do not create lists of current members, for example "Current Simulators", "Current Astros", and "Current MCs" pages. Instead, these should be mentioned on the appropriate Mission article.

Years

For the wiki, all years are noted in 20##-## form. (ex 2005-06). Please use this for all links and references to facilitate linking and make everything look uniform. Do not use eg. 2005-2006 or 2005.

Bolding

Please bold (enclose in triple apostrophes) the title of an article. This rule does not apply to Mission (1992-93 for example) pages, talk pages, etc.

Talk Pages

Signatures

Talk pages are a prime breeding ground for poor formatting, just as swamps breed disgusting insects. The two main things to make sure of when editing a talk page are to sign everything you write (by typing ~~~~ after your comment, or by clicking the button that looks like a signature, second from the right). Otherwise, you are likely to be ignored, since we don't know who we're talking to.

Your signature can be customized (look at mine: The Killer Rabbit aka Nevin). There is a wikipedia article on how to do this (Wikipedia:How to fix your signature), which deals with pointers on how to correct errors; if you know basic HTML, both it and Wiki formatting work in signatures if you turn on the "Raw Signatures" option in your preferences. For example, my signature is set up like this: 
[[User:TheKillerRabbit|<font color="green">The</font> <font color="#0099CC">Killer</font> <font color="red">Rabbit</font>]] <font size="1">[http://vv.carleton.ca/~nhotson aka Nevin]</font>

It uses a mix of Wiki formatting (for the links) and HTML tags (for the colours and sizes).

Indenting

If you're part of a discussion about something, indent your posts. Do this by adding a certain number of colons before your post; the first person puts no colons, the second person puts one, the third person puts two, and so on ad infinitum. This allows everyone to see who said what.

Example:

Blah

Blah?
Blah!
Blah!
BLAH!
Retrieved from "http://wiki.spacesim.org/index.php?title=Style_Guide&oldid=8840"