User:Sirryan2002/WikiGuide

This article or section is a Work in Progress.
Assigned to:Sirryan2002

Please discuss changes with assigned users. If no one is assigned, or if the user is inactive, feel free to edit.

Wiki Editing Tutorial

Many people want to edit the Paradise wiki but have absolutely no idea how or where to start learning. This guide serves as the easiest way to pick up on basic-intermediate wiki code and provide a stepping stone for others to improve their wiki knowledge.

This is not a set of rules for the wiki, for that, you should go Here. Template:TOC

Making Edits

Wikis are such a fabulous tool for servers because they can be constantly edited and updated by the playerbase. Whenever you make a change/edit to any page it is documented in the view history tab at the top of the page. In there you can see who made the edit, when they made it, and what they said they edited. In addition, you can compare edits to see the changes between them and undo them.

Whenever you make an edit, you are required to do two things.

1. Summarize your edit
2. Declare the type of edit you're making

When summarizing your edit, keep it concise(in 1 sentence) and describe vaguely what you did. For example, if you add a bunch of items to a table, you can just specify "Added additional items to the (insert name here) table."

If your edit is purely to correct a small(within 50 characters) grammatical/phrasing/spelling issue then you should declare your edit as a Minor Edit "grammar fix" or "spellcheck" will suffice as a summary for these types of edits.

Comments

You are able to Comment out text inside the pages wikicode. This is great for letting other editors what to do/not do.

Comments should be used for:

• Explaining Template Code
• Warning users not to delete certain code
• Explaining weird/uncommon syntax
• Warning users not to add something because previous content of that type has been repeatedly reverted
• Used to section areas of the code off when it gets messy

Comments should not be used to:

• Leave funny/friendly messages or jokes
• Temporarily remove sections to be re-added later (this is what user and draft pages are for)
• Explain changes made

Text Formatting

Text by itself is extremely boring and often hard to read, so you can use text formatting to make your words really POP!

Format Type	Usage	Output
Bold	Use this to bring attention to important text <b>This text is bold!</b> or '''This text is bold'''	This text is bold!
Underline	Use this to underscore important information or warnings <u>This text is underlined!</u>	This text is underlined!
Italic	Use this to enounciate certain words <i>This text is italicized!</i> or ''This text is italicized!''	This text is italicized!
Headings	Use this to declare a section of your article and organize it Level 1 Headings should not be used because it conflicts with the wiki page's HTML file 4 or more headings causes the page to have a Table of Contents(TOC) Headings must be at the start of a line and not border other text ===Level 3=== ====Level 4==== =====Level 5===== ======Level 6 ======	Level 3 Level 4 Level 5 Level 6
Bullet Lists	This is how you create bullet lists *Item 1 * Item 2 ** Item 2.1 ** Item 2.2 * Item 3 ** Item 3.1 *:- Definition	Item 2 Item 2.1 Item 2.2 Item 3 Item 3.1 - Definition
Numbered Lists	This is how you create numbered lists #Item 1 # Item 2 ## Item 2.1 ## Item 2.2 # Item 3 ## Item 3.1	Item 1 Item 2 Item 2.1 Item 2.2 Item 3 Item 3.1
Preformatted Text	Use this to preformat text with a certain, this will alos allow you to write anything within the pre blocks without the wiki recognizing it as text formatting. <pre>This text is preformatted to be the default font and style, <b>Things aren't bolded</b> or <i>Italicized</i>!!!</pre>	This text is preformatted to be the default font and style, <b>Things aren't bolded</b> or <i>Italicized</i>!!!
Comments	Use this to leave important notes/messages to people editing the page. Comments do not show up when you view the wiki page and are only visible in the page editor. <!--This is a comment, to whoever is reading this --> The Fitness Gram Pacer Test is a multi-stage aerobic exercise...	The Fitness Gram Pacer Test is a multi-stage aerobic exercise...
Nowiki	The nowiki block makes it so that any formatting within the block is ignore and is instead displayed as regular text. <nowiki><b>This is bold!<b> this is a burger: [[File:Burger.png]]</nowiki>	<b>This is bold!<b> this is a burger: [[File:Burger.png]]

