Difference between revisions of "User:Sirryan2002/WikiGuide"

From Paradise Station Wiki
Jump to navigation Jump to search
(→‎Making Edits: added this section)
(→‎Images: lots of content added)
Line 125: Line 125:
===Font Usage===
===Font Usage===
=Images=
=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==
==Usage and Formatting==
In order to use an image you must utilize the <nowiki>[[File:]]</nowiki> synax.
For example, if you want to use Burger.png: [[File:Burger.png|32px]] then you must specify <nowiki>[[File:Burger.png]]</nowiki>. 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 <nowiki>[[File:Burger.png|64px|link=Space Law]]</nowiki>. There's a ton of parameters you can use but the most important ones are listed below.
{|class="wikitable mw-collapsible"
|- style="font-weight:bold;background-color:Gray;text-align:center;"
! style="center; width: 10%"| Format Type
! style="left;"              | Usage
! style="center;"            | 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. <pre>[[File:Burger.png|128px]]</pre>
| [[File:Burger.png|128px]]
|-
! Image Alignment
| You can align an image like you align text. You have four options: left, right, center, and justified <pre>[[File:Burger.png|right]]</pre>
| [[File:Burger.png|right]]
|-
! Framing
| You can put an image in a bordered frame. However, this will not allow you to resize the image. <pre>[[File:Burger.png|frame]]</pre>
| [[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 <pre>[[File:Burger.png|thumb]]</pre>
| [[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. <pre>[[File:Burger.png|link=Space Law]]</pre>
| [[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. <pre>[[File:Burger.png|Hello! this is my caption!]] and also [[File:Burger.png|Hello! this is my second caption!|frame]]</pre>
| [[File:Burger.png|Hello! this is my caption!]] [[File:Burger.png|Hello! this is my second caption!|frame]]
|}
==Uploading==
==Uploading==
In order to upload an image, you must click on [[Special:Upload|<b>upload file</b>]] 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=
=References=

Revision as of 19:29, 16 January 2021

Sloth construction.png
Sloth construction.png
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 games because they can be constantly edited and updated by the playerbase much like our wiki is. 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.

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 add commented out text inside the pages wikicode. This is great for letting other editors what to do/not do.

Comments should be avoided unless they're:

  • 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
  1. Item 1
  2. Item 2
    1. Item 2.1
    2. Item 2.2
  3. Item 3
    1. 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 don't do such and such -->
The Fitness Gram Pacer Test is a multi-stage aerobic exercise...

The Fitness Gram Pacer Test is a multi-stage aerobic exercise...

Font Usage

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: 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]]
Burger.png
Image Alignment You can align an image like you align text. You have four options: left, right, center, and justified
[[File:Burger.png|right]]
Burger.png
Framing You can put an image in a bordered frame. However, this will not allow you to resize the image.
[[File:Burger.png|frame]]
Burger.png
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]]
Burger.png
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]]
Burger.png
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 caption!
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

Anchors

Tables

Span

Templates

Calling Templates

Making Templates

Categories

Protected Pages

Special Pages

Advanced Topics

Magic Words

Parser Functions

Definitions