Guide to Editing the Wiki

From Paradise Station Wiki
Jump to: navigation, search
So you wanna contribute to the wiki?

Well as easy as it sounds, wait what am I saying it is easy.

BUT There are still some things you should know.


The Basics

OK so first off you have to sign up on the wiki here After you create a account you should see that when you enter the wiki again you will have your name on the top right, if you don't wait a minute or 2 and refresh.

Alright now its time to starting figuring out how to understand basic wiki code. When you see the page you want to edit click the topish area that says edit and you will be taken to the editing panel. Here is where the magic happens.

When editing, please do not edit any Lore, SOP or Space Law pages without express approval from the Headmins.

General Guidelines to Follow

This is just a quick list of general suggestions for wiki editing guidelines.

  • Whenever possible, properly capitalize links and link names. This fits in better with how the Wiki supports article names at a software level, and proper nouns are supposed to be capitalized anyway.
  • Try not to make every reference to a wiki article a link. The first one or two in an article is perfectly sufficient.
  • When uploading images, try to use GIF or PNG format, as those are lossless compression formats, unlike JPG, and are not huge, unlike BMP.
  • If you want to upload an image, check first if there is an older version of the image already in the wiki. If there is, update it. That will automatically do everything else for you. And it keeps the wiki tidy.
  • Make sure to include the size modifier when calling file images. IE: File:Cat.png|32px as opposed to File:Cat.png
  • Fill out the comment to let people know what you did.
  • We try to keep the wiki semi-serious. Making things entertaining to read is key, but we don't really need jokes everywhere.
  • Keep on subject. Try to keep articles related to the title. If you feel like you're going off on a tangent, try linking to a new article.
  • Unless it is barely anything try not delete someones hard work instead just try to go with their style and fix it accordingly.
  • Before you start a page like in Locations or in Roles try to read a few other pages to make sure that you are using the right template and the right colors in some cases.
  • When first starting out, start small like add picture from the code [here] by going to the \Paradise-master\icons part of the file. Adding pictures helps alot of people in the long run and gives a good idea on what you will be doing when editing the pages. Make sure that the base resolution of uploaded files is at least 64x64px and that they have a transparent background.

Templates and Categories

Here is a list of all Categories and the important Templates we are using. If you make one, add it to the list (some templates automatically add categories to an article if you use them).

  • Templates
  • Categories (Note: Some Categories redirect to a wikipage. To get to the Category, click on the reference below the pagename)

Please read the description in every Category and add it to an article where appropriate.

Locations

  • Obvious exits should not include cardinal directions to reduce page bloat. Simply list the exits in a flowing list, IE: Central Primary Hallway, Bar/Chapel Maintenance
  • Access Level should list the exact access required to access that location. Higher level access (such as Captain) should not be listed.
  • Clearance should list only the minimum job rank/most obvious job rank required to access a location unless the location page references multiple areas like Escape Pods.
  • Clearance (when listed) should contain page links to the jobs put under clearance.
  • Any text on the page should appear in the description field and not below the template. This includes Guide links.
  • The Department field should match the section the area is found in under the Template:Locations template.

Templates

Templates are pretty much just a fill in the blanks dealio and there are a bunch of them here!