Images

Images are extremely important for our wiki, without them people wouldn't know what icons/mobs would look like or get a visual representation of what they're supposed to do. Trying to include pictures in your articles can seem daunting at first, but it's super easy once you get a handle on it.

Usage and Formatting

In order to use an image you must utilize the [[File:]] synax.

For example, if you want to use Burger.png: then you must specify [[File:Burger.png]]. This will make Burger.png appear wherever you declare this.

However, in order to make images useful to us, we need to format that in a way that is easy to understand and see. We can add parameters to our image by utilizing the '|' character. If you want your image to a certain size and make it link to another page you can specify it as [[File:Burger.png|64px|link=Space Law]]. There's a ton of parameters you can use but the most important ones are listed below.

Format Type	Usage	Output
Pixel Size	You can declare how large you want your image to be in pixels. Generally, you want to stick with either the original size of the file, 64px, or 32px. Or else you may have lossy resizing. [[File:Burger.png|128px]]
Image Alignment	You can align an image like you align text. You have four options: left, right, center, and justified [[File:Burger.png|right]]
Framing	You can put an image in a bordered frame. However, this will not allow you to resize the image. [[File:Burger.png|frame]]
Thumbnail	You can put an object in a thumbnail which allows the image to be clicked and expanded. This allows you to resize an image while still having it be in a frame [[File:Burger.png|thumb]]
Links	You can make an image link to a page when it is clicked. You only need to include the page name/subsection and not the full link. [[File:Burger.png|link=Space Law]]
Captions	You can add a caption to a framed image or have a tooltip appear with that caption with non framed images. [[File:Burger.png|Hello! this is my caption!]] and also [[File:Burger.png|Hello! this is my second caption!|frame]]	Hello! this is my second caption!

Uploading

In order to upload an image, you must click on upload file in the left taskbar. Here you can upload lots of files(if they're supported) to the wiki.

General Rules about uploading:

• Check to make sure your image doesn't already exist on the wiki
• If your image already exists but you want a better resolution, upload a new version to that file
• Try and upload sprites with the size 32px or 64px
• Once you upload an image, it cannot be removed except by an admin
• Give your images proper names
• Make your images have a transparent background if applicable
• Try to only use these formats: .png and .gif
• Larger images such as File:General Destruction.png don't have to follow sizing guidelines because they're supposed to be large and high resolution

References

It is very important the articles link to each other so we have a web of information. In order to do this, we can reference articles and link keywords to those articles.

The most obvious way to do this is by typing [[Article Name]]

For example, you could link to Space Law by typing

[[Space Law]]

You can also link the article and change the link text. If you wanted to still link to space law but instead have the link be Legal Suggestions then you would have to use the syntax below. The two parameters for images is the Page Name and the Link Text --> [[Page Name|Link Text]]

[[Space Law|Legal Suggestions]]

Referencing Nuances

As a general note, you should always add spaces after references as it will include any characters that are next to it. So if you write [[Space Law]]textextext It will output as Space Lawtextextext.

If you wanted to do something like SMES's where you have characters directly next to the link then you would have to add the <nowiki /> tag to it --> [[SMES]]<nowiki />'s

If you want to link to an image rather than embedding it you will need to add a ':' colon before the name. For example, I can reference File:Burger.png without the image embedding itself by doing:

[[:File:Burger.png]]

If you want to link to something outside of the Main: Namespace (if you're not sure what a namespace is, go here, but for now all you need to know is that all general users will be reading are in the Main Namespace) you will have to specify which namespace the article is in before you link it.

For example if I wanted to link to my user page:User:Sirryan2002 I cannot just use [[Sirryan2002]] because it will automatically default to the main namespace -> [[Main:Sirryan2002]] which does not exist. I will have to instead specify which name space I'm searching in. For the user's name space I will specify User

[[User:Sirryan2002]]

Referencing Subsections

Sometimes you don't want to just link to an article, you want to link to a specific point in that article.

By adding a hashtag '#' to the end of a page name in your link you can specify where you want to go in that article. You can do this for any subsection in an article.

If I wanted to link this to Crime Codes References on the Space Law page. All I would have to do is specify it like so:

 [[Space Law#Crime Codes Quick Reference]]

If the area you're referencing is in the article where the link is you can shorten the syntax. For example if I was on the Space Law page and I wanted to link a certain word to a subsection/anchor all I would have to do is use a '#' and write the subsection name:

[[#Crime Codes Quick Reference]]

Anchors

An Anchor is a defined place within in a page that you can link people to. They work much like headings where you can link people to them:

[[Page Name#Anchor Name]]. Infact, all headings have anchors attached to them!

On our wiki we have [[Template:Anchor]] which allows us to create anchors extremely easily. What you will need to do is find the area you want someone to be taken to and place the anchor directly next to it via <pre>{{Anchor|Anchor_Name}}

If I wanted to create an anchor right -> here <- all I would have to do is this:

If I wanted to create an anchor right -> here{{Anchor|AnchorExampleSpot}} <-

now if you click on #AnchorExampleSpot it should take you directly to the anchor.

Tables

This is where wikicode starts getting a little more difficult and confusing.

A wikitable always has to be wrapped by curly brackets

{|
All the content goes here
|}

Below from left to right is Table Syntax, an example table in final form, and example code for a table.

Syntax	What it does
{|	Start a table - required
|}	End a table - required
|+	Add a definition/title to the table
|-	Starts a new row
!	Creates a Header Cell
|	creates a new cell

Header Cell	Header Cell	Header Cell
Header Cell	Cell	Cell
Header Cell	Cell	Cell
Header Cell	Cell	Cell
Header Cell	Cell	Cell
Header Cell	Cell	Cell
Header Cell	Cell	Cell

{|class="wikitable" style="float:left; margin:10pt;"
|- style="font-weight:bold;background-color:Gray;text-align:center;"
! Header Cell
! Header Cell
! Header Cell
|-
! Header Cell
| Cell
| Cell
|}

Table Classes

On the Paradise wiki, we never go with the default table setup because it has no border or lines to break up cells. In order to give our tables fancy UI we have to declare what class it is.

We always do this at the beginning directly after the table start syntax

{|class="wikitable"
|-
! Header Cell
! Header Cell
! Header Cell
|-
! Header Cell
| Cell
| Cell
|}

The wikitable class gives our tables borders/outlines

Header Cell	Header Cell	Header Cell
Header Cell	Cell	Cell

The mw-collapsible class makes it so you can collapse the table(have to include wikitable class)

{|class="wikitable mw-collapsible"
|-
! Header Cell
! Header Cell
! Header Cell
|-
! Header Cell
| Cell
| Cell
|}

Header Cell	Header Cell	Header Cell
Header Cell	Cell	Cell

The mw-collapsed starts a table with a mw-collapsible class in the collapsed state.

{|class="wikitable mw-collapsible mw-collapsed"
|-
! Header Cell
! Header Cell
! Header Cell
|-
! Header Cell
| Cell
| Cell
|}

Header Cell	Header Cell	Header Cell
Header Cell	Cell	Cell

Table Style

Without defining the style of your table, it will look barebones without color background or formatted text. It will be default font with only borders.

Cell	Cell	Cell
Header Cell	Cell	Cell
Header Cell	Cell	Cell

For style options/syntax please go here #Style

Categories

In order to assign a wikipage to a category, all you need to do is add this to the bottom of the page:

 [[Category:Category name]] 

For example, I've assigned this article to Category:Guides by adding this to my page code:

[[Category:Guides]]

You can create a category by typing this into the search bar and creating "create page" which should be highlighted in red

 [[Category:Insert name here]]