Wiki Tutorial

From GMod Wiki

Revision as of 16:23, 20 August 2010 by Crazy Quebecer (Talk | contribs)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to: navigation, search



Tick 64.pngEditing the GMod Wiki give back to the Garry's Mod community! It is very easy, gives you a great sense of accomplishment, and helps out others who may have struggled with a problem before. This page outlines the techniques involved in editing a Wiki page. Have a read here and then try out some techniques in the Sandbox!

Basic stuff

Opening pages for editing

Opening a page for editing

If you want to edit a page, you have to open it for editing. You can to this by clicking the "edit" tab that is located on top of every page. If you want to experiment, do so in the Sandbox.

Creating new pages

Often it will be necessary to add new pages to the wiki. To do so, enter a name for the page you want to add into the search box in the navigation area, then click at "Go". If there isn't already a page under this name you will get the notice "You can create this page". Click on that link to create the page.

WikiTut-Create.png

WikiTut-Create2.png

Creating a new page, first step. Creating a new page, second step.



GMod Wiki Cheatsheet

Works anywhere in the text - Text types
Description You type You get
Italic text

''italic''

italic

Bold text

'''bold'''

bold

Bold and italic text

'''''bold & italic'''''

bold & italic

Underlined Text
Depreciated - Avoid using this.

<u>underlined</u>

underlined

Striked Out Text
Depreciated on Article Pages.
Acceptable on Talk Pages.

<strike>striked out</strike>

striked out

Small Text

<small>small</small>

small

Big Text

<big>big</big>

big

Typewriter Text

<tt>typewriter text</tt>

typewriter text

Code
The difference between Typewriter text and Code is the white background, but it's not very noticeable on the standard Wiki pages.

<code>code</code>

code

Lua
Use this to add Lua code to a page.

<lua>function foo(bar) return not bar end</lua>

function foo(bar)
	return not bar
end
Subscripts and Superscripts

<sub>subscript</sub> <sup>superscript</sup>

subscript superscript

Comments
Comments are not visable on the page, but are left for future editors, to help them understand the page in Edit view.

<!--Comment-->

Works anywhere in the text - Links and images
Description You type You get
Link to another GMod Wiki page

[[Name of page]]
[[Name of page|Text to display]]

Name of page
Text to display

Link to an external webpage
Note the space between the URL and the descriptive text

[http://example.com/ example.com]

example.com

Add an image
Thumbnail with caption

[[File:Yarin_Kaul_Icon_Jumbo48.png|thumb|alt=Alt text|Caption]]

Alt text
Caption
Add an image
In-line with text

Example example [[Image:Yarin_Kaul_Icon_Jumbo48.png]] example.

Example example Yarin Kaul Icon Jumbo48.png example.

Add an image
Galleries

<gallery caption="The Icon Gallery"> Image:Yarin_Kaul_Icon_Trap48.png|Trap Image:Yarin_Kaul_Icon_Jumbo48.png|Airplane </gallery>

Add a table

{| border="1"
! Column Title1 !! Column Title2 !! Column Title3
|-
| Row1, Column 1
| Row1, Column 2
| Row1, Column 3
|}

Column Title1 Column Title2 Column Title3
Row1, Column 1 Row1, Column 2 Row1, Column 3
Add a page to a category [[Category:Category name]]
Categories should be placed at the end of pages. The category name will display in a bar at the bottom when the page is previewed or saved.
Signature
Only sign your contributions when posting to a Talk Page.
Do not sign when contributing to an article.

~~~~

Username (talk) 20:00, 12 December 2011 (UTC)

Works only at the beginning of lines
Description You type You get
Redirect to another page
Redirects must be placed at the start of the first line.

#REDIRECT [[Target page]]

Redirect arrow without text.pngTarget page

Section headings
A Table of Contents will automatically be generated when four headings are added to an article.
=Level 1= should not be used.

== Level 2 ==
=== Level 3 ===
==== Level 4 ====
===== Level 5 =====
====== Level 6 ======

Level 2

Level 3

Level 4

Level 5
Level 6
Bulleted list

* One
* Two
** Two point one
* Three

  • One
  • Two
    • Two point one
  • Three
Numbered list

# One
# Two
## Two point one
# Three

  1. One
  2. Two
    1. Two point one
  3. Three
Indenting text
This is generally used when replying on a Talk Page, as it keeps conversations easy to browse.

no indent (normal)
:first indent
::second indent
:::third indent

no indent (normal)

first indent
second indent
third indent
Preview Boxes
Created by either using the <pre> & </pre> or putting a space (" ") first on a line.

<pre>Fist Example</pre>
Second Example

First Example
Second Example
For more details on how to edit a Wiki, see the help section on Wikipedia.

Garry's Mod Wiki specific

Templates

Warning 64.png Templates used on Wikipedia will not work on GMod Wiki! See a full list of GMod Wiki templates here.


Templates are predefined, reusable text snippets. If you insert the name of a template between {{ and }} (no spaces) into a page, the wiki will replace it with the content of the template. Templates are used to save typing work and to reach a consistent look'n'feel.

You can also deliver parameters to some templates to fit it to your needs. Parameters are separated by |. Here is an example:

 {{MyTemplate|FirstParam=moo|SecondParam=foobar}}

Some templates take unnamed parameters. They are used like this:

 {{MyTemplate|moo|foobar}}

The wiki contains several templates you can use. A complete list can be found here.

Personal tools
Namespaces
Variants
Actions
Navigation
Lua Scripting
Functions
Hooks
Toolbox