{| style="border:1px solid {{{bgcolor2|#bbbbbb}}};" cellpadding="0" cellspacing="0"
 |
{|width="100%" cellspacing="0" cellpadding="2"
|align=center width="150" style="background-color:{{{bgcolor1|lightgrey}}}"|[[File:{{{image|{{{name|Unknown}}}.png}}}|50px]]
<br>'''{{{name|Item name here}}}'''
|'''Found in: '''{{{foundin|Places item is found in}}}
<br>'''Used for:''' {{{usedfor|What the item is used for }}}
<br>'''Strategy:''' {{{strategy|How to obtain or use the item properly}}}
|}
{|width="100%" cellspacing="0" cellpadding="2"
| style="background-color:{{{bgcolor2|grey}}};" |'''Description'''
|}Place description here<br>
{|width="100%" cellspacing="0" cellpadding="2"
| style="background-color:{{{bgcolor2|grey}}};" |'''Contains'''
|}
  Put Pictures here if any

If you understand this then you can skip this section!

Otherwise, all of the above is the basic template for adding a item. Now all this you really don't have to know its just there to tell the wiki what to do. Other templates like this one:

{{Template:Location
 |headerbgcolor=darkblue
 |headerfontcolor=white
 |imagebgcolor=lightblue
 |department = General
 |name=Mint and Mint Vault
 |image=Mint.png
 |big_image=Mint_big.png
 |exits=[[Hallway|Hallway]] north, [[Maintenance|maintenance]] south, [[Maintenance|maintenance]] east
 |purpose=Production and storage of [[Coins|coins]]
 |access=Mint for reception desks and loading area, Mint vault for vault
 |contents=Coin press, Some Coins
 |clearance=[[Captain]], [[Head of Personnel]], [[Quartermaster]], [[Shaft Miner]], [[Chief Engineer]]
 |description=A semi-protected room, accessible from the south and east from [[Maintenance|maintenance]] and from the [[Hallways|main hallway]] in the north. 
Modeled to look like a bank, it is intended to stora money and other valuables. It's vault is a lot less protected than the [[Vault| main vault]] tho. |sec_level=Medium to high |style=Bank |balance=No major balance requirements |other=-- }}

are more user friendly and can greatly help you in the long run, I will be using this as my example. Now when you apply this to a blank page it will look like this:


General Area
General Description
Obvious exits: Hallway north, maintenance south, maintenance east
Purpose: Production and storage of coins
Access level: Mint for reception desks and loading area, Mint vault for vault
Noteworthy contents: Coin press, Some coins
Clearance: Captain, Head of Personnel, Quartermaster, Shaft Miner, Chief Engineer
Security level: Medium to high
A semi-protected room, accessible from the south and east from maintenance and from the main hallway in the north.
Modeled to look like a bank, it is intended to store money and other valuables. It's vault is a lot less protected than the main vault tho.
caption=Mint and Mint Vault

When you change around the wording you will get different results, if you want you can try it out by click your name in the top then click on your profile page edit, after that copy the lines of code up there and change around the wording to see what happens.

Categories

Categories categorizes the pages and files of the wiki to help people find them easier, but the search bar works a little better.

Uploading a file to the Wiki

Uploading a file is as simple as one two three, just follow this and you will see!

Step: One

Go Here

Step: Two

Click upload file and find the file you wanna upload. Just make sure that it is either has a .PNG, .GIF, .JPEG, or .JPG format because those are the only ones you can upload. Also make sure to give it a appropriate name and a possible summary. If it is contradicting with another file make sure to look at both and decide which is better then update or not update the old file accordingly.

Step: Three

Now you can add it to anything your heart so desires just make sure it goes with the page. To add it simply put this code in [[File:imangename.png]] and it should place the picture like this:

Paradise.PNG

Now if you happen to use a .png format then you can add special tags on it like this [[File:Paradise.PNG|500px|thumb|left|alt text]]
Picture with tags


The 200px means how big it will be and will not work if you add the thumb tag.

The left means that the picture will be placed on either the left side, right side or the center of the screen.

The thumb means that it will place it in a thumbnail and put the alt text on the bottom.

The Alt text means that when you hover your mouse of it or if the the pic is broken it will show whatever you wrote for it.


Tags

Now the Wiki uses basic HTML with some BBcode elements, if you dont know what HTML is then click [here]. BBcode is just a way to simplify HTML to make it more user friendly. You might of used BBcode if you were ever the HoP or the Bartender because the paper writing system uses basic HTML and BBcode! Read the top of this Guide to Paperwork. As you can see if you made a menu or a job app then you already know some basic things, the following tags are just a extent of HTML that this wiki will understand and you can use it to help make the pages prettier.

Word Tags

=text= creates the largest headline

======text====== creates the smallest headline

<b></b> Creates bold text

<i></i> Creates italic text

<tt></tt> Creates teletype, or typewriter-style text

<cite></cite> Creates a citation, usually italic

<em></em> Emphasizes a word (with italic or bold)

<strong></strong> Emphasizes a word (with italic or bold)

<font size="3"></font> Sets size of font, from 1 to 7

<font color="green"></font> Sets font color, using name or hex value

Links

[[Page Name Here]] creates a hyperlink

[[File:Filename.filetype|sizepx]] creates an image/link

[[Page Name Here#Subsection Here]] creates a target location within a document

[[#Subsection In Page]] links to that target location from elsewhere in the document

Formatting

<p align="left"> Aligns a paragraph to the left (default), right, or center.

<br> Inserts a line break

<blockquote></blockquote> Indents text from both sides

<dl></dl> Creates a definition list

<dt> Precedes each definition term

<dd> Precedes each definition

<ol></ol> Creates a numbered list

<ul></ul> Creates a bulleted list

<li></li> Precedes each list item, and adds a number or symbol depending upon the type of list selected

<div align="left"> A generic tag used to format large blocks of HTML, also used for stylesheets

<img src="name" align="left"> Aligns an image: left, right, center; bottom, top, middle

<img src="name" border="1"> Sets size of border around an image

<hr /> Inserts a horizontal rule

<hr size="3" /> Sets size (height) of rule

<hr width="80%" /> Sets width of rule, in percentage or absolute value

<hr noshade /> Creates a rule without a shadow

Tables

<table></table> Creates a table

<tr></tr> Sets off each row in a table

<td></td> Sets off each cell in a row

<th></th> Sets off the table header (a normal cell with bold, centered text)

Table Attributes

<table border="1"> Sets width of border around table cells

<table cellspacing="1"> Sets amount of space between table cells

<table cellpadding="1"> Sets amount of space between a cell’s border and its contents

<table width="500" or "80%"> Sets width of table, in pixels or as a percentage of document width

<tr align="left"> or <td align="left"> Sets alignment for cell(s) (left, center, or right)

<tr valign="top"> or <td valign="top"> Sets vertical alignment for cell(s) (top, middle, or bottom)

<td colspan="2"> Sets number of columns a cell should span (default=1)

<td rowspan="4"> Sets number of rows a cell should span (default=1)

<td nowrap> Prevents the lines within a cell from being broken to fit

Useful pages

Categories Used, unused and wanted

Templates Used, unused and wanted

Files: All, unused and wanted

All pages: All existing pages and Wanted pages

Contribution Guides
General Complete Guide to Contributing, Contributing to Paracode, Setting up TortoiseGit, Game Resources category
Setting server Setting up the Database, Creating your own paracode server
Coding Understanding SS13 Code, SS13 for experienced programmers
Mapping Guide to Mapping,
Spriting Guide to Spriting,
Wiki Guide to Editing the Wiki