Contraption guidelines
From GMod Wiki
In order to make the contraptions section as nice as possible; I suggest some guidelines for posting contraptions.
Contents |
Use a spell checker
If you cannot spell properly; get a web browser that spell checks forms for you, like Firefox. Bad spelling really does look messy and makes your contraption entries hard to read. Take a few seconds before you post to read through your entry and make sure the instructions make sense.
Don't spell like a 13 year old (even if you are one). Use proper English; avoid unnecessary shortening of words and use correct punctuation and capitalization.
SO liek, tihs sentese iz nawt akseptibl KK?
Leave out the back patting comments
MediaWiki keeps a permanent history of who edited what on the history tab. There is no reason to fill up articles with unnecessary comments like "I added these images". Thanks for your contribution and everything, but people who care can look it up in the change log. Just be complacent that you have made the Garry's Mod Wiki better :)
Likewise, avoid "If you have any questions..." comments; that is what the discussion sections are for. If you make the author tag in the contraption header a link to your user page; people can contact you there.
Contraption template header
In order to give a consistent look across the contraptions section, a modified version of the Article template is available. It will create the second-level heading for you. Please enter the date in the same format as the below example.
{{Contraption |
name = Example Contraption Header |
author = [[User:Sam Douglas|Sam Douglas]] |
date = 4 December 2006 |
description = An example header block that you would put at the top of your contraption instructions.}}
Example Contraption Header
| Contraption guidelines: Example Contraption Header |
 Description: | An example header block that you would put at the top of your contraption instructions. |
 Original Author: | Sam Douglas |
 Created: | 4 December 2006 |
| Notes: | - |
Images
Please try at the very least to post an image of the finished contraption on the Wiki. You can upload the image to the Garry's mod wiki server using the "Upload File" link in the toolbox to the left. Please don't host the images on ImageShack or a similar service as all of the external links leave the Wiki looking cluttered and difficult to read.
You can upload the image at a moderately high resolution (to allow people to look closely at it) and ask Mediawiki to create a thumbnail of it for you when loading the page.
The example image in this section was adding using the code
[[Image:Contraption_bathtub_car.jpg|thumb|300px|Bathtub car example image]]
In addition to posting a finished image, you can (and should depending on the complexity of the contraption) post images from different steps in the construction process. These can be put into a nice table underneath your instructions like this:
{|
|-
|[[Image:Contraption_advanced_spaceship_step1.jpg|left|thumb|150px|Required Parts]]
|[[Image:Contraption_advanced_spaceship_step2.jpg|left|thumb|150px|Adding hoverballs]]
|-
|[[Image:Contraption_advanced_spaceship_step3.jpg|left|thumb|150px|Adding rear thrusters]]
|[[Image:Contraption_advanced_spaceship_step4.jpg|left|thumb|150px|Adding front thrusters]]
|}
 |  |
 |  |
Images should be clear and well composed.
Formatting
Mediawiki "wikitext" should be used wherever possible; as it is generally clearer than HTML and less prone to errors.
Please look at the documentation on the Mediawiki site for information about how to edit and format stuff properly.
Headings
Mediawiki provides five different levels of headings. They are created by placing the appropriate number of equals signs on each side of the heading text; Mediawiki will handle the formatting for it.
== My second level heading ==
For any page; it is bad style to use multiple level one headings. Don't do it.
For contraptions pages, the contraption template header will automatically create the second level heading for you; so any subheadings you create should be level 3.
Don't jump heading levels... If you are currently writing under a second level heading; don't make a fourth level heading under it.
A page's headings are automatically used to create the table of contents box at the top of the page.
Lists
Mediawiki provides shorthands for writing lists.
Numbered lists (ordered lists) can be created by prefixing each line with a # character.
# List item 1 # List item 2 ## Sub item 1 ## Sub item 2 # List item 3
- List item 1
- List item 2
- Sub item 1
- Sub item 2
- List item 3
Bulleted lists (unordered lists) work in a similar way, except you use the * character
* List item 1 ** Sub item 1
- List item 1
- Sub item 1
Don't use your own methods of making lists!
Linking
When linking to internal pages (pages on the Garry's mod Wiki), use the syntax:
[[Page_name | text for link]]
When linking to external pages (not on the Wiki), use the syntax:
[http://www.google.com Google]